countly-sdk-web 22.6.3 → 22.6.5

package/.eslintignore

@@ -7,7 +7,6 @@ node_modules
 .vscode
 .github
 .gitignore
-bower.json
 CHANGELOG.md
 cypress.json
 generateDocs.sh

package/.github/dependabot.yml

@@ -1,38 +1,38 @@
 version: 2
 updates:
-- package-ecosystem: npm
-  directory: "/"
-  schedule:
-    interval: daily
-  open-pull-requests-limit: 10
-  reviewers:
-  - turtledreams
-  assignees:
-  - turtledreams
-  labels:
-  - dependencies
-  versioning-strategy: increase-if-necessary
-- package-ecosystem: npm
-  directory: "/examples/symbolication/"
-  schedule:
-    interval: daily
-  open-pull-requests-limit: 10
-  reviewers:
-  - turtledreams
-  assignees:
-  - turtledreams
-  labels:
-  - dependencies
-  versioning-strategy: increase-if-necessary
-- package-ecosystem: npm
-  directory: "/examples/react/"
-  schedule:
-    interval: daily
-  open-pull-requests-limit: 10
-  reviewers:
-  - turtledreams
-  assignees:
-  - turtledreams
-  labels:
-  - dependencies
-  versioning-strategy: increase-if-necessary
+  - package-ecosystem: npm
+    directory: "/"
+    schedule:
+      interval: monthly
+    open-pull-requests-limit: 10
+    reviewers:
+      - turtledreams
+    assignees:
+      - turtledreams
+    labels:
+      - dependencies
+    versioning-strategy: increase-if-necessary
+  - package-ecosystem: npm
+    directory: "/examples/symbolication/"
+    schedule:
+      interval: monthly
+    open-pull-requests-limit: 10
+    reviewers:
+      - turtledreams
+    assignees:
+      - turtledreams
+    labels:
+      - dependencies
+    versioning-strategy: increase-if-necessary
+  - package-ecosystem: npm
+    directory: "/examples/react/"
+    schedule:
+      interval: monthly
+    open-pull-requests-limit: 10
+    reviewers:
+      - turtledreams
+    assignees:
+      - turtledreams
+    labels:
+      - dependencies
+    versioning-strategy: increase-if-necessary

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 22.06.5
+- SDK now adds userAgent string to each request to prevent proxy related issues
+- Added a method to cancel timed events manually
+- Fixed a race condition bug where a recorded event would have the wrong user properties in the drill database on the server. Now event queue is emptied (formed into a request) before recording any user profile changes
+
+## 22.06.4
+- Fixed an issue with remote configs not working without a parameter
+
 ## 22.06.3
 - Fixed an issue that arose when sending crashes through a gateway. User agent information is now sent as part of the request.
 

package/README.md

@@ -4,11 +4,11 @@
 
 # Countly Web SDK
 
