countly-sdk-web 22.2.2 → 22.2.3

package/cypress/integration/events.js

@@ -1,65 +1,65 @@
-/* eslint-disable cypress/no-unnecessary-waiting */
-/* eslint-disable require-jsdoc */
-var Countly = require("../../lib/countly");
-var hp = require("../support/helper");
-
-function initMain() {
-    Countly.init({
-        app_key: "YOUR_APP_KEY",
-        url: "https://try.count.ly",
-        session_update: 3,
-        tests: true,
-        max_events: -1,
-        debug: true
-    });
-}
-// an event object to use 
-const eventObj = {
-    key: "in_app_purchase",
-    count: 3,
-    sum: 2.97,
-    dur: 1000,
-    segmentation: {
-        app_version: "1.0",
-        country: "Tahiti",
-    },
-};
-// a timed event object
-const timedEventObj = {
-    key: "timed",
-    count: 1,
-    segmentation: {
-        app_version: "1.0",
-        country: "Tahiti",
-    },
-};
-
-describe("Events tests ", () => {
-    it("Checks if adding events works", () => {
-        hp.haltAndClearStorage(() => {
-            initMain();
-            Countly.add_event(eventObj);
-            cy.fetch_local_event_queue().then((eq) => {
-                expect(eq.length).to.equal(1);
-                cy.check_event(eq[0], eventObj);
-            });
-        });
-    });
-    it("Checks if timed events works", () => {
-        hp.haltAndClearStorage(() => {
-            initMain();
-            // start the timer
-            Countly.start_event("timed");
-            // wait for a while
-            cy.wait(3000).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, 3);
-                });
-            });
-        });
-    });
-});
+/* eslint-disable cypress/no-unnecessary-waiting */
+/* eslint-disable require-jsdoc */
+var Countly = require("../../lib/countly");
+var hp = require("../support/helper");
+
+function initMain() {
+    Countly.init({
+        app_key: "YOUR_APP_KEY",
+        url: "https://try.count.ly",
+        session_update: 3,
+        test_mode: true,
+        max_events: -1,
+        debug: true
+    });
+}
+// an event object to use 
+const eventObj = {
+    key: "in_app_purchase",
+    count: 3,
+    sum: 2.97,
+    dur: 1000,
+    segmentation: {
+        app_version: "1.0",
+        country: "Tahiti",
+    },
+};
+// a timed event object
+const timedEventObj = {
+    key: "timed",
+    count: 1,
+    segmentation: {
+        app_version: "1.0",
+        country: "Tahiti",
+    },
+};
+
+describe("Events tests ", () => {
+    it("Checks if adding events works", () => {
+        hp.haltAndClearStorage(() => {
+            initMain();
+            Countly.add_event(eventObj);
+            cy.fetch_local_event_queue().then((eq) => {
+                expect(eq.length).to.equal(1);
+                cy.check_event(eq[0], eventObj);
+            });
+        });
+    });
+    it("Checks if timed events works", () => {
+        hp.haltAndClearStorage(() => {
+            initMain();
+            // start the timer
+            Countly.start_event("timed");
+            // wait for a while
+            cy.wait(3000).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, 3);
+                });
+            });
+        });
+    });
+});

package/cypress/integration/heatmaps.js

@@ -0,0 +1,52 @@
+// TODO: click and scrolls tests but scrolls first, with html files
+
+/* eslint-disable require-jsdoc */
+var hp = require("../support/helper");
+
+describe("Browser heatmap tests", () => {
+    it("Check if scrolls are sent if page url changes", () => {
+        cy.visit("./cypress/fixtures/scroll_test.html");
+        cy.scrollTo("bottom");
+        cy.visit("./cypress/fixtures/scroll_test_2.html");
+        cy.fetch_local_request_queue(hp.appKey).then((rq) => {
+            cy.log(rq);
+            // 2 session and 1 orientation 1 event
+            expect(rq.length).to.equal(4);
+            // first object of the queue should be about begin session, second is orientation
+            cy.check_session(rq[0], undefined, undefined, hp.appKey);
+            // third object of the queue should be about session extension, also input the expected duration range, we expect 0 here so we enter a value lower than that but not deviated more than 1
+            cy.check_session(rq[2], -0.5, undefined);
+            // fourth object of the queue should be events in the queue, there must be 4 of them
+            cy.check_view_event(JSON.parse(rq[3].events)[0], "/cypress/fixtures/scroll_test.html", 0);
+            cy.check_scroll_event(JSON.parse(rq[3].events)[1]);
+            // number 3 is orientation
+            cy.check_view_event(JSON.parse(rq[3].events)[3], "/cypress/fixtures/scroll_test_2.html");
+        });
+    });
+    it("Check if scrolls are sent if for single page apps/sites", () => {
+        cy.visit("./cypress/fixtures/scroll_test_3.html");
+        // TODO: gave exact coordinates and check those exact coordinates are recorded or not for scrolls
+        cy.scrollTo("bottom");
+        // click button that triggers view change
+        cy.get("#b1").click();
+        cy.scrollTo("bottom");
+        // click button that triggers view change
+        cy.get("#b2").click();
+        // 2 request with 1 session and 1 events
+        cy.fetch_local_request_queue(hp.appKey).then((rq) => {
+            cy.log(rq);
+            expect(rq.length).to.equal(2);
+            cy.check_session(rq[0], undefined, undefined, hp.appKey);
+        });
+        // 6 events with 4 views and 2 scrolls must be here
+        cy.fetch_local_event_queue(hp.appKey).then((eq) => {
+            cy.log(eq);
+            cy.check_scroll_event(eq[0]);
+            cy.check_view_event(eq[1], "/cypress/fixtures/scroll_test_3.html", 0);
+            cy.check_view_event(eq[2], "v1");
+            cy.check_scroll_event(eq[3]);
+            cy.check_view_event(eq[4], "v1", 0);
+            cy.check_view_event(eq[5], "v2");
+        });
+    });
+});

