countly-sdk-web 21.11.0 → 21.11.1

package/.eslintignore

@@ -1,4 +1,18 @@
 lib/countly.min.js
 lib/countly.pack.js
-plugin/boomerang/boomerang*.js
-samples
+plugin
+examples
+test
+node_modules
+coverage
+.vscode
+.github
+.gitignore
+bower.json
+CHANGELOG.md
+cypress.json
+generateDocs.sh
+inch.json
+jsdoc_conf.json
+LICENSE
+webpack.config.js

package/.eslintrc.js

@@ -1,14 +1,42 @@
 module.exports = {
-    "env": {
-        "browser": true,
-        "amd": true,
-        "commonjs": true
+    /**
+     * By default, ESLint expects ECMAScript 5 syntax. You can override that setting to enable support
+     * for other ECMAScript versions as well as JSX by using parser options. However for IE9 compatibility
+     * updating it to ECMAScript 6 or above is currently not permitted. -D
+     * */
+    env: {
+        browser: true,
+        amd: true,
+        commonjs: true
     },
-    "extends": "eslint:recommended",
-    "parserOptions": {
-        "ecmaVersion": 5
-    },
-    "rules": {
+    extends: "airbnb/legacy",
+    rules: {
+        "prefer-arrow-callback": "off",
+        "prefer-destructuring": "off",
+        "comma-dangle": "off",
+        "no-restricted-globals": "off",
+        "no-restricted-properties": "off",
+        //
+        "no-unused-vars": "warn",
+        "no-var": "off",
+        "func-names": "off",
+        "consistent-return": "off",
+        "prefer-rest-params": "off",
+        radix: "off",
+        "prefer-spread": "off",
+        "no-plusplus": "off",
+        camelcase: "off",
+        "no-use-before-define": "off",
+        "no-lonely-if": "off",
+        "no-restricted-syntax": "off",
+        "vars-on-top": "off",
+        "no-param-reassign": "off",
+        "max-len": "off",
+        "guard-for-in": "off",
+        "no-underscore-dangle": "off",
+        "no-bitwise": "off",
+        "no-mixed-operators": "off",
+        "object-shorthand": "off",
         "block-spacing": [
             "error",
             "always"
@@ -20,8 +48,8 @@ module.exports = {
         "comma-spacing": [
             "error",
             {
-                "before": false,
-                "after": true
+                before: false,
+                after: true
             }
         ],
         "comma-style": [
@@ -32,7 +60,7 @@ module.exports = {
             "error",
             "never"
         ],
-        "curly": [
+        curly: [
             "error",
             "all"
         ],
@@ -41,22 +69,22 @@ module.exports = {
             "error",
             "never"
         ],
-        "indent": [
+        indent: [
             "error",
             4
         ],
         "key-spacing": [
             "error",
             {
-                "beforeColon": false,
-                "afterColon": true
+                beforeColon: false,
+                afterColon: true
             }
         ],
         "keyword-spacing": [
             "error",
             {
-                "before": true,
-                "after": true
+                before: true,
+                after: true
             }
         ],
         "lines-between-class-members": [
@@ -69,7 +97,7 @@ module.exports = {
         "no-trailing-spaces": [
             "error",
             {
-                "ignoreComments": true
+                ignoreComments: true
             }
         ],
         "no-whitespace-before-property": [
@@ -78,17 +106,17 @@ module.exports = {
         "object-curly-newline": [
             "error",
             {
-                "multiline": true,
-                "consistent": true
+                multiline: true,
+                consistent: true
             }
         ],
         "object-property-newline": [
             "error",
             {
-                "allowAllPropertiesOnSameLine": true
+                allowAllPropertiesOnSameLine: true
             }
         ],
-        "semi": [
+        semi: [
             "error",
             "always"
         ],
@@ -114,8 +142,8 @@ module.exports = {
         "space-unary-ops": [
             "error",
             {
-                "words": true,
-                "nonwords": false
+                words: true,
+                nonwords: false
             }
         ],
         "switch-colon-spacing": [
@@ -130,22 +158,24 @@ module.exports = {
             "unix"
         ],
         "no-useless-escape": "off",
-        "quotes": "off",
+        quotes: ["error",
+            "double"
+        ],
         "valid-jsdoc": [
             "error",
             {
-                "requireReturn": false
+                requireReturn: false
             }
         ],
         "require-jsdoc": [
             "error",
             {
-                "require": {
-                    "FunctionDeclaration": true,
-                    "MethodDefinition": true,
-                    "ClassDeclaration": true,
-                    "ArrowFunctionExpression": true,
-                    "FunctionExpression": false
+                require: {
+                    FunctionDeclaration: true,
+                    MethodDefinition: true,
+                    ClassDeclaration: true,
+                    ArrowFunctionExpression: true,
+                    FunctionExpression: false
                 }
             }
         ],
@@ -155,7 +185,7 @@ module.exports = {
         "dot-notation": [
             "error"
         ],
-        "eqeqeq": [
+        eqeqeq: [
             "error",
             "always"
         ],
@@ -181,19 +211,5 @@ module.exports = {
             "error"
         ]
     },
-    "overrides": [
-        {
-            "files": [
-                "test/**/*.js",
-                "webpack.config.js"
-            ],
-            "env": {
-                "es6": true,
-                "node": true
-            },
-            rules: {
-                "require-jsdoc": "off",
-            }
-        }
-    ]
-};
+
+};

package/.github/workflows/node.js.yml

@@ -5,9 +5,9 @@ name: Node.js CI
 
 on:
   push:
-    branches: [ master, next ]
+    branches: [ master, staging ]
   pull_request:
-    branches: [ master, next ]
+    branches: [ master, staging ]
 
 jobs:
   build:

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 21.11.1
+- Fixed feedback widget bug related to the 'close events' origin check
+- When consent is changed it will now send the full consent state instead of just the changed consents
+- Rating widgets will now also be used through the feedback widgets API (in case the server supports it)
+- When overriding 'getViewName' it is now possible to return 'null' to indicate that the page name should not be recorded
+- Logs are now rearranged to include log levels
+
 ## 21.11.0
 - !! Major breaking change !! Rating and Feedback widgets now require 'star-rating' or 'feedback' consent exclusively, according to their type, instead of both:
     - `present_feedback_widget` needs 'feedback' consent only

package/README.md

@@ -1,5 +1,5 @@
 # Countly Web SDK 
-[![Build Status](https://api.travis-ci.org/Countly/countly-sdk-web.png?branch=master)](https://travis-ci.org/Countly/countly-sdk-web) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/031d2021b8334af3ac8d2462500bd1aa)](https://www.codacy.com/app/ar2rsawseen/countly-sdk-web?utm_source=github.com&utm_medium=referral&utm_content=Countly/countly-sdk-web&utm_campaign=Badge_Grade) [![npm version](https://badge.fury.io/js/countly-sdk-web.svg)](https://badge.fury.io/js/countly-sdk-web) [![Inline docs](https://inch-ci.org/github/Countly/countly-sdk-web.svg?branch=master)](https://inch-ci.org/github/Countly/countly-sdk-web) [![](https://data.jsdelivr.com/v1/package/npm/countly-sdk-web/badge)](https://www.jsdelivr.com/package/npm/countly-sdk-web)
+ [![Codacy Badge](https://api.codacy.com/project/badge/Grade/031d2021b8334af3ac8d2462500bd1aa)](https://www.codacy.com/app/ar2rsawseen/countly-sdk-web?utm_source=github.com&utm_medium=referral&utm_content=Countly/countly-sdk-web&utm_campaign=Badge_Grade) [![npm version](https://badge.fury.io/js/countly-sdk-web.svg)](https://badge.fury.io/js/countly-sdk-web) [![Inline docs](https://inch-ci.org/github/Countly/countly-sdk-web.svg?branch=master)](https://inch-ci.org/github/Countly/countly-sdk-web) [![](https://data.jsdelivr.com/v1/package/npm/countly-sdk-web/badge)](https://www.jsdelivr.com/package/npm/countly-sdk-web)
 
 ## What is Countly?
 [Countly](http://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/your-data-your-rules), Countly allows you to innovate and enhance your products to provide personalized and customized customer experiences, and meet key business and revenue goals.
@@ -30,7 +30,7 @@ or
 
 Countly web SDK is available on CDNJS. Use either
 
-[https://cdnjs.cloudflare.com/ajax/libs/countly-sdk-web/21.11.0/countly.min.js](https://cdnjs.cloudflare.com/ajax/libs/countly-sdk-web/21.11.0/countly.min.js)
+[https://cdnjs.cloudflare.com/ajax/libs/countly-sdk-web/21.11.1/countly.min.js](https://cdnjs.cloudflare.com/ajax/libs/countly-sdk-web/21.11.1/countly.min.js)
 
 or
 

package/cypress/.eslintrc.js

@@ -0,0 +1,23 @@
+module.exports = {
+    plugins: [
+        "cypress"
+    ],
+    parserOptions: {
+        ecmaVersion: 6
+    },
+    rules: {
+        "cypress/no-assigning-return-values": "error",
+        "cypress/no-unnecessary-waiting": "off",
+        "cypress/assertion-before-screenshot": "warn",
+        "cypress/no-force": "warn",
+        "cypress/no-async-tests": "error",
+        "cypress/no-pause": "error"
+    },
+    env: {
+        "cypress/globals": true
+    },
+    extends: [
+        "plugin:cypress/recommended",
+        "plugin:chai-friendly/recommended"
+    ],
+};

package/cypress/fixtures/variables.json

@@ -0,0 +1 @@
+{}

package/cypress/integration/consents.js

@@ -0,0 +1,166 @@
+/* eslint-disable cypress/no-unnecessary-waiting */
+/* eslint-disable require-jsdoc */
+var Countly = require("../../lib/countly");
+var hp = require("../support/helper");
+
+function initMain(consent) {
+    Countly.init({
+        app_key: "YOUR_APP_KEY",
+        url: "https://try.count.ly",
+        require_consent: consent,
+        device_id: "György Ligeti",
+        tests: true,
+        max_events: -1,
+        debug: true
+    });
+}
+// gathered events. count and segmentation key/values must be consistent
+const eventArray = [
+    // first event must be custom event
+    {
+        key: "a",
+        count: 1,
+        segmentation: {
+            1: "1",
+        },
+    },
+    // rest can be internal events
+    {
+        key: "[CLY]_view",
+        count: 2,
+        segmentation: {
+            2: "2",
+        },
+    },
+    {
+        key: "[CLY]_nps",
+        count: 3,
+        segmentation: {
+            3: "3",
+        },
+    },
+    {
+        key: "[CLY]_survey",
+        count: 4,
+        segmentation: {
+            4: "4",
+        },
+    },
+    {
+        key: "[CLY]_star_rating",
+        count: 5,
+        segmentation: {
+            5: "5",
+        },
+    },
+    {
+        key: "[CLY]_orientation",
+        count: 6,
+        segmentation: {
+            6: "6",
+        },
+    }
+];
+// event adding loop
+function events() {
+    for (var i = 0, len = eventArray.length; i < len; i++) {
+        Countly.add_event(eventArray[i]);
+    }
+}
+
+/**
+ * Checks a queue object for valid/correct values/limits during consent tests
+ * @param {Array} eq - events queue 
+ * @param {Array} eventArr - events array for the events to test
+ * @param {boolean} custom - custom event check
+ * @param {boolean} internalOnly - internal event check
+ */
+function consent_check(eq, eventArr, custom, internalOnly) {
+    var i = 0;
+    var b = i;
+    var len = eventArr.length;
+    if (custom) {
+        len = 0;
+    }
+    if (internalOnly) {
+        b = i + 1;
+        len = eventArr.length - 1;
+    }
+    while (i < len) {
+        expect(eq[i].key).to.equal(eventArr[b].key);
+        expect(eq[i].count).to.equal(eventArr[b].count);
+        expect(eq[i].segmentation[eventArr[b].count]).to.equal(eventArr[b].segmentation[eventArr[b].count]);
+        i++;
+        b++;
+    }
+}
+
+// tests
+describe("Consent tests", () => {
+    it("Only custom event should be sent to the queue", () => {
+        hp.haltAndClearStorage(() => {
+            initMain(true);
+            Countly.add_consent(["events"]);
+            events();
+            cy.fetch_local_event_queue().then((eq) => {
+                expect(eq.length).to.equal(1);
+                consent_check(eq, eventArray, true);
+            });
+        });
+    });
+    it("All but custom event should be sent to the queue", () => {
+        hp.haltAndClearStorage(() => {
+            initMain(true);
+            Countly.add_consent(["sessions", "views", "users", "star-rating", "apm", "feedback"]);
+            events();
+            cy.fetch_local_event_queue().then((eq) => {
+                expect(eq.length).to.equal(5);
+                consent_check(eq, eventArray, false, true);
+            });
+        });
+    });
+    it("All consents given and all events should be recorded", () => {
+        hp.haltAndClearStorage(() => {
+            initMain(true);
+            Countly.add_consent(["sessions", "views", "users", "star-rating", "apm", "feedback", "events"]);
+            events();
+            cy.fetch_local_event_queue().then((eq) => {
+                expect(eq.length).to.equal(6);
+                consent_check(eq, eventArray, false, false);
+            });
+        });
+    });
+    it("No consent required and all events should be recorded", () => {
+        hp.haltAndClearStorage(() => {
+            initMain(false);
+            events();
+            cy.fetch_local_event_queue().then((eq) => {
+                expect(eq.length).to.equal(6);
+                consent_check(eq, eventArray, false, false);
+            });
+        });
+    });
+    it("Non-merge ID change should reset all consents", () => {
+        hp.haltAndClearStorage(() => {
+            initMain(true);
+            Countly.add_consent(["sessions", "views", "users", "star-rating", "apm", "feedback"]);
+            Countly.change_id("Richard Wagner II", false);
+            events();
+            cy.fetch_local_event_queue().then((eq) => {
+                expect(eq.length).to.equal(0);
+            });
+        });
+    });
+    it("Merge ID change should not reset consents", () => {
+        hp.haltAndClearStorage(() => {
+            initMain(true);
+            Countly.add_consent(["sessions", "views", "users", "star-rating", "apm", "feedback"]);
+            Countly.change_id("Richard Wagner the second", true);
+            events();
+            cy.fetch_local_event_queue().then((eq) => {
+                expect(eq.length).to.equal(5);
+                consent_check(eq, eventArray, false, true);
+            });
+        });
+    });
+});

package/cypress/integration/events.js

@@ -0,0 +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);
+                });
+            });
+        });
+    });
+});

package/cypress/integration/internal_limits.js

@@ -0,0 +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);
+            });
+        });
+    });
+});