[SDK-448] Internal consent (#19)

* internal consent

* fixed some typos

* modified testing and logging

* changelog entry

* example

* added comments to the example

* example

* changes to example

* typo

* fixed the example

* tests added

* eliminated old tests

* grouped events

* clean up

* tests fixed

* name change

Co-authored-by: ArtursKadikis <kadikis.arturs@gmail.com>

Author: turtledreams

CHANGELOG.md

@@ -8,6 +8,7 @@
     - Maximum stack trace lines per thread is now 30 by default.
     - Maximum stack trace line length is now 200 by default. 
 - ! Minor breaking change ! After initialization, the logging/debugging mode can only be changed with `Countly.setLoggingEnabled` instead of `Countly.debug` now.
+- When recording internal events with 'add_event', the respective feature consent will now be checked instead of just the 'events' consent. 
 - Fixed a bug where the SDK throws a `Bulk user storage exception` due to a missing folder
 - Increased the default max event batch size to 100.
 - Logs are now color coded and indicate log levels.

examples/consent_removal_example.js

@@ -134,10 +134,16 @@ function CountlyBulkUser(conf) {
     this.check_consent = function(feature) {
         if (!conf.require_consent) {
             //we don't need to have specific consents
+            cc.log(cc.logLevelEnums.INFO, "check_consent, Require consent is off. Giving consent for : [ " + feature + " ] feature.");
             return true;
         }
-        if (consents[feature]) {
-            return (consents[feature] && consents[feature].optin) ? true : false;
+        if (consents[feature] && consents[feature].optin) {
+            cc.log(cc.logLevelEnums.INFO, "check_consent, Giving consent for : [ " + feature + " ] feature.");
+            return true;
+        }
+        if (consents[feature] && !consents[feature].optin) {
+            cc.log(cc.logLevelEnums.ERROR, "check_consent, User is not optin. Consent refused for : [ " + feature + " ] feature.");
+            return false;
         }
         else {
             cc.log(cc.logLevelEnums.WARNING, "check_consent, No feature available for " + feature);
@@ -221,7 +227,7 @@ function CountlyBulkUser(conf) {
                     updateConsent();
                 }
             }
-            cc.log("Consent removal triggered.");
+            cc.log(cc.logLevelEnums.DEBUG, "remove_consent, Consent removal triggered.");
 
         }
         else {
@@ -247,7 +253,7 @@ function CountlyBulkUser(conf) {
                 }
             }
             conf.server.add_bulk_request({consent: JSON.stringify(consentMessage)});
-            cc.log("Consent update request has been sent to the queue.");
+            cc.log(cc.logLevelEnums.DEBUG, "Consent update request has been sent to the queue.");
         }, 1000);
     };
 
