Merge pull request #8 from Countly/warn_def

[JS] Add warnings to all SDK example apps that would check if propper credentials have been set or it still has the defaults.
Countly · Jan 29, 2024 · d882f8b · d882f8b
2 parents 8fa0988 + 8e1d48c
commit d882f8b
Show file tree

Hide file tree

Showing 15 changed files with 154 additions and 39 deletions.
diff --git a/examples/Angular/main.ts b/examples/Angular/main.ts
@@ -8,9 +8,16 @@ import Countly from 'countly-sdk-web';
 
 window.Countly = Countly;
 
+const COUNTLY_SERVER_KEY = "https://your.server.ly";
+const COUNTLY_APP_KEY = "YOUR_APP_KEY";
+
+if(COUNTLY_APP_KEY === "YOUR_APP_KEY" || COUNTLY_SERVER_KEY === "https://your.server.ly"){
+  console.warn("Please do not use default set of app key and server url")
+}
+// initializing countly with params
 Countly.init({
-  app_key: "YOUR_APP_KEY",
-  url: "https://your.domain.count.ly",
+  app_key: COUNTLY_APP_KEY,
+  url: COUNTLY_SERVER_KEY, //your server goes here
   debug: true
 });
 Countly.track_sessions();

diff --git a/examples/React/src/index.js b/examples/React/src/index.js
@@ -8,9 +8,17 @@ import Countly from 'countly-sdk-web';
 //Exposing Countly to the DOM as a global variable
 //Usecase - Heatmaps
 window.Countly = Countly;
+
+const COUNTLY_SERVER_KEY = "https://your.server.ly";
+const COUNTLY_APP_KEY = "YOUR_APP_KEY";
+
+if(COUNTLY_APP_KEY === "YOUR_APP_KEY" || COUNTLY_SERVER_KEY === "https://your.server.ly"){
+  console.warn("Please do not use default set of app key and server url")
+}
+// initializing countly with params
 Countly.init({
-    app_key: 'YOUR_APP_KEY',
-    url: 'YOUR_SERVER_URL',
+    app_key: COUNTLY_APP_KEY,
+    url: COUNTLY_SERVER_KEY, //your server goes here
     debug: true
 });
 

diff --git a/examples/Symbolication/src/main.js b/examples/Symbolication/src/main.js
@@ -1,9 +1,16 @@
 import Countly from "countly-sdk-web";
 
+const COUNTLY_SERVER_KEY = "https://your.server.ly";
+const COUNTLY_APP_KEY = "YOUR_APP_KEY";
+
+if(COUNTLY_APP_KEY === "YOUR_APP_KEY" || COUNTLY_SERVER_KEY === "https://your.server.ly"){
+  console.warn("Please do not use default set of app key and server url")
+}
+// initializing countly with params
 Countly.init({
-  app_key: "YOUR_APP_KEY",
+  app_key: COUNTLY_APP_KEY,
+  url: COUNTLY_SERVER_KEY, //your server goes here
   app_version: "1.0",
-  url: "https://your.domain.count.ly",
   debug: true
 });
 

diff --git a/examples/example_async.html b/examples/example_async.html
@@ -12,7 +12,11 @@
 
 		//provide countly initialization parameters
 		Countly.app_key = "YOUR_APP_KEY";
-		Countly.url = "https://your.domain.count.ly"; //your server goes here
+		Countly.url = "https://your.server.ly"; //your server goes here
+
+		if(Countly.app_key === "YOUR_APP_KEY" || Countly.url === "https://your.server.ly"){
+    		console.warn("Please do not use default set of app key and server url")
+		}
 		Countly.debug = true;
 
 		//start pushing function calls to queue

diff --git a/examples/example_fb.html b/examples/example_fb.html
@@ -11,10 +11,16 @@
     <script type='module'>
         import Countly from '../Countly.js';
 
