@cloudcare/browser-core 3.2.13 → 3.2.16

package/esm/helper/serialisation/customerDataTracker.js

@@ -0,0 +1,116 @@
+import { ONE_KIBI_BYTE, computeBytesCount } from '../byteUtils';
+import { throttle, isEmptyObject } from '../tools';
+import { jsonStringify } from './jsonStringify';
+import { display } from '../display';
+
+// RUM and logs batch bytes limit is 16KB
+// ensure that we leave room for other event attributes and maintain a decent amount of event per batch
+// (3KB (customer data) + 1KB (other attributes)) * 4 (events per batch) = 16KB
+export var CUSTOMER_DATA_BYTES_LIMIT = 3 * ONE_KIBI_BYTE;
+
+// We observed that the compression ratio is around 8 in general, but we also want to keep a margin
+// because some data might not be compressed (ex: last view update on page exit). We chose 16KiB
+// because it is also the limit of the 'batchBytesCount' that we use for RUM and Logs data, but this
+// is a bit arbitrary.
+export var CUSTOMER_COMPRESSED_DATA_BYTES_LIMIT = 16 * ONE_KIBI_BYTE;
+export var BYTES_COMPUTATION_THROTTLING_DELAY = 200;
+export var CustomerDataCompressionStatus = {
+  Unknown: 0,
+  Enabled: 1,
+  Disabled: 2
+};
+export function createCustomerDataTrackerManager() {
+  var compressionStatus = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : CustomerDataCompressionStatus.Disabled;
+  var customerDataTrackers = new Map();
+  var alreadyWarned = false;
+  function checkCustomerDataLimit() {
+    var initialBytesCount = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 0;
+    if (alreadyWarned || compressionStatus === CustomerDataCompressionStatus.Unknown) {
+      return;
+    }
+    var bytesCountLimit = compressionStatus === CustomerDataCompressionStatus.Disabled ? CUSTOMER_DATA_BYTES_LIMIT : CUSTOMER_COMPRESSED_DATA_BYTES_LIMIT;
+    var bytesCount = initialBytesCount;
+    customerDataTrackers.forEach(function (tracker) {
+      bytesCount += tracker.getBytesCount();
+    });
+    if (bytesCount > bytesCountLimit) {
+      displayCustomerDataLimitReachedWarning(bytesCountLimit);
+      alreadyWarned = true;
+    }
+  }
+  return {
+    /**
+     * Creates a detached tracker. The manager will not store a reference to that tracker, and the
+     * bytes count will be counted independently from other detached trackers.
+     *
+     * This is particularly useful when we don't know when the tracker will be unused, so we don't
+     * leak memory (ex: when used in Logger instances).
+     */
+    createDetachedTracker: function createDetachedTracker() {
+      var tracker = createCustomerDataTracker(function () {
+        return checkCustomerDataLimit(tracker.getBytesCount());
+      });
+      return tracker;
+    },
+    /**
+     * Creates a tracker if it doesn't exist, and returns it.
+     */
+    getOrCreateTracker: function getOrCreateTracker(type) {
+      if (!customerDataTrackers.has(type)) {
+        customerDataTrackers.set(type, createCustomerDataTracker(checkCustomerDataLimit));
+      }
+      return customerDataTrackers.get(type);
+    },
+    setCompressionStatus: function setCompressionStatus(newCompressionStatus) {
+      if (compressionStatus === CustomerDataCompressionStatus.Unknown) {
+        compressionStatus = newCompressionStatus;
+        checkCustomerDataLimit();
+      }
+    },
+    getCompressionStatus: function getCompressionStatus() {
+      return compressionStatus;
+    },
+    stop: function stop() {
+      customerDataTrackers.forEach(function (tracker) {
+        return tracker.stop();
+      });
+      customerDataTrackers.clear();
+    }
+  };
+}
+export function createCustomerDataTracker(checkCustomerDataLimit) {
+  var bytesCountCache = 0;
+
+  // Throttle the bytes computation to minimize the impact on performance.
+  // Especially useful if the user call context APIs synchronously multiple times in a row
+  var _throttle = throttle(function (context) {
+      bytesCountCache = computeBytesCount(jsonStringify(context));
+      checkCustomerDataLimit();
+    }, BYTES_COMPUTATION_THROTTLING_DELAY),
+    computeBytesCountThrottled = _throttle.throttled,
+    cancelComputeBytesCount = _throttle.cancel;
+  var resetBytesCount = function resetBytesCount() {
+    cancelComputeBytesCount();
+    bytesCountCache = 0;
+  };
+  return {
+    updateCustomerData: function updateCustomerData(context) {
+      if (isEmptyObject(context)) {
+        resetBytesCount();
+      } else {
+        computeBytesCountThrottled(context);
+      }
+    },
+    resetCustomerData: resetBytesCount,
+    getBytesCount: function getBytesCount() {
+      return bytesCountCache;
+    },
+    stop: function stop() {
+      cancelComputeBytesCount();
+    }
+  };
+}
+function displayCustomerDataLimitReachedWarning(bytesCountLimit) {
+  display.warn("Customer data exceeds the recommended ".concat(bytesCountLimit / ONE_KIBI_BYTE, "KiB threshold."));
+}
+//# sourceMappingURL=customerDataTracker.js.map

