mixpanel-browser 2.65.0 → 2.67.0

package/dist/mixpanel.umd.js

@@ -13948,7 +13948,7 @@
 
     var Config = {
         DEBUG: false,
-        LIB_VERSION: '2.65.0'
+        LIB_VERSION: '2.67.0'
     };
 
     /* eslint camelcase: "off", eqeqeq: "off" */
@@ -17066,6 +17066,13 @@
      * @property {string} replayStartUrl
      */
 
+    /**
+     * @typedef {Object} UserIdInfo
+     * @property {string} distinct_id
+     * @property {string} user_id
+     * @property {string} device_id
+     */
+
 
     /**
      * This class encapsulates a single session recording and its lifecycle.
@@ -17121,6 +17128,30 @@
         });
     };
 
+    /**
+     * @returns {UserIdInfo}
+     */
+    SessionRecording.prototype.getUserIdInfo = function () {
+        if (this.finalFlushUserIdInfo) {
+            return this.finalFlushUserIdInfo;
+        }
+
+        var userIdInfo = {
+            'distinct_id': String(this._mixpanel.get_distinct_id()),
+        };
+
+        // send ID management props if they exist
+        var deviceId = this._mixpanel.get_property('$device_id');
+        if (deviceId) {
+            userIdInfo['$device_id'] = deviceId;
+        }
+        var userId = this._mixpanel.get_property('$user_id');
+        if (userId) {
+            userIdInfo['$user_id'] = userId;
+        }
+        return userIdInfo;
+    };
+
     SessionRecording.prototype.unloadPersistedData = function () {
         this.batcher.stop();
         return this.batcher.flush()
@@ -17245,6 +17276,9 @@
     };
 
     SessionRecording.prototype.stopRecording = function (skipFlush) {
+        // store the user ID info in case this is getting called in mixpanel.reset()
+        this.finalFlushUserIdInfo = this.getUserIdInfo();
+
         if (!this.isRrwebStopped()) {
             try {
                 this._stopRecording();
@@ -17355,8 +17389,8 @@
                 retryAfter: response.headers.get('Retry-After')
             });
         }.bind(this);