-This repository contains the Countly Web SDK, which can be integrated into websites and web applications. The Countly Web SDK is intended to be used with [Countly Community Edition](https://github.com/Countly/countly-server) or [Countly Enterprise Edition](https://count.ly/product).
+This repository contains the Countly Web SDK, which can be integrated into websites and web applications. The Countly Web SDK is intended to be used with [Countly Community Edition](https://github.com/Countly/countly-server) or [Countly Enterprise Edition](https://countly.com/product).
 
 ## What is Countly?
-[Countly](https://count.ly) is a product analytics solution and innovation enabler that helps teams track product performance and customer journey and behavior across [mobile](https://count.ly/mobile-analytics), [web](http://count.ly/web-analytics),
-and [desktop](https://count.ly/desktop-analytics) applications. [Ensuring privacy by design](https://count.ly/privacy-by-design), Countly allows you to innovate and enhance your products to provide personalized and customized customer experiences, and meet key business and revenue goals.
+[Countly](https://countly.com) is a product analytics solution and innovation enabler that helps teams track product performance and customer journey and behavior across [mobile](https://countly.com/mobile-analytics), [web](https://countly.com/web-analytics),
+and [desktop](https://countly.com/desktop-analytics) applications. [Ensuring privacy by design](https://countly.com/privacy-by-design), Countly allows you to innovate and enhance your products to provide personalized and customized customer experiences, and meet key business and revenue goals.
 
 Track, measure, and take action - all without leaving Countly.
 
@@ -41,21 +41,21 @@ This SDK supports the following features:
 Security is very important to us. If you discover any issue regarding security, please disclose the information responsibly by sending an email to security@count.ly and **not by creating a GitHub issue**.
 
 ## Badges
-If you like Countly, [why not use one of our badges](https://count.ly/brand-assets) and give a link back to us so others know about this wonderful platform?
+If you like Countly, [why not use one of our badges](https://countly.com/brand-guidelines) and give a link back to us so others know about this wonderful platform?
 
-<a href="https://count.ly/f/badge" rel="nofollow"><img style="width:145px;height:60px" src="https://count.ly/badges/dark.svg?v2" alt="Countly - Product Analytics" /></a>
+<a href="https://countly.com/f/badge" rel="nofollow"><img style="width:145px;height:60px" src="https://countly.com/badges/dark.svg?v2" alt="Countly - Product Analytics" /></a>
 
 ```JS
-<a href="https://count.ly/f/badge" rel="nofollow"><img style="width:145px;height:60px" src="https://count.ly/badges/dark.svg" alt="Countly - Product Analytics" /></a>
+<a href="https://countly.com/f/badge" rel="nofollow"><img style="width:145px;height:60px" src="https://countly.com/badges/dark.svg" alt="Countly - Product Analytics" /></a>
 ```
 
-<a href="https://count.ly/f/badge" rel="nofollow"><img style="width:145px;height:60px" src="https://count.ly/badges/light.svg?v2" alt="Countly - Product Analytics" /></a>
+<a href="https://countly.com/f/badge" rel="nofollow"><img style="width:145px;height:60px" src="https://countly.com/badges/light.svg?v2" alt="Countly - Product Analytics" /></a>
 
 ```JS
-<a href="https://count.ly/f/badge" rel="nofollow"><img style="width:145px;height:60px" src="https://count.ly/badges/light.svg" alt="Countly - Product Analytics" /></a>
+<a href="https://countly.com/f/badge" rel="nofollow"><img style="width:145px;height:60px" src="https://countly.com/badges/light.svg" alt="Countly - Product Analytics" /></a>
 ```
 
 ## How can I help you with your efforts?
 Glad you asked! We need ideas, feedback and constructive comments. All your suggestions will be taken care of with utmost importance. For feature requests and engaging with the community, join [our Slack Community](https://slack.count.ly) or [Community Forum](https://support.count.ly/hc/en-us/community/topics).
 
-We are on [Twitter](http://twitter.com/gocountly), [Facebook](https://www.facebook.com/Countly) and [LinkedIn](https://www.linkedin.com/company/countly) if you would like to keep up with Countly related updates.
+We are on [Twitter](https://twitter.com/gocountly), [Facebook](https://www.facebook.com/Countly) and [LinkedIn](https://www.linkedin.com/company/countly) if you would like to keep up with Countly related updates.

package/cypress/integration/events.js

@@ -34,6 +34,18 @@ const timedEventObj = {
     }
 };
 
+const longStringName = "LongStringNameLongStringNameLongStringNameLongStringNameLongStringNameLongStringNameLongStringNameLongStringName";
+
+// a timed event object with long string key
+const timedEventObjLong = {
+    key: longStringName,
+    count: 1,
+    segmentation: {
+        app_version: "1.0",
+        country: "Tahiti"
+    }
+};
+
 describe("Events tests ", () => {
     it("Checks if adding events works", () => {
         hp.haltAndClearStorage(() => {
@@ -52,7 +64,106 @@ describe("Events tests ", () => {
             Countly.start_event("timed");
             // wait for a while
             cy.wait(3000).then(() => {
-                // end the event and check duration
+                cy.fetch_local_event_queue().then((eq) => {
+                    // there should be nothing in the queue
+                    expect(eq.length).to.equal(0);
+                });
+                cy.wait(1000).then(() => {
+                    // end the event and check duration
+                    Countly.end_event(timedEventObj);
+                    cy.fetch_local_event_queue().then((eq) => {
+                        expect(eq.length).to.equal(1);
+                        // we waited 3000 milliseconds so duration must be 3 to 4
+                        cy.check_event(eq[0], timedEventObj, 4);
+                    });
+                });
+            });
+        });
+    });
+    it("Checks if timed events works with long string", () => {
+        hp.haltAndClearStorage(() => {
+            initMain();
+            // start the timer
+            Countly.start_event(longStringName);
+            // wait for a while
+            cy.wait(3000).then(() => {
+                cy.fetch_local_event_queue().then((eq) => {
+                    // there should be nothing in the queue
+                    expect(eq.length).to.equal(0);
+                });
+                cy.wait(1000).then(() => {
+                    // end the event and check duration
+                    Countly.end_event(timedEventObjLong);
+                    cy.fetch_local_event_queue().then((eq) => {
+                        expect(eq.length).to.equal(1);
+                        // we waited 3000 milliseconds so duration must be 3 to 4
+                        cy.check_event(eq[0], timedEventObjLong, 4);
+                    });
+                });
+            });
+        });
+    });
+    it("Checks if canceling timed events works", () => {
+        hp.haltAndClearStorage(() => {
+            initMain();
+            // start the timer
+            Countly.start_event("timed");
+            // wait for a while
+            cy.wait(1000).then(() => {
+                const didCancel = Countly.cancel_event("timed");
+                expect(didCancel).to.be.true;
+                Countly.end_event(timedEventObj);
+                cy.fetch_local_event_queue().then((eq) => {
+                    // queue should be empty and end_event should not create an event
+                    expect(eq.length).to.equal(0);
+                });
+            });
+        });
+    });
+    it("Checks if canceling timed events works with long string key", () => {
+        hp.haltAndClearStorage(() => {
+            initMain();
+            // start the timer
+            Countly.start_event(longStringName);
+            // wait for a while
+            cy.wait(1000).then(() => {
+                const didCancel = Countly.cancel_event(longStringName);
+                expect(didCancel).to.be.true;
+                Countly.end_event(timedEventObjLong);
+                cy.fetch_local_event_queue().then((eq) => {
+                    // queue should be empty and end_event should not create an event
+                    expect(eq.length).to.equal(0);
+                });
+            });
+        });
+    });
+    it("Checks if canceling timed events with wrong key does nothing", () => {
+        hp.haltAndClearStorage(() => {
+            initMain();
+            // start the timer
+            Countly.start_event("timed");
+            // wait for a while
+            cy.wait(3000).then(() => {
+                const didCancel = Countly.cancel_event("false_key");
+                expect(didCancel).to.be.false; // did not cancel as the key was wrong
+                Countly.end_event(timedEventObj);
+                cy.fetch_local_event_queue().then((eq) => {
+                    expect(eq.length).to.equal(1);
+                    // we waited 3000 milliseconds so duration must be 3 to 4
+                    cy.check_event(eq[0], timedEventObj, 3);
+                });
+            });
+        });
+    });
+    it("Checks if canceling timed events with empty key does nothing", () => {
+        hp.haltAndClearStorage(() => {
+            initMain();
+            // start the timer
+            Countly.start_event("timed");
+            // wait for a while
+            cy.wait(3000).then(() => {
+                const didCancel = Countly.cancel_event();
+                expect(didCancel).to.be.false; // did not cancel as the key was wrong
                 Countly.end_event(timedEventObj);
                 cy.fetch_local_event_queue().then((eq) => {
                     expect(eq.length).to.equal(1);
@@ -62,4 +173,38 @@ describe("Events tests ", () => {
             });
         });
     });
+    it("Checks if canceling non existent timed events with false key does nothing", () => {
+        hp.haltAndClearStorage(() => {
+            initMain();
+            // start the timer
+            Countly.start_event();
+            // wait for a while
+            cy.wait(3000).then(() => {
+                const didCancel = Countly.cancel_event("false_key");
+                expect(didCancel).to.be.false; // did not cancel as the key was wrong
+                Countly.end_event();
+                cy.fetch_local_event_queue().then((eq) => {
+                    expect(eq.length).to.equal(0);
+                });
+            });
+        });
+    });
+    it("Checks if canceling timed events with wrong key does nothing with Long string key", () => {
+        hp.haltAndClearStorage(() => {
+            initMain();
+            // start the timer
+            Countly.start_event(longStringName);
+            // wait for a while
+            cy.wait(3000).then(() => {
+                const didCancel = Countly.cancel_event("false_key");
+                expect(didCancel).to.be.false; // did not cancel as the key was wrong
+                Countly.end_event(timedEventObjLong);
+                cy.fetch_local_event_queue().then((eq) => {
+                    expect(eq.length).to.equal(1);
+                    // we waited 3000 milliseconds so duration must be 3 to 4
+                    cy.check_event(eq[0], timedEventObjLong, 3);
+                });
+            });
+        });
+    });
 });

package/cypress/integration/internal_limits.js

@@ -147,7 +147,7 @@ describe("Internal limit tests ", () => {
             Countly.userData.save();
             cy.fetch_local_request_queue().then((rq) => {
                 expect(rq.length).to.equal(1);
-                cy.check_custom_properties(rq[0], customProperties, limits);
+                cy.check_custom_properties_limit(rq[0], customProperties, limits);
             });
         });
     });

package/cypress/integration/sessions.js

@@ -20,7 +20,12 @@ function initMain() {
         test_mode: true
     });
 }
-const dummyQueue = [{ begin_session: 1, metrics: "{\"_app_version\":\"0.0\",\"_ua\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:96.0) Gecko/20100101 Firefox/96.0\",\"_resolution\":\"1568x882\",\"_density\":1.2244897959183674,\"_locale\":\"en-US\"}", app_key: "YOUR_APP_KEY", device_id: "55669b9b-f9d7-4ed5-bc77-ec5ebb65ddd8", sdk_name: "javascript_native_web", sdk_version: "21.11.0", timestamp: 1644909864950, hour: 10, dow: 2 }, { events: "[{\"key\":\"[CLY]_orientation\",\"count\":1,\"segmentation\":{\"mode\":\"portrait\"},\"timestamp\":1644909864949,\"hour\":10,\"dow\":2}]", app_key: "YOUR_APP_KEY", device_id: "55669b9b-f9d7-4ed5-bc77-ec5ebb65ddd8", sdk_name: "javascript_native_web", sdk_version: "21.11.0", timestamp: 1644909864958, hour: 10, dow: 2 }, { session_duration: 4, app_key: "YOUR_APP_KEY", device_id: "55669b9b-f9d7-4ed5-bc77-ec5ebb65ddd8", sdk_name: "javascript_native_web", sdk_version: "21.11.0", timestamp: 1644909868015, hour: 10, dow: 2 }, { end_session: 1, session_duration: 10, app_key: "YOUR_APP_KEY", device_id: "55669b9b-f9d7-4ed5-bc77-ec5ebb65ddd8", sdk_name: "javascript_native_web", sdk_version: "21.11.0", timestamp: 1644909869459, hour: 10, dow: 2 }];
+const dummyQueue = [
+    { begin_session: 1, metrics: "{\"_app_version\":\"0.0\",\"_ua\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:96.0) Gecko/20100101 Firefox/96.0\",\"_resolution\":\"1568x882\",\"_density\":1.2244897959183674,\"_locale\":\"en-US\"}", app_key: "YOUR_APP_KEY", device_id: "55669b9b-f9d7-4ed5-bc77-ec5ebb65ddd8", sdk_name: "javascript_native_web", sdk_version: "21.11.0", timestamp: 1644909864950, hour: 10, dow: 2 },
+    { events: "[{\"key\":\"[CLY]_orientation\",\"count\":1,\"segmentation\":{\"mode\":\"portrait\"},\"timestamp\":1644909864949,\"hour\":10,\"dow\":2}]", app_key: "YOUR_APP_KEY", device_id: "55669b9b-f9d7-4ed5-bc77-ec5ebb65ddd8", sdk_name: "javascript_native_web", sdk_version: "21.11.0", timestamp: 1644909864958, hour: 10, dow: 2 },
+    { session_duration: 4, metrics: "{\"_ua\":\"hey\"}", app_key: "YOUR_APP_KEY", device_id: "55669b9b-f9d7-4ed5-bc77-ec5ebb65ddd8", sdk_name: "javascript_native_web", sdk_version: "21.11.0", timestamp: 1644909868015, hour: 10, dow: 2 },
+    { end_session: 1, session_duration: 10, metrics: "{\"_ua\":\"hey\"}", app_key: "YOUR_APP_KEY", device_id: "55669b9b-f9d7-4ed5-bc77-ec5ebb65ddd8", sdk_name: "javascript_native_web", sdk_version: "21.11.0", timestamp: 1644909869459, hour: 10, dow: 2 }
+];
 
 describe("Session tests ", () => {
     it("Checks if session start, extension and ending works with a dummy queue", () => {
@@ -194,3 +199,36 @@ describe("Browser session tests, manual 2, no cookie", () => {
         });
     });
 });
+describe("Check request related functions", () => {
+    it("Check if prepareRequest forms a proper request object", () => {
+        hp.haltAndClearStorage(() => {
+        // initialize countly
+            initMain();
+            let reqObject = {};
+            Countly._internals.prepareRequest(reqObject);
+            cy.check_commons(reqObject);
+            cy.check_request_commons(reqObject);
+        });
+    });
+    it("Check if prepareRequest forms a proper request object from a bad one ", () => {
+        hp.haltAndClearStorage(() => {
+        // initialize countly
+            initMain();
+            let reqObject = { app_key: null, device_id: null };
+            Countly._internals.prepareRequest(reqObject);
+            cy.check_commons(reqObject);
+            cy.check_request_commons(reqObject);
+        });
+    });
+    it("Check if prepareRequest forms a proper request object and not erase an extra value ", () => {
+        hp.haltAndClearStorage(() => {
+        // initialize countly
+            initMain();
+            let reqObject = { extraKey: "value" };
+            Countly._internals.prepareRequest(reqObject);
+            expect(reqObject.extraKey).to.equal("value");
+            cy.check_commons(reqObject);
+            cy.check_request_commons(reqObject);
+        });
+    });
+});