package/esm/helper/serialisation/customerDataTracker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"customerDataTracker.js","names":["ONE_KIBI_BYTE","computeBytesCount","throttle","isEmptyObject","jsonStringify","display","CUSTOMER_DATA_BYTES_LIMIT","CUSTOMER_COMPRESSED_DATA_BYTES_LIMIT","BYTES_COMPUTATION_THROTTLING_DELAY","CustomerDataCompressionStatus","Unknown","Enabled","Disabled","createCustomerDataTrackerManager","compressionStatus","arguments","length","undefined","customerDataTrackers","Map","alreadyWarned","checkCustomerDataLimit","initialBytesCount","bytesCountLimit","bytesCount","forEach","tracker","getBytesCount","displayCustomerDataLimitReachedWarning","createDetachedTracker","createCustomerDataTracker","getOrCreateTracker","type","has","set","get","setCompressionStatus","newCompressionStatus","getCompressionStatus","stop","clear","bytesCountCache","_throttle","context","computeBytesCountThrottled","throttled","cancelComputeBytesCount","cancel","resetBytesCount","updateCustomerData","resetCustomerData","warn","concat"],"sources":["../../../src/helper/serialisation/customerDataTracker.js"],"sourcesContent":["import { ONE_KIBI_BYTE, computeBytesCount } from '../byteUtils'\nimport { throttle, isEmptyObject } from '../tools'\nimport { jsonStringify } from './jsonStringify'\nimport { display } from '../display'\n\n// RUM and logs batch bytes limit is 16KB\n// ensure that we leave room for other event attributes and maintain a decent amount of event per batch\n// (3KB (customer data) + 1KB (other attributes)) * 4 (events per batch) = 16KB\nexport const CUSTOMER_DATA_BYTES_LIMIT = 3 * ONE_KIBI_BYTE\n\n// We observed that the compression ratio is around 8 in general, but we also want to keep a margin\n// because some data might not be compressed (ex: last view update on page exit). We chose 16KiB\n// because it is also the limit of the 'batchBytesCount' that we use for RUM and Logs data, but this\n// is a bit arbitrary.\nexport const CUSTOMER_COMPRESSED_DATA_BYTES_LIMIT = 16 * ONE_KIBI_BYTE\n\nexport const BYTES_COMPUTATION_THROTTLING_DELAY = 200\n\nexport const CustomerDataCompressionStatus = {\n  Unknown: 0,\n  Enabled: 1,\n  Disabled: 2\n}\n\nexport function createCustomerDataTrackerManager(\n  compressionStatus = CustomerDataCompressionStatus.Disabled\n) {\n  const customerDataTrackers = new Map()\n\n  let alreadyWarned = false\n  function checkCustomerDataLimit(initialBytesCount = 0) {\n    if (\n      alreadyWarned ||\n      compressionStatus === CustomerDataCompressionStatus.Unknown\n    ) {\n      return\n    }\n\n    const bytesCountLimit =\n      compressionStatus === CustomerDataCompressionStatus.Disabled\n        ? CUSTOMER_DATA_BYTES_LIMIT\n        : CUSTOMER_COMPRESSED_DATA_BYTES_LIMIT\n\n    let bytesCount = initialBytesCount\n    customerDataTrackers.forEach((tracker) => {\n      bytesCount += tracker.getBytesCount()\n    })\n\n    if (bytesCount > bytesCountLimit) {\n      displayCustomerDataLimitReachedWarning(bytesCountLimit)\n      alreadyWarned = true\n    }\n  }\n\n  return {\n    /**\n     * Creates a detached tracker. The manager will not store a reference to that tracker, and the\n     * bytes count will be counted independently from other detached trackers.\n     *\n     * This is particularly useful when we don't know when the tracker will be unused, so we don't\n     * leak memory (ex: when used in Logger instances).\n     */\n    createDetachedTracker: () => {\n      const tracker = createCustomerDataTracker(() =>\n        checkCustomerDataLimit(tracker.getBytesCount())\n      )\n      return tracker\n    },\n\n    /**\n     * Creates a tracker if it doesn't exist, and returns it.\n     */\n    getOrCreateTracker: (type) => {\n      if (!customerDataTrackers.has(type)) {\n        customerDataTrackers.set(\n          type,\n          createCustomerDataTracker(checkCustomerDataLimit)\n        )\n      }\n      return customerDataTrackers.get(type)\n    },\n\n    setCompressionStatus: (newCompressionStatus) => {\n      if (compressionStatus === CustomerDataCompressionStatus.Unknown) {\n        compressionStatus = newCompressionStatus\n        checkCustomerDataLimit()\n      }\n    },\n\n    getCompressionStatus: () => compressionStatus,\n\n    stop: () => {\n      customerDataTrackers.forEach((tracker) => tracker.stop())\n      customerDataTrackers.clear()\n    }\n  }\n}\n\nexport function createCustomerDataTracker(checkCustomerDataLimit) {\n  let bytesCountCache = 0\n\n  // Throttle the bytes computation to minimize the impact on performance.\n  // Especially useful if the user call context APIs synchronously multiple times in a row\n  const {\n    throttled: computeBytesCountThrottled,\n    cancel: cancelComputeBytesCount\n  } = throttle((context) => {\n    bytesCountCache = computeBytesCount(jsonStringify(context))\n    checkCustomerDataLimit()\n  }, BYTES_COMPUTATION_THROTTLING_DELAY)\n\n  const resetBytesCount = () => {\n    cancelComputeBytesCount()\n    bytesCountCache = 0\n  }\n\n  return {\n    updateCustomerData: (context) => {\n      if (isEmptyObject(context)) {\n        resetBytesCount()\n      } else {\n        computeBytesCountThrottled(context)\n      }\n    },\n    resetCustomerData: resetBytesCount,\n    getBytesCount: () => bytesCountCache,\n    stop: () => {\n      cancelComputeBytesCount()\n    }\n  }\n}\n\nfunction displayCustomerDataLimitReachedWarning(bytesCountLimit) {\n  display.warn(\n    `Customer data exceeds the recommended ${\n      bytesCountLimit / ONE_KIBI_BYTE\n    }KiB threshold.`\n  )\n}\n"],"mappings":"AAAA,SAASA,aAAa,EAAEC,iBAAiB,QAAQ,cAAc;AAC/D,SAASC,QAAQ,EAAEC,aAAa,QAAQ,UAAU;AAClD,SAASC,aAAa,QAAQ,iBAAiB;AAC/C,SAASC,OAAO,QAAQ,YAAY;;AAEpC;AACA;AACA;AACA,OAAO,IAAMC,yBAAyB,GAAG,CAAC,GAAGN,aAAa;;AAE1D;AACA;AACA;AACA;AACA,OAAO,IAAMO,oCAAoC,GAAG,EAAE,GAAGP,aAAa;AAEtE,OAAO,IAAMQ,kCAAkC,GAAG,GAAG;AAErD,OAAO,IAAMC,6BAA6B,GAAG;EAC3CC,OAAO,EAAE,CAAC;EACVC,OAAO,EAAE,CAAC;EACVC,QAAQ,EAAE;AACZ,CAAC;AAED,OAAO,SAASC,gCAAgCA,CAAA,EAE9C;EAAA,IADAC,iBAAiB,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAGN,6BAA6B,CAACG,QAAQ;EAE1D,IAAMM,oBAAoB,GAAG,IAAIC,GAAG,CAAC,CAAC;EAEtC,IAAIC,aAAa,GAAG,KAAK;EACzB,SAASC,sBAAsBA,CAAA,EAAwB;IAAA,IAAvBC,iBAAiB,GAAAP,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,CAAC;IACnD,IACEK,aAAa,IACbN,iBAAiB,KAAKL,6BAA6B,CAACC,OAAO,EAC3D;MACA;IACF;IAEA,IAAMa,eAAe,GACnBT,iBAAiB,KAAKL,6BAA6B,CAACG,QAAQ,GACxDN,yBAAyB,GACzBC,oCAAoC;IAE1C,IAAIiB,UAAU,GAAGF,iBAAiB;IAClCJ,oBAAoB,CAACO,OAAO,CAAC,UAACC,OAAO,EAAK;MACxCF,UAAU,IAAIE,OAAO,CAACC,aAAa,CAAC,CAAC;IACvC,CAAC,CAAC;IAEF,IAAIH,UAAU,GAAGD,eAAe,EAAE;MAChCK,sCAAsC,CAACL,eAAe,CAAC;MACvDH,aAAa,GAAG,IAAI;IACtB;EACF;EAEA,OAAO;IACL;AACJ;AACA;AACA;AACA;AACA;AACA;IACIS,qBAAqB,EAAE,SAAAA,sBAAA,EAAM;MAC3B,IAAMH,OAAO,GAAGI,yBAAyB,CAAC;QAAA,OACxCT,sBAAsB,CAACK,OAAO,CAACC,aAAa,CAAC,CAAC,CAAC;MAAA,CACjD,CAAC;MACD,OAAOD,OAAO;IAChB,CAAC;IAED;AACJ;AACA;IACIK,kBAAkB,EAAE,SAAAA,mBAACC,IAAI,EAAK;MAC5B,IAAI,CAACd,oBAAoB,CAACe,GAAG,CAACD,IAAI,CAAC,EAAE;QACnCd,oBAAoB,CAACgB,GAAG,CACtBF,IAAI,EACJF,yBAAyB,CAACT,sBAAsB,CAClD,CAAC;MACH;MACA,OAAOH,oBAAoB,CAACiB,GAAG,CAACH,IAAI,CAAC;IACvC,CAAC;IAEDI,oBAAoB,EAAE,SAAAA,qBAACC,oBAAoB,EAAK;MAC9C,IAAIvB,iBAAiB,KAAKL,6BAA6B,CAACC,OAAO,EAAE;QAC/DI,iBAAiB,GAAGuB,oBAAoB;QACxChB,sBAAsB,CAAC,CAAC;MAC1B;IACF,CAAC;IAEDiB,oBAAoB,EAAE,SAAAA,qBAAA;MAAA,OAAMxB,iBAAiB;IAAA;IAE7CyB,IAAI,EAAE,SAAAA,KAAA,EAAM;MACVrB,oBAAoB,CAACO,OAAO,CAAC,UAACC,OAAO;QAAA,OAAKA,OAAO,CAACa,IAAI,CAAC,CAAC;MAAA,EAAC;MACzDrB,oBAAoB,CAACsB,KAAK,CAAC,CAAC;IAC9B;EACF,CAAC;AACH;AAEA,OAAO,SAASV,yBAAyBA,CAACT,sBAAsB,EAAE;EAChE,IAAIoB,eAAe,GAAG,CAAC;;EAEvB;EACA;EACA,IAAAC,SAAA,GAGIxC,QAAQ,CAAC,UAACyC,OAAO,EAAK;MACxBF,eAAe,GAAGxC,iBAAiB,CAACG,aAAa,CAACuC,OAAO,CAAC,CAAC;MAC3DtB,sBAAsB,CAAC,CAAC;IAC1B,CAAC,EAAEb,kCAAkC,CAAC;IALzBoC,0BAA0B,GAAAF,SAAA,CAArCG,SAAS;IACDC,uBAAuB,GAAAJ,SAAA,CAA/BK,MAAM;EAMR,IAAMC,eAAe,GAAG,SAAlBA,eAAeA,CAAA,EAAS;IAC5BF,uBAAuB,CAAC,CAAC;IACzBL,eAAe,GAAG,CAAC;EACrB,CAAC;EAED,OAAO;IACLQ,kBAAkB,EAAE,SAAAA,mBAACN,OAAO,EAAK;MAC/B,IAAIxC,aAAa,CAACwC,OAAO,CAAC,EAAE;QAC1BK,eAAe,CAAC,CAAC;MACnB,CAAC,MAAM;QACLJ,0BAA0B,CAACD,OAAO,CAAC;MACrC;IACF,CAAC;IACDO,iBAAiB,EAAEF,eAAe;IAClCrB,aAAa,EAAE,SAAAA,cAAA;MAAA,OAAMc,eAAe;IAAA;IACpCF,IAAI,EAAE,SAAAA,KAAA,EAAM;MACVO,uBAAuB,CAAC,CAAC;IAC3B;EACF,CAAC;AACH;AAEA,SAASlB,sCAAsCA,CAACL,eAAe,EAAE;EAC/DlB,OAAO,CAAC8C,IAAI,0CAAAC,MAAA,CAER7B,eAAe,GAAGvB,aAAa,mBAEnC,CAAC;AACH","ignoreList":[]}