-        //initializing countly with params
+        const COUNTLY_SERVER_KEY = "https://your.server.ly";
+        const COUNTLY_APP_KEY = "YOUR_APP_KEY";
+
+        if(COUNTLY_APP_KEY === "YOUR_APP_KEY" || COUNTLY_SERVER_KEY === "https://your.server.ly"){
+            console.warn("Please do not use default set of app key and server url")
+        }
+        // initializing countly with params
         Countly.init({
-            app_key: "YOUR_APP_KEY",
-            url: "https://your.domain.count.ly", //your server goes here
+            app_key: COUNTLY_APP_KEY,
+            url: COUNTLY_SERVER_KEY, //your server goes here
             debug: true
         });
         Countly.begin_session();

diff --git a/examples/example_formdata.html b/examples/example_formdata.html
@@ -11,10 +11,16 @@
 	<script type='module'>
 		import Countly from '../Countly.js';
 
-		//initializing countly with params
-		Countly.init({
-			app_key: "YOUR_APP_KEY",
-			url: "https://your.domain.count.ly", //your server goes here
+		const COUNTLY_SERVER_KEY = "https://your.server.ly";
+        const COUNTLY_APP_KEY = "YOUR_APP_KEY";
+
+        if(COUNTLY_APP_KEY === "YOUR_APP_KEY" || COUNTLY_SERVER_KEY === "https://your.server.ly"){
+            console.warn("Please do not use default set of app key and server url")
+        }
+        // initializing countly with params
+        Countly.init({
+            app_key: COUNTLY_APP_KEY,
+            url: COUNTLY_SERVER_KEY, //your server goes here
 			debug: true
 		});
 		Countly.begin_session();

diff --git a/examples/example_gdpr.html b/examples/example_gdpr.html
@@ -9,9 +9,16 @@
         import Countly from '../Countly.js';
 
         //initializing countly with params and passing require_consent config as true
+        const COUNTLY_SERVER_KEY = "https://your.server.ly";
+        const COUNTLY_APP_KEY = "YOUR_APP_KEY";
+
+        if(COUNTLY_APP_KEY === "YOUR_APP_KEY" || COUNTLY_SERVER_KEY === "https://your.server.ly"){
+            console.warn("Please do not use default set of app key and server url")
+        }
+        // initializing countly with params
         Countly.init({
-            app_key: "YOUR_APP_KEY",
-            url: "https://your.domain.count.ly", //your server goes here
+            app_key: COUNTLY_APP_KEY,
+            url: COUNTLY_SERVER_KEY, //your server goes here
             debug: true,
             require_consent: true //this true means consent is required
         });

diff --git a/examples/example_helpers.html b/examples/example_helpers.html
@@ -9,9 +9,16 @@
         import Countly from '../Countly.js';
 
         //initializing countly with params
+        const COUNTLY_SERVER_KEY = "https://your.server.ly";
+        const COUNTLY_APP_KEY = "YOUR_APP_KEY";
+
+        if(COUNTLY_APP_KEY === "YOUR_APP_KEY" || COUNTLY_SERVER_KEY === "https://your.server.ly"){
+            console.warn("Please do not use default set of app key and server url")
+        }
+        // initializing countly with params
         Countly.init({
-            app_key: "YOUR_APP_KEY",
-            url: "https://your.domain.count.ly", //your server goes here
+            app_key: COUNTLY_APP_KEY,
+            url: COUNTLY_SERVER_KEY, //your server goes here
             debug: true
         });
 

diff --git a/examples/example_multiple_instances.html b/examples/example_multiple_instances.html
@@ -10,9 +10,16 @@
 		import Countly from '../Countly.js';
 
 		//initializing first instance, which will be global Countly
-		Countly.init({
-			app_key: "YOUR_APP_KEY1",
-			url: "https://your.domain.count.ly", //your server goes here
+        const COUNTLY_SERVER_KEY = "https://your.server.ly";
+        const COUNTLY_APP_KEY = "YOUR_APP_KEY";
+
+        if(COUNTLY_APP_KEY === "YOUR_APP_KEY" || COUNTLY_SERVER_KEY === "https://your.server.ly"){
+            console.warn("Please do not use default set of app key and server url")
+        }
+        // initializing countly with params
+        Countly.init({
+            app_key: COUNTLY_APP_KEY,
+            url: COUNTLY_SERVER_KEY, //your server goes here
 			debug: true
 		})
 		//report event to first app
@@ -23,26 +30,39 @@
 
 
 		//initialize second instance for another app synchronously
-		var Countly2 = Countly.init({
-			app_key: "YOUR_APP_KEY2", //must have different APP key
-			url: "https://your.domain.count.ly", //your server goes here
+        const COUNTLY_SERVER_KEY2 = "https://your.server.ly";
+        const COUNTLY_APP_KEY2 = "YOUR_APP_KEY2";
+
+        if(COUNTLY_APP_KEY2 === "YOUR_APP_KEY2" || COUNTLY_SERVER_KEY2 === "https://your.server.ly"){
+            console.warn("Please do not use default set of app key and server url")
+        }
+        // initializing countly with params
+        var Countly2 = Countly.init({
+            app_key: COUNTLY_APP_KEY2,
+            url: COUNTLY_SERVER_KEY2, //your server goes here
 			debug: true
 		});
+
 		//report event to second app
 		Countly2.add_event({
 			key: "second_app"
 		});
 
+		const COUNTLY_SERVER_KEY3 = "https://your.server.ly";
+        const COUNTLY_APP_KEY3 = "YOUR_APP_KEY3";
 
+        if(COUNTLY_APP_KEY3 === "YOUR_APP_KEY3" || COUNTLY_SERVER_KEY2 === "https://your.server.ly"){
+            console.warn("Please do not use default set of app key and server url")
+        }
 
 		//initialize third instance for another app asynchronously
 		Countly.q.push(["init", {
-			app_key: "YOUR_APP_KEY3", //must have different APP key
-			url: "https://your.domain.count.ly", //your server goes here
+			app_key: COUNTLY_APP_KEY3, //must have different APP key
+			url: COUNTLY_SERVER_KEY3, //your server goes here
 			debug: true
 		}])
 		//report event to third app asynchronously by passing app key as first arg
-		Countly.q.push(["YOUR_APP_KEY3", "add_event", {
+		Countly.q.push([COUNTLY_APP_KEY3, "add_event", {
 			key: "third_app"
 		}]);
 	</script>

diff --git a/examples/example_opt_out.html b/examples/example_opt_out.html
@@ -9,9 +9,16 @@
         import Countly from '../Countly.js';
 
         //initializing countly with params
+        const COUNTLY_SERVER_KEY = "https://your.server.ly";
+        const COUNTLY_APP_KEY = "YOUR_APP_KEY";
+
+        if(COUNTLY_APP_KEY === "YOUR_APP_KEY" || COUNTLY_SERVER_KEY === "https://your.server.ly"){
+            console.warn("Please do not use default set of app key and server url")
+        }
+        // initializing countly with params
         Countly.init({
-            app_key: "YOUR_APP_KEY",
-            url: "https://your.domain.count.ly", //your server goes here
+            app_key: COUNTLY_APP_KEY,
+            url: COUNTLY_SERVER_KEY, //your server goes here
             debug: true
         })
         //track sessions automatically

diff --git a/examples/example_rating_widgets.html b/examples/example_rating_widgets.html
@@ -8,9 +8,16 @@
     <script type='module'>
         import Countly from '../Countly.js';
 
+        const COUNTLY_SERVER_KEY = "https://your.server.ly";
+        const COUNTLY_APP_KEY = "YOUR_APP_KEY";
+
+        if(COUNTLY_APP_KEY === "YOUR_APP_KEY" || COUNTLY_SERVER_KEY === "https://your.server.ly"){
+            console.warn("Please do not use default set of app key and server url")
+        }
+        // initializing countly with params
         Countly.init({
-            app_key: 'YOUR_APP_KEY', //your app key
-            url: 'https://your.domain.count.ly', //your server goes here
+            app_key: COUNTLY_APP_KEY,
+            url: COUNTLY_SERVER_KEY, //your server goes here
             debug: true
         });
         //=====================================================================================================

diff --git a/examples/example_remote_config.html b/examples/example_remote_config.html
@@ -9,9 +9,16 @@
         import Countly from '../Countly.js';
 
         //initializing countly with params and remote config
+        const COUNTLY_SERVER_KEY = "https://your.server.ly";
+        const COUNTLY_APP_KEY = "YOUR_APP_KEY";
+
+        if(COUNTLY_APP_KEY === "YOUR_APP_KEY" || COUNTLY_SERVER_KEY === "https://your.server.ly"){
+            console.warn("Please do not use default set of app key and server url")
+        }
+        // initializing countly with params
         Countly.init({
-            app_key: "YOUR_APP_KEY",
-            url: "https://your.domain.count.ly", //your server goes here
+            app_key: COUNTLY_APP_KEY,
+            url: COUNTLY_SERVER_KEY, //your server goes here
             debug: true,
             rc_automatic_optin_for_ab: false, // set it to false for not opting in users for AB testing while fetching the remote config (only with latest API)
             use_explicit_rc_api: true, // set it to true to use the latest API

diff --git a/examples/example_sync.html b/examples/example_sync.html
@@ -9,9 +9,16 @@
     import Countly from '../Countly.js';
 
         //initializing countly with params
+        const COUNTLY_SERVER_KEY = "https://your.server.ly";
+        const COUNTLY_APP_KEY = "YOUR_APP_KEY";
+
+        if(COUNTLY_APP_KEY === "YOUR_APP_KEY" || COUNTLY_SERVER_KEY === "https://your.server.ly"){
+            console.warn("Please do not use default set of app key and server url")
+        }
+        // initializing countly with params
         Countly.init({
-            app_key: "YOUR_APP_KEY",
-            url: "https://your.domain.count.ly", //your server goes here
+            app_key: COUNTLY_APP_KEY,
+            url: COUNTLY_SERVER_KEY, //your server goes here
             debug: true
         })
         //track sessions automatically

diff --git a/examples/examples_feedback_widgets.html b/examples/examples_feedback_widgets.html
@@ -8,9 +8,16 @@
   <script type='module'>
     import Countly from '../Countly.js';
 
+    const COUNTLY_SERVER_KEY = "https://your.server.ly";
+    const COUNTLY_APP_KEY = "YOUR_APP_KEY";
+
+    if(COUNTLY_APP_KEY === "YOUR_APP_KEY" || COUNTLY_SERVER_KEY === "https://your.server.ly"){
+      console.warn("Please do not use default set of app key and server url")
+    }
+    // initializing countly with params
     Countly.init({
-      app_key: 'YOUR_APP_KEY', //your app key
-      url: 'https://your.domain.count.ly', //your server goes here
+      app_key: COUNTLY_APP_KEY,
+      url: COUNTLY_SERVER_KEY, //your server goes here
       debug: true
     });
 

diff --git a/examples/worker.js b/examples/worker.js
@@ -1,9 +1,17 @@
 import Countly from "../Countly.js";
 
 const STORAGE = {};
+
+const COUNTLY_SERVER_KEY = "https://your.server.ly";
+const COUNTLY_APP_KEY = "YOUR_APP_KEY";
+
+if(COUNTLY_APP_KEY === "YOUR_APP_KEY" || COUNTLY_SERVER_KEY === "https://your.server.ly"){
+    console.warn("Please do not use default set of app key and server url")
+}
+
 Countly.init({
-    app_key: "YOUR_APP_KEY",
-    url: "https://your.domain.count.ly",
+    app_key: COUNTLY_APP_KEY,
+    url: COUNTLY_SERVER_KEY,
     debug: true,
     clear_stored_id: true, // Resets the stored device ID on init
     storage: {