release ready (#463)

Author: turtledreams

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 23.12.3
+- Added bot detection for workers
+- Added the ability to clear stored device IDs in the workers
+- Mitigated an issue where utm naming could have been affected if 'searchQuery' did not return '?'
+
 ## 23.12.2
 - Improved bot detection capabilities
 

cypress/integration/bridge_utils.js

@@ -16,7 +16,7 @@ function initMain(name, version) {
 }
 
 const SDK_NAME = "javascript_native_web";
-const SDK_VERSION = "23.12.2";
+const SDK_VERSION = "23.12.3";
 
 // tests
 describe("Bridged SDK Utilities Tests", () => {

cypress/integration/user_agent.js

@@ -58,6 +58,8 @@ describe("User Agent tests ", () => {
             expect(Countly._internals.userAgentSearchBotDetection("123")).to.equal(false);
             expect(Countly._internals.userAgentSearchBotDetection("Googlebot")).to.equal(true);
             expect(Countly._internals.userAgentSearchBotDetection("Google")).to.equal(false);
+            expect(Countly._internals.userAgentSearchBotDetection("HeadlessChrome")).to.equal(true);
+            expect(Countly._internals.userAgentSearchBotDetection("Chrome-Lighthouse")).to.equal(true);
         });
     });
 });

cypress/integration/utm.js

