rudder-sdk-js 1.2.14 → 1.2.15

package/index.js

@@ -5555,7 +5555,7 @@
     PRODUCT_REVIEWED: "Product Reviewed"
   }; // Enumeration for integrations supported
 
-  var CONFIG_URL = "https://api.rudderlabs.com/sourceConfig/?p=npm&v=1.2.14";
+  var CONFIG_URL = "https://api.rudderlabs.com/sourceConfig/?p=npm&v=1.2.15";
   var MAX_WAIT_FOR_INTEGRATION_LOAD = 10000;
   var INTEGRATION_LOAD_CHECK_INTERVAL = 1000;
   /* module.exports = {
@@ -11507,6 +11507,10 @@
       if (Store.enabled) {
         this.storage = Store;
       }
+
+      if (!this.storage) {
+        throw Error("Could not initialize the SDK :: no storage is available");
+      }
     }
 
     _createClass(Storage, [{
@@ -34243,7 +34247,7 @@
     this.build = "1.0.0";
     this.name = "RudderLabs JavaScript SDK";
     this.namespace = "com.rudderlabs.javascript";
-    this.version = "1.2.14";
+    this.version = "1.2.15";
   });
 
   // Library information class
@@ -34251,7 +34255,7 @@
     _classCallCheck(this, RudderLibraryInfo);
 
     this.name = "RudderLabs JavaScript SDK";
-    this.version = "1.2.14";
+    this.version = "1.2.15";
   }); // Operating System information class
 
 
@@ -35940,14 +35944,6 @@
 
   var lib$2 = Queue;
 
-  // Payload class, contains batch of Elements
-  var RudderPayload = /*#__PURE__*/_createClass(function RudderPayload() {
-    _classCallCheck(this, RudderPayload);
-
-    this.batch = null;
-    this.writeKey = null;
-  });
-
   var queueOptions = {
     maxRetryDelay: 360000,
     minRetryDelay: 1000,
@@ -35955,34 +35951,21 @@
     maxAttempts: 10,
     maxItems: 100
   };
-  var MESSAGE_LENGTH = 32 * 1000; // ~32 Kb
-
-  /**
-   *
-   * @class EventRepository responsible for adding events into
-   * flush queue and sending data to rudder backend
-   * in batch and maintains order of the event.
-   */
 