package/cypress/integration/internal_limits.js

@@ -1,154 +1,154 @@
-/* eslint-disable cypress/no-unnecessary-waiting */
-/* eslint-disable require-jsdoc */
-var Countly = require("../../lib/countly");
-var hp = require("../support/helper");
-
-const limits = {
-    key: 8,
-    value: 8,
-    segment: 3,
-    breadcrumb: 2,
-    line_thread: 3,
-    line_length: 10
-};
-
-function initMain() {
-    Countly.init({
-        app_key: "YOUR_APP_KEY",
-        url: "https://try.count.ly",
-        max_events: -1,
-        tests: true,
-        debug: true,
-        max_key_length: limits.key, // set maximum key length here
-        max_value_size: limits.value, // set maximum value length here
-        max_segmentation_values: limits.segment, // set maximum segmentation number here
-        max_breadcrumb_count: limits.breadcrumb, // set maximum number of logs that will be stored before erasing old ones
-        max_stack_trace_lines_per_thread: limits.line_thread, // set maximum number of lines for stack trace
-        max_stack_trace_line_length: limits.line_length, // set maximum length of a line for stack 
-    });
-}
-const error = {
-    stack: "Lorem ipsum dolor sit amet,\n consectetur adipiscing elit, sed do eiusmod tempor\n incididunt ut labore et dolore magna\n aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.\n Duis aute irure dolor in reprehenderit in voluptate\n velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia\n deserunt mollit anim id\n est laborum.",
-};
-const bread = {
-    one: "log1",
-    two: "log2",
-    three: "log3",
-    four: "log4",
-    five: "log5 too many",
-    six: "log6",
-    seven: "log7",
-};
-const customEvent = {
-    key: "Enter your key here",
-    count: 1,
-    segmentation: {
-        "key of 1st seg": "Value of 1st seg",
-        "key of 2nd seg": "Value of 2nd seg",
-        "key of 3rd seg": "Value of 3rd seg",
-        "key of 4th seg": "Value of 4th seg",
-        "key of 5th seg": "Value of 5th seg",
-    },
-};
-const viewName = "a very long page name";
-
-const userDetail = {
-    name: "Gottlob Frege",
-    username: "Grundgesetze",
-    email: "test@isatest.com",
-    organization: "Bialloblotzsky",
-    phone: "+4555999423",
-    // Web URL pointing to user picture
-    picture:
-    "https://ih0.redbubble.net/image.276305970.7419/flat,550x550,075,f.u3.jpg",
-    gender: "M",
-    byear: 1848, // birth year
-    custom: {
-        "SEGkey 1st one": "SEGVal 1st one",
-        "SEGkey 2st one": "SEGVal 2st one",
-        "SEGkey 3st one": "SEGVal 3st one",
-        "SEGkey 4st one": "SEGVal 4st one",
-        "SEGkey 5st one": "SEGVal 5st one",
-    },
-};
-
-const customProperties = {
-    set: ["name of a character", "Bertrand Arthur William Russell"],
-    set_once: ["A galaxy far far away", "Called B48FF"],
-    increment_by: ["byear", 123456789012345],
-    multiply: ["byear", 2345678901234567],
-    max: ["byear", 3456789012345678],
-    min: ["byear", 4567890123456789],
-    push: ["gender", "II Fernando Valdez"],
-    push_unique: ["gender", "III Fernando Valdez"],
-    pull: ["gender", "III Fernando Valdez"],
-};
-
-describe("Internal limit tests ", () => {
-    it("Checks if custom event limits works", () => {
-        hp.haltAndClearStorage(() => {
-            initMain();
-            Countly.add_event(customEvent);
-            cy.fetch_local_event_queue().then((eq) => {
-                expect(eq.length).to.equal(1);
-                cy.check_custom_event_limit(eq[0], customEvent, limits);
-            });
-        });
-    });
-    it("Checks if view event limits works", () => {
-        hp.haltAndClearStorage(() => {
-            initMain();
-            Countly.track_pageview(viewName);
-            cy.fetch_local_event_queue().then((eq) => {
-                expect(eq.length).to.equal(1);
-                cy.check_view_event_limit(eq[0], viewName, limits);
-            });
-        });
-    });
-    it("Checks if view event limits works", () => {
-        hp.haltAndClearStorage(() => {
-            initMain();
-            Countly.add_log(bread.one);
-            Countly.add_log(bread.two);
-            Countly.add_log(bread.three);
-            Countly.add_log(bread.four);
-            Countly.add_log(bread.five);
-            Countly.add_log(bread.six);
-            Countly.add_log(bread.seven);
-            Countly.log_error(error);
-            cy.fetch_local_request_queue().then((rq) => {
-                expect(rq.length).to.equal(1);
-                cy.check_error_limit(rq[0], limits);
-            });
-        });
-    });
-    it("Checks if user detail limits works", () => {
-        hp.haltAndClearStorage(() => {
-            initMain();
-            Countly.user_details(userDetail);
-            cy.fetch_local_request_queue().then((rq) => {
-                expect(rq.length).to.equal(1);
-                cy.check_user_details(rq[0], userDetail, limits);
-            });
-        });
-    });
-    it("Checks if custom property limits works", () => {
-        hp.haltAndClearStorage(() => {
-            initMain();
-            Countly.userData.set(customProperties.set[0], customProperties.set[1]); // set custom property
-            Countly.userData.set_once(customProperties.set_once[0], customProperties.set_once[1]); // set custom property only if property does not exist
-            Countly.userData.increment_by(customProperties.increment_by[0], customProperties.increment_by[1]); // increment value in key by provided value
-            Countly.userData.multiply(customProperties.multiply[0], customProperties.multiply[1]); // multiply value in key by provided value
-            Countly.userData.max(customProperties.max[0], customProperties.max[1]); // save max value between current and provided
-            Countly.userData.min(customProperties.min[0], customProperties.min[1]); // save min value between current and provided
-            Countly.userData.push(customProperties.push[0], customProperties.push[1]); // add value to key as array element
-            Countly.userData.push_unique(customProperties.push_unique[0], customProperties.push_unique[1]); // add value to key as array element, but only store unique values in array
-            Countly.userData.pull(customProperties.pull[0], customProperties.pull[1]); // remove value from array under property with key as name
-            Countly.userData.save();
-            cy.fetch_local_request_queue().then((rq) => {
-                expect(rq.length).to.equal(1);
-                cy.check_custom_properties(rq[0], customProperties, limits);
-            });
-        });
-    });
+/* eslint-disable cypress/no-unnecessary-waiting */
+/* eslint-disable require-jsdoc */
+var Countly = require("../../lib/countly");
+var hp = require("../support/helper");
+
+const limits = {
+    key: 8,
+    value: 8,
+    segment: 3,
+    breadcrumb: 2,
+    line_thread: 3,
+    line_length: 10
+};
+
+function initMain() {
+    Countly.init({
+        app_key: "YOUR_APP_KEY",
+        url: "https://try.count.ly",
+        max_events: -1,
+        test_mode: true,
+        debug: true,
+        max_key_length: limits.key, // set maximum key length here
+        max_value_size: limits.value, // set maximum value length here
+        max_segmentation_values: limits.segment, // set maximum segmentation number here
+        max_breadcrumb_count: limits.breadcrumb, // set maximum number of logs that will be stored before erasing old ones
+        max_stack_trace_lines_per_thread: limits.line_thread, // set maximum number of lines for stack trace
+        max_stack_trace_line_length: limits.line_length, // set maximum length of a line for stack 
+    });
+}
+const error = {
+    stack: "Lorem ipsum dolor sit amet,\n consectetur adipiscing elit, sed do eiusmod tempor\n incididunt ut labore et dolore magna\n aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.\n Duis aute irure dolor in reprehenderit in voluptate\n velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia\n deserunt mollit anim id\n est laborum.",
+};
+const bread = {
+    one: "log1",
+    two: "log2",
+    three: "log3",
+    four: "log4",
+    five: "log5 too many",
+    six: "log6",
+    seven: "log7",
+};
+const customEvent = {
+    key: "Enter your key here",
+    count: 1,
+    segmentation: {
+        "key of 1st seg": "Value of 1st seg",
+        "key of 2nd seg": "Value of 2nd seg",
+        "key of 3rd seg": "Value of 3rd seg",
+        "key of 4th seg": "Value of 4th seg",
+        "key of 5th seg": "Value of 5th seg",
+    },
+};
+const viewName = "a very long page name";
+
+const userDetail = {
+    name: "Gottlob Frege",
+    username: "Grundgesetze",
+    email: "test@isatest.com",
+    organization: "Bialloblotzsky",
+    phone: "+4555999423",
+    // Web URL pointing to user picture
+    picture:
+    "https://ih0.redbubble.net/image.276305970.7419/flat,550x550,075,f.u3.jpg",
+    gender: "M",
+    byear: 1848, // birth year
+    custom: {
+        "SEGkey 1st one": "SEGVal 1st one",
+        "SEGkey 2st one": "SEGVal 2st one",
+        "SEGkey 3st one": "SEGVal 3st one",
+        "SEGkey 4st one": "SEGVal 4st one",
+        "SEGkey 5st one": "SEGVal 5st one",
+    },
+};
+
+const customProperties = {
+    set: ["name of a character", "Bertrand Arthur William Russell"],
+    set_once: ["A galaxy far far away", "Called B48FF"],
+    increment_by: ["byear", 123456789012345],
+    multiply: ["byear", 2345678901234567],
+    max: ["byear", 3456789012345678],
+    min: ["byear", 4567890123456789],
+    push: ["gender", "II Fernando Valdez"],
+    push_unique: ["gender", "III Fernando Valdez"],
+    pull: ["gender", "III Fernando Valdez"],
+};
+
+describe("Internal limit tests ", () => {
+    it("Checks if custom event limits works", () => {
+        hp.haltAndClearStorage(() => {
+            initMain();
+            Countly.add_event(customEvent);
+            cy.fetch_local_event_queue().then((eq) => {
+                expect(eq.length).to.equal(1);
+                cy.check_custom_event_limit(eq[0], customEvent, limits);
+            });
+        });
+    });
+    it("Checks if view event limits works", () => {
+        hp.haltAndClearStorage(() => {
+            initMain();
+            Countly.track_pageview(viewName);
+            cy.fetch_local_event_queue().then((eq) => {
+                expect(eq.length).to.equal(1);
+                cy.check_view_event_limit(eq[0], viewName, limits);
+            });
+        });
+    });
+    it("Checks if view event limits works", () => {
+        hp.haltAndClearStorage(() => {
+            initMain();
+            Countly.add_log(bread.one);
+            Countly.add_log(bread.two);
+            Countly.add_log(bread.three);
+            Countly.add_log(bread.four);
+            Countly.add_log(bread.five);
+            Countly.add_log(bread.six);
+            Countly.add_log(bread.seven);
+            Countly.log_error(error);
+            cy.fetch_local_request_queue().then((rq) => {
+                expect(rq.length).to.equal(1);
+                cy.check_error_limit(rq[0], limits);
+            });
+        });
+    });
+    it("Checks if user detail limits works", () => {
+        hp.haltAndClearStorage(() => {
+            initMain();
+            Countly.user_details(userDetail);
+            cy.fetch_local_request_queue().then((rq) => {
+                expect(rq.length).to.equal(1);
+                cy.check_user_details(rq[0], userDetail, limits);
+            });
+        });
+    });
+    it("Checks if custom property limits works", () => {
+        hp.haltAndClearStorage(() => {
+            initMain();
+            Countly.userData.set(customProperties.set[0], customProperties.set[1]); // set custom property
+            Countly.userData.set_once(customProperties.set_once[0], customProperties.set_once[1]); // set custom property only if property does not exist
+            Countly.userData.increment_by(customProperties.increment_by[0], customProperties.increment_by[1]); // increment value in key by provided value
+            Countly.userData.multiply(customProperties.multiply[0], customProperties.multiply[1]); // multiply value in key by provided value
+            Countly.userData.max(customProperties.max[0], customProperties.max[1]); // save max value between current and provided
+            Countly.userData.min(customProperties.min[0], customProperties.min[1]); // save min value between current and provided
+            Countly.userData.push(customProperties.push[0], customProperties.push[1]); // add value to key as array element
+            Countly.userData.push_unique(customProperties.push_unique[0], customProperties.push_unique[1]); // add value to key as array element, but only store unique values in array
+            Countly.userData.pull(customProperties.pull[0], customProperties.pull[1]); // remove value from array under property with key as name
+            Countly.userData.save();
+            cy.fetch_local_request_queue().then((rq) => {
+                expect(rq.length).to.equal(1);
+                cy.check_custom_properties(rq[0], customProperties, limits);
+            });
+        });
+    });
 });