@@ -38,7 +38,7 @@ describe("UTM tests ", () => {
     });
     it("Checks if a single custom utm tag works", () => {
         hp.haltAndClearStorage(() => {
-            initMulti("YOUR_APP_KEY", "?utm_aa=hehe", { aa: true, bb: true });
+            initMulti("YOUR_APP_KEY", "utm_aa=hehe", { aa: true, bb: true });
             cy.fetch_local_request_queue().then((rq) => {
                 cy.log(rq);
                 const custom = JSON.parse(rq[0].user_details).custom;
@@ -50,7 +50,7 @@ describe("UTM tests ", () => {
     });
     it("Checks if custom utm tags works", () => {
         hp.haltAndClearStorage(() => {
-            initMulti("YOUR_APP_KEY", "?utm_aa=hehe&utm_bb=hoho", { aa: true, bb: true });
+            initMulti("YOUR_APP_KEY", "utm_aa=hehe&utm_bb=hoho", { aa: true, bb: true });
             cy.fetch_local_request_queue().then((rq) => {
                 cy.log(rq);
                 const custom = JSON.parse(rq[0].user_details).custom;
@@ -72,7 +72,7 @@ describe("UTM tests ", () => {
             initMulti("Countly_3", "?utm_source=hehe3", undefined);
 
             // utm object not provided with inappropriate query
-            initMulti("Countly_5", "?utm_ss=hehe5", undefined);
+            initMulti("Countly_5", "utm_ss=hehe5", undefined);
 
             // default (original) init with no custom tags and default query
             initMulti("YOUR_APP_KEY", "?utm_source=hehe", undefined);
@@ -116,7 +116,7 @@ describe("UTM tests ", () => {
             initMulti("Countly_multi_2", "?utm_source=hehe&utm_medium=hehe1&utm_campaign=hehe2&utm_term=hehe3&utm_content=hehe4&utm_sthelse=hehe5&fdsjhflkjhsdlkfjhsdlkjfhksdjhfkj+dsf;jsdlkjflk+=skdjflksjd=fksdfl;sd=sdkfmk&&&", { source: true, term: true, sthelse: true });
 
             // empty init, garbage query + 1 default
-            initMulti("Countly_multi_3", "?dasdashdjkhaslkjdhsakj=dasmndlask=asdkljska&&utm_source=hehe", undefined);
+            initMulti("Countly_multi_3", "dasdashdjkhaslkjdhsakj=dasmndlask=asdkljska&&utm_source=hehe", undefined);
 
             // full default utm obj + custom 1, full query + 1
             initMulti("Countly_multi_4", "?utm_source=hehe&utm_medium=hehe1&utm_campaign=hehe2&utm_term=hehe3&utm_content=hehe4&utm_next=hehe5", { source: true, medium: true, campaign: true, term: true, content: true, next: true });

cypress/integration/view_utm_referrer.js

@@ -42,7 +42,7 @@ describe("View with utm and referrer tests ", () => {
     // we record 2 views and check if both have the same utm tag
     it("Checks if a single default utm tag is at view segmentation of both views", () => {
         hp.haltAndClearStorage(() => {
-            init("YOUR_APP_KEY", "?utm_source=hehe", undefined);
+            init("YOUR_APP_KEY", "utm_source=hehe", undefined);
             Countly.track_view(pageNameOne); // first view
             Countly.track_view(pageNameTwo); // second view
             // View event should have the utm tag

examples/worker.js

@@ -6,6 +6,7 @@ Countly.init({
     app_key: "YOUR_APP_KEY",
     url: "https://your.domain.countly",
     debug: true,
+    clear_stored_id: true, // Resets the stored device ID on init
     storage: {
         getItem: function (key) {
             return STORE[key];

lib/countly.js

@@ -196,7 +196,7 @@
         statusCode: "cly_hc_status_code",
         errorMessage: "cly_hc_error_message"
     });
-    var SDK_VERSION = "23.12.2";
+    var SDK_VERSION = "23.12.3";
     var SDK_NAME = "javascript_native_web";
 
     // Using this on document.referrer would return an array with 15 elements in it. The 12th element (array[11]) would be the path we are looking for. Others would be things like password and such (use https://regex101.com/ to check more)
@@ -831,7 +831,7 @@
             this.getSearchQuery = getConfig("getSearchQuery", ob, Countly.getSearchQuery);
             this.DeviceIdType = Countly.DeviceIdType; // it is Countly device Id type Enums for clients to use
             this.namespace = getConfig("namespace", ob, "");
-            this.clearStoredId = !isBrowser ? undefined : getConfig("clear_stored_id", ob, false);
+            this.clearStoredId = getConfig("clear_stored_id", ob, false);
             this.app_key = getConfig("app_key", ob, null);
             this.onload = getConfig("onload", ob, []);
             this.utm = getConfig("utm", ob, {
@@ -854,7 +854,7 @@
             this.country_code = getConfig("country_code", ob, null);
             this.city = getConfig("city", ob, null);
             this.ip_address = getConfig("ip_address", ob, null);
-            this.ignore_bots = !isBrowser ? undefined : getConfig("ignore_bots", ob, true);
+            this.ignore_bots = getConfig("ignore_bots", ob, true);
             this.force_post = getConfig("force_post", ob, false);
             this.remote_config = getConfig("remote_config", ob, false);
             this.ignore_visitor = getConfig("ignore_visitor", ob, false);
@@ -918,9 +918,9 @@
                 }
                 // then clear the storage so that a new device ID is set again later
                 log(logLevelEnums.INFO, "initialize, Clearing the device ID storage");
-                localStorage.removeItem(this.app_key + "/cly_id");
-                localStorage.removeItem(this.app_key + "/cly_id_type");
-                localStorage.removeItem(this.app_key + "/cly_session");
+                removeValueFromStorage("cly_id");
+                removeValueFromStorage("cly_id_type");
+                removeValueFromStorage("cly_session");
             }
             checkIgnore();
             if (isBrowser) {
@@ -1107,7 +1107,11 @@
             var hasUTM = false;
             var utms = {};
             if (searchQuery) {
-                var parts = searchQuery.substring(1).split("&");
+                // remove the '?' character from the beginning if it exists
+                if (searchQuery.indexOf('?') === 0) {
+                    searchQuery = searchQuery.substring(1);
+                }
+                var parts = searchQuery.split("&");
                 for (var i = 0; i < parts.length; i++) {
                     var nv = parts[i].split("=");
                     if (nv[0] === "cly_id") {
@@ -4003,11 +4007,14 @@
          *  Check if user or visit should be ignored
          */
         function checkIgnore() {
+            log(logLevelEnums.INFO, "checkIgnore, Checking if user or visit should be ignored");
             if (self.ignore_prefetch && isBrowser && typeof document.visibilityState !== "undefined" && document.visibilityState === "prerender") {
                 self.ignore_visitor = true;
+                log(logLevelEnums.DEBUG, "checkIgnore, Ignoring visit due to prerendering");
             }
             if (self.ignore_bots && userAgentSearchBotDetection()) {
                 self.ignore_visitor = true;
+                log(logLevelEnums.DEBUG, "checkIgnore, Ignoring visit due to bot");
             }
         }