posthog-js 1.17.7 → 1.18.0

package/dist/module.js

@@ -865,7 +865,7 @@ var LZString = {
   }
 };
 
-var version = "1.17.7";
+var version = "1.18.0";
 
 var Config$1 = {
   DEBUG: false,
@@ -902,15 +902,18 @@ var _ = {
   }
 }; // Console override
 
-var console$1 = {
+var logger = {
   /** @type {function(...*)} */
   log: function log() {
     if (Config$1.DEBUG && !_.isUndefined(window.console) && window.console) {
+      // Don't log PostHog debug messages in rrweb
+      var log = window.console.log['__rrweb_original__'] ? window.console.log['__rrweb_original__'] : window.console.log;
+
       try {
-        window.console.log.apply(window.console, arguments);
+        log.apply(window.console, arguments);
       } catch (err) {
         _.each(arguments, function (arg) {
-          window.console.log(arg);
+          log(arg);
         });
       }
     }
@@ -919,13 +922,15 @@ var console$1 = {
   /** @type {function(...*)} */
   error: function error() {
     if (Config$1.DEBUG && !_.isUndefined(window.console) && window.console) {
-      var args = ['PostHog error:'].concat(Array.prototype.slice.call(arguments));
+      var args = ['PostHog error:'].concat(Array.prototype.slice.call(arguments)); // Don't log PostHog debug messages in rrweb
+
+      var error = window.console.error['__rrweb_original__'] ? window.console.error['__rrweb_original__'] : window.console.error;
 
       try {
-        window.console.error.apply(window.console, args);
+        error.apply(window.console, args);
       } catch (err) {
         _.each(args, function (arg) {
-          window.console.error(arg);
+          error(arg);
         });
       }
     }
@@ -934,13 +939,15 @@ var console$1 = {
   /** @type {function(...*)} */
   critical: function critical() {
     if (!_.isUndefined(window.console) && window.console) {
-      var args = ['PostHog error:'].concat(Array.prototype.slice.call(arguments));
+      var args = ['PostHog error:'].concat(Array.prototype.slice.call(arguments)); // Don't log PostHog debug messages in rrweb
+
+      var error = window.console.error['__rrweb_original__'] ? window.console.error['__rrweb_original__'] : window.console.error;
 
       try {
-        window.console.error.apply(window.console, args);
+        error.apply(window.console, args);
       } catch (err) {
         _.each(args, function (arg) {
-          window.console.error(arg);
+          error(arg);
         });
       }
     }
@@ -1140,10 +1147,10 @@ _.safewrap = function (f) {
     try {
       return f.apply(this, arguments);
     } catch (e) {
-      console$1.critical('Implementation error. Please turn on debug and contact support@posthog.com.');
+      logger.critical('Implementation error. Please turn on debug and contact support@posthog.com.');
 
       if (Config$1.DEBUG) {
-        console$1.critical(e);
+        logger.critical(e);
       }
     }
   };
@@ -1434,7 +1441,7 @@ _.getQueryParam = function (url, param) {
     try {
       result = decodeURIComponent(result);
     } catch (err) {
-      console$1.error('Skipping decoding for malformed query param: ' + result);
+      logger.error('Skipping decoding for malformed query param: ' + result);
     }
 
     return result.replace(/\+/g, ' ');
@@ -1463,7 +1470,7 @@ _.register_event = function () {
    */
   var register_event = function register_event(element, type, handler, oldSchool, useCapture) {
     if (!element) {
-      console$1.error('No valid element provided to register_event');
+      logger.error('No valid element provided to register_event');
       return;
     }
 
@@ -2304,7 +2311,7 @@ var autocapture = {
     var token = instance.get_config('token');
 
     if (this._initializedTokens.indexOf(token) > -1) {
-      console.log('autocapture already initialized for token "' + token + '"');
+      logger.log('autocapture already initialized for token "' + token + '"');
       return;
     }
 
@@ -2443,14 +2450,14 @@ var localStore = {
     }
 
     if (!supported) {
-      console$1.error('localStorage unsupported; falling back to cookie store');
+      logger.error('localStorage unsupported; falling back to cookie store');
     }
 
     _localStorage_supported = supported;
     return supported;
   },
   error: function error(msg) {
-    console$1.error('localStorage error: ' + msg);
+    logger.error('localStorage error: ' + msg);
   },
   get: function get(name) {
     try {
@@ -2541,7 +2548,7 @@ var memoryStore = {
     return true;
   },
   error: function error(msg) {
-    console$1.error('memoryStorage error: ' + msg);
+    logger.error('memoryStorage error: ' + msg);
   },
   parse: function parse(name) {
     return memoryStorage[name] || null;
@@ -2585,7 +2592,7 @@ var sessionStore = {
   },
   error: function error(msg) {
     if (Config.DEBUG) {
-      console$1.error('sessionStorage error: ', msg);
+      logger.error('sessionStorage error: ', msg);
     }
   },
   get: function get(name) {
@@ -3409,7 +3416,7 @@ var CAMPAIGN_IDS_KEY = '__cmpns';
 var EVENT_TIMERS_KEY = '__timers';
 /** @const */
 
-var SESSION_RECORDING_ENABLED = '$session_recording_enabled';
+var SESSION_RECORDING_ENABLED_SERVER_SIDE = '$session_recording_enabled_server_side';
 /** @const */
 
 var SESSION_ID = '$sesid';
@@ -3418,7 +3425,7 @@ var SESSION_ID = '$sesid';
 var ENABLED_FEATURE_FLAGS = '$enabled_feature_flags';
 /** @const */
 
-var RESERVED_PROPERTIES = [SET_QUEUE_KEY, SET_ONCE_QUEUE_KEY, UNSET_QUEUE_KEY, ADD_QUEUE_KEY, APPEND_QUEUE_KEY, REMOVE_QUEUE_KEY, UNION_QUEUE_KEY, PEOPLE_DISTINCT_ID_KEY, ALIAS_ID_KEY, CAMPAIGN_IDS_KEY, EVENT_TIMERS_KEY, SESSION_RECORDING_ENABLED, SESSION_ID, ENABLED_FEATURE_FLAGS];
+var RESERVED_PROPERTIES = [SET_QUEUE_KEY, SET_ONCE_QUEUE_KEY, UNSET_QUEUE_KEY, ADD_QUEUE_KEY, APPEND_QUEUE_KEY, REMOVE_QUEUE_KEY, UNION_QUEUE_KEY, PEOPLE_DISTINCT_ID_KEY, ALIAS_ID_KEY, CAMPAIGN_IDS_KEY, EVENT_TIMERS_KEY, SESSION_RECORDING_ENABLED_SERVER_SIDE, SESSION_ID, ENABLED_FEATURE_FLAGS];
 /**
  * PostHog Persistence Object
  * @constructor
@@ -3445,7 +3452,7 @@ var PostHogPersistence = function PostHogPersistence(config) {
   var storage_type = config['persistence'];
 
   if (storage_type !== 'cookie' && storage_type.indexOf('localStorage') === -1 && storage_type !== 'memory') {
-    console$1.critical('Unknown persistence type ' + storage_type + '; falling back to cookie');
+    logger.critical('Unknown persistence type ' + storage_type + '; falling back to cookie');
     storage_type = config['persistence'] = 'cookie';
   }
 
@@ -3731,18 +3738,22 @@ var SessionRecording = /*#__PURE__*/function () {
     this.instance = instance;
     this.captureStarted = false;
     this.snapshots = [];
-    this.emit = false;
+    this.emit = false; // Controls whether data is sent to the server or not
+
     this.endpoint = BASE_ENDPOINT;
     this.stopRrweb = null;
     this.windowId = null;
     this.sessionId = null;
+    this.receivedDecide = false;
   }
 
   _createClass(SessionRecording, [{
     key: "startRecordingIfEnabled",
     value: function startRecordingIfEnabled() {
-      if (this.instance.get_property(SESSION_RECORDING_ENABLED) && !this.instance.get_config('disable_session_recording')) {
-        this._startCapture();
+      if (this.isRecordingEnabled()) {
+        this.startCaptureAndTrySendingQueuedSnapshots();
+      } else {
+        this.stopRecording();
       }
     }
   }, {
@@ -3759,35 +3770,47 @@ var SessionRecording = /*#__PURE__*/function () {
         this.captureStarted = false;
       }
     }
+  }, {
+    key: "isRecordingEnabled",
+    value: function isRecordingEnabled() {
+      var enabled_server_side = !!this.instance.get_property(SESSION_RECORDING_ENABLED_SERVER_SIDE);
+      var enabled_client_side = !this.instance.get_config('disable_session_recording');
+      return enabled_server_side && enabled_client_side;
+    }
   }, {
     key: "afterDecideResponse",
     value: function afterDecideResponse(response) {
-      var enableRecordings = !this.instance.get_config('disable_session_recording') && !!response['sessionRecording'];
+      var _response$sessionReco;
+
+      this.receivedDecide = true;
 
       if (this.instance.persistence) {
-        this.instance.persistence.register(_defineProperty({}, SESSION_RECORDING_ENABLED, enableRecordings));
+        this.instance.persistence.register(_defineProperty({}, SESSION_RECORDING_ENABLED_SERVER_SIDE, !!response['sessionRecording']));
       }
 
-      if (enableRecordings) {
-        if (response['sessionRecording'].endpoint) {
-          this.endpoint = response['sessionRecording'].endpoint;
-        }
+      if ((_response$sessionReco = response.sessionRecording) !== null && _response$sessionReco !== void 0 && _response$sessionReco.endpoint) {
+        var _response$sessionReco2;
 
-        this.submitRecordings();
+        this.endpoint = (_response$sessionReco2 = response.sessionRecording) === null || _response$sessionReco2 === void 0 ? void 0 : _response$sessionReco2.endpoint;
       }
+
+      this.startRecordingIfEnabled();
     }
   }, {
-    key: "submitRecordings",
-    value: function submitRecordings() {
+    key: "startCaptureAndTrySendingQueuedSnapshots",
+    value: function startCaptureAndTrySendingQueuedSnapshots() {
       var _this = this;
 
-      this.emit = true;
+      // Only submit data after we've received a decide response to account for
+      // changing endpoints and the feature being disabled on the server side.
+      if (this.receivedDecide) {
+        this.emit = true;
+        this.snapshots.forEach(function (properties) {
+          return _this._captureSnapshot(properties);
+        });
+      }
 
       this._startCapture();
-
-      this.snapshots.forEach(function (properties) {
-        return _this._captureSnapshot(properties);
-      });
     }
   }, {
     key: "_startCapture",
@@ -3817,7 +3840,7 @@ var SessionRecording = /*#__PURE__*/function () {
 
 
       if ((this.windowId !== windowId || this.sessionId !== sessionId) && [FULL_SNAPSHOT_EVENT_TYPE, META_EVENT_TYPE].indexOf(event.type) === -1) {
-        window.rrweb.record.takeFullSnapshot();
+        this.rrwebRecord.takeFullSnapshot();
       }
 
       this.windowId = windowId;
@@ -3840,7 +3863,10 @@ var SessionRecording = /*#__PURE__*/function () {
         maskInputFn: null,
         slimDOMOptions: {},
         collectFonts: false
-      }; // only allows user to set our 'whitelisted' options
+      }; // We switched from loading all of rrweb to just the record part, but
+      // keep backwards compatibility if someone hasn't upgraded PostHog
+
+      this.rrwebRecord = window.rrweb ? window.rrweb.record : window.rrwebRecord; // only allows user to set our 'whitelisted' options
 
       var userSessionRecordingOptions = this.instance.get_config('session_recording');
 
@@ -3854,7 +3880,7 @@ var SessionRecording = /*#__PURE__*/function () {
         }
       }
 
-      this.stopRrweb = window.rrweb.record(_objectSpread2({
+      this.stopRrweb = this.rrwebRecord(_objectSpread2({
         emit: function emit(event) {
           event = filterDataURLsFromLargeDataObjects(event);
 
@@ -3875,13 +3901,14 @@ var SessionRecording = /*#__PURE__*/function () {
           } else {
             _this2.snapshots.push(properties);
           }
-        }
+        },
+        plugins: window.rrwebConsoleRecord && this.instance.get_config('enable_recording_console_log') ? [window.rrwebConsoleRecord.getRecordConsolePlugin()] : []
       }, sessionRecordingOptions)); // :TRICKY: rrweb does not capture navigation within SPA-s, so hook into our $pageview events to get access to all events.
       //   Dropping the initial event is fine (it's always captured by rrweb).
 
       this.instance._addCaptureHook(function (eventName) {
         if (eventName === '$pageview') {
-          window.rrweb.record.addCustomEvent('$pageview', {
+          _this2.rrwebRecord.addCustomEvent('$pageview', {
             href: window.location.href
           });
         }
@@ -5220,7 +5247,7 @@ var xhr = function xhr(_ref) {
           try {
             response = JSON.parse(req.responseText);
           } catch (e) {
-            console$1.error(e);
+            logger.error(e);
             return;
           }
 
@@ -5603,9 +5630,33 @@ function deduplicateKeys(performanceEntries) {
     });
   })];
 }
+/*
+The duration property is on the PerformanceNavigationTiming object.
+
+It is a timestamp that is the difference between the PerformanceNavigationTiming.loadEventEnd
+and PerformanceEntry.startTime properties.
+https://developer.mozilla.org/en-US/docs/Web/API/PerformanceNavigationTiming
+
+Even in browsers that implement it, it is not always available to us
+ */
+
 function pageLoadFrom(performanceData) {
-  var keyIndex = performanceData.navigation && performanceData.navigation[0] && performanceData.navigation[0].indexOf('duration');
-  return performanceData.navigation[1] && performanceData.navigation[1][0][keyIndex];
+  var keys = performanceData.navigation && performanceData.navigation[0];
+  var values = performanceData.navigation && performanceData.navigation[1] && performanceData.navigation[1][0];
+  var durationIndex = keys && keys.indexOf('duration');
+
+  if (durationIndex > -1) {
+    return values[durationIndex];
+  } else {
+    var endKeyIndex = keys && keys.indexOf('loadEventEnd');
+    var startKeyIndex = keys && keys.indexOf('startTime'); // start key is not present if start is 0
+
+    if (endKeyIndex > -1) {
+      var end = values && values[endKeyIndex];
+      var start = values && values[startKeyIndex] || 0;
+      return end - start;
+    }
+  }
 }
 function getPerformanceData() {
   var performanceEntries = {
@@ -5681,6 +5732,7 @@ var defaultConfig = function defaultConfig() {
     disable_session_recording: false,
     disable_persistence: false,
     disable_cookie: false,
+    enable_recording_console_log: false,
     secure_cookie: win.location.protocol === 'https:',
     ip: true,
     opt_out_capturing_by_default: false,
@@ -5713,7 +5765,7 @@ var defaultConfig = function defaultConfig() {
     advanced_disable_toolbar_metrics: false,
     on_xhr_error: function on_xhr_error(req) {
       var error = 'Bad HTTP status: ' + req.status + ' ' + req.statusText;
-      console$1.error(error);
+      console.error(error);
     },
     // Used for internal testing
     _onCapture: function _onCapture() {},
@@ -5745,7 +5797,7 @@ var create_mplib = function create_mplib(token, config, name) {
     instance = target;
   } else {
     if (target && !_.isArray(target)) {
-      console$1.error('You have already initialized ' + name);
+      console.error('You have already initialized ' + name);
       return;
     }
 
@@ -5772,10 +5824,10 @@ var create_mplib = function create_mplib(token, config, name) {
 
     if (!autocapture.enabledForProject(instance.get_config('token'), num_buckets, num_enabled_buckets)) {
       instance['__autocapture_enabled'] = false;
-      console$1.log('Not in active bucket: disabling Automatic Event Collection.');
+      logger.log('Not in active bucket: disabling Automatic Event Collection.');
     } else if (!autocapture.isBrowserSupported()) {
       instance['__autocapture_enabled'] = false;
-      console$1.log('Disabling Automatic Event Collection because this browser is not supported');
+      logger.log('Disabling Automatic Event Collection because this browser is not supported');
     } else {
       autocapture.init(instance);
     }
@@ -5817,12 +5869,12 @@ var create_mplib = function create_mplib(token, config, name) {
 
 PostHogLib.prototype.init = function (token, config, name) {
   if (_.isUndefined(name)) {
-    console$1.error('You must name your new library: init(token, config, name)');
+    console.error('You must name your new library: init(token, config, name)');
     return;
   }
 
   if (name === PRIMARY_INSTANCE_NAME) {
-    console$1.error('You must initialize the main posthog object right after you include the PostHog js snippet');
+    console.error('You must initialize the main posthog object right after you include the PostHog js snippet');
     return;
   }
 
@@ -5889,7 +5941,7 @@ PostHogLib.prototype._loaded = function () {
   try {
     this.get_config('loaded')(this);
   } catch (err) {
-    console$1.error('`loaded` function failed', err);
+    console.error('`loaded` function failed', err);
   }
 
   this._start_queue_if_opted_in(); // this happens after so a user can call identify in
@@ -6052,7 +6104,7 @@ PostHogLib.prototype._send_request = function (url, data, options, callback) {
       })));
     } catch (e) {
       if (this.get_config('debug')) {
-        console$1.error(e);
+        console.error(e);
       }
     }
   } else if (USE_XHR) {
@@ -6069,7 +6121,7 @@ PostHogLib.prototype._send_request = function (url, data, options, callback) {
         onXHRError: this.get_config('on_xhr_error')
       });
     } catch (e) {
-      console$1.error(e);
+      console.error(e);
     }
   } else {
     var script = document$1.createElement('script');
@@ -6195,7 +6247,7 @@ PostHogLib.prototype.capture = addOptOutCheckPostHogLib(function (event_name, pr
   }
 
   if (_.isUndefined(event_name) || typeof event_name !== 'string') {
-    console$1.error('No event name provided to posthog.capture');
+    console.error('No event name provided to posthog.capture');
     return;
   }
 
@@ -6227,7 +6279,7 @@ PostHogLib.prototype.capture = addOptOutCheckPostHogLib(function (event_name, pr
   data = _.copyAndTruncateStrings(data, options._noTruncate ? null : this.get_config('properties_string_max_length'));
 
   if (this.get_config('debug')) {
-    console$1.log('PostHog.js send', data);
+    logger.log('PostHog.js send', data);
   }
 
   var jsonData = JSON.stringify(data);
@@ -6261,7 +6313,8 @@ PostHogLib.prototype._invokeCaptureHooks = function (eventName, eventData) {
 
 PostHogLib.prototype._calculate_event_properties = function (event_name, event_properties, start_timestamp) {
   // set defaults
-  var properties = event_properties || {};
+  var properties = _objectSpread2({}, event_properties);
+
   properties['token'] = this.get_config('token');
 
   if (event_name === '$snapshot') {
@@ -6302,7 +6355,7 @@ PostHogLib.prototype._calculate_event_properties = function (event_name, event_p
       delete properties[blacklisted_prop];
     });
   } else {
-    console$1.error('Invalid value for property_blacklist config: ' + property_blacklist);
+    console.error('Invalid value for property_blacklist config: ' + property_blacklist);
   }
 
   var sanitize_properties = this.get_config('sanitize_properties');
@@ -6471,7 +6524,7 @@ PostHogLib.prototype.onFeatureFlags = function (callback) {
 PostHogLib.prototype.identify = function (new_distinct_id, userPropertiesToSet, userPropertiesToSetOnce) {
   //if the new_distinct_id has not been set ignore the identify event
   if (!new_distinct_id) {
-    console$1.error('Unique user id has not been set in posthog.identify');
+    console.error('Unique user id has not been set in posthog.identify');
     return;
   }
 
@@ -6541,7 +6594,7 @@ PostHogLib.prototype.identify = function (new_distinct_id, userPropertiesToSet,
 
 PostHogLib.prototype.group = function (groupType, groupKey, groupPropertiesToSet) {
   if (!groupType || !groupKey) {
-    console$1.error('posthog.group requires a group type and group key');
+    console.error('posthog.group requires a group type and group key');
     return;
   }
 
@@ -6635,7 +6688,7 @@ PostHogLib.prototype.alias = function (alias, original) {
   // posthog.people.identify() call made for this user. It is VERY BAD to make an alias with
   // this ID, as it will duplicate users.
   if (alias === this.get_property(PEOPLE_DISTINCT_ID_KEY)) {
-    console$1.critical('Attempting to create alias for existing People user - aborting.');
+    console.critical('Attempting to create alias for existing People user - aborting.');
     return -2;
   }
 
@@ -6656,7 +6709,7 @@ PostHogLib.prototype.alias = function (alias, original) {
       _this.identify(alias);
     });
   } else {
-    console$1.error('alias matches current distinct_id - skipping api call.');
+    console.error('alias matches current distinct_id - skipping api call.');
     this.identify(alias);
     return -1;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "posthog-js",
-    "version": "1.17.7",
+    "version": "1.18.0",
     "description": "Posthog-js allows you to automatically capture usage and send events to PostHog.",
     "repository": "https://github.com/PostHog/posthog-js",
     "author": "hey@posthog.com",
@@ -50,7 +50,7 @@
         "fast-check": "^2.17.0",
         "given2": "^2.1.7",
         "husky": "^4.2.5",
-        "jest": "^26.1.0",
+        "jest": "^27.5.1",
         "jsdom": "16.2.2",
         "jsdom-global": "3.0.2",
         "lint-staged": "^10.2.11",
@@ -60,7 +60,7 @@
         "posthog-js": "link:.",
         "prettier": "^2.0.5",
         "rollup": "^2.18.2",
-        "rrweb": "^1.0.6",
+        "rrweb": "^1.1.2",
         "sinon": "9.0.2",
         "testcafe": "^1.17.1",
         "testcafe-browser-provider-browserstack": "^1.13.2-alpha.1",
@@ -92,6 +92,7 @@
         "setupFilesAfterEnv": [
             "given2/setup"
         ],
-        "clearMocks": true
+        "clearMocks": true,
+        "testEnvironment": "jsdom"
     }
 }