@@ -327,11 +333,41 @@ function CountlyBulkUser(conf) {
     * @param {number=} event.timestamp - timestamp when event occurred
     * @param {Object=} event.segmentation - object with segments key /values
     * @returns {module:lib/countly-bulk-user} instance
-    **/
+     **/
     this.add_event = function(event) {
-        event.key = cc.truncateSingleValue(event.key, conf.maxKeyLength, "add_event");
-        event.segmentation = cc.truncateObject(event.segmentation, conf.maxKeyLength, conf.maxValueSize, conf.maxSegmentationValues, "add_event");
-        if (this.check_consent("events")) {
+        cc.log('Trying to add the event: [ ' + event.key + ' ]');
+        //initially no consent is given
+        var respectiveConsent = false;
+        //to match the internal events and their respective required consents. Sets respectiveConsent to true if the consent is given
+        switch (event.key) {
+        case cc.internalEventKeyEnums.NPS:
+            respectiveConsent = this.check_consent('feedback');
+            break;
+        case cc.internalEventKeyEnums.SURVEY:
+            respectiveConsent = this.check_consent('feedback');
+            break;
+        case cc.internalEventKeyEnums.STAR_RATING:
+            respectiveConsent = this.check_consent('star-rating');
+            break;
+        case cc.internalEventKeyEnums.VIEW:
+            respectiveConsent = this.check_consent('views');
+            break;
+        case cc.internalEventKeyEnums.ORIENTATION:
+            respectiveConsent = this.check_consent('users');
+            break;
+        case cc.internalEventKeyEnums.PUSH_ACTION:
+            respectiveConsent = this.check_consent('push');
+            break;
+        case cc.internalEventKeyEnums.ACTION:
+            respectiveConsent = this.check_consent('clicks') || this.check_consent('scroll');
+            break;
+        default:
+            respectiveConsent = this.check_consent('events');
+        }
+
+        if (respectiveConsent) {
+            event.key = cc.truncateSingleValue(event.key, conf.maxKeyLength, "add_event");
+            event.segmentation = cc.truncateObject(event.segmentation, conf.maxKeyLength, conf.maxValueSize, conf.maxSegmentationValues, "add_event");
             conf.server.add_event(conf.device_id, event);
         }
         return this;
@@ -419,7 +455,7 @@ function CountlyBulkUser(conf) {
 
         if (this.check_consent("views")) {
             var event = {
-                "key": "[CLY]_view",
+                "key": cc.internalEventKeyEnums.VIEW,
                 "dur": duration,
                 "count": 1,
                 "segmentation": {
@@ -474,7 +510,7 @@ function CountlyBulkUser(conf) {
             if (this.check_consent("events")) {
                 var props = ["widget_id", "contactMe", "platform", "app_version", "rating", "email", "comment"];
                 var event = {
-                    key: "[CLY]_star_rating",
+                    key: cc.internalEventKeyEnums.STAR_RATING,
                     count: 1,
                     segmentation: {}
                 };

lib/countly-bulk-user.js

@@ -23,6 +23,26 @@ var cc = {
         DEBUG: '[DEBUG] ',
         VERBOSE: '[VERBOSE] ',
     },
+    /**
+     * At the current moment there are following internal events and their respective required consent:
+        [CLY]_nps - "feedback" consent
+        [CLY]_survey - "feedback" consent
+        [CLY]_star_rating - "star_rating" consent
+        [CLY]_view - "view" consent
+        [CLY]_orientation - "users" consent
+        [CLY]_push_action - "push" consent
+        [CLY]_action - "clicks" or "scroll" consent
+     */
+    internalEventKeyEnums: {
+        NPS: '[CLY]_nps',
+        SURVEY: '[CLY]_survey',
+        STAR_RATING: '[CLY]_star_rating',
+        VIEW: '[CLY]_view',
+        ORIENTATION: '[CLY]_orientation',
+        PUSH_ACTION: '[CLY]_push_action',
+        ACTION: '[CLY]_action'
+    },
+
     /**
      *  Get current timestamp
      *  @returns {number} unix timestamp in seconds

lib/countly-common.js

@@ -220,40 +220,72 @@ Countly.Bulk = Bulk;
      * 
      * Resets Countly to its initial state (used mainly to wipe the queues in memory).
      * Calling this will result in a loss of data
+     * @param {boolean} preventRequestProcessing - if true request queues wont be processed, for testing purposes
      */
-    Countly.halt = function name() {
+    Countly.halt = function(preventRequestProcessing) {
         cc.log(cc.logLevelEnums.WARNING, "halt, Resetting Countly");
         inited = false;
         sessionStarted = false;
-        beatInterval = 500,
-        queueSize = 1000,
-        requestQueue = [],
-        eventQueue = [],
-        remoteConfigs = {},
-        crashLogs = [],
-        timedEvents = {},
-        crashSegments = null,
-        autoExtend = true,
-        storedDuration = 0,
-        lastView = null,
-        lastViewTime = 0,
-        lastMsTs = 0,
-        lastViewStoredDuration = 0,
-        failTimeout = 0,
-        failTimeoutAmount = 60,
-        sessionUpdate = 60,
-        maxEventBatch = 100,
-        readyToProcess = true,
-        trackTime = true,
-        metrics = {},
-        lastParams = {},
-        maxKeyLength = 128,
-        maxValueSize = 256,
-        maxSegmentationValues = 30,
-        maxBreadcrumbCount = 100,
-        maxStackTraceLinesPerThread = 30,
-        maxStackTraceLineLength = 200,
+        beatInterval = 500;
+        queueSize = 1000;
+        requestQueue = [];
+        eventQueue = [];
+        remoteConfigs = {};
+        crashLogs = [];
+        timedEvents = {};
+        crashSegments = null;
+        autoExtend = true;
+        storedDuration = 0;
+        lastView = null;
+        lastViewTime = 0;
+        lastMsTs = 0;
+        lastViewStoredDuration = 0;
+        failTimeout = 0;
+        failTimeoutAmount = 60;
+        sessionUpdate = 60;
+        maxEventBatch = 100;
+        readyToProcess = !preventRequestProcessing;
+        trackTime = true;
+        metrics = {};
+        lastParams = {};
+        maxKeyLength = 128;
+        maxValueSize = 256;
+        maxSegmentationValues = 30;
+        maxBreadcrumbCount = 100;
+        maxStackTraceLinesPerThread = 30;
+        maxStackTraceLineLength = 200;
         __data = {};
+
+        //cc DEBUG
+        cc.debug = false;
+        cc.debugBulk = false;
+        cc.debugBulkUser = false;
+
+        //CONSENTS
+        consents = {};
+        for (var a = 0; a < Countly.features.length; a++) {
+            consents[Countly.features[a]] = {};
+        }
+
+        //device_id
+        Countly.device_id = undefined;
+        Countly.remote_config = undefined;
+        Countly.require_consent = false;
+        Countly.debug = undefined;
+        Countly.app_key = undefined;
+        Countly.url = undefined;
+        Countly.app_version = undefined;
+        Countly.country_code = undefined;
+        Countly.city = undefined;
+        Countly.ip_address = undefined;
+        Countly.force_post = undefined;
+        Countly.storage_path = undefined;
+        Countly.require_consent = undefined;
+        Countly.http_options = undefined;
+
+        asyncWriteLock = false;
+        asyncWriteQueue = [];
+
     };
 
     /**
@@ -304,10 +336,16 @@ Countly.Bulk = Bulk;
     Countly.check_consent = function(feature) {
         if (!Countly.require_consent) {
             //we don't need to have specific consents
+            cc.log(cc.logLevelEnums.INFO, "check_consent, Require consent is off. Giving consent for : [ " + feature + " ] feature.");
+            return true;
+        }
+        if (consents[feature] && consents[feature].optin) {
+            cc.log(cc.logLevelEnums.INFO, "check_consent, Giving consent for : [ " + feature + " ] feature.");
             return true;
         }
-        if (consents[feature]) {
-            return (consents[feature] && consents[feature].optin) ? true : false;
+        if (consents[feature] && !consents[feature].optin) {
+            cc.log(cc.logLevelEnums.ERROR, "check_consent, User is not optin. Consent refused for : [ " + feature + " ] feature.");
+            return false;
         }
         else {
             cc.log(cc.logLevelEnums.ERROR, "check_consent, No feature available for " + feature);
@@ -427,7 +465,7 @@ Countly.Bulk = Bulk;
                     updateConsent();
                 }
             }
-            cc.log("Consent removal triggered.");
+            cc.log(cc.logLevelEnums.DEBUG, "remove_consent, Consent removal triggered.");
 
         }
         else {
@@ -453,7 +491,7 @@ Countly.Bulk = Bulk;
                 }
             }
             toRequestQueue({consent: JSON.stringify(consentMessage)});
-            cc.log("Consent update request has been sent to the queue.");
+            cc.log(cc.logLevelEnums.DEBUG, "Consent update request has been sent to the queue.");
         }, 1000);
     };
 
@@ -573,11 +611,41 @@ Countly.Bulk = Bulk;
     * @param {Object=} event.segmentation - object with segments key /values
     **/
     Countly.add_event = function(event) {
-        if (Countly.check_consent("events")) {
+        cc.log('Trying to add the event: [ ' + event.key + ' ]');
+        //initially no consent is given
+        var respectiveConsent = false;
+        //to match the internal events and their respective required consents. Sets respectiveConsent to true if the consent is given
+        switch (event.key) {
+        case cc.internalEventKeyEnums.NPS:
+            respectiveConsent = Countly.check_consent('feedback');
+            break;
+        case cc.internalEventKeyEnums.SURVEY:
+            respectiveConsent = Countly.check_consent('feedback');
+            break;
+        case cc.internalEventKeyEnums.STAR_RATING:
+            respectiveConsent = Countly.check_consent('star-rating');
+            break;
+        case cc.internalEventKeyEnums.VIEW:
+            respectiveConsent = Countly.check_consent('views');
+            break;
+        case cc.internalEventKeyEnums.ORIENTATION:
+            respectiveConsent = Countly.check_consent('users');
+            break;
+        case cc.internalEventKeyEnums.PUSH_ACTION:
+            respectiveConsent = Countly.check_consent('push');
+            break;
+        case cc.internalEventKeyEnums.ACTION:
+            respectiveConsent = Countly.check_consent('clicks') || Countly.check_consent('scroll');
+            break;
+        default:
+            respectiveConsent = Countly.check_consent('events');
+
+        }
+        //if consent is given adds event to the queue
+        if (respectiveConsent) {
             add_cly_events(event);
         }
     };
-
     /**
     *  Add events to event queue
     *  @memberof Countly._internals
@@ -894,7 +962,7 @@ Countly.Bulk = Bulk;
             if (Countly.check_consent("events")) {
                 var props = ["widget_id", "contactMe", "platform", "app_version", "rating", "email", "comment"];
                 var event = {
-                    key: "[CLY]_star_rating",
+                    key: cc.internalEventKeyEnums.STAR_RATING,
                     count: 1,
                     segmentation: {}
                 };
@@ -1113,7 +1181,7 @@ Countly.Bulk = Bulk;
             //track pageview
             if (Countly.check_consent("views")) {
                 add_cly_events({
-                    "key": "[CLY]_view",
+                    "key": cc.internalEventKeyEnums.VIEW,
                     "segmentation": segments
                 });
             }
@@ -1229,7 +1297,7 @@ Countly.Bulk = Bulk;
             //track pageview
             if (Countly.check_consent("views")) {
                 add_cly_events({
-                    "key": "[CLY]_view",
+                    "key": cc.internalEventKeyEnums.VIEW,
                     "dur": cc.getTimestamp() - lastViewTime,
                     "segmentation": segments
                 });
@@ -1328,7 +1396,7 @@ Countly.Bulk = Bulk;
                 if (err) {
                     requestQueue.unshift(res);
                     failTimeout = cc.getTimestamp() + failTimeoutAmount;
-                    cc.log("Encountered a problem while making the request.");
+                    cc.log(cc.logLevelEnums.ERROR, "makeRequest, Encountered a problem while making the request.");
                 }
                 storeSet("cly_queue", requestQueue);
                 readyToProcess = true;