-  var EventRepository = /*#__PURE__*/function () {
-    /**
-     *Creates an instance of EventRepository.
-     * @memberof EventRepository
-     */
-    function EventRepository(options) {
-      _classCallCheck(this, EventRepository);
+  var XHRQueue = /*#__PURE__*/function () {
+    function XHRQueue() {
+      _classCallCheck(this, XHRQueue);
 
-      this.eventsBuffer = [];
-      this.writeKey = "";
       this.url = "";
-      this.state = "READY";
-      this.batchSize = 0; // previous implementation
-      // setInterval(this.preaparePayloadAndFlush, FLUSH_INTERVAL_DEFAULT, this);
+      this.writeKey = "";
     }
 
-    _createClass(EventRepository, [{
-      key: "startQueue",
-      value: function startQueue(options) {
+    _createClass(XHRQueue, [{
+      key: "init",
+      value: function init(writeKey, url, options) {
+        this.url = url;
+        this.writeKey = writeKey;
+
         if (options) {
           // TODO: add checks for value - has to be +ve?
           _extends(queueOptions, options);
@@ -35991,79 +35974,20 @@
         this.payloadQueue = new lib$2("rudder", queueOptions, function (item, done) {
           // apply sentAt at flush time and reset on each retry
           item.message.sentAt = getCurrentTimeFormatted(); // send this item for processing, with a callback to enable queue to get the done status
+          // eslint-disable-next-line no-use-before-define
 
-          eventRepository.processQueueElement(item.url, item.headers, item.message, 10 * 1000, function (err, res) {
+          this.processQueueElement(item.url, item.headers, item.message, 10 * 1000, // eslint-disable-next-line consistent-return
+          function (err, res) {
             if (err) {
               return done(err);
             }
 
             done(null, res);
           });
-        }); // start queue
+        }.bind(this)); // start queue
 
         this.payloadQueue.start();
       }
-      /**
-       *
-       *
-       * @param {EventRepository} repo
-       * @returns
-       * @memberof EventRepository
-       */
-
-    }, {
-      key: "preaparePayloadAndFlush",
-      value: function preaparePayloadAndFlush(repo) {
-        // construct payload
-        logger.debug("==== in preaparePayloadAndFlush with state: ".concat(repo.state));
-        logger.debug(repo.eventsBuffer);
-
-        if (repo.eventsBuffer.length == 0 || repo.state === "PROCESSING") {
-          return;
-        }
-
-        var eventsPayload = repo.eventsBuffer;
-        var payload = new RudderPayload();
-        payload.batch = eventsPayload;
-        payload.writeKey = repo.writeKey;
-        payload.sentAt = getCurrentTimeFormatted(); // add sentAt to individual events as well
-
-        payload.batch.forEach(function (event) {
-          event.sentAt = payload.sentAt;
-        });
-        repo.batchSize = repo.eventsBuffer.length; // server-side integration, XHR is node module
-
-        if (true) {
-          var xhr = new XMLHttpRequest();
-        } else {
-          var xhr;
-        }
-
-        logger.debug("==== in flush sending to Rudder BE ====");
-        logger.debug(JSON.stringify(payload, replacer));
-        xhr.open("POST", repo.url, true);
-        xhr.setRequestHeader("Content-Type", "application/json");
-
-        {
-          xhr.setRequestHeader("Authorization", "Basic ".concat(btoa("".concat(payload.writeKey, ":"))));
-        } // register call back to reset event buffer on successfull POST
-
-
-        xhr.onreadystatechange = function () {
-          if (xhr.readyState === 4 && xhr.status === 200) {
-            logger.debug("====== request processed successfully: ".concat(xhr.status));
-            repo.eventsBuffer = repo.eventsBuffer.slice(repo.batchSize);
-            logger.debug(repo.eventsBuffer.length);
-          } else if (xhr.readyState === 4 && xhr.status !== 200) {
-            handleError(new Error("request failed with status: ".concat(xhr.status, " for url: ").concat(repo.url)));
-          }
-
-          repo.state = "READY";
-        };
-
-        xhr.send(JSON.stringify(payload, replacer));
-        repo.state = "PROCESSING";
-      }
       /**
        * the queue item proceesor
        * @param {*} url to send requests to
@@ -36105,6 +36029,216 @@
           queueFn(error);
         }
       }
+    }, {
+      key: "enqueue",
+      value: function enqueue(message, type) {
+        var headers = {
+          "Content-Type": "application/json",
+          Authorization: "Basic ".concat(btoa("".concat(this.writeKey, ":"))),
+          AnonymousId: btoa(message.anonymousId)
+        }; // add items to the queue
+
+        this.payloadQueue.addItem({
+          url: "".concat(this.url, "/v1/").concat(type),
+          headers: headers,
+          message: message
+        });
+      }
+    }]);
+
+    return XHRQueue;
+  }();
+
+  var defaults$3 = {
+    queue: "queue",
+    maxPayloadSize: 64 * 1000
+  };
+
+  var BeaconQueue = /*#__PURE__*/function () {
+    function BeaconQueue() {
+      _classCallCheck(this, BeaconQueue);
+
+      this.storage = Store;
+      this.maxItems = 10;
+      this.flushQueueTimeOut = undefined;
+      this.timeOutActive = false;
+      this.flushQueueTimeOutInterval = 1000 * 60 * 10; // 10 mins
+
+      this.url = "";
+      this.writekey = "";
+      this.queueName = "".concat(defaults$3.queue, ".").concat(Date.now());
+    }
+
+    _createClass(BeaconQueue, [{
+      key: "sendQueueDataForBeacon",
+      value: function sendQueueDataForBeacon() {
+        this.sendDataFromQueueAndDestroyQueue();
+      }
+    }, {
+      key: "init",
+      value: function init(writekey, url, options) {
+        this.url = url;
+        this.writekey = writekey;
+        if (options.maxItems) this.maxItems = options.maxItems;
+        if (options.flushQueueInterval) this.flushQueueTimeOutInterval = options.flushQueueInterval;
+        var sendQueueData = this.sendQueueDataForBeacon.bind(this);
+        window.addEventListener("unload", sendQueueData);
+      }
+    }, {
+      key: "getQueue",
+      value: function getQueue() {
+        return this.storage.get(this.queueName);
+      }
+    }, {
+      key: "setQueue",
+      value: function setQueue(value) {
+        this.storage.set(this.queueName, value);
+      }
+      /**
+       *
+       * Utility method for excluding null and empty values in JSON
+       * @param {*} _key
+       * @param {*} value
+       * @returns
+       */
+
+    }, {
+      key: "replacer",
+      value: function replacer(_key, value) {
+        if (value === null || value === undefined) {
+          return undefined;
+        }
+
+        return value;
+      }
+    }, {
+      key: "enqueue",
+      value: function enqueue(message) {
+        var queue = this.getQueue() || [];
+        queue = queue.slice(-(this.maxItems - 1));
+        queue.push(message);
+        var batch = queue.slice(0);
+        var data = {
+          batch: batch
+        };
+        var dataToSend = JSON.stringify(data, this.replacer);
+
+        if (dataToSend.length > defaults$3.maxPayloadSize) {
+          batch = queue.slice(0, queue.length - 1);
+          this.flushQueue(batch);
+          queue = this.getQueue();
+          queue.push(message);
+        }
+
+        this.setQueue(queue);
+        this.setTimer();
+
+        if (queue.length === this.maxItems) {
+          this.flushQueue(batch);
+        }
+      }
+    }, {
+      key: "sendDataFromQueueAndDestroyQueue",
+      value: function sendDataFromQueueAndDestroyQueue() {
+        this.sendDataFromQueue();
+        this.storage.remove(this.queueName);
+      }
+    }, {
+      key: "sendDataFromQueue",
+      value: function sendDataFromQueue() {
+        var queue = this.getQueue();
+
+        if (queue && queue.length > 0) {
+          var batch = queue.slice(0, queue.length);
+          this.flushQueue(batch);
+        }
+      }
+    }, {
+      key: "flushQueue",
+      value: function flushQueue(batch) {
+        batch.map(function (event) {
+          event.sentAt = new Date().toISOString();
+        });
+        var data = {
+          batch: batch
+        };
+        var payload = JSON.stringify(data, this.replacer);
+        var blob = new Blob([payload], {
+          type: "application/json"
+        });
+        var isPushed = navigator.sendBeacon("".concat(this.url, "?writeKey=").concat(this.writekey), blob);
+
+        if (!isPushed) {
+          logger.debug("Unable to send data");
+        }
+
+        this.setQueue([]);
+        this.clearTimer();
+      }
+    }, {
+      key: "setTimer",
+      value: function setTimer() {
+        if (!this.timeOutActive) {
+          this.flushQueueTimeOut = setTimeout(this.sendDataFromQueue.bind(this), this.flushQueueTimeOutInterval);
+          this.timeOutActive = true;
+        }
+      }
+    }, {
+      key: "clearTimer",
+      value: function clearTimer() {
+        if (this.timeOutActive) {
+          clearTimeout(this.flushQueueTimeOut);
+          this.timeOutActive = false;
+        }
+      }
+    }]);
+
+    return BeaconQueue;
+  }();
+
+  var MESSAGE_LENGTH = 32 * 1000; // ~32 Kb
+
+  /**
+   *
+   * @class EventRepository responsible for adding events into
+   * flush queue and sending data to rudder backend
+   * in batch and maintains order of the event.
+   */
+
+  var EventRepository = /*#__PURE__*/function () {
+    /**
+     *Creates an instance of EventRepository.
+     * @memberof EventRepository
+     */
+    function EventRepository() {
+      _classCallCheck(this, EventRepository);
+
+      this.queue = undefined;
+    }
+
+    _createClass(EventRepository, [{
+      key: "initialize",
+      value: function initialize(writeKey, url, options) {
+        var queueOptions = {};
+        var targetUrl = url.slice(-1) === "/" ? url.slice(0, -1) : url;
+
+        if (options && options.useBeacon) {
+          if (options && options.beaconQueueOptions && options.beaconQueueOptions != null && _typeof(options.beaconQueueOptions) === "object") {
+            queueOptions = options.beaconQueueOptions;
+          }
+
+          targetUrl = "".concat(targetUrl, "/beacon/v1/batch");
+          this.queue = new BeaconQueue();
+        } else {
+          if (options && options.queueOptions && options.queueOptions != null && _typeof(options.queueOptions) === "object") {
+            queueOptions = options.queueOptions;
+          }
+
+          this.queue = new XHRQueue();
+        }
+
+        this.queue.init(writeKey, targetUrl, queueOptions);
+      }
       /**
        *
        *
@@ -36116,34 +36250,22 @@
       key: "enqueue",
       value: function enqueue(rudderElement, type) {
         var message = rudderElement.getElementContent();
-        var headers = {
-          "Content-Type": "application/json",
-          Authorization: "Basic ".concat(btoa("".concat(this.writeKey, ":"))),
-          AnonymousId: btoa(message.anonymousId)
-        };
         message.originalTimestamp = getCurrentTimeFormatted();
         message.sentAt = getCurrentTimeFormatted(); // add this, will get modified when actually being sent
         // check message size, if greater log an error
 
         if (JSON.stringify(message).length > MESSAGE_LENGTH) {
           logger.error("[EventRepository] enqueue:: message length greater 32 Kb ", message);
-        } // modify the url for event specific endpoints
-
-
-        var url = this.url.slice(-1) == "/" ? this.url.slice(0, -1) : this.url; // add items to the queue
+        }
 
-        this.payloadQueue.addItem({
-          url: "".concat(url, "/v1/").concat(type),
-          headers: headers,
-          message: message
-        });
+        this.queue.enqueue(message, type);
       }
     }]);
 
     return EventRepository;
   }();
 
-  var eventRepository = new EventRepository();
+  var eventRepository = new EventRepository(); // eslint-disable-next-line import/prefer-default-export
 
   function addDomEventHandlers(rudderanalytics) {
     var handler = function handler(e) {
@@ -36770,6 +36892,131 @@
     return Math.floor(Date.now() / 60000);
   }
 
+  /* eslint-disable class-methods-use-this */
+
+  var OneTrust = /*#__PURE__*/function () {
+    function OneTrust(sourceConfig) {
+      var _this = this;
+
+      _classCallCheck(this, OneTrust);
+
+      this.sourceConfig = sourceConfig; // If user does not load onetrust sdk before loading rudderstack sdk
+      // we will not be filtering any of the destinations.
+
+      if (!window.OneTrust || !window.OnetrustActiveGroups) {
+        logger.debug("Onetrust window objects not retrieved. Thus events are sent.");
+        return true;
+      } // OneTrust Cookie Compliance populates a data layer object OnetrustActiveGroups with
+      // the cookie categories that the user has consented to.
+      // Eg: ',C0001,C0003,'
+      // We split it and save it as an array.
+
+
+      var userSetConsentGroupIds = window.OnetrustActiveGroups.split(","); // Ids user has consented
+      // Get information about the cookie script - data includes, consent models, cookies in preference centre, etc.
+      // We get the groups(cookie categorization), user has created in one trust account.
+
+      var oneTrustAllGroupsInfo = window.OneTrust.GetDomainData().Groups;
+      this.userSetConsentGroupNames = []; // Get the names of the cookies consented by the user in the browser.
+
+      oneTrustAllGroupsInfo.forEach(function (group) {
+        var CustomGroupId = group.CustomGroupId,
+            GroupName = group.GroupName;
+
+        if (userSetConsentGroupIds.includes(CustomGroupId)) {
+          _this.userSetConsentGroupNames.push(GroupName.toUpperCase().trim());
+        }
+      });
+    }
+
+    _createClass(OneTrust, [{
+      key: "isEnabled",
+      value: function isEnabled(destConfig) {
+        var _this2 = this;
+
+        try {
+          /**
+          * Structure of onetrust consent group destination config.
+          * 
+          * "oneTrustConsentGroup": [
+                            {
+                                "oneTrustConsentGroup": "Performance Cookies"
+                            },
+                            {
+                                "oneTrustConsentGroup": "Functional Cookies"
+                            },
+                            {
+                                "oneTrustConsentGroup": ""
+                            }
+                        ]
+          *
+          */
+          var oneTrustCookieCategories = destConfig.oneTrustCookieCategories; // mapping of the destination with the consent group name
+          // If the destination do not have this mapping events will be sent.
+
+          if (!oneTrustCookieCategories) {
+            return true;
+          } // Change the structure of oneTrustConsentGroup as an array and filter values if empty string
+          // Eg:
+          // ["Performance Cookies", "Functional Cookies"]
+
+
+          var oneTrustConsentGroupArr = oneTrustCookieCategories.map(function (c) {
+            return c.oneTrustCookieCategory;
+          }).filter(function (n) {
+            return n;
+          });
+          var containsAllConsent = true; // Check if all the destination's mapped cookie categories are consented by the user in the browser.
+
+          containsAllConsent = oneTrustConsentGroupArr.every(function (element) {
+            return _this2.userSetConsentGroupNames.includes(element.toUpperCase().trim());
+          });
+          return containsAllConsent;
+        } catch (e) {
+          logger.error("Error during onetrust cookie consent management ".concat(e));
+          return true;
+        }
+      }
+    }]);
+
+    return OneTrust;
+  }();
+
+  var CookieConsentFactory = /*#__PURE__*/function () {
+    function CookieConsentFactory() {
+      _classCallCheck(this, CookieConsentFactory);
+    }
+
+    _createClass(CookieConsentFactory, null, [{
+      key: "initialize",
+      value: function initialize(sourceConfig, cookieConsentOptions) {
+        var _cookieConsentOptions;
+
+        /**
+         *
+         * check which type of cookie consent manager needs to be called if enabled
+         * for now we have only OneTrust.
+         * But if new cookie consent manager options are implemented,
+         * we need to make sure only one of them is enabled by the user in the
+         * load options
+         *
+         */
+        if (cookieConsentOptions !== null && cookieConsentOptions !== void 0 && (_cookieConsentOptions = cookieConsentOptions.oneTrust) !== null && _cookieConsentOptions !== void 0 && _cookieConsentOptions.enabled) {
+          // This is P1. When we have an ui in source side to turn on/off of cookie consent
+          // if (sourceConfig &&
+          //     sourceConfig.cookieConsentManager &&
+          // sourceConfig.cookieConsentManager.oneTrust &&
+          // sourceConfig.cookieConsentManager.oneTrustenabled) {
+          return new OneTrust(); // }
+        }
+
+        return null;
+      }
+    }]);
+
+    return CookieConsentFactory;
+  }();
+
   var queryDefaults = {
     trait: "ajs_trait_",
     prop: "ajs_prop_"
@@ -36829,6 +37076,7 @@
       };
       this.loaded = false;
       this.loadIntegration = true;
+      this.cookieConsentOptions = {};
     }
     /**
      * initialize the user after load config
@@ -36900,10 +37148,20 @@
           }, this);
           logger.debug("this.clientIntegrations: ", this.clientIntegrations); // intersection of config-plane native sdk destinations with sdk load time destination list
 
-          this.clientIntegrations = findAllEnabledDestinations(this.loadOnlyIntegrations, this.clientIntegrations); // remove from the list which don't have support yet in SDK
+          this.clientIntegrations = findAllEnabledDestinations(this.loadOnlyIntegrations, this.clientIntegrations);
+          var cookieConsent = undefined; // Check if cookie consent manager is being set through load options
+
+          if (Object.keys(this.cookieConsentOptions).length) {
+            // Call the cookie consent factory to initialise and return the type of cookie
+            // consent being set. For now we only support OneTrust.
+            cookieConsent = CookieConsentFactory.initialize(response, this.cookieConsentOptions);
+          } // If cookie consent object is return we filter according to consents given by user
+          // else we do not consider any filtering for cookie consent.
+
 
           this.clientIntegrations = this.clientIntegrations.filter(function (intg) {
-            return integrations[intg.name] != undefined;
+            return integrations[intg.name] != undefined && (!cookieConsent || // check if cookieconsent object is present and then do filtering
+            cookieConsent && cookieConsent.isEnabled(intg.config));
           });
           this.init(this.clientIntegrations);
         } catch (error) {
@@ -37567,6 +37825,7 @@
         var _this3 = this;
 
         logger.debug("inside load ");
+        if (options && options.cookieConsentManager) this.cookieConsentOptions = lodash_clonedeep(options.cookieConsentManager);
         if (this.loaded) return;
         var configUrl = CONFIG_URL;
 
@@ -37633,22 +37892,11 @@
           this.registerCallbacks(true);
         }
 
-        if (options && options.queueOptions && options.queueOptions != null && _typeof(options.queueOptions) == "object") {
-          this.eventRepository.startQueue(options.queueOptions);
-        } else {
-          this.eventRepository.startQueue({});
-        }
-
         if (options && options.loadIntegration != undefined) {
           this.loadIntegration = !!options.loadIntegration;
         }
 
-        this.eventRepository.writeKey = writeKey;
-
-        if (serverUrl) {
-          this.eventRepository.url = serverUrl;
-        }
-
+        this.eventRepository.initialize(writeKey, serverUrl, options);
         this.initializeUser();
         this.setInitialPageProperties();
         this.loaded = true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rudder-sdk-js",
-  "version": "1.2.14",
+  "version": "1.2.15",
   "description": "RudderStack Javascript SDK",
   "main": "index.js",
   "types": "index.d.ts",