mixpanel-browser 2.77.0 → 2.79.0

package/src/mixpanel-core.js

@@ -1,6 +1,6 @@
 /* eslint camelcase: "off" */
 import {Config, TARGETING_FILENAME} from './config';
-import { MAX_RECORDING_MS, _, console, userAgent, document, navigator, slice, NOOP_FUNC, JSONStringify } from './utils';
+import { MAX_RECORDING_MS, _, console, userAgent, document, navigator, slice, NOOP_FUNC, JSONStringify, safewrap } from './utils';
 import { window } from './window';
 import { Autocapture } from './autocapture';
 import { FeatureFlagManager } from './flags';
@@ -341,6 +341,7 @@ MixpanelLib.prototype._init = function(token, config, name) {
         'disable_all_events': false,
         'identify_called': false
     };
+    this._remote_settings_strict_disabled = false;
 
     // set up request queueing/batching
     this.request_batchers = {};
@@ -415,9 +416,6 @@ MixpanelLib.prototype._init = function(token, config, name) {
     this.flags.init();
     this['flags'] = this.flags;
 
-    this.autocapture = new Autocapture(this);
-    this.autocapture.init();
-
     this._init_tab_id();
 
     // Based on remote_settings_mode, fetch remote settings and then start session recording if applicable
@@ -429,6 +427,9 @@ MixpanelLib.prototype._init = function(token, config, name) {
     } else {
         this.__session_recording_init_promise = this._check_and_start_session_recording();
     }
+
+    this.autocapture = new Autocapture(this);
+    this.autocapture.init();
 };
 
 /**
@@ -475,9 +476,19 @@ MixpanelLib.prototype._check_and_start_session_recording = addOptOutCheckMixpane
     return this.recorderManager.checkAndStartSessionRecording(force_start);
 });
 
-MixpanelLib.prototype._start_recording_on_event = function(event_name, properties) {
-    return this.recorderManager.startRecordingOnEvent(event_name, properties);
-};
+MixpanelLib.prototype._start_recording_on_event = safewrap(function(event_name, properties) {
+    // Wait for recording init to complete before evaluating event triggers.
+    // This ensures recording_event_triggers config is fully loaded when remote settings are used.
+    if (this.__session_recording_init_promise) {
+        this.__session_recording_init_promise.then(_.bind(function() {
+            // In strict mode, skip recording if remote settings failed
+            if (this._remote_settings_strict_disabled) {
+                return;
+            }
+            return this.recorderManager.startRecordingOnEvent(event_name, properties);
+        }, this));
+    }
+});
 
 MixpanelLib.prototype.start_session_recording = function () {
     return this._check_and_start_session_recording(true);
@@ -776,6 +787,7 @@ MixpanelLib.prototype._fetch_remote_settings = function(mode) {
     var disableRecordingIfStrict = function() {
         if (mode === 'strict') {
             self.set_config({'record_sessions_percent': 0});
+            self._remote_settings_strict_disabled = true;
         }
     };
 
@@ -1401,6 +1413,10 @@ MixpanelLib.prototype.track_pageview = addOptOutCheckMixpanelLib(function(proper
         properties
     );
 
+    if (this.is_recording_heatmap_data()) {
+        event_properties['$captured_for_heatmap'] = true;
+    }
+
     return this.track(event_name, event_properties);
 });
 
@@ -1724,7 +1740,9 @@ MixpanelLib.prototype.identify = function(
 
     // check feature flags again if distinct id has changed
     if (new_distinct_id !== previous_distinct_id) {
-        this.flags.fetchFlags();
+        this.flags.fetchFlags().catch(function() {
+            console.error('[flags] Error fetching flags during identify');
+        });
     }
 };
 
@@ -1742,6 +1760,7 @@ MixpanelLib.prototype.reset = function() {
         '$device_id': uuid
     }, '');
     this._check_and_start_session_recording();
+    this.flags.reset();
 };
 
 /**

package/src/recorder/idb-config.js

@@ -0,0 +1,16 @@
+var MIXPANEL_BROWSER_DB_NAME = 'mixpanelBrowserDb';
+var RECORDING_EVENTS_STORE_NAME = 'mixpanelRecordingEvents';
+var RECORDING_REGISTRY_STORE_NAME = 'mixpanelRecordingRegistry';
+
+// Keeping these two properties closeby, as adding additional stores to a DB in IndexedDB requires a version increment
+var RECORDER_VERSION_DATA = {
+    version: 1,
+    storeNames: [RECORDING_EVENTS_STORE_NAME, RECORDING_REGISTRY_STORE_NAME]
+};
+
+export {
+    MIXPANEL_BROWSER_DB_NAME,
+    RECORDING_EVENTS_STORE_NAME,
+    RECORDING_REGISTRY_STORE_NAME,
+    RECORDER_VERSION_DATA
+};

package/src/recorder/recording-registry.js

@@ -1,5 +1,10 @@
 import { Promise } from '../promise-polyfill';
-import { IDBStorageWrapper, RECORDING_REGISTRY_STORE_NAME } from '../storage/indexed-db';
+import { IDBStorageWrapper } from '../storage/indexed-db';
+import {
+    MIXPANEL_BROWSER_DB_NAME,
+    RECORDING_REGISTRY_STORE_NAME,
+    RECORDER_VERSION_DATA
+} from './idb-config';
 import { SessionRecording } from './session-recording';
 import { isRecordingExpired } from './utils';
 
@@ -9,7 +14,7 @@ import { isRecordingExpired } from './utils';
  */
 var RecordingRegistry = function (options) {
     /** @type {IDBStorageWrapper} */
-    this.idb = new IDBStorageWrapper(RECORDING_REGISTRY_STORE_NAME);
+    this.idb = new IDBStorageWrapper(MIXPANEL_BROWSER_DB_NAME, RECORDING_REGISTRY_STORE_NAME, RECORDER_VERSION_DATA);
     this.errorReporter = options.errorReporter;
     this.mixpanelInstance = options.mixpanelInstance;
     this.sharedLockStorage = options.sharedLockStorage;

package/src/recorder/session-recording.js

@@ -4,8 +4,13 @@
 
 import { window } from '../window';
 import { EventType, getRecordConsolePlugin, IncrementalSource } from './rrweb-entrypoint';
-import { MAX_RECORDING_MS, MAX_VALUE_FOR_MIN_RECORDING_MS, console_with_prefix, NOOP_FUNC, _, localStorageSupported, canUseCompressionStream, navigator, userAgent, windowOpera} from '../utils'; // eslint-disable-line camelcase
-import { IDBStorageWrapper, RECORDING_EVENTS_STORE_NAME } from '../storage/indexed-db';
+import { MAX_RECORDING_MS, MAX_VALUE_FOR_MIN_RECORDING_MS, console_with_prefix, NOOP_FUNC, _, localStorageSupported, getLocalStorage, canUseCompressionStream, navigator, userAgent, windowOpera} from '../utils'; // eslint-disable-line camelcase
+import { IDBStorageWrapper } from '../storage/indexed-db';
+import {
+    MIXPANEL_BROWSER_DB_NAME,
+    RECORDING_EVENTS_STORE_NAME,
+    RECORDER_VERSION_DATA
+} from './idb-config';
 import { addOptOutCheckMixpanelLib } from '../gdpr-utils';
 import { RequestBatcher } from '../request-batcher';
 
@@ -111,11 +116,11 @@ var SessionRecording = function(options) {
 
     // disable persistence if localStorage is not supported
     // request-queue will automatically disable persistence if indexedDB fails to initialize
-    var usePersistence = localStorageSupported(options.sharedLockStorage, true) && !this.getConfig('disable_persistence');
+    var usePersistence = localStorageSupported(options.sharedLockStorage || getLocalStorage(), true) && !this.getConfig('disable_persistence');
 
     // each replay has its own batcher key to avoid conflicts between rrweb events of different recordings
     this.batcherKey = '__mprec_' + this.getConfig('name') + '_' + this.getConfig('token') + '_' + this.replayId;
-    this.queueStorage = new IDBStorageWrapper(RECORDING_EVENTS_STORE_NAME);
+    this.queueStorage = new IDBStorageWrapper(MIXPANEL_BROWSER_DB_NAME, RECORDING_EVENTS_STORE_NAME, RECORDER_VERSION_DATA);
     this.batcher = new RequestBatcher(this.batcherKey, {
         errorReporter: this.reportError.bind(this),
         flushOnlyOnInterval: true,

package/src/recorder-manager.js

@@ -4,7 +4,12 @@ import {RECORDER_FILENAME, TARGETING_FILENAME, RECORDER_GLOBAL_NAME} from './con
 import { _, console, console_with_prefix, safewrap, safewrapClass } from './utils';
 import { window } from './window';
 import { Promise } from './promise-polyfill';
-import { IDBStorageWrapper, RECORDING_REGISTRY_STORE_NAME } from './storage/indexed-db';
+import { IDBStorageWrapper } from './storage/indexed-db';
+import {
+    MIXPANEL_BROWSER_DB_NAME,
+    RECORDING_REGISTRY_STORE_NAME,
+    RECORDER_VERSION_DATA
+} from './recorder/idb-config';
 import { isRecordingExpired, validateAllowedOrigins } from './recorder/utils';
 import { getTargetingPromise } from './targeting/loader';
 
@@ -43,7 +48,7 @@ RecorderManager.prototype.shouldLoadRecorder = function() {
         return Promise.resolve(false);
     }
 
-    var recording_registry_idb = new IDBStorageWrapper(RECORDING_REGISTRY_STORE_NAME);
+    var recording_registry_idb = new IDBStorageWrapper(MIXPANEL_BROWSER_DB_NAME, RECORDING_REGISTRY_STORE_NAME, RECORDER_VERSION_DATA);
     var tab_id = this.getTabId();
     return recording_registry_idb.init()
         .then(function () {

package/src/request-queue.js

@@ -1,6 +1,5 @@
 import { SharedLock } from './shared-lock';
 import { batchedThrottle, cheap_guid, console_with_prefix, localStorageSupported, _ } from './utils'; // eslint-disable-line camelcase
-import { window } from './window';
 import { LocalStorageWrapper } from './storage/local-storage';
 import { Promise } from './promise-polyfill';
 
@@ -29,7 +28,7 @@ var RequestQueue = function (storageKey, options) {
     if (this.usePersistence) {
         this.queueStorage = options.queueStorage || new LocalStorageWrapper();
         this.lock = new SharedLock(storageKey, {
-            storage: options.sharedLockStorage || window.localStorage,
+            storage: options.sharedLockStorage,
             timeoutMS: options.sharedLockTimeoutMS,
         });
     }

package/src/shared-lock.js

@@ -1,6 +1,5 @@
 import { Promise } from './promise-polyfill';
-import { console_with_prefix, localStorageSupported, _ } from './utils'; // eslint-disable-line camelcase
-import { window } from './window';
+import { console_with_prefix, localStorageSupported, getLocalStorage, _ } from './utils'; // eslint-disable-line camelcase
 
 var logger = console_with_prefix('lock');
 
@@ -28,7 +27,7 @@ var SharedLock = function(key, options) {
     options = options || {};
 
     this.storageKey = key;
-    this.storage = options.storage || window.localStorage;
+    this.storage = options.storage || getLocalStorage();
     this.pollIntervalMS = options.pollIntervalMS || 100;
     this.timeoutMS = options.timeoutMS || 2000;
 

package/src/storage/indexed-db.js

@@ -1,29 +1,26 @@
 import { Promise } from '../promise-polyfill';
 import { window } from '../window';
 
-var MIXPANEL_DB_NAME = 'mixpanelBrowserDb';
-
-var RECORDING_EVENTS_STORE_NAME = 'mixpanelRecordingEvents';
-var RECORDING_REGISTRY_STORE_NAME = 'mixpanelRecordingRegistry';
-
-// note: increment the version number when adding new object stores
-var DB_VERSION = 1;
-var OBJECT_STORES = [RECORDING_EVENTS_STORE_NAME, RECORDING_REGISTRY_STORE_NAME];
-
 /**
  * @type {import('./wrapper').StorageWrapper}
  */
-var IDBStorageWrapper = function (storeName) {
+var IDBStorageWrapper = function (dbName, storeName, versionData) {
+    this.dbName = dbName;
+    this.storeName = storeName;
+    this.version = versionData.version;
+    this.storeNamesInDb = versionData.storeNames;
     /**
      * @type {Promise<IDBDatabase>|null}
      */
     this.dbPromise = null;
-    this.storeName = storeName;
 };
 
 IDBStorageWrapper.prototype._openDb = function () {
+    var dbName = this.dbName;
+    var version = this.version;
+    var storeNamesInDb = this.storeNamesInDb;
     return new Promise(function (resolve, reject) {
-        var openRequest = window.indexedDB.open(MIXPANEL_DB_NAME, DB_VERSION);
+        var openRequest = window.indexedDB.open(dbName, version);
         openRequest['onerror'] = function () {
             reject(openRequest.error);
         };
@@ -35,8 +32,10 @@ IDBStorageWrapper.prototype._openDb = function () {
         openRequest['onupgradeneeded'] = function (ev) {
             var db = ev.target.result;
 
-            OBJECT_STORES.forEach(function (storeName) {
-                db.createObjectStore(storeName);
+            storeNamesInDb.forEach(function (storeName) {
+                if (!db.objectStoreNames.contains(storeName)) {
+                    db.createObjectStore(storeName);
+                }
             });
         };
     });
@@ -128,4 +127,6 @@ IDBStorageWrapper.prototype.getAll = function () {
     });
 };
 
-export { IDBStorageWrapper, RECORDING_EVENTS_STORE_NAME, RECORDING_REGISTRY_STORE_NAME };
+export {
+    IDBStorageWrapper
+};

package/src/storage/local-storage.js

@@ -1,15 +1,17 @@
 import { Promise } from '../promise-polyfill';
-import { _, JSONParse, JSONStringify } from '../utils'; // eslint-disable-line camelcase
-import { window } from '../window';
+import { _, JSONParse, JSONStringify, getLocalStorage } from '../utils'; // eslint-disable-line camelcase
 
 /**
  * @type {import('./wrapper').StorageWrapper}
  */
 var LocalStorageWrapper = function (storageOverride) {
-    this.storage = storageOverride || window.localStorage;
+    this.storage = storageOverride || getLocalStorage();
 };
 
 LocalStorageWrapper.prototype.init = function () {
+    if (!this.storage) {
+        return Promise.reject(new Error('localStorage is not available'));
+    }
     return Promise.resolve();
 };
 

package/src/utils.js

@@ -104,6 +104,7 @@ var log_func_with_prefix = function(func, prefix) {
 var console_with_prefix = function(prefix) {
     return {
         log: log_func_with_prefix(console.log, prefix),
+        warn: log_func_with_prefix(console.warn, prefix),
         error: log_func_with_prefix(console.error, prefix),
         critical: log_func_with_prefix(console.critical, prefix)
     };
@@ -1050,7 +1051,8 @@ var localStorageSupported = function(storage, forceCheck) {
     if (_localStorageSupported !== null && !forceCheck) {
         return _localStorageSupported;
     }
-    return _localStorageSupported = _testStorageSupported(storage || window.localStorage);
+
+    return _localStorageSupported = _testStorageSupported(storage);
 };
 
 var _sessionStorageSupported = null;
@@ -1058,7 +1060,8 @@ var sessionStorageSupported = function(storage, forceCheck) {
     if (_sessionStorageSupported !== null && !forceCheck) {
         return _sessionStorageSupported;
     }
-    return _sessionStorageSupported = _testStorageSupported(storage || window.sessionStorage);
+
+    return _sessionStorageSupported = _testStorageSupported(storage);
 };
 
 function _storageWrapper(storage, name, is_supported_fn) {
@@ -1108,17 +1111,26 @@ function _storageWrapper(storage, name, is_supported_fn) {
     };
 }
 
-// Safari errors out accessing localStorage/sessionStorage when cookies are disabled,
-// so create dummy storage wrappers that silently fail as a fallback.
-var windowLocalStorage = null, windowSessionStorage = null;
-try {
-    windowLocalStorage = window.localStorage;
-    windowSessionStorage = window.sessionStorage;
-    // eslint-disable-next-line no-empty
-} catch (_err) {}
+// Safari and other browsers may error out accessing localStorage/sessionStorage
+// when cookies are disabled, so wrap access in a try-catch.
+var getLocalStorage = function() {
+    try {
+        return window.localStorage; // eslint-disable-line no-restricted-properties
+    } catch (_err) {
+        return null;
+    }
+};
+
+var getSessionStorage = function() {
+    try {
+        return window.sessionStorage; // eslint-disable-line no-restricted-properties
+    } catch (_err) {
+        return null;
+    }
+};
 
-_.localStorage = _storageWrapper(windowLocalStorage, 'localStorage', localStorageSupported);
-_.sessionStorage = _storageWrapper(windowSessionStorage, 'sessionStorage', sessionStorageSupported);
+_.localStorage = _storageWrapper(getLocalStorage(), 'localStorage', localStorageSupported);
+_.sessionStorage = _storageWrapper(getSessionStorage(), 'sessionStorage', sessionStorageSupported);
 
 _.register_event = (function() {
     // written by Dean Edwards, 2005
@@ -1810,5 +1822,6 @@ export {
     slice,
     urlMatchesRegexList,
     userAgent,
+    getLocalStorage,
     windowOpera,
 };

package/testServer.js

@@ -124,6 +124,8 @@ for (const [suiteId, suite] of Object.entries(TEST_SUITES)) {
     // Cross-origin child iframe page for session recording tests
     app.get('/tests/new/' + suiteId + '-cross-origin-page', function(req, res) {
         res.render('cross-origin-page.pug', {
+            customLibUrl: suite.customLibUrl || './static/build/mixpanel.js',
+            snippetUrl: suite.snippetUrl || './static/src/loaders/mixpanel-jslib-snippet.js',
             testUrl: './static/build/test/browser/cross-origin-page.js'
         });
     });

package/tsconfig.base.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "node"
+  }
+}