package/esm/helper/tools.js

@@ -319,15 +319,6 @@ export var safeJSONParse = function safeJSONParse(str) {
   }
   return val;
 };
-export var decodeURIComponent = function decodeURIComponent(val) {
-  var result = val;
-  try {
-    result = decodeURIComponent(val);
-  } catch (error) {
-    result = val;
-  }
-  return result;
-};
 export var encodeDates = function encodeDates(obj) {
   each(obj, function (v, k) {
     if (isDate(v)) {
@@ -574,18 +565,6 @@ export function replaceNumberCharByPath(path) {
   }
   return pathGroup || '/';
 }
-export var getQueryParam = function getQueryParam(url, param) {
-  param = param.replace(/[\[]/, '\\[').replace(/[\]]/, '\\]');
-  url = decodeURIComponent(url);
-  var regexS = '[\\?&]' + param + '=([^&#]*)',
-    regex = new RegExp(regexS),
-    results = regex.exec(url);
-  if (results === null || results && typeof results[1] !== 'string' && results[1].length) {
-    return '';
-  } else {
-    return decodeURIComponent(results[1]);
-  }
-};
 export var urlParse = function urlParse(para) {
   var URLParser = function URLParser(a) {
     this._fields = {
@@ -678,44 +657,6 @@ export function elementMatches(element, selector) {
   }
   return false;
 }
-export var cookie = {
-  get: function get(name) {
-    var nameEQ = name + '=';
-    var ca = document.cookie.split(';');
-    for (var i = 0; i < ca.length; i++) {
-      var c = ca[i];
-      while (c.charAt(0) == ' ') {
-        c = c.substring(1, c.length);
-      }
-      if (c.indexOf(nameEQ) == 0) {
-        return decodeURIComponent(c.substring(nameEQ.length, c.length));
-      }
-    }
-    return null;
-  },
-  set: function set(name, value, days, is_secure) {
-    var cdomain = '',
-      expires = '',
-      secure = '';
-    days = days == null ? 73000 : days;
-    if (days !== 0) {
-      var date = new Date();
-      if (String(days).slice(-1) === 's') {
-        date.setTime(date.getTime() + Number(String(days).slice(0, -1)) * 1000);
-      } else {
-        date.setTime(date.getTime() + days * 24 * 60 * 60 * 1000);
-      }
-      expires = '; expires=' + date.toGMTString();
-    }
-    if (is_secure) {
-      secure = '; secure';
-    }
-    document.cookie = name + '=' + encodeURIComponent(value) + expires + '; path=/' + cdomain + secure;
-  },
-  remove: function remove(name) {
-    cookie.set(name, '', -1);
-  }
-};
 export var localStorage = {
   get: function get(name) {
     return window.localStorage.getItem(name);
@@ -1044,55 +985,6 @@ export function mergeInto(destination, source, circularReferenceChecker) {
 export function deepClone(value) {
   return mergeInto(undefined, value);
 }
-export var _URL = function _URL(url) {
-  var result = {};
-  var basicProps = ['hash', 'host', 'hostname', 'href', 'origin', 'password', 'pathname', 'port', 'protocol', 'search', 'username'];
-  var isURLAPIWorking = function isURLAPIWorking() {
-    var url;
-    try {
-      url = new URL('http://modernizr.com/');
-      return url.href === 'http://modernizr.com/';
-    } catch (e) {
-      return false;
-    }
-  };
-  if (typeof window.URL === 'function' && isURLAPIWorking()) {
-    result = new URL(url);
-    if (!result.searchParams) {
-      result.searchParams = function () {
-        var params = getURLSearchParams(result.search);
-        return {
-          get: function get(searchParam) {
-            return params[searchParam];
-          }
-        };
-      }();
-    }
-  } else {
-    var _regex = /^https?:\/\/.+/;
-    if (_regex.test(url) === false) {
-      throw 'Invalid URL';
-    }
-    var link = document.createElement('a');
-    link.href = url;
-    for (var i = basicProps.length - 1; i >= 0; i--) {
-      var prop = basicProps[i];
-      result[prop] = link[prop];
-    }
-    if (result.hostname && typeof result.pathname === 'string' && result.pathname.indexOf('/') !== 0) {
-      result.pathname = '/' + result.pathname;
-    }
-    result.searchParams = function () {
-      var params = getURLSearchParams(result.search);
-      return {
-        get: function get(searchParam) {
-          return params[searchParam];
-        }
-      };
-    }();
-  }
-  return result;
-};
 export var getCurrentDomain = function getCurrentDomain(url) {
   var cookieTopLevelDomain = getCookieTopLevelDomain();
   if (url === '') {