-
-        win['fetch'](this.getConfig('api_host') + '/' + this.getConfig('api_routes')['record'] + '?' + new URLSearchParams(reqParams), {
+        var apiHost = (this._mixpanel.get_api_host && this._mixpanel.get_api_host('record')) || this.getConfig('api_host');
+        win['fetch'](apiHost + '/' + this.getConfig('api_routes')['record'] + '?' + new URLSearchParams(reqParams), {
             'method': 'POST',
             'headers': {
                 'Authorization': 'Basic ' + btoa(this.getConfig('token') + ':'),
@@ -17410,7 +17444,6 @@
                 '$current_url': this.batchStartUrl,
                 '$lib_version': Config.LIB_VERSION,
                 'batch_start_time': batchStartTime / 1000,
-                'distinct_id': String(this._mixpanel.get_distinct_id()),
                 'mp_lib': 'web',
                 'replay_id': replayId,
                 'replay_length_ms': replayLengthMs,
@@ -17419,16 +17452,7 @@
                 'seq': this.seqNo
             };
             var eventsJson = JSON.stringify(data);
-
-            // send ID management props if they exist
-            var deviceId = this._mixpanel.get_property('$device_id');
-            if (deviceId) {
-                reqParams['$device_id'] = deviceId;
-            }
-            var userId = this._mixpanel.get_property('$user_id');
-            if (userId) {
-                reqParams['$user_id'] = userId;
-            }
+            Object.assign(reqParams, this.getUserIdInfo());
 
             if (CompressionStream) {
                 var jsonStream = new Blob([eventsJson], {type: 'application/json'}).stream();
@@ -17573,6 +17597,7 @@
         this._flushInactivePromise = this.recordingRegistry.flushInactiveRecordings();
 
         this.activeRecording = null;
+        this.stopRecordingInProgress = false;
     };
 
     MixpanelRecorder.prototype.startRecording = function(options) {
@@ -17621,19 +17646,26 @@
     };
 
     MixpanelRecorder.prototype.stopRecording = function() {
-        var stopPromise = this._stopCurrentRecording(false);
-        this.recordingRegistry.clearActiveRecording();
-        this.activeRecording = null;
-        return stopPromise;
+        // Prevents activeSerializedRecording from being reused when stopping the recording.
+        this.stopRecordingInProgress = true;
+        return this._stopCurrentRecording(false, true).then(function() {
+            return this.recordingRegistry.clearActiveRecording();
+        }.bind(this)).then(function() {
+            this.stopRecordingInProgress = false;
+        }.bind(this));
     };
 
     MixpanelRecorder.prototype.pauseRecording = function() {
         return this._stopCurrentRecording(false);
     };
 
-    MixpanelRecorder.prototype._stopCurrentRecording = function(skipFlush) {
+    MixpanelRecorder.prototype._stopCurrentRecording = function(skipFlush, disableActiveRecording) {
         if (this.activeRecording) {
-            return this.activeRecording.stopRecording(skipFlush);
+            var stopRecordingPromise = this.activeRecording.stopRecording(skipFlush);
+            if (disableActiveRecording) {
+                this.activeRecording = null;
+            }
+            return stopRecordingPromise;
         }
         return PromisePolyfill.resolve();
     };
@@ -17646,7 +17678,7 @@
 
         return this.recordingRegistry.getActiveRecording()
             .then(function (activeSerializedRecording) {
-                if (activeSerializedRecording) {
+                if (activeSerializedRecording && !this.stopRecordingInProgress) {
                     return this.startRecording({activeSerializedRecording: activeSerializedRecording});
                 } else if (startNewIfInactive) {
                     return this.startRecording({shouldStopBatcher: false});
@@ -18549,8 +18581,9 @@
      * @constructor
      */
     var FeatureFlagManager = function(initOptions) {
+        this.getFullApiRoute = initOptions.getFullApiRoute;
         this.getMpConfig = initOptions.getConfigFunc;
-        this.getDistinctId = initOptions.getDistinctIdFunc;
+        this.getMpProperty = initOptions.getPropertyFunc;
         this.track = initOptions.trackingFunc;
     };
 
@@ -18599,12 +18632,14 @@
             return;
         }
 
-        var distinctId = this.getDistinctId();
+        var distinctId = this.getMpProperty('distinct_id');
+        var deviceId = this.getMpProperty('$device_id');
         logger.log('Fetching flags for distinct ID: ' + distinctId);
         var reqParams = {
-            'context': _.extend({'distinct_id': distinctId}, this.getConfig(CONFIG_CONTEXT))
+            'context': _.extend({'distinct_id': distinctId, 'device_id': deviceId}, this.getConfig(CONFIG_CONTEXT))
         };
-        this.fetchPromise = win['fetch'](this.getMpConfig('api_host') + '/' + this.getMpConfig('api_routes')['flags'], {
+        this._fetchInProgressStartTime = Date.now();
+        this.fetchPromise = win['fetch'](this.getFullApiRoute(), {
             'method': 'POST',
             'headers': {
                 'Authorization': 'Basic ' + btoa(this.getMpConfig('token') + ':'),
@@ -18612,6 +18647,7 @@
             },
             'body': JSON.stringify(reqParams)
         }).then(function(response) {
+            this.markFetchComplete();
             return response.json().then(function(responseBody) {
                 var responseFlags = responseBody['flags'];
                 if (!responseFlags) {
@@ -18626,9 +18662,24 @@
                 });
                 this.flags = flags;
             }.bind(this)).catch(function(error) {
+                this.markFetchComplete();
                 logger.error(error);
-            });
-        }.bind(this)).catch(function() {});
+            }.bind(this));
+        }.bind(this)).catch(function(error) {
+            this.markFetchComplete();
+            logger.error(error);
+        }.bind(this));
+    };
+
+    FeatureFlagManager.prototype.markFetchComplete = function() {
+        if (!this._fetchInProgressStartTime) {
+            logger.error('Fetch in progress started time not set, cannot mark fetch complete');
+            return;
+        }
+        this._fetchStartTime = this._fetchInProgressStartTime;
+        this._fetchCompleteTime = Date.now();
+        this._fetchLatency = this._fetchCompleteTime - this._fetchStartTime;
+        this._fetchInProgressStartTime = null;
     };
 
     FeatureFlagManager.prototype.getVariant = function(featureName, fallback) {
@@ -18707,7 +18758,10 @@
         this.track('$experiment_started', {
             'Experiment name': featureName,
             'Variant name': feature['key'],
-            '$experiment_type': 'feature_flag'
+            '$experiment_type': 'feature_flag',
+            'Variant fetch start time': new Date(this._fetchStartTime).toISOString(),
+            'Variant fetch complete time': new Date(this._fetchCompleteTime).toISOString(),
+            'Variant fetch latency (ms)': this._fetchLatency
         });
     };
 
@@ -19148,7 +19202,7 @@
         return this._mixpanel._track_or_batch({
             type: 'groups',
             data: date_encoded_data,
-            endpoint: this._get_config('api_host') + '/' +  this._get_config('api_routes')['groups'],
+            endpoint: this._mixpanel.get_api_host('groups') + '/' +  this._get_config('api_routes')['groups'],
             batcher: this._mixpanel.request_batchers.groups
         }, callback);
     };
@@ -19500,7 +19554,7 @@
         return this._mixpanel._track_or_batch({
             type: 'people',
             data: date_encoded_data,
-            endpoint: this._get_config('api_host') + '/' +  this._get_config('api_routes')['engage'],
+            endpoint: this._mixpanel.get_api_host('people') + '/' +  this._get_config('api_routes')['engage'],
             batcher: this._mixpanel.request_batchers.people
         }, callback);
     };
@@ -20137,6 +20191,7 @@
      */
     var DEFAULT_CONFIG = {
         'api_host':                          'https://api-js.mixpanel.com',
+        'api_hosts':                         {},
         'api_routes':                        DEFAULT_API_ROUTES,
         'api_extra_query_params':            {},
         'api_method':                        'POST',
@@ -20406,8 +20461,11 @@
         }
 
         this.flags = new FeatureFlagManager({
+            getFullApiRoute: _.bind(function() {
+                return this.get_api_host('flags') + '/' + this.get_config('api_routes')['flags'];
+            }, this),
             getConfigFunc: _.bind(this.get_config, this),
-            getDistinctIdFunc: _.bind(this.get_distinct_id, this),
+            getPropertyFunc: _.bind(this.get_property, this),
             trackingFunc: _.bind(this.track, this)
         });
         this.flags.init();
@@ -20522,20 +20580,23 @@
 
     MixpanelLib.prototype.stop_session_recording = function () {
         if (this._recorder) {
-            this._recorder['stopRecording']();
+            return this._recorder['stopRecording']();
         }
+        return Promise.resolve();
     };
 
     MixpanelLib.prototype.pause_session_recording = function () {
         if (this._recorder) {
-            this._recorder['pauseRecording']();
+            return this._recorder['pauseRecording']();
         }
+        return Promise.resolve();
     };
 
     MixpanelLib.prototype.resume_session_recording = function () {
         if (this._recorder) {
-            this._recorder['resumeRecording']();
+            return this._recorder['resumeRecording']();
         }
+        return Promise.resolve();
     };
 
     MixpanelLib.prototype.is_recording_heatmap_data = function () {
@@ -20890,11 +20951,10 @@
 
     MixpanelLib.prototype.get_batcher_configs = function() {
         var queue_prefix = '__mpq_' + this.get_config('token');
-        var api_routes = this.get_config('api_routes');
         this._batcher_configs = this._batcher_configs || {
-            events: {type: 'events', endpoint: '/' + api_routes['track'], queue_key: queue_prefix + '_ev'},
-            people: {type: 'people', endpoint: '/' + api_routes['engage'], queue_key: queue_prefix + '_pp'},
-            groups: {type: 'groups', endpoint: '/' + api_routes['groups'], queue_key: queue_prefix + '_gr'}
+            events: {type: 'events', api_name: 'track', queue_key: queue_prefix + '_ev'},
+            people: {type: 'people', api_name: 'engage', queue_key: queue_prefix + '_pp'},
+            groups: {type: 'groups', api_name: 'groups', queue_key: queue_prefix + '_gr'}
         };
         return this._batcher_configs;
     };
@@ -20908,8 +20968,9 @@
                         libConfig: this['config'],
                         errorReporter: this.get_config('error_reporter'),
                         sendRequestFunc: _.bind(function(data, options, cb) {
+                            var api_routes = this.get_config('api_routes');
                             this._send_request(
-                                this.get_config('api_host') + attrs.endpoint,
+                                this.get_api_host(attrs.api_name) + '/' + api_routes[attrs.api_name],
                                 this._encode_data_for_request(data),
                                 options,
                                 this._prepare_callback(cb, data)
@@ -21135,7 +21196,7 @@
         var ret = this._track_or_batch({
             type: 'events',
             data: data,
-            endpoint: this.get_config('api_host') + '/' + this.get_config('api_routes')['track'],
+            endpoint: this.get_api_host('events') + '/' + this.get_config('api_routes')['track'],
             batcher: this.request_batchers.events,
             should_send_immediately: should_send_immediately,
             send_request_options: options
@@ -21637,6 +21698,7 @@
      * Useful for clearing data when a user logs out.
      */
     MixpanelLib.prototype.reset = function() {
+        this.stop_session_recording();
         this['persistence'].clear();
         this._flags.identify_called = false;
         var uuid = _.UUID();
@@ -21644,7 +21706,6 @@
             'distinct_id': DEVICE_ID_PREFIX + uuid,
             '$device_id': uuid
         }, '');
-        this.stop_session_recording();
         this._check_and_start_session_recording();
     };
 
@@ -21956,6 +22017,16 @@
         return this['persistence'].load_prop([property_name]);
     };
 
+    /**
+     * Get the API host for a specific endpoint type, falling back to the default api_host if not specified
+     *
+     * @param {String} endpoint_type The type of endpoint (e.g., "events", "people", "groups")
+     * @returns {String} The API host to use for this endpoint
+     */
+    MixpanelLib.prototype.get_api_host = function(endpoint_type) {
+        return this.get_config('api_hosts')[endpoint_type] || this.get_config('api_host');
+    };
+
     MixpanelLib.prototype.toString = function() {
         var name = this.get_config('name');
         if (name !== PRIMARY_INSTANCE_NAME) {
@@ -22251,6 +22322,7 @@
     MixpanelLib.prototype['name_tag']                           = MixpanelLib.prototype.name_tag;
     MixpanelLib.prototype['set_config']                         = MixpanelLib.prototype.set_config;
     MixpanelLib.prototype['get_config']                         = MixpanelLib.prototype.get_config;
+    MixpanelLib.prototype['get_api_host']                       = MixpanelLib.prototype.get_api_host;
     MixpanelLib.prototype['get_property']                       = MixpanelLib.prototype.get_property;
     MixpanelLib.prototype['get_distinct_id']                    = MixpanelLib.prototype.get_distinct_id;
     MixpanelLib.prototype['toString']                           = MixpanelLib.prototype.toString;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mixpanel-browser",
-  "version": "2.65.0",
+  "version": "2.67.0",
   "description": "The official Mixpanel JavaScript browser client library",
   "main": "dist/mixpanel.cjs.js",
   "module": "dist/mixpanel.module.js",
@@ -22,6 +22,7 @@
     "unit-test": "BABEL_ENV=test mocha --require babel-core/register tests/unit/*.js",
     "validate": "npm ls"
   },
+  "types": "./src/index.d.ts",
   "repository": {
     "type": "git",
     "url": "https://github.com/mixpanel/mixpanel-js.git"

package/src/config.js

@@ -1,6 +1,6 @@
 var Config = {
     DEBUG: false,
-    LIB_VERSION: '2.65.0'
+    LIB_VERSION: '2.67.0'
 };
 
 export default Config;

package/src/flags/index.js

@@ -15,8 +15,9 @@ CONFIG_DEFAULTS[CONFIG_CONTEXT] = {};
  * @constructor
  */
 var FeatureFlagManager = function(initOptions) {
+    this.getFullApiRoute = initOptions.getFullApiRoute;
     this.getMpConfig = initOptions.getConfigFunc;
-    this.getDistinctId = initOptions.getDistinctIdFunc;
+    this.getMpProperty = initOptions.getPropertyFunc;
     this.track = initOptions.trackingFunc;
 };
 
@@ -65,12 +66,14 @@ FeatureFlagManager.prototype.fetchFlags = function() {
         return;
     }
 
-    var distinctId = this.getDistinctId();
+    var distinctId = this.getMpProperty('distinct_id');
+    var deviceId = this.getMpProperty('$device_id');
     logger.log('Fetching flags for distinct ID: ' + distinctId);
     var reqParams = {
-        'context': _.extend({'distinct_id': distinctId}, this.getConfig(CONFIG_CONTEXT))
+        'context': _.extend({'distinct_id': distinctId, 'device_id': deviceId}, this.getConfig(CONFIG_CONTEXT))
     };
-    this.fetchPromise = window['fetch'](this.getMpConfig('api_host') + '/' + this.getMpConfig('api_routes')['flags'], {
+    this._fetchInProgressStartTime = Date.now();
+    this.fetchPromise = window['fetch'](this.getFullApiRoute(), {
         'method': 'POST',
         'headers': {
             'Authorization': 'Basic ' + btoa(this.getMpConfig('token') + ':'),
@@ -78,6 +81,7 @@ FeatureFlagManager.prototype.fetchFlags = function() {
         },
         'body': JSON.stringify(reqParams)
     }).then(function(response) {
+        this.markFetchComplete();
         return response.json().then(function(responseBody) {
             var responseFlags = responseBody['flags'];
             if (!responseFlags) {
@@ -92,9 +96,24 @@ FeatureFlagManager.prototype.fetchFlags = function() {
             });
             this.flags = flags;
         }.bind(this)).catch(function(error) {
+            this.markFetchComplete();
             logger.error(error);
-        });
-    }.bind(this)).catch(function() {});
+        }.bind(this));
+    }.bind(this)).catch(function(error) {
+        this.markFetchComplete();
+        logger.error(error);
+    }.bind(this));
+};
+
+FeatureFlagManager.prototype.markFetchComplete = function() {
+    if (!this._fetchInProgressStartTime) {
+        logger.error('Fetch in progress started time not set, cannot mark fetch complete');
+        return;
+    }
+    this._fetchStartTime = this._fetchInProgressStartTime;
+    this._fetchCompleteTime = Date.now();
+    this._fetchLatency = this._fetchCompleteTime - this._fetchStartTime;
+    this._fetchInProgressStartTime = null;
 };
 
 FeatureFlagManager.prototype.getVariant = function(featureName, fallback) {
@@ -173,7 +192,10 @@ FeatureFlagManager.prototype.trackFeatureCheck = function(featureName, feature)
     this.track('$experiment_started', {
         'Experiment name': featureName,
         'Variant name': feature['key'],
-        '$experiment_type': 'feature_flag'
+        '$experiment_type': 'feature_flag',
+        'Variant fetch start time': new Date(this._fetchStartTime).toISOString(),
+        'Variant fetch complete time': new Date(this._fetchCompleteTime).toISOString(),
+        'Variant fetch latency (ms)': this._fetchLatency
     });
 };