Merge pull request #524 from Countly/cypress-update

cypress 13

.eslintignore

@@ -7,7 +7,8 @@ node_modules
 .github
 .gitignore
 CHANGELOG.md
-cypress.json
+cypress.config.js
 generateDocs.sh
 jsdoc_conf.json
-LICENSE
+LICENSE
+cypress/

.github/workflows/node.js.yml

@@ -13,7 +13,7 @@ jobs:
   build-and-test:
     strategy:
       matrix:
-        node-version: [12.x, 14.x, 16.x]
+        node-version: [14.x, 16.x, 18.x, 20.x]
 
     runs-on: ubuntu-latest
 

cypress.config.js

@@ -0,0 +1,9 @@
+const { defineConfig } = require('cypress')
+module.exports =  defineConfig({
+  e2e: {
+    setupNodeEvents(on, config) {
+      // implement node event listeners here
+    },
+  },
+  userAgent: "abcd",
+});

cypress/integration/async_queue.js → cypress/e2e/async_queue.cy.js

@@ -1,8 +1,6 @@
-/* eslint-disable cypress/no-unnecessary-waiting */
 /* eslint-disable require-jsdoc */
 var Countly = require("../../lib/countly");
-// import * as Countly from "../../dist/countly_umd.js";
-var hp = require("../support/helper.js");
+var hp = require("../support/helper");
 
 function initMain(clear) {
     Countly.init({
@@ -62,22 +60,22 @@ describe("Test Countly.q related methods and processes", () => {
                 // Check that the .q is empty
                 expect(Countly.q.length).to.equal(0);
 
-                cy.fetch_local_request_queue().then((rq_2) => {
+                cy.fetch_local_request_queue().then((rq) => {
                     // Check that nothing sent to request queue
-                    expect(rq_2.length).to.equal(0);
+                    expect(rq.length).to.equal(0);
                     cy.fetch_local_event_queue().then((eq) => {
                         // Check that events are now in event queue
                         expect(eq.length).to.equal(4);
 
                         // Send events from event queue to request queue
                         Countly._internals.sendEventsForced();
-                        cy.fetch_local_event_queue().then((eq_2) => {
+                        cy.fetch_local_event_queue().then((eq) => {
                             // Check that event queue is empty
-                            expect(eq_2.length).to.equal(0);
-                            cy.fetch_local_request_queue().then((rq_3) => {
+                            expect(eq.length).to.equal(0);
+                            cy.fetch_local_request_queue().then((rq) => {
                                 // Check that events are now in request queue
-                                expect(rq_3.length).to.equal(1);
-                                const eventsArray = JSON.parse(rq_3[0].events);
+                                expect(rq.length).to.equal(1);
+                                const eventsArray = JSON.parse(rq[0].events);
                                 expect(eventsArray[0].key).to.equal("event_1");
                                 expect(eventsArray[1].key).to.equal("event_2");
                                 expect(eventsArray[2].key).to.equal("event_3");
@@ -125,16 +123,16 @@ describe("Test Countly.q related methods and processes", () => {
                     // Check that event queue has new device ID's orientation event
                     expect(eq.length).to.equal(1);
                     expect(eq[0].key).to.equal("[CLY]_orientation");
-                    cy.fetch_local_request_queue().then((rq_2) => {
+                    cy.fetch_local_request_queue().then((rq) => {
                         // Check that events are now in request queue (second request is begin session for new device ID)
-                        expect(rq_2.length).to.equal(2);
-                        const eventsArray = JSON.parse(rq_2[0].events);
+                        expect(rq.length).to.equal(2);
+                        const eventsArray = JSON.parse(rq[0].events);
                         expect(eventsArray[0].key).to.equal("event_1");
                         expect(eventsArray[1].key).to.equal("event_2");
                         expect(eventsArray[2].key).to.equal("event_3");
                         expect(eventsArray[3].key).to.equal("event_4");
                         // check begin session
-                        expect(rq_2[1].begin_session).to.equal(1);
+                        expect(rq[1].begin_session).to.equal(1);
                     });
                 });
             });
@@ -175,16 +173,16 @@ describe("Test Countly.q related methods and processes", () => {
                 cy.fetch_local_event_queue().then((eq) => {
                     // Check that event queue is empty
                     expect(eq.length).to.equal(0);
-                    cy.fetch_local_request_queue().then((rq_2) => {
+                    cy.fetch_local_request_queue().then((rq) => {
                         // Check that events are now in request queue (second request is user details)
-                        expect(rq_2.length).to.equal(2);
-                        const eventsArray = JSON.parse(rq_2[0].events);
+                        expect(rq.length).to.equal(2);
+                        const eventsArray = JSON.parse(rq[0].events);
                         expect(eventsArray[0].key).to.equal("event_1");
                         expect(eventsArray[1].key).to.equal("event_2");
                         expect(eventsArray[2].key).to.equal("event_3");
                         expect(eventsArray[3].key).to.equal("event_4");
                         // check user details
-                        const user_details = JSON.parse(rq_2[1].user_details);
+                        const user_details = JSON.parse(rq[1].user_details);
                         expect(user_details.name).to.equal("test_user");
                     });
                 });
@@ -227,16 +225,16 @@ describe("Test Countly.q related methods and processes", () => {
                 cy.fetch_local_event_queue().then((eq) => {
                     // Check that event queue is empty
                     expect(eq.length).to.equal(0);
-                    cy.fetch_local_request_queue().then((rq_2) => {
+                    cy.fetch_local_request_queue().then((rq) => {
                         // Check that events are now in request queue (second request is user details)
-                        expect(rq_2.length).to.equal(2);
-                        const eventsArray = JSON.parse(rq_2[0].events);
+                        expect(rq.length).to.equal(2);
+                        const eventsArray = JSON.parse(rq[0].events);
                         expect(eventsArray[0].key).to.equal("event_1");
                         expect(eventsArray[1].key).to.equal("event_2");
                         expect(eventsArray[2].key).to.equal("event_3");
                         expect(eventsArray[3].key).to.equal("event_4");
                         // check user data
-                        const user_details = JSON.parse(rq_2[1].user_details);
+                        const user_details = JSON.parse(rq[1].user_details);
                         expect(user_details.custom.name).to.equal("test_user");
                     });
                 });
@@ -267,15 +265,15 @@ describe("Test Countly.q related methods and processes", () => {
                     expect(Countly.q.length).to.equal(4);
                     // Wait for heartBeat to process the .q
                     cy.wait(1500).then(() => {
-                        // Check that the .q is empty
+                    // Check that the .q is empty
                         expect(Countly.q.length).to.equal(0);
-                        cy.fetch_local_event_queue().then((eq_2) => {
-                            // Check that event queue is empty as all must be in request queue
-                            expect(eq_2.length).to.equal(0);
-                            cy.fetch_local_request_queue().then((rq_2) => {
-                                // Check that events are now in request queue
-                                expect(rq_2.length).to.equal(1);
-                                const eventsArray = JSON.parse(rq_2[0].events);
+                        cy.fetch_local_event_queue().then((eq) => {
+                        // Check that event queue is empty as all must be in request queue
+                            expect(eq.length).to.equal(0);
+                            cy.fetch_local_request_queue().then((rq) => {
+                            // Check that events are now in request queue
+                                expect(rq.length).to.equal(1);
+                                const eventsArray = JSON.parse(rq[0].events);
                                 expect(eventsArray[0].key).to.equal("event_1");
                                 expect(eventsArray[1].key).to.equal("event_2");
                                 expect(eventsArray[2].key).to.equal("event_3");

cypress/integration/bridge_utils.js → cypress/e2e/bridged_utils.cy.js

@@ -1,7 +1,6 @@
 /* eslint-disable cypress/no-unnecessary-waiting */
 /* eslint-disable require-jsdoc */
 var Countly = require("../../lib/countly");
-// import * as Countly from "../../dist/countly_umd.js";
 var hp = require("../support/helper.js");
 
 function initMain(name, version) {
@@ -22,7 +21,7 @@ const SDK_VERSION = "24.4.1";
 describe("Bridged SDK Utilities Tests", () => {
     it("Check if we can override sdk name and version successful", () => {
         hp.haltAndClearStorage(() => {
-            initMain("javascript_gtm_web", "24.0.0");
+            initMain('javascript_gtm_web', '24.0.0');
             hp.events();
             cy.fetch_local_request_queue().then((eq) => {
                 expect(eq).to.have.length(1);
@@ -33,7 +32,7 @@ describe("Bridged SDK Utilities Tests", () => {
     });
     it("Check if SDK uses default values if SDK name and version was not overriden", () => {
         hp.haltAndClearStorage(() => {
-            initMain(undefined, undefined);
+            initMain(undefined, undefined); 
             hp.events();
             cy.fetch_local_request_queue().then((eq) => {
                 expect(eq).to.have.length(1);

cypress/integration/consents.js → cypress/e2e/consents.cy.js

@@ -1,12 +1,13 @@
 /* eslint-disable cypress/no-unnecessary-waiting */
 /* eslint-disable require-jsdoc */
 var Countly = require("../../lib/countly");
-var hp = require("../support/helper");
+// import * as Countly from "../../dist/countly_umd.js";
+var hp = require("../support/helper.js");
 
 function initMain(consent) {
     Countly.init({
         app_key: "YOUR_APP_KEY",
-        url: "https://your.domain.countly",
+        url: "https://your.domain.count.ly",
         require_consent: consent,
         device_id: "György Ligeti",
         test_mode: true,

cypress/integration/crashes.js → cypress/e2e/crashes.cy.js

@@ -5,7 +5,7 @@ var hp = require("../support/helper");
 function initMain() {
     Countly.init({
         app_key: "YOUR_APP_KEY",
-        url: "https://your.domain.countly",
+        url: "https://your.domain.count.ly",
         test_mode: true
     });
 }
@@ -26,7 +26,7 @@ describe("Crashes tests ", () => {
             catch (err) {
                 Countly.log_error(err);
             }
-            cy.wait(3000).then(() => {
+            cy.wait(1000).then(() => {
                 cy.fetch_local_request_queue().then((rq) => {
                     cy.check_crash(rq[0], hp.appKey);
                 });

cypress/integration/device_id.js → cypress/e2e/device_id.cy.js

@@ -5,7 +5,7 @@ var hp = require("../support/helper");
 function initMain(deviceId, offline, searchQuery, clear, rq, eq) {
     Countly.init({
         app_key: "YOUR_APP_KEY",
-        url: "https://your.domain.countly",
+        url: "https://your.domain.count.ly",
         device_id: deviceId,
         test_mode: rq,
         test_mode_eq: eq,

cypress/integration/device_id_change.js → cypress/e2e/device_id_change.cy.js

@@ -1,5 +1,5 @@
 var Countly = require("../../lib/countly");
-var hp = require("../support/helper");
+var hp = require("../support/helper.js");
 
 // ========================================
 // Device ID change tests 
@@ -14,7 +14,7 @@ var hp = require("../support/helper");
 function initMain(offline) {
     Countly.init({
         app_key: "YOUR_APP_KEY",
-        url: "https://your.domain.countly",
+        url: "https://your.domain.count.ly",
         test_mode: true,
         debug: true,
         offline_mode: offline
@@ -220,7 +220,7 @@ describe("Device ID change tests ", ()=>{
 });
 
 describe("Set ID change tests ", () => {
-    it("set_id should be non merge as there was dev provided id", () => {
+    it('set_id should be non merge as there was dev provided id', () => {
         hp.haltAndClearStorage(() => {
             Countly.init({
                 app_key: "YOUR_APP_KEY",
@@ -239,16 +239,16 @@ describe("Set ID change tests ", () => {
                 cy.fetch_local_request_queue().then((eq2) => {
                     expect(eq2.length).to.equal(3); // no merge request
                     expect(eq2[0].device_id).to.equal("old ID");
-                    expect(eq2[0].events).to.contains("\"key\":\"1\"");
+                    expect(eq2[0].events).to.contains('"key\":\"1\"');
                     expect(eq2[1].device_id).to.equal("new ID");
                     expect(eq2[1].begin_session).to.equal(1);
                     expect(eq2[2].device_id).to.equal("new ID");
-                    expect(eq2[2].events).to.contains("\"key\":\"2\"");
+                    expect(eq2[2].events).to.contains('"key\":\"2\"');
                 });
             });
         });
     });
-    it("set_id should be merge as there was sdk generated id", () => {
+    it('set_id should be merge as there was sdk generated id', () => {
         hp.haltAndClearStorage(() => {
             initMain(false); // init normally
             Countly.add_event(eventObj("1")); // record an event.
@@ -264,13 +264,14 @@ describe("Set ID change tests ", () => {
                     cy.log(eq2);
                     expect(eq2.length).to.equal(3); // merge request
                     expect(eq2[0].device_id).to.equal(generatedID);
-                    expect(eq2[0].events).to.contains("\"key\":\"1\"");
+                    expect(eq2[0].events).to.contains('"key\":\"1\"');
                     expect(eq2[1].device_id).to.equal("new ID");
                     expect(eq2[1].old_device_id).to.equal(generatedID);
                     expect(eq2[2].device_id).to.equal("new ID");
-                    expect(eq2[2].events).to.contains("\"key\":\"2\"");
+                    expect(eq2[2].events).to.contains('"key\":\"2\"');
                 });
             });
         });
     });
+
 });

cypress/integration/device_id_init_scenarios.js → cypress/e2e/device_id_init_scenarios.cy.js

@@ -90,7 +90,7 @@ var hp = require("../support/helper");
 function initMain(deviceId, offline, searchQuery, clear) {
     Countly.init({
         app_key: "YOUR_APP_KEY",
-        url: "https://your.domain.countly",
+        url: "https://your.domain.count.ly",
         device_id: deviceId,
         test_mode: true,
         debug: true,

cypress/integration/events.js → cypress/e2e/events.cy.js

@@ -6,7 +6,7 @@ var hp = require("../support/helper");
 function initMain() {
     Countly.init({
         app_key: "YOUR_APP_KEY",
-        url: "https://your.domain.countly",
+        url: "https://your.domain.count.ly",
         session_update: 3,
         test_mode: true,
         test_mode_eq: true,

cypress/integration/health_check.js → cypress/e2e/health_check.cy.js

@@ -5,7 +5,7 @@ var hp = require("../support/helper");
 function initMain() {
     Countly.init({
         app_key: "YOUR_APP_KEY",
-        url: "https://your.domain.countly",
+        url: "https://your.domain.count.ly",
         test_mode: true
     });
 }
@@ -14,7 +14,7 @@ describe("Health Check tests ", () => {
     it("Check if health check is sent at the beginning", () => {
         hp.haltAndClearStorage(() => {
             initMain();
-            cy.intercept("https://your.domain.countly/i?*").as("getXhr");
+            cy.intercept("https://your.domain.count.ly/i?*").as("getXhr");
             cy.wait("@getXhr").then((xhr) => {
                 const url = new URL(xhr.request.url);
 

cypress/integration/heatmaps.js → cypress/e2e/heatmaps.cy.js

@@ -11,8 +11,10 @@ function click_check(segmentation, offX, offY) {
     expect(segmentation.height).to.be.ok;
     expect(segmentation.view).to.be.ok;
     expect(segmentation.width).to.be.ok;
-    expect(segmentation.x).to.equal(clickX + offX);
-    expect(segmentation.y).to.equal(clickY + offY);
+    expect(segmentation.x).to.be.above(clickX + offX - 2);
+    expect(segmentation.x).to.be.below(clickX + offX + 2);
+    expect(segmentation.y).to.be.above(clickY + offY - 2);
+    expect(segmentation.y).to.be.below(clickY + offY + 2);
 }
 
 describe("Browser heatmap tests, scrolls", () => {

cypress/integration/integration.js → cypress/e2e/integration.cy.js

@@ -7,7 +7,7 @@ var hp = require("../support/helper");
 function initMain() {
     Countly.init({
         app_key: "YOUR_APP_KEY",
-        url: "https://your.domain.countly",
+        url: "https://your.domain.count.ly",
         debug: true,
         test_mode: true
     });
@@ -50,7 +50,7 @@ describe("Integration test", () => {
         // TODO: make better
         cy.fetch_local_request_queue().then((rq) => {
             cy.log(rq);
-            hp.testNormalFlow(rq, "/__cypress/iframes/integration%2Fintegration.js", hp.appKey);
+            hp.testNormalFlow(rq, "/__cypress/iframes/cypress%5Ce2e%5Cintegration.cy.js", hp.appKey);
             expect(consentStatus).to.equal(true); // no consent necessary
             expect(remote).to.eql({}); // deepEqual
             expect(rq[0].device_id).to.equal(id);

cypress/integration/internal_limits.js → cypress/e2e/internal_limits.cy.js

@@ -15,7 +15,7 @@ const limits = {
 function initMain() {
     Countly.init({
         app_key: "YOUR_APP_KEY",
-        url: "https://your.domain.countly",
+        url: "https://your.domain.count.ly",
         test_mode_eq: true,
         test_mode: true,
         debug: true,

cypress/integration/manual_widget_reporting.js → cypress/e2e/manual_widget_reporting.cy.js

@@ -58,7 +58,7 @@ function common_rating_check(param, num) {
 function initMain() {
     Countly.init({
         app_key: "YOUR_APP_KEY",
-        url: "https://your.domain.countly",
+        url: "https://your.domain.count.ly",
         test_mode_eq: true,
         test_mode: true,
         debug: true

cypress/integration/remaining_requests.js → cypress/e2e/remaining_requests.cy.js

@@ -5,7 +5,7 @@ var hp = require("../support/helper");
 function initMain(shouldStopRequests) {
     Countly.init({
         app_key: "YOUR_APP_KEY",
-        url: "https://your.domain.countly",
+        url: "https://your.domain.count.ly",
         app_version: "1.0",
         // would prevent requests from being sent to the server if true
         test_mode: shouldStopRequests
@@ -36,7 +36,7 @@ describe("Remaining requests tests ", () => {
                 });
                 // End the session
                 Countly.end_session(undefined, true);
-                hp.interceptAndCheckRequests(undefined, undefined, undefined, undefined, "end_session", (requestParams) => {
+                    hp.interceptAndCheckRequests(undefined, undefined, undefined, "?end_session=*", "end", (requestParams) => {
                     expect(requestParams.get("end_session")).to.equal("1");
                     expect(requestParams.get("rr")).to.equal("2");
                     expect(requestParams.get("av")).to.equal(av);