@cloudcare/browser-core 2.0.4 → 2.0.6

package/esm/helper/tools.js

@@ -1,5 +1,5 @@
 import { DOM_EVENT } from './enums';
-import { getZoneJsOriginalValue } from './getZoneJsOriginalValue';
+import { setTimeout, clearTimeout } from './timer';
 var ArrayProto = Array.prototype;
 var FuncProto = Function.prototype;
 var ObjProto = Object.prototype;
@@ -749,121 +749,6 @@ export function elementMatches(element, selector) {
 
   return false;
 }
-export var addEvent = function addEvent() {
-  function fixEvent(event) {
-    if (event) {
-      event.preventDefault = fixEvent.preventDefault;
-      event.stopPropagation = fixEvent.stopPropagation;
-      event._getPath = fixEvent._getPath;
-    }
-
-    return event;
-  }
-
-  fixEvent._getPath = function () {
-    var ev = this;
-
-    var polyfill = function polyfill() {
-      try {
-        var element = ev.target;
-        var pathArr = [element];
-
-        if (element === null || element.parentElement === null) {
-          return [];
-        }
-
-        while (element.parentElement !== null) {
-          element = element.parentElement;
-          pathArr.unshift(element);
-        }
-
-        return pathArr;
-      } catch (error) {
-        return [];
-      }
-    };
-
-    return this.path || this.composedPath() && this.composedPath() || polyfill();
-  };
-
-  fixEvent.preventDefault = function () {
-    this.returnValue = false;
-  };
-
-  fixEvent.stopPropagation = function () {
-    this.cancelBubble = true;
-  };
-
-  var register_event = function register_event(element, type, handle) {
-    if (element && element.addEventListener) {
-      element.addEventListener(type, function (e) {
-        e._getPath = fixEvent._getPath;
-        handler.call(this, e);
-      }, false);
-    } else {
-      var ontype = 'on' + type;
-      var old_handler = element[ontype];
-      element[ontype] = makeHandler(element, handler, old_handler);
-    }
-  };
-
-  function makeHandler(element, new_handler, old_handlers) {
-    var handler = function handler(event) {
-      event = event || fixEvent(window.event);
-
-      if (!event) {
-        return undefined;
-      }
-
-      event.target = event.srcElement;
-      var ret = true;
-      var old_result, new_result;
-
-      if (typeof old_handlers === 'function') {
-        old_result = old_handlers(event);
-      }
-
-      new_result = new_handler.call(element, event);
-
-      if (false === old_result || false === new_result) {
-        ret = false;
-      }
-
-      return ret;
-    };
-
-    return handler;
-  }
-
-  register_event.apply(null, arguments);
-};
-export var addHashEvent = function addHashEvent(callback) {
-  var hashEvent = 'pushState' in window.history ? 'popstate' : 'hashchange';
-  addEvent(window, hashEvent, callback);
-};
-export var addSinglePageEvent = function addSinglePageEvent(callback) {
-  var current_url = location.href;
-  var historyPushState = window.history.pushState;
-  var historyReplaceState = window.history.replaceState;
-
-  window.history.pushState = function () {
-    historyPushState.apply(window.history, arguments);
-    callback(current_url);
-    current_url = location.href;
-  };
-
-  window.history.replaceState = function () {
-    historyReplaceState.apply(window.history, arguments);
-    callback(current_url);
-    current_url = location.href;
-  };
-
-  var singlePageEvent = historyPushState ? 'popstate' : 'hashchange';
-  addEvent(window, singlePageEvent, function () {
-    callback(current_url);
-    current_url = location.href;
-  });
-};
 export var cookie = {
   get: function get(name) {
     var nameEQ = name + '=';
@@ -1510,63 +1395,12 @@ export var getReferrer = function getReferrer() {
 export var typeDecide = function typeDecide(o, type) {
   return toString.call(o) === '[object ' + type + ']';
 };
-export function jsonStringify(value, replacer, space) {
-  if (value === null || value === undefined) {
-    return JSON.stringify(value);
-  }
-
-  var originalToJSON = [false, undefined];
-
-  if (hasToJSON(value)) {
-    // We need to add a flag and not rely on the truthiness of value.toJSON
-    // because it can be set but undefined and that's actually significant.
-    originalToJSON = [true, value.toJSON];
-    delete value.toJSON;
-  }
-
-  var originalProtoToJSON = [false, undefined];
-  var prototype;
-
-  if (typeof value === 'object') {
-    prototype = Object.getPrototypeOf(value);
-
-    if (hasToJSON(prototype)) {
-      originalProtoToJSON = [true, prototype.toJSON];
-      delete prototype.toJSON;
-    }
-  }
-
-  var result;
-
-  try {
-    result = JSON.stringify(value, undefined, space);
-  } catch (e) {
-    result = '<error: unable to serialize object>';
-  } finally {
-    if (originalToJSON[0]) {
-      value.toJSON = originalToJSON[1];
-    }
-
-    if (originalProtoToJSON[0]) {
-      prototype.toJSON = originalProtoToJSON[1];
-    }
-  }
-
-  return result;
-}
-
-function hasToJSON(value) {
-  return typeof value === 'object' && value !== null && value.hasOwnProperty('toJSON');
-}
-
 export function noop() {}
 export var ONE_SECOND = 1000;
 export var ONE_MINUTE = 60 * ONE_SECOND;
 export var ONE_HOUR = 60 * ONE_MINUTE;
 export var ONE_DAY = 24 * ONE_HOUR;
 export var ONE_YEAR = 365 * ONE_DAY;
-export var ONE_KIBI_BYTE = 1024;
-export var ONE_MEBI_BYTE = 1024 * ONE_KIBI_BYTE;
 /**
  * Return true if the draw is successful
  * @param threshold between 0 and 100
@@ -1710,94 +1544,10 @@ export function safeTruncate(candidate, length) {
 
   return candidate.slice(0, length);
 }
-export function addEventListener(eventTarget, event, listener, options) {
-  return addEventListeners(eventTarget, [event], listener, options);
-}
-/**
- * Add event listeners to an event emitter object (Window, Element, mock object...).  This provides
- * a few conveniences compared to using `element.addEventListener` directly:
- *
- * * supports IE11 by:
- *   * using an option object only if needed
- *   * emulating the `once` option
- *
- * * wraps the listener with a `monitor` function
- *
- * * returns a `stop` function to remove the listener
- *
- * * with `once: true`, the listener will be called at most once, even if different events are
- *   listened
- */
-
-export function addEventListeners(eventTarget, events, listener, options) {
-  var wrappedListener = options && options.once ? function (event) {
-    stop();
-    listener(event);
-  } : listener;
-  options = options && options.passive ? {
-    capture: options.capture,
-    passive: options.passive
-  } : options && options.capture;
-  var add = getZoneJsOriginalValue(eventTarget, 'addEventListener');
-  each(events, function (event) {
-    add.call(eventTarget, event, wrappedListener, options);
-  });
-
-  var stop = function stop() {
-    var remove = getZoneJsOriginalValue(eventTarget, 'removeEventListener');
-    each(events, function (event) {
-      remove.call(eventTarget, event, wrappedListener, options);
-    });
-  };
-
-  return {
-    stop: stop
-  };
-}
 export function includes(candidate, search) {
   // tslint:disable-next-line: no-unsafe-any
   return candidate.indexOf(search) !== -1;
 }
-export function createContextManager() {
-  var context = {};
-  return {
-    get: function get() {
-      return context;
-    },
-    add: function add(key, value) {
-      if (isString(key)) {
-        context[key] = value;
-      } else {
-        console.error('key 需要传递字符串类型');
-      }
-    },
-    remove: function remove(key) {
-      delete context[key];
-    },
-    set: function set(newContext) {
-      if (isObject(newContext)) {
-        context = newContext;
-      } else {
-        console.error('content 需要传递对象类型数据');
-      }
-    },
-    getContext: function getContext() {
-      return deepClone(context);
-    },
-    setContext: function setContext(newContext) {
-      context = deepClone(newContext);
-    },
-    setContextProperty: function setContextProperty(key, property) {
-      context[key] = deepClone(property);
-    },
-    removeContextProperty: function removeContextProperty(key) {
-      delete context[key];
-    },
-    clearContext: function clearContext() {
-      context = {};
-    }
-  };
-}
 export function find(array, predicate) {
   for (var i = 0; i < array.length; i += 1) {
     var item = array[i];
@@ -1889,37 +1639,6 @@ export function toSnakeCase(word) {
     return (index !== 0 ? '_' : '') + uppercaseLetter.toLowerCase();
   }).replace(/-/g, '_');
 }
-export function escapeRowData(str) {
-  if (typeof str === 'object' && str) {
-    str = jsonStringify(str);
-  } else if (!isString(str)) {
-    return str;
-  }
-
-  var reg = /[\s=,"]/g;
-  return String(str).replace(reg, function (word) {
-    return '\\' + word;
-  });
-}
-export function escapeJsonValue(value) {
-  if (isString(value)) {
-    return value;
-  } else {
-    return jsonStringify(value);
-  }
-}
-export function escapeFieldValueStr(str) {
-  return '"' + str.replace(/\\/g, '\\\\').replace(/[\\]*"/g, '"').replace(/"/g, '\\"') + '"';
-}
-export function escapeRowField(value) {
-  if (typeof value === 'object' && value) {
-    return escapeFieldValueStr(jsonStringify(value));
-  } else if (isString(value)) {
-    return escapeFieldValueStr(value);
-  } else {
-    return value;
-  }
-}
 export function isNullUndefinedDefaultValue(data, defaultValue) {
   if (data !== null && data !== void 0) {
     return data;
@@ -1927,16 +1646,6 @@ export function isNullUndefinedDefaultValue(data, defaultValue) {
     return defaultValue;
   }
 }
-export function runOnReadyState(expectedReadyState, callback) {
-  if (document.readyState === expectedReadyState || document.readyState === 'complete') {
-    callback();
-  } else {
-    var eventName = expectedReadyState === 'complete' ? DOM_EVENT.LOAD : DOM_EVENT.DOM_CONTENT_LOADED;
-    addEventListener(window, eventName, callback, {
-      once: true
-    });
-  }
-}
 export function requestIdleCallback(callback, opts) {
   // Use 'requestIdleCallback' when available: it will throttle the mutation processing if the
   // browser is busy rendering frames (ex: when frames are below 60fps). When not available, the

package/esm/index.js

@@ -4,6 +4,7 @@ export * from './helper/deviceInfo';
 export * from './helper/enums';
 export * from './helper/instrumentMethod';
 export * from './helper/errorTools';
+export * from './helper/byteUtils';
 export * from './error/trackRuntimeError';
 export * from './console/consoleObservable';
 export * from './report/reportObservable';
@@ -17,6 +18,7 @@ export * from './helper/tools';
 export * from './helper/urlPolyfill';
 export * from './helper/mobileUtil';
 export * from './helper/getZoneJsOriginalValue';
+export * from './helper/timer';
 export * from './helper/readBytesFromStream';
 export * from './tracekit';
 export * from './configuration/configuration';
@@ -26,6 +28,8 @@ export * from './browser/fetchObservable';
 export * from './browser/xhrObservable';
 export * from './browser/pageExitObservable';
 export * from './browser/htmlDomUtils';
+export * from './browser/addEventListener';
+export * from './browser/runOnReadyState';
 export * from './dataMap';
 export * from './init';
 export * from './session/sessionManagement';
@@ -33,4 +37,9 @@ export * from './session/sessionConstants';
 export * from './session/sessionCookieStore';
 export * from './session/sessionStore';
 export * from './transport';
-export * from './synthetics/syntheticsWorkerValues';
+export * from './synthetics/syntheticsWorkerValues';
+export * from './helper/serialisation/contextManager';
+export * from './helper/serialisation/heavyCustomerDataWarning';
+export * from './helper/serialisation/jsonStringify';
+export * from './helper/serialisation/rowData';
+export * from './user';

package/esm/init.js

@@ -14,13 +14,13 @@ export function makePublicApi(stub) {
     }
   }); // Add an "hidden" property to set debug mode. We define it that way to hide it
   // as much as possible but of course it's not a real protection.
+  //   Object.defineProperty(publicApi, '_setDebug', {
+  //     get: function () {
+  //       return setDebugMode
+  //     },
+  //     enumerable: false
+  //   })
 
-  Object.defineProperty(publicApi, '_setDebug', {
-    get: function get() {
-      return setDebugMode;
-    },
-    enumerable: false
-  });
   return publicApi;
 }
 export function defineGlobal(global, name, api) {

package/esm/report/reportObservable.js

@@ -1,6 +1,7 @@
 import { toStackTraceString } from '../helper/errorTools';
 import { mergeObservables, Observable } from '../helper/observable';
-import { includes, addEventListener, safeTruncate, filter, each } from '../helper/tools';
+import { includes, safeTruncate, filter, each } from '../helper/tools';
+import { addEventListener } from '../browser/addEventListener';
 import { DOM_EVENT } from '../helper/enums';
 export var RawReportType = {
   intervention: 'intervention',
@@ -75,7 +76,7 @@ function buildRawReportFromReport(report) {
 
 function buildRawReportFromCspViolation(event) {
   var type = RawReportType.cspViolation;
-  var message = '\'' + event.blockedURI + '\' blocked by \'' + event.effectiveDirective + '\' directive';
+  var message = "'" + event.blockedURI + "' blocked by '" + event.effectiveDirective + "' directive";
   return {
     type: RawReportType.cspViolation,
     subtype: event.effectiveDirective,

package/esm/session/sessionCookieStore.js

@@ -1,6 +1,7 @@
 import { getCookie, setCookie } from '../browser/cookie';
 import { isChromium, dateNow, isEmptyObject, UUID, objectEntries, map, each } from '../helper/tools';
 import { SESSION_EXPIRATION_DELAY } from './sessionConstants';
+import { setTimeout } from '../helper/timer';
 var SESSION_ENTRY_REGEXP = /^([a-z]+)=([a-z0-9-]+)$/;
 var SESSION_ENTRY_SEPARATOR = '&';
 export var SESSION_COOKIE_NAME = '_dataflux_s'; // arbitrary values

package/esm/session/sessionManagement.js

@@ -1,8 +1,10 @@
-import { relativeNow, clocksOrigin, ONE_MINUTE, each, addEventListeners, addEventListener } from '../helper/tools';
+import { relativeNow, clocksOrigin, ONE_MINUTE, each } from '../helper/tools';
+import { addEventListeners, addEventListener } from '../browser/addEventListener';
 import { ContextHistory } from '../helper/contextHistory';
 import { startSessionStore } from './sessionStore';
 import { SESSION_TIME_OUT_DELAY } from './sessionConstants';
 import { DOM_EVENT } from '../helper/enums';
+import { clearInterval, setInterval } from '../helper/timer';
 export var VISIBILITY_CHECK_DELAY = ONE_MINUTE;
 var SESSION_CONTEXT_TIMEOUT_DELAY = SESSION_TIME_OUT_DELAY;
 var stopCallbacks = [];
@@ -42,7 +44,8 @@ export var startSessionManager = function startSessionManager(options, productKe
       return sessionContextHistory.find(startTime);
     },
     renewObservable: sessionStore.renewObservable,
-    expireObservable: sessionStore.expireObservable
+    expireObservable: sessionStore.expireObservable,
+    expire: sessionStore.expire
   };
 };
 export function stopSessionManager() {

package/esm/session/sessionStore.js

@@ -3,6 +3,7 @@ import { Observable } from '../helper/observable';
 import { dateNow, UUID, throttle } from '../helper/tools';
 import { SESSION_TIME_OUT_DELAY } from './sessionConstants';
 import { retrieveSession, withCookieLockAccess } from './sessionCookieStore';
+import { clearInterval, setInterval } from '../helper/timer';
 /**
  * Different session concepts:
  * - tracked, the session has an id and is updated along the user navigation
@@ -67,7 +68,7 @@ export function startSessionStore(options, productKey, computeSessionState) {
 
     if (hasSessionInCache()) {
       if (isSessionInCacheOutdated(cookieSession)) {
-        expireSession();
+        expireSessionInCache();
       } else {
         sessionCache = cookieSession;
       }
@@ -98,7 +99,7 @@ export function startSessionStore(options, productKey, computeSessionState) {
     return sessionCache.id !== cookieSession.id || sessionCache[productKey] !== cookieSession[productKey];
   }
 
-  function expireSession() {
+  function expireSessionInCache() {
     sessionCache = {};
     expireObservable.notify();
   }
@@ -132,6 +133,10 @@ export function startSessionStore(options, productKey, computeSessionState) {
     },
     renewObservable: renewObservable,
     expireObservable: expireObservable,
+    expire: function expire() {
+      deleteSessionCookie(options);
+      synchronizeSession({});
+    },
     stop: function stop() {
       clearInterval(watchSessionTimeoutId);
     }

package/esm/transport/batch.js

@@ -1,7 +1,10 @@
 import { display } from '../helper/display';
-import { addEventListener, noop, values, findByPath, escapeRowData, each, isNumber, isArray, extend, isString, toServerDuration, isBoolean, isEmptyObject, isObject, escapeJsonValue, escapeRowField } from '../helper/tools';
+import { values, findByPath, each, isNumber, isArray, extend, isString, toServerDuration, isBoolean, isEmptyObject, isObject } from '../helper/tools';
+import { escapeJsonValue, escapeRowField, escapeRowData } from '../helper/serialisation/rowData';
 import { commonTags, dataMap, commonFields } from '../dataMap';
-import { DOM_EVENT, RumEventType } from '../helper/enums'; // https://en.wikipedia.org/wiki/UTF-8
+import { RumEventType } from '../helper/enums';
+import { computeBytesCount } from '../helper/byteUtils';
+import { isPageExitReason } from '../browser/pageExitObservable'; // https://en.wikipedia.org/wiki/UTF-8
 // eslint-disable-next-line no-control-regex
 
 var HAS_MULTI_BYTES_CHARACTERS = /[^\u0000-\u007F]/;
@@ -124,23 +127,18 @@ export var processedMessageByDataMap = function processedMessageByDataMap(messag
   };
 };
 
-var batch = function batch(request, batchMessagesLimit, batchBytesLimit, messageBytesLimit, flushTimeout, pageExitObservable) {
+var batch = function batch(request, flushController, messageBytesLimit) {
   this.pushOnlyBuffer = [];
   this.upsertBuffer = {};
-  this.bufferBytesCount = 0;
-  this.bufferMessagesCount = 0;
   this.request = request;
-  this.batchMessagesLimit = batchMessagesLimit;
-  this.batchBytesLimit = batchBytesLimit;
+  this.flushController = flushController;
   this.messageBytesLimit = messageBytesLimit;
-  this.flushTimeout = flushTimeout;
 
   var _this = this;
 
-  pageExitObservable.subscribe(function () {
-    _this.flush(_this.request.sendOnExit);
+  this.flushController.flushObservable.subscribe(function (event) {
+    _this.flush(event);
   });
-  this.flushPeriodically();
 };
 
 batch.prototype.add = function (message) {
@@ -151,45 +149,26 @@ batch.prototype.upsert = function (message, key) {
   this.addOrUpdate(message, key);
 };
 
-batch.prototype.flush = function (sendFn) {
-  if (typeof sendFn !== 'function') {
-    sendFn = this.request.send;
-  }
+batch.prototype.flush = function (event) {
+  var messages = this.pushOnlyBuffer.concat(values(this.upsertBuffer));
+  this.pushOnlyBuffer = [];
+  this.upsertBuffer = {};
 
-  if (this.bufferMessagesCount !== 0) {
-    var messages = this.pushOnlyBuffer.concat(values(this.upsertBuffer));
-    var bytesCount = this.bufferBytesCount;
-    this.pushOnlyBuffer = [];
-    this.upsertBuffer = {};
-    this.bufferBytesCount = 0;
-    this.bufferMessagesCount = 0;
-
-    if (messages.length > 0) {
-      sendFn({
-        data: messages.join('\n'),
-        bytesCount: bytesCount
-      });
+  if (messages.length > 0) {
+    var payload = {
+      data: messages.join('\n'),
+      bytesCount: event.bytesCount,
+      flushReason: event.reason
+    };
+
+    if (isPageExitReason(event.reason)) {
+      this.request.sendOnExit(payload);
+    } else {
+      this.request.send(payload);
     }
   }
 };
 
-batch.prototype.flushOnExit = function () {
-  this.flush(this.request.sendOnExit);
-};
-
-batch.prototype.computeBytesCount = function (candidate) {
-  // Accurate bytes count computations can degrade performances when there is a lot of events to process
-  if (!HAS_MULTI_BYTES_CHARACTERS.test(candidate)) {
-    return candidate.length;
-  }
-
-  if (window.TextEncoder !== undefined) {
-    return new TextEncoder().encode(candidate).length;
-  }
-
-  return new Blob([candidate]).size;
-};
-
 batch.prototype.addOrUpdate = function (message, key) {
   var _process = this.process(message);
 
@@ -205,20 +184,12 @@ batch.prototype.addOrUpdate = function (message, key) {
     this.remove(key);
   }
 
-  if (this.willReachedBytesLimitWith(messageBytesCount)) {
-    this.flush();
-  }
-
   this.push(processedMessage, messageBytesCount, key);
-
-  if (this.isFull()) {
-    this.flush();
-  }
 };
 
 batch.prototype.process = function (message) {
   var processedMessage = processedMessageByDataMap(message).rowStr;
-  var messageBytesCount = this.computeBytesCount(processedMessage);
+  var messageBytesCount = computeBytesCount(processedMessage);
   return {
     processedMessage: processedMessage,
     messageBytesCount: messageBytesCount
@@ -226,10 +197,8 @@ batch.prototype.process = function (message) {
 };
 
 batch.prototype.push = function (processedMessage, messageBytesCount, key) {
-  if (this.bufferMessagesCount > 0) {
-    // \n separator at serialization
-    this.bufferBytesCount += 1;
-  }
+  var separatorBytesCount = this.flushController.getMessagesCount() > 0 ? 1 : 0;
+  this.flushController.notifyBeforeAddMessage(messageBytesCount + separatorBytesCount);
 
   if (key !== undefined) {
     this.upsertBuffer[key] = processedMessage;
@@ -237,43 +206,20 @@ batch.prototype.push = function (processedMessage, messageBytesCount, key) {
     this.pushOnlyBuffer.push(processedMessage);
   }
 
-  this.bufferBytesCount += messageBytesCount;
-  this.bufferMessagesCount += 1;
+  this.flushController.notifyAfterAddMessage();
 };
 
 batch.prototype.remove = function (key) {
   var removedMessage = this.upsertBuffer[key];
   delete this.upsertBuffer[key];
-  var messageBytesCount = this.computeBytesCount(removedMessage);
-  this.bufferBytesCount -= messageBytesCount;
-  this.bufferMessagesCount -= 1;
+  var messageBytesCount = computeBytesCount(removedMessage); // If there are other messages, a '\n' will be added at serialization
 
-  if (this.bufferMessagesCount > 0) {
-    this.bufferBytesCount -= 1;
-  }
+  var separatorBytesCount = this.flushController.getMessagesCount() > 1 ? 1 : 0;
+  this.flushController.notifyAfterRemoveMessage(messageBytesCount + separatorBytesCount);
 };
 
 batch.prototype.hasMessageFor = function (key) {
   return key !== undefined && this.upsertBuffer[key] !== undefined;
 };
 
-batch.prototype.willReachedBytesLimitWith = function (messageBytesCount) {
-  // byte of the separator at the end of the message
-  return this.bufferBytesCount + messageBytesCount + 1 >= this.batchBytesLimit;
-};
-
-batch.prototype.isFull = function () {
-  return this.bufferMessagesCount === this.batchMessagesLimit || this.bufferBytesCount >= this.batchBytesLimit;
-};
-
-batch.prototype.flushPeriodically = function () {
-  var _this = this;
-
-  setTimeout(function () {
-    _this.flush();
-
-    _this.flushPeriodically();
-  }, this.flushTimeout);
-};
-
 export var Batch = batch;