@cloudcare/browser-core 3.2.13 → 3.2.15

package/esm/helper/serialisation/contextManager.js

@@ -1,77 +1,74 @@
-import { computeBytesCount } from '../byteUtils';
-import { deepClone, throttle, getType } from '../tools';
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+function _iterableToArrayLimit(arr, i) { var _i = null == arr ? null : "undefined" != typeof Symbol && arr[Symbol.iterator] || arr["@@iterator"]; if (null != _i) { var _s, _e, _x, _r, _arr = [], _n = !0, _d = !1; try { if (_x = (_i = _i.call(arr)).next, 0 === i) { if (Object(_i) !== _i) return; _n = !1; } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0); } catch (err) { _d = !0, _e = err; } finally { try { if (!_n && null != _i["return"] && (_r = _i["return"](), Object(_r) !== _r)) return; } finally { if (_d) throw _e; } } return _arr; } }
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+import { deepClone, getType } from '../tools';
 import { sanitize } from '../sanitize';
-import { jsonStringify } from './jsonStringify';
 import { Observable } from '../observable';
-import { warnIfCustomerDataLimitReached } from './heavyCustomerDataWarning';
-export var BYTES_COMPUTATION_THROTTLING_DELAY = 200;
-export function createContextManager(customerDataType, computeBytesCountImpl) {
-  if (typeof computeBytesCountImpl === 'undefined') {
-    computeBytesCountImpl = computeBytesCount;
+import { display } from '../display';
+function ensureProperties(context, propertiesConfig, name) {
+  var newContext = _objectSpread({}, context);
+  for (var _i = 0, _Object$entries = Object.entries(propertiesConfig); _i < _Object$entries.length; _i++) {
+    var _Object$entries$_i = _slicedToArray(_Object$entries[_i], 2),
+      key = _Object$entries$_i[0],
+      _Object$entries$_i$ = _Object$entries$_i[1],
+      required = _Object$entries$_i$.required,
+      type = _Object$entries$_i$.type;
+    /**
+     * Ensure specified properties are strings as defined here:
+     */
+    if (type === 'string' && key in newContext) {
+      newContext[key] = String(newContext[key]);
+    }
+    if (required && !(key in context)) {
+      display.warn("The property ".concat(key, " of ").concat(name, " context is required; context will not be sent to the intake."));
+    }
   }
+  return newContext;
+}
+export function createContextManager() {
+  var name = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '';
+  var _ref = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},
+    customerDataTracker = _ref.customerDataTracker,
+    _ref$propertiesConfig = _ref.propertiesConfig,
+    propertiesConfig = _ref$propertiesConfig === void 0 ? {} : _ref$propertiesConfig;
   var context = {};
-  var bytesCountCache;
-  var alreadyWarned = false;
   var changeObservable = new Observable();
-  // 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 computeBytesCountThrottled = throttle(function (context) {
-    bytesCountCache = computeBytesCountImpl(jsonStringify(context));
-    if (!alreadyWarned) {
-      alreadyWarned = warnIfCustomerDataLimitReached(bytesCountCache, customerDataType);
-    }
-  }, BYTES_COMPUTATION_THROTTLING_DELAY).throttled;
   var contextManager = {
-    getBytesCount: function getBytesCount() {
-      return bytesCountCache;
-    },
-    /** @deprecated use getContext instead */
-    get: function get() {
-      return context;
-    },
-    /** @deprecated use setContextProperty instead */
-    add: function add(key, value) {
-      context[key] = value;
-      computeBytesCountThrottled(context);
-      changeObservable.notify();
-    },
-    /** @deprecated renamed to removeContextProperty */
-    remove: function remove(key) {
-      delete context[key];
-      computeBytesCountThrottled(context);
-      changeObservable.notify();
-    },
-    /** @deprecated use setContext instead */
-    set: function set(newContext) {
-      context = newContext;
-      computeBytesCountThrottled(context);
-      changeObservable.notify();
-    },
     getContext: function getContext() {
       return deepClone(context);
     },
     setContext: function setContext(newContext) {
       if (getType(newContext) === 'object') {
-        context = sanitize(newContext);
-        computeBytesCountThrottled(context);
+        context = sanitize(ensureProperties(newContext, propertiesConfig, name));
+        customerDataTracker === null || customerDataTracker === void 0 ? void 0 : customerDataTracker.updateCustomerData(context);
       } else {
         contextManager.clearContext();
       }
       changeObservable.notify();
     },
     setContextProperty: function setContextProperty(key, property) {
-      context[key] = deepClone(property);
-      computeBytesCountThrottled(context);
+      context[key] = sanitize(ensureProperties(_defineProperty({}, key, property), propertiesConfig, name)[key]);
+      customerDataTracker === null || customerDataTracker === void 0 ? void 0 : customerDataTracker.updateCustomerData(context);
       changeObservable.notify();
     },
     removeContextProperty: function removeContextProperty(key) {
       delete context[key];
-      computeBytesCountThrottled(context);
+      customerDataTracker === null || customerDataTracker === void 0 ? void 0 : customerDataTracker.updateCustomerData(context);
+      ensureProperties(context, propertiesConfig, name);
       changeObservable.notify();
     },
     clearContext: function clearContext() {
       context = {};
-      bytesCountCache = 0;
+      customerDataTracker === null || customerDataTracker === void 0 ? void 0 : customerDataTracker.resetCustomerData();
       changeObservable.notify();
     },
     changeObservable: changeObservable

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

@@ -1 +1 @@
-{"version":3,"file":"contextManager.js","names":["computeBytesCount","deepClone","throttle","getType","sanitize","jsonStringify","Observable","warnIfCustomerDataLimitReached","BYTES_COMPUTATION_THROTTLING_DELAY","createContextManager","customerDataType","computeBytesCountImpl","context","bytesCountCache","alreadyWarned","changeObservable","computeBytesCountThrottled","throttled","contextManager","getBytesCount","get","add","key","value","notify","remove","set","newContext","getContext","setContext","clearContext","setContextProperty","property","removeContextProperty"],"sources":["../../../src/helper/serialisation/contextManager.js"],"sourcesContent":["import { computeBytesCount } from '../byteUtils'\nimport { deepClone, throttle, getType } from '../tools'\nimport { sanitize } from '../sanitize'\nimport { jsonStringify } from './jsonStringify'\nimport { Observable } from '../observable'\nimport { warnIfCustomerDataLimitReached } from './heavyCustomerDataWarning'\n\nexport var BYTES_COMPUTATION_THROTTLING_DELAY = 200\n\nexport function createContextManager(customerDataType, computeBytesCountImpl) {\n  if (typeof computeBytesCountImpl === 'undefined') {\n    computeBytesCountImpl = computeBytesCount\n  }\n  var context = {}\n  var bytesCountCache\n  var alreadyWarned = false\n  var changeObservable = new Observable()\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  var computeBytesCountThrottled = throttle(function (context) {\n    bytesCountCache = computeBytesCountImpl(jsonStringify(context))\n    if (!alreadyWarned) {\n      alreadyWarned = warnIfCustomerDataLimitReached(\n        bytesCountCache,\n        customerDataType\n      )\n    }\n  }, BYTES_COMPUTATION_THROTTLING_DELAY).throttled\n\n  var contextManager = {\n    getBytesCount: function () {\n      return bytesCountCache\n    },\n    /** @deprecated use getContext instead */\n    get: function () {\n      return context\n    },\n\n    /** @deprecated use setContextProperty instead */\n    add: function (key, value) {\n      context[key] = value\n      computeBytesCountThrottled(context)\n      changeObservable.notify()\n    },\n\n    /** @deprecated renamed to removeContextProperty */\n    remove: function (key) {\n      delete context[key]\n      computeBytesCountThrottled(context)\n      changeObservable.notify()\n    },\n\n    /** @deprecated use setContext instead */\n    set: function (newContext) {\n      context = newContext\n      computeBytesCountThrottled(context)\n      changeObservable.notify()\n    },\n\n    getContext: function () {\n      return deepClone(context)\n    },\n\n    setContext: function (newContext) {\n      if (getType(newContext) === 'object') {\n        context = sanitize(newContext)\n        computeBytesCountThrottled(context)\n      } else {\n        contextManager.clearContext()\n      }\n      changeObservable.notify()\n    },\n\n    setContextProperty: function (key, property) {\n      context[key] = deepClone(property)\n      computeBytesCountThrottled(context)\n      changeObservable.notify()\n    },\n\n    removeContextProperty: function (key) {\n      delete context[key]\n      computeBytesCountThrottled(context)\n      changeObservable.notify()\n    },\n\n    clearContext: function () {\n      context = {}\n      bytesCountCache = 0\n      changeObservable.notify()\n    },\n    changeObservable: changeObservable\n  }\n  return contextManager\n}\n"],"mappings":"AAAA,SAASA,iBAAiB,QAAQ,cAAc;AAChD,SAASC,SAAS,EAAEC,QAAQ,EAAEC,OAAO,QAAQ,UAAU;AACvD,SAASC,QAAQ,QAAQ,aAAa;AACtC,SAASC,aAAa,QAAQ,iBAAiB;AAC/C,SAASC,UAAU,QAAQ,eAAe;AAC1C,SAASC,8BAA8B,QAAQ,4BAA4B;AAE3E,OAAO,IAAIC,kCAAkC,GAAG,GAAG;AAEnD,OAAO,SAASC,oBAAoBA,CAACC,gBAAgB,EAAEC,qBAAqB,EAAE;EAC5E,IAAI,OAAOA,qBAAqB,KAAK,WAAW,EAAE;IAChDA,qBAAqB,GAAGX,iBAAiB;EAC3C;EACA,IAAIY,OAAO,GAAG,CAAC,CAAC;EAChB,IAAIC,eAAe;EACnB,IAAIC,aAAa,GAAG,KAAK;EACzB,IAAIC,gBAAgB,GAAG,IAAIT,UAAU,CAAC,CAAC;EACvC;EACA;EACA,IAAIU,0BAA0B,GAAGd,QAAQ,CAAC,UAAUU,OAAO,EAAE;IAC3DC,eAAe,GAAGF,qBAAqB,CAACN,aAAa,CAACO,OAAO,CAAC,CAAC;IAC/D,IAAI,CAACE,aAAa,EAAE;MAClBA,aAAa,GAAGP,8BAA8B,CAC5CM,eAAe,EACfH,gBACF,CAAC;IACH;EACF,CAAC,EAAEF,kCAAkC,CAAC,CAACS,SAAS;EAEhD,IAAIC,cAAc,GAAG;IACnBC,aAAa,EAAE,SAAAA,cAAA,EAAY;MACzB,OAAON,eAAe;IACxB,CAAC;IACD;IACAO,GAAG,EAAE,SAAAA,IAAA,EAAY;MACf,OAAOR,OAAO;IAChB,CAAC;IAED;IACAS,GAAG,EAAE,SAAAA,IAAUC,GAAG,EAAEC,KAAK,EAAE;MACzBX,OAAO,CAACU,GAAG,CAAC,GAAGC,KAAK;MACpBP,0BAA0B,CAACJ,OAAO,CAAC;MACnCG,gBAAgB,CAACS,MAAM,CAAC,CAAC;IAC3B,CAAC;IAED;IACAC,MAAM,EAAE,SAAAA,OAAUH,GAAG,EAAE;MACrB,OAAOV,OAAO,CAACU,GAAG,CAAC;MACnBN,0BAA0B,CAACJ,OAAO,CAAC;MACnCG,gBAAgB,CAACS,MAAM,CAAC,CAAC;IAC3B,CAAC;IAED;IACAE,GAAG,EAAE,SAAAA,IAAUC,UAAU,EAAE;MACzBf,OAAO,GAAGe,UAAU;MACpBX,0BAA0B,CAACJ,OAAO,CAAC;MACnCG,gBAAgB,CAACS,MAAM,CAAC,CAAC;IAC3B,CAAC;IAEDI,UAAU,EAAE,SAAAA,WAAA,EAAY;MACtB,OAAO3B,SAAS,CAACW,OAAO,CAAC;IAC3B,CAAC;IAEDiB,UAAU,EAAE,SAAAA,WAAUF,UAAU,EAAE;MAChC,IAAIxB,OAAO,CAACwB,UAAU,CAAC,KAAK,QAAQ,EAAE;QACpCf,OAAO,GAAGR,QAAQ,CAACuB,UAAU,CAAC;QAC9BX,0BAA0B,CAACJ,OAAO,CAAC;MACrC,CAAC,MAAM;QACLM,cAAc,CAACY,YAAY,CAAC,CAAC;MAC/B;MACAf,gBAAgB,CAACS,MAAM,CAAC,CAAC;IAC3B,CAAC;IAEDO,kBAAkB,EAAE,SAAAA,mBAAUT,GAAG,EAAEU,QAAQ,EAAE;MAC3CpB,OAAO,CAACU,GAAG,CAAC,GAAGrB,SAAS,CAAC+B,QAAQ,CAAC;MAClChB,0BAA0B,CAACJ,OAAO,CAAC;MACnCG,gBAAgB,CAACS,MAAM,CAAC,CAAC;IAC3B,CAAC;IAEDS,qBAAqB,EAAE,SAAAA,sBAAUX,GAAG,EAAE;MACpC,OAAOV,OAAO,CAACU,GAAG,CAAC;MACnBN,0BAA0B,CAACJ,OAAO,CAAC;MACnCG,gBAAgB,CAACS,MAAM,CAAC,CAAC;IAC3B,CAAC;IAEDM,YAAY,EAAE,SAAAA,aAAA,EAAY;MACxBlB,OAAO,GAAG,CAAC,CAAC;MACZC,eAAe,GAAG,CAAC;MACnBE,gBAAgB,CAACS,MAAM,CAAC,CAAC;IAC3B,CAAC;IACDT,gBAAgB,EAAEA;EACpB,CAAC;EACD,OAAOG,cAAc;AACvB","ignoreList":[]}
+{"version":3,"file":"contextManager.js","names":["deepClone","getType","sanitize","Observable","display","ensureProperties","context","propertiesConfig","name","newContext","_objectSpread","_i","_Object$entries","Object","entries","length","_Object$entries$_i","_slicedToArray","key","_Object$entries$_i$","required","type","String","warn","concat","createContextManager","arguments","undefined","_ref","customerDataTracker","_ref$propertiesConfig","changeObservable","contextManager","getContext","setContext","updateCustomerData","clearContext","notify","setContextProperty","property","_defineProperty","removeContextProperty","resetCustomerData"],"sources":["../../../src/helper/serialisation/contextManager.js"],"sourcesContent":["import { deepClone, getType } from '../tools'\nimport { sanitize } from '../sanitize'\nimport { Observable } from '../observable'\nimport { display } from '../display'\n\nfunction ensureProperties(context, propertiesConfig, name) {\n  const newContext = { ...context }\n\n  for (const [key, { required, type }] of Object.entries(propertiesConfig)) {\n    /**\n     * Ensure specified properties are strings as defined here:\n     */\n    if (type === 'string' && key in newContext) {\n      newContext[key] = String(newContext[key])\n    }\n\n    if (required && !(key in context)) {\n      display.warn(\n        `The property ${key} of ${name} context is required; context will not be sent to the intake.`\n      )\n    }\n  }\n\n  return newContext\n}\n\nexport function createContextManager(\n  name = '',\n  { customerDataTracker, propertiesConfig = {} } = {}\n) {\n  let context = {}\n  const changeObservable = new Observable()\n\n  const contextManager = {\n    getContext: () => deepClone(context),\n\n    setContext: (newContext) => {\n      if (getType(newContext) === 'object') {\n        context = sanitize(ensureProperties(newContext, propertiesConfig, name))\n        customerDataTracker?.updateCustomerData(context)\n      } else {\n        contextManager.clearContext()\n      }\n      changeObservable.notify()\n    },\n\n    setContextProperty: (key, property) => {\n      context[key] = sanitize(\n        ensureProperties({ [key]: property }, propertiesConfig, name)[key]\n      )\n      customerDataTracker?.updateCustomerData(context)\n      changeObservable.notify()\n    },\n\n    removeContextProperty: (key) => {\n      delete context[key]\n      customerDataTracker?.updateCustomerData(context)\n      ensureProperties(context, propertiesConfig, name)\n      changeObservable.notify()\n    },\n\n    clearContext: () => {\n      context = {}\n      customerDataTracker?.resetCustomerData()\n      changeObservable.notify()\n    },\n\n    changeObservable\n  }\n  return contextManager\n}\n"],"mappings":";;;;;;;;;;;;AAAA,SAASA,SAAS,EAAEC,OAAO,QAAQ,UAAU;AAC7C,SAASC,QAAQ,QAAQ,aAAa;AACtC,SAASC,UAAU,QAAQ,eAAe;AAC1C,SAASC,OAAO,QAAQ,YAAY;AAEpC,SAASC,gBAAgBA,CAACC,OAAO,EAAEC,gBAAgB,EAAEC,IAAI,EAAE;EACzD,IAAMC,UAAU,GAAAC,aAAA,KAAQJ,OAAO,CAAE;EAEjC,SAAAK,EAAA,MAAAC,eAAA,GAAwCC,MAAM,CAACC,OAAO,CAACP,gBAAgB,CAAC,EAAAI,EAAA,GAAAC,eAAA,CAAAG,MAAA,EAAAJ,EAAA,IAAE;IAArE,IAAAK,kBAAA,GAAAC,cAAA,CAAAL,eAAA,CAAAD,EAAA;MAAOO,GAAG,GAAAF,kBAAA;MAAAG,mBAAA,GAAAH,kBAAA;MAAII,QAAQ,GAAAD,mBAAA,CAARC,QAAQ;MAAEC,IAAI,GAAAF,mBAAA,CAAJE,IAAI;IAC/B;AACJ;AACA;IACI,IAAIA,IAAI,KAAK,QAAQ,IAAIH,GAAG,IAAIT,UAAU,EAAE;MAC1CA,UAAU,CAACS,GAAG,CAAC,GAAGI,MAAM,CAACb,UAAU,CAACS,GAAG,CAAC,CAAC;IAC3C;IAEA,IAAIE,QAAQ,IAAI,EAAEF,GAAG,IAAIZ,OAAO,CAAC,EAAE;MACjCF,OAAO,CAACmB,IAAI,iBAAAC,MAAA,CACMN,GAAG,UAAAM,MAAA,CAAOhB,IAAI,kEAChC,CAAC;IACH;EACF;EAEA,OAAOC,UAAU;AACnB;AAEA,OAAO,SAASgB,oBAAoBA,CAAA,EAGlC;EAAA,IAFAjB,IAAI,GAAAkB,SAAA,CAAAX,MAAA,QAAAW,SAAA,QAAAC,SAAA,GAAAD,SAAA,MAAG,EAAE;EAAA,IAAAE,IAAA,GAAAF,SAAA,CAAAX,MAAA,QAAAW,SAAA,QAAAC,SAAA,GAAAD,SAAA,MACwC,CAAC,CAAC;IAAjDG,mBAAmB,GAAAD,IAAA,CAAnBC,mBAAmB;IAAAC,qBAAA,GAAAF,IAAA,CAAErB,gBAAgB;IAAhBA,gBAAgB,GAAAuB,qBAAA,cAAG,CAAC,CAAC,GAAAA,qBAAA;EAE5C,IAAIxB,OAAO,GAAG,CAAC,CAAC;EAChB,IAAMyB,gBAAgB,GAAG,IAAI5B,UAAU,CAAC,CAAC;EAEzC,IAAM6B,cAAc,GAAG;IACrBC,UAAU,EAAE,SAAAA,WAAA;MAAA,OAAMjC,SAAS,CAACM,OAAO,CAAC;IAAA;IAEpC4B,UAAU,EAAE,SAAAA,WAACzB,UAAU,EAAK;MAC1B,IAAIR,OAAO,CAACQ,UAAU,CAAC,KAAK,QAAQ,EAAE;QACpCH,OAAO,GAAGJ,QAAQ,CAACG,gBAAgB,CAACI,UAAU,EAAEF,gBAAgB,EAAEC,IAAI,CAAC,CAAC;QACxEqB,mBAAmB,aAAnBA,mBAAmB,uBAAnBA,mBAAmB,CAAEM,kBAAkB,CAAC7B,OAAO,CAAC;MAClD,CAAC,MAAM;QACL0B,cAAc,CAACI,YAAY,CAAC,CAAC;MAC/B;MACAL,gBAAgB,CAACM,MAAM,CAAC,CAAC;IAC3B,CAAC;IAEDC,kBAAkB,EAAE,SAAAA,mBAACpB,GAAG,EAAEqB,QAAQ,EAAK;MACrCjC,OAAO,CAACY,GAAG,CAAC,GAAGhB,QAAQ,CACrBG,gBAAgB,CAAAmC,eAAA,KAAItB,GAAG,EAAGqB,QAAQ,GAAIhC,gBAAgB,EAAEC,IAAI,CAAC,CAACU,GAAG,CACnE,CAAC;MACDW,mBAAmB,aAAnBA,mBAAmB,uBAAnBA,mBAAmB,CAAEM,kBAAkB,CAAC7B,OAAO,CAAC;MAChDyB,gBAAgB,CAACM,MAAM,CAAC,CAAC;IAC3B,CAAC;IAEDI,qBAAqB,EAAE,SAAAA,sBAACvB,GAAG,EAAK;MAC9B,OAAOZ,OAAO,CAACY,GAAG,CAAC;MACnBW,mBAAmB,aAAnBA,mBAAmB,uBAAnBA,mBAAmB,CAAEM,kBAAkB,CAAC7B,OAAO,CAAC;MAChDD,gBAAgB,CAACC,OAAO,EAAEC,gBAAgB,EAAEC,IAAI,CAAC;MACjDuB,gBAAgB,CAACM,MAAM,CAAC,CAAC;IAC3B,CAAC;IAEDD,YAAY,EAAE,SAAAA,aAAA,EAAM;MAClB9B,OAAO,GAAG,CAAC,CAAC;MACZuB,mBAAmB,aAAnBA,mBAAmB,uBAAnBA,mBAAmB,CAAEa,iBAAiB,CAAC,CAAC;MACxCX,gBAAgB,CAACM,MAAM,CAAC,CAAC;IAC3B,CAAC;IAEDN,gBAAgB,EAAhBA;EACF,CAAC;EACD,OAAOC,cAAc;AACvB","ignoreList":[]}

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/index.js

@@ -43,10 +43,11 @@ export { STORAGE_POLL_DELAY } from './session/sessionStore';
 export * from './transport';
 export * from './synthetics/syntheticsWorkerValues';
 export * from './helper/serialisation/contextManager';
-export * from './helper/serialisation/heavyCustomerDataWarning';
+export * from './helper/serialisation/const';
 export * from './helper/serialisation/jsonStringify';
 export * from './helper/serialisation/rowData';
 export * from './helper/serialisation/storedContextManager';
+export * from './helper/serialisation/customerDataTracker';
 export * from './helper/encoder';
 export * from './user';
 export * from './helper/polyfills';

package/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["startSessionManager","stopSessionManager","SESSION_TIME_OUT_DELAY","SESSION_STORE_KEY","STORAGE_POLL_DELAY"],"sources":["../src/index.js"],"sourcesContent":["export * from './helper/boundedBuffer'\nexport * from './helper/valueHistory'\nexport * from './helper/deviceInfo'\nexport * from './helper/enums'\nexport * from './helper/instrumentMethod'\nexport * from './helper/errorTools'\nexport * from './helper/byteUtils'\nexport * from './error/trackRuntimeError'\nexport * from './console/consoleObservable'\nexport * from './report/reportObservable'\nexport * from './helper/display'\nexport * from './helper/monitor'\nexport * from './helper/sanitize'\nexport * from './helper/eventEmitter'\nexport * from './helper/lifeCycle'\nexport * from './helper/limitModification'\nexport * from './helper/createEventRateLimiter'\nexport * from './helper/observable'\nexport * from './helper/tools'\nexport * from './helper/urlPolyfill'\nexport * from './helper/mobileUtil'\nexport * from './helper/getZoneJsOriginalValue'\nexport * from './helper/timer'\nexport * from './helper/readBytesFromStream'\nexport * from './helper/requestIdleCallback'\nexport * from './helper/taskQueue'\nexport * from './tracekit'\nexport * from './configuration/configuration'\nexport * from './configuration/transportConfiguration'\nexport * from './browser/cookie'\nexport * from './browser/fetchObservable'\nexport * from './browser/xhrObservable'\nexport * from './browser/pageExitObservable'\nexport * from './browser/htmlDomUtils'\nexport * from './browser/addEventListener'\nexport * from './browser/runOnReadyState'\nexport * from './browser/scroll'\n\nexport * from './dataMap'\nexport * from './init'\nexport {\n  startSessionManager,\n  stopSessionManager\n} from './session/sessionManagement'\nexport {\n  SESSION_TIME_OUT_DELAY,\n  SESSION_STORE_KEY\n} from './session/sessionConstants'\nexport { STORAGE_POLL_DELAY } from './session/sessionStore'\nexport * from './transport'\nexport * from './synthetics/syntheticsWorkerValues'\n\nexport * from './helper/serialisation/contextManager'\nexport * from './helper/serialisation/heavyCustomerDataWarning'\nexport * from './helper/serialisation/jsonStringify'\nexport * from './helper/serialisation/rowData'\nexport * from './helper/serialisation/storedContextManager'\nexport * from './helper/encoder'\nexport * from './user'\nexport * from './helper/polyfills'\nexport * from './telemetry/telemetry'\nexport * from './helper/catchUserErrors'\nexport * from './helper/connectivity'\nexport * from './helper/displayAlreadyInitializedError'\n"],"mappings":"AAAA,cAAc,wBAAwB;AACtC,cAAc,uBAAuB;AACrC,cAAc,qBAAqB;AACnC,cAAc,gBAAgB;AAC9B,cAAc,2BAA2B;AACzC,cAAc,qBAAqB;AACnC,cAAc,oBAAoB;AAClC,cAAc,2BAA2B;AACzC,cAAc,6BAA6B;AAC3C,cAAc,2BAA2B;AACzC,cAAc,kBAAkB;AAChC,cAAc,kBAAkB;AAChC,cAAc,mBAAmB;AACjC,cAAc,uBAAuB;AACrC,cAAc,oBAAoB;AAClC,cAAc,4BAA4B;AAC1C,cAAc,iCAAiC;AAC/C,cAAc,qBAAqB;AACnC,cAAc,gBAAgB;AAC9B,cAAc,sBAAsB;AACpC,cAAc,qBAAqB;AACnC,cAAc,iCAAiC;AAC/C,cAAc,gBAAgB;AAC9B,cAAc,8BAA8B;AAC5C,cAAc,8BAA8B;AAC5C,cAAc,oBAAoB;AAClC,cAAc,YAAY;AAC1B,cAAc,+BAA+B;AAC7C,cAAc,wCAAwC;AACtD,cAAc,kBAAkB;AAChC,cAAc,2BAA2B;AACzC,cAAc,yBAAyB;AACvC,cAAc,8BAA8B;AAC5C,cAAc,wBAAwB;AACtC,cAAc,4BAA4B;AAC1C,cAAc,2BAA2B;AACzC,cAAc,kBAAkB;AAEhC,cAAc,WAAW;AACzB,cAAc,QAAQ;AACtB,SACEA,mBAAmB,EACnBC,kBAAkB,QACb,6BAA6B;AACpC,SACEC,sBAAsB,EACtBC,iBAAiB,QACZ,4BAA4B;AACnC,SAASC,kBAAkB,QAAQ,wBAAwB;AAC3D,cAAc,aAAa;AAC3B,cAAc,qCAAqC;AAEnD,cAAc,uCAAuC;AACrD,cAAc,iDAAiD;AAC/D,cAAc,sCAAsC;AACpD,cAAc,gCAAgC;AAC9C,cAAc,6CAA6C;AAC3D,cAAc,kBAAkB;AAChC,cAAc,QAAQ;AACtB,cAAc,oBAAoB;AAClC,cAAc,uBAAuB;AACrC,cAAc,0BAA0B;AACxC,cAAc,uBAAuB;AACrC,cAAc,yCAAyC","ignoreList":[]}
+{"version":3,"file":"index.js","names":["startSessionManager","stopSessionManager","SESSION_TIME_OUT_DELAY","SESSION_STORE_KEY","STORAGE_POLL_DELAY"],"sources":["../src/index.js"],"sourcesContent":["export * from './helper/boundedBuffer'\nexport * from './helper/valueHistory'\nexport * from './helper/deviceInfo'\nexport * from './helper/enums'\nexport * from './helper/instrumentMethod'\nexport * from './helper/errorTools'\nexport * from './helper/byteUtils'\nexport * from './error/trackRuntimeError'\nexport * from './console/consoleObservable'\nexport * from './report/reportObservable'\nexport * from './helper/display'\nexport * from './helper/monitor'\nexport * from './helper/sanitize'\nexport * from './helper/eventEmitter'\nexport * from './helper/lifeCycle'\nexport * from './helper/limitModification'\nexport * from './helper/createEventRateLimiter'\nexport * from './helper/observable'\nexport * from './helper/tools'\nexport * from './helper/urlPolyfill'\nexport * from './helper/mobileUtil'\nexport * from './helper/getZoneJsOriginalValue'\nexport * from './helper/timer'\nexport * from './helper/readBytesFromStream'\nexport * from './helper/requestIdleCallback'\nexport * from './helper/taskQueue'\nexport * from './tracekit'\nexport * from './configuration/configuration'\nexport * from './configuration/transportConfiguration'\nexport * from './browser/cookie'\nexport * from './browser/fetchObservable'\nexport * from './browser/xhrObservable'\nexport * from './browser/pageExitObservable'\nexport * from './browser/htmlDomUtils'\nexport * from './browser/addEventListener'\nexport * from './browser/runOnReadyState'\nexport * from './browser/scroll'\n\nexport * from './dataMap'\nexport * from './init'\nexport {\n  startSessionManager,\n  stopSessionManager\n} from './session/sessionManagement'\nexport {\n  SESSION_TIME_OUT_DELAY,\n  SESSION_STORE_KEY\n} from './session/sessionConstants'\nexport { STORAGE_POLL_DELAY } from './session/sessionStore'\nexport * from './transport'\nexport * from './synthetics/syntheticsWorkerValues'\n\nexport * from './helper/serialisation/contextManager'\nexport * from './helper/serialisation/const'\nexport * from './helper/serialisation/jsonStringify'\nexport * from './helper/serialisation/rowData'\nexport * from './helper/serialisation/storedContextManager'\nexport * from './helper/serialisation/customerDataTracker'\nexport * from './helper/encoder'\nexport * from './user'\nexport * from './helper/polyfills'\nexport * from './telemetry/telemetry'\nexport * from './helper/catchUserErrors'\nexport * from './helper/connectivity'\nexport * from './helper/displayAlreadyInitializedError'\n"],"mappings":"AAAA,cAAc,wBAAwB;AACtC,cAAc,uBAAuB;AACrC,cAAc,qBAAqB;AACnC,cAAc,gBAAgB;AAC9B,cAAc,2BAA2B;AACzC,cAAc,qBAAqB;AACnC,cAAc,oBAAoB;AAClC,cAAc,2BAA2B;AACzC,cAAc,6BAA6B;AAC3C,cAAc,2BAA2B;AACzC,cAAc,kBAAkB;AAChC,cAAc,kBAAkB;AAChC,cAAc,mBAAmB;AACjC,cAAc,uBAAuB;AACrC,cAAc,oBAAoB;AAClC,cAAc,4BAA4B;AAC1C,cAAc,iCAAiC;AAC/C,cAAc,qBAAqB;AACnC,cAAc,gBAAgB;AAC9B,cAAc,sBAAsB;AACpC,cAAc,qBAAqB;AACnC,cAAc,iCAAiC;AAC/C,cAAc,gBAAgB;AAC9B,cAAc,8BAA8B;AAC5C,cAAc,8BAA8B;AAC5C,cAAc,oBAAoB;AAClC,cAAc,YAAY;AAC1B,cAAc,+BAA+B;AAC7C,cAAc,wCAAwC;AACtD,cAAc,kBAAkB;AAChC,cAAc,2BAA2B;AACzC,cAAc,yBAAyB;AACvC,cAAc,8BAA8B;AAC5C,cAAc,wBAAwB;AACtC,cAAc,4BAA4B;AAC1C,cAAc,2BAA2B;AACzC,cAAc,kBAAkB;AAEhC,cAAc,WAAW;AACzB,cAAc,QAAQ;AACtB,SACEA,mBAAmB,EACnBC,kBAAkB,QACb,6BAA6B;AACpC,SACEC,sBAAsB,EACtBC,iBAAiB,QACZ,4BAA4B;AACnC,SAASC,kBAAkB,QAAQ,wBAAwB;AAC3D,cAAc,aAAa;AAC3B,cAAc,qCAAqC;AAEnD,cAAc,uCAAuC;AACrD,cAAc,8BAA8B;AAC5C,cAAc,sCAAsC;AACpD,cAAc,gCAAgC;AAC9C,cAAc,6CAA6C;AAC3D,cAAc,4CAA4C;AAC1D,cAAc,kBAAkB;AAChC,cAAc,QAAQ;AACtB,cAAc,oBAAoB;AAClC,cAAc,uBAAuB;AACrC,cAAc,0BAA0B;AACxC,cAAc,uBAAuB;AACrC,cAAc,yCAAyC","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cloudcare/browser-core",
-    "version": "3.2.13",
+    "version": "3.2.15",
     "main": "cjs/index.js",
     "module": "esm/index.js",
     "types": "types/index.d.ts",
@@ -22,5 +22,5 @@
     "author": "dataflux",
     "license": "MIT",
     "description": "DataFlux RUM Web 端数据指标监控",
-    "gitHead": "495ab0c29f4a869e9ad76d8fa2622dd924f3d90d"
+    "gitHead": "3d694e63c364e9195b8a7f81dd184adf1f3ea2c0"
 }

package/src/dataMap.js

@@ -28,7 +28,7 @@ export var commonTags = {
   view_url: 'view.url',
   view_host: 'view.host',
   view_path: 'view.path',
-  view_name: 'view.path', // 冗余一个字段
+  view_name: 'view.name', // 冗余一个字段
   view_path_group: 'view.path_group'
 }
 export var commonFields = {

package/src/helper/lifeCycle.js

@@ -4,6 +4,7 @@ export var LifeCycleEventType = {
   BEFORE_VIEW_CREATED: 'BEFORE_VIEW_CREATED',
   VIEW_CREATED: 'VIEW_CREATED',
   VIEW_UPDATED: 'VIEW_UPDATED',
+  BEFORE_VIEW_UPDATED: 'BEFORE_VIEW_UPDATED',
   VIEW_ENDED: 'VIEW_ENDED',
   AFTER_VIEW_ENDED: 'AFTER_VIEW_ENDED',
   SESSION_RENEWED: 'SESSION_RENEWED',

package/src/helper/limitModification.js

@@ -1,65 +1,60 @@
-import { extend2Lev, each, objectEntries, getType, deepClone } from './tools'
+import { objectEntries, getType, deepClone } from './tools'
 import { sanitize } from './sanitize'
 
-/**
- * Current limitation:
- * - field path do not support array, 'a.b.c' only
- */
 export function limitModification(object, modifiableFieldPaths, modifier) {
-  var clone = deepClone(object)
-  var result = modifier(clone)
-  each(objectEntries(modifiableFieldPaths), function (filedPaths) {
-    var fieldPath = filedPaths[0]
-    var fieldType = filedPaths[1]
-    var newValue = get(clone, fieldPath)
-    var newType = getType(newValue)
-    if (newType === fieldType) {
-      set(object, fieldPath, sanitize(newValue))
-    } else if (
-      fieldType === 'object' &&
-      (newType === 'undefined' || newType === 'null')
-    ) {
-      set(object, fieldPath, {})
-    }
-  })
+  const clone = deepClone(object)
+  const result = modifier(clone)
+
+  objectEntries(modifiableFieldPaths).forEach(([fieldPath, fieldType]) =>
+    // Traverse both object and clone simultaneously up to the path and apply the modification from the clone to the original object when the type is valid
+    setValueAtPath(object, clone, fieldPath.split(/\.|(?=\[\])/), fieldType)
+  )
 
   return result
 }
 
-function get(object, path) {
-  var current = object
-  for (var _i = 0, _a = path.split('.'); _i < _a.length; _i++) {
-    var field = _a[_i]
-    if (!isValidObjectContaining(current, field)) {
-      return
+function setValueAtPath(object, clone, pathSegments, fieldType) {
+  const [field, ...restPathSegments] = pathSegments
+
+  if (field === '[]') {
+    if (Array.isArray(object) && Array.isArray(clone)) {
+      object.forEach((item, i) =>
+        setValueAtPath(item, clone[i], restPathSegments, fieldType)
+      )
     }
-    current = current[field]
+
+    return
+  }
+
+  if (!isValidObject(object) || !isValidObject(clone)) {
+    return
+  }
+
+  if (restPathSegments.length > 0) {
+    return setValueAtPath(
+      object[field],
+      clone[field],
+      restPathSegments,
+      fieldType
+    )
   }
-  return current
+
+  setNestedValue(object, field, clone[field], fieldType)
 }
 
-function set(object, path, value) {
-  var current = object
-  var fields = path.split('.')
-  for (var i = 0; i < fields.length; i += 1) {
-    var field = fields[i]
-    if (!isValidObject(current)) {
-      return
-    }
-    if (i !== fields.length - 1) {
-      current = current[field]
-    } else {
-      current[field] = value
-    }
+function setNestedValue(object, field, value, fieldType) {
+  const newType = getType(value)
+
+  if (newType === fieldType) {
+    object[field] = sanitize(value)
+  } else if (
+    fieldType === 'object' &&
+    (newType === 'undefined' || newType === 'null')
+  ) {
+    object[field] = {}
   }
 }
 
 function isValidObject(object) {
   return getType(object) === 'object'
 }
-
-function isValidObjectContaining(object, field) {
-  return (
-    isValidObject(object) && Object.prototype.hasOwnProperty.call(object, field)
-  )
-}

package/src/helper/serialisation/const.js

@@ -0,0 +1,10 @@
+// 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 CustomerDataType = {
+  FeatureFlag: 'feature flag evaluation',
+  User: 'user',
+  GlobalContext: 'global context',
+  View: 'view'
+}

package/src/helper/serialisation/contextManager.js

@@ -1,94 +1,71 @@
-import { computeBytesCount } from '../byteUtils'
-import { deepClone, throttle, getType } from '../tools'
+import { deepClone, getType } from '../tools'
 import { sanitize } from '../sanitize'
-import { jsonStringify } from './jsonStringify'
 import { Observable } from '../observable'
-import { warnIfCustomerDataLimitReached } from './heavyCustomerDataWarning'
+import { display } from '../display'
 
-export var BYTES_COMPUTATION_THROTTLING_DELAY = 200
+function ensureProperties(context, propertiesConfig, name) {
+  const newContext = { ...context }
 
-export function createContextManager(customerDataType, computeBytesCountImpl) {
-  if (typeof computeBytesCountImpl === 'undefined') {
-    computeBytesCountImpl = computeBytesCount
-  }
-  var context = {}
-  var bytesCountCache
-  var alreadyWarned = false
-  var changeObservable = new Observable()
-  // 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 computeBytesCountThrottled = throttle(function (context) {
-    bytesCountCache = computeBytesCountImpl(jsonStringify(context))
-    if (!alreadyWarned) {
-      alreadyWarned = warnIfCustomerDataLimitReached(
-        bytesCountCache,
-        customerDataType
-      )
+  for (const [key, { required, type }] of Object.entries(propertiesConfig)) {
+    /**
+     * Ensure specified properties are strings as defined here:
+     */
+    if (type === 'string' && key in newContext) {
+      newContext[key] = String(newContext[key])
     }
-  }, BYTES_COMPUTATION_THROTTLING_DELAY).throttled
-
-  var contextManager = {
-    getBytesCount: function () {
-      return bytesCountCache
-    },
-    /** @deprecated use getContext instead */
-    get: function () {
-      return context
-    },
 
-    /** @deprecated use setContextProperty instead */
-    add: function (key, value) {
-      context[key] = value
-      computeBytesCountThrottled(context)
-      changeObservable.notify()
-    },
+    if (required && !(key in context)) {
+      display.warn(
+        `The property ${key} of ${name} context is required; context will not be sent to the intake.`
+      )
+    }
+  }
 
-    /** @deprecated renamed to removeContextProperty */
-    remove: function (key) {
-      delete context[key]
-      computeBytesCountThrottled(context)
-      changeObservable.notify()
-    },
+  return newContext
+}
 
-    /** @deprecated use setContext instead */
-    set: function (newContext) {
-      context = newContext
-      computeBytesCountThrottled(context)
-      changeObservable.notify()
-    },
+export function createContextManager(
+  name = '',
+  { customerDataTracker, propertiesConfig = {} } = {}
+) {
+  let context = {}
+  const changeObservable = new Observable()
 
-    getContext: function () {
-      return deepClone(context)
-    },
+  const contextManager = {
+    getContext: () => deepClone(context),
 
-    setContext: function (newContext) {
+    setContext: (newContext) => {
       if (getType(newContext) === 'object') {
-        context = sanitize(newContext)
-        computeBytesCountThrottled(context)
+        context = sanitize(ensureProperties(newContext, propertiesConfig, name))
+        customerDataTracker?.updateCustomerData(context)
       } else {
         contextManager.clearContext()
       }
       changeObservable.notify()
     },
 
-    setContextProperty: function (key, property) {
-      context[key] = deepClone(property)
-      computeBytesCountThrottled(context)
+    setContextProperty: (key, property) => {
+      context[key] = sanitize(
+        ensureProperties({ [key]: property }, propertiesConfig, name)[key]
+      )
+      customerDataTracker?.updateCustomerData(context)
       changeObservable.notify()
     },
 
-    removeContextProperty: function (key) {
+    removeContextProperty: (key) => {
       delete context[key]
-      computeBytesCountThrottled(context)
+      customerDataTracker?.updateCustomerData(context)
+      ensureProperties(context, propertiesConfig, name)
       changeObservable.notify()
     },
 
-    clearContext: function () {
+    clearContext: () => {
       context = {}
-      bytesCountCache = 0
+      customerDataTracker?.resetCustomerData()
       changeObservable.notify()
     },
-    changeObservable: changeObservable
+
+    changeObservable
   }
   return contextManager
 }