mixpanel-browser 2.47.0 → 2.48.0

package/CHANGELOG.md

@@ -1,8 +1,16 @@
+**2.48.0** (7 Nov 2023)
+- API endpoint routes can now be configured individually (i.e. rename /track, /engage, /groups)
+- Event properties object passed to mixpanel.track() will no longer be mutated
+- Super properties are now reloaded from persistence when making every tracking call (i.e., kept fresh when another tab/window in the same browser has updated them)
+- Extra failsafe behavior for trying to clear queued requests when localStorage doesn't work on startup, e.g., when localStorage is full so writes fail
+- Block Chrome-Lighthouse user agent
+- Fix for error in add_group() when adding a new group to an existing list
+
 **2.47.0** (27 Apr 2023)
 - Collect richer marketing attribution properties for multi-touch attribution
 - New implementation of previously-deprecated track_pageview() method and init option to send automatically
 - Use performance.now when available for time-based entropy component of UUID-generation (thanks @adrianherd)
-- looser API Host check for default JSON-payload sending to mipxanel.com hosts
+- Looser API Host check for default JSON-payload sending to mipxanel.com hosts
 
 **2.46.0** (20 Mar 2023)
 - Updates for new identity management system

package/dist/mixpanel.amd.js

@@ -2,7 +2,7 @@ define(function () { 'use strict';
 
     var Config = {
         DEBUG: false,
-        LIB_VERSION: '2.47.0'
+        LIB_VERSION: '2.48.0'
     };
 
     // since es6 imports are static and we run unit tests from the console, window won't be defined when importing this file
@@ -904,6 +904,7 @@ define(function () { 'use strict';
         'baiduspider',
         'bingbot',
         'bingpreview',
+        'chrome-lighthouse',
         'facebookexternal',
         'petalbot',
         'pinterest',
@@ -3132,7 +3133,7 @@ define(function () { 'use strict';
         return this._mixpanel._track_or_batch({
             type: 'groups',
             data: date_encoded_data,
-            endpoint: this._get_config('api_host') + '/groups/',
+            endpoint: this._get_config('api_host') + '/' +  this._get_config('api_routes')['groups'],
             batcher: this._mixpanel.request_batchers.groups
         }, callback);
     };
@@ -3493,7 +3494,7 @@ define(function () { 'use strict';
         return this._mixpanel._track_or_batch({
             type: 'people',
             data: date_encoded_data,
-            endpoint: this._get_config('api_host') + '/engage/',
+            endpoint: this._get_config('api_host') + '/' +  this._get_config('api_routes')['engage'],
             batcher: this._mixpanel.request_batchers.people
         }, callback);
     };
@@ -3529,11 +3530,12 @@ define(function () { 'use strict';
 
     MixpanelPeople.prototype._flush_one_queue = function(action, action_method, callback, queue_to_params_fn) {
         var _this = this;
-        var queued_data = _.extend({}, this._mixpanel['persistence']._get_queue(action));
+        var queued_data = _.extend({}, this._mixpanel['persistence'].load_queue(action));
         var action_params = queued_data;
 
         if (!_.isUndefined(queued_data) && _.isObject(queued_data) && !_.isEmptyObject(queued_data)) {
             _this._mixpanel['persistence']._pop_from_people_queue(action, queued_data);
+            _this._mixpanel['persistence'].save();
             if (queue_to_params_fn) {
                 action_params = queue_to_params_fn(queued_data);
             }
@@ -3555,8 +3557,6 @@ define(function () { 'use strict';
         _set_callback, _add_callback, _append_callback, _set_once_callback, _union_callback, _unset_callback, _remove_callback
     ) {
         var _this = this;
-        var $append_queue = this._mixpanel['persistence']._get_queue(APPEND_ACTION);
-        var $remove_queue = this._mixpanel['persistence']._get_queue(REMOVE_ACTION);
 
         this._flush_one_queue(SET_ACTION, this.set, _set_callback);
         this._flush_one_queue(SET_ONCE_ACTION, this.set_once, _set_once_callback);
@@ -3566,6 +3566,7 @@ define(function () { 'use strict';
 
         // we have to fire off each $append individually since there is
         // no concat method server side
+        var $append_queue = this._mixpanel['persistence'].load_queue(APPEND_ACTION);
         if (!_.isUndefined($append_queue) && _.isArray($append_queue) && $append_queue.length) {
             var $append_item;
             var append_callback = function(response, data) {
@@ -3577,16 +3578,17 @@ define(function () { 'use strict';
                 }
             };
             for (var i = $append_queue.length - 1; i >= 0; i--) {
+                $append_queue = this._mixpanel['persistence'].load_queue(APPEND_ACTION);
                 $append_item = $append_queue.pop();
+                _this._mixpanel['persistence'].save();
                 if (!_.isEmptyObject($append_item)) {
                     _this.append($append_item, append_callback);
                 }
             }
-            // Save the shortened append queue
-            _this._mixpanel['persistence'].save();
         }
 
         // same for $remove
+        var $remove_queue = this._mixpanel['persistence'].load_queue(REMOVE_ACTION);
         if (!_.isUndefined($remove_queue) && _.isArray($remove_queue) && $remove_queue.length) {
             var $remove_item;
             var remove_callback = function(response, data) {
@@ -3598,12 +3600,13 @@ define(function () { 'use strict';
                 }
             };
             for (var j = $remove_queue.length - 1; j >= 0; j--) {
+                $remove_queue = this._mixpanel['persistence'].load_queue(REMOVE_ACTION);
                 $remove_item = $remove_queue.pop();
+                _this._mixpanel['persistence'].save();
                 if (!_.isEmptyObject($remove_item)) {
                     _this.remove($remove_item, remove_callback);
                 }
             }
-            _this._mixpanel['persistence'].save();
         }
     };
 
@@ -3685,6 +3688,9 @@ define(function () { 'use strict';
 
     MixpanelPersistence.prototype.properties = function() {
         var p = {};
+
+        this.load();
+
         // Filter out reserved properties
         _.each(this['props'], function(v, k) {
             if (!_.include(RESERVED_PROPERTIES, k)) {
@@ -3761,6 +3767,7 @@ define(function () { 'use strict';
 
     MixpanelPersistence.prototype.save = function() {
         if (this.disabled) { return; }
+
         this.storage.set(
             this.name,
             _.JSONEncode(this['props']),
@@ -3772,6 +3779,11 @@ define(function () { 'use strict';
         );
     };
 
+    MixpanelPersistence.prototype.load_prop = function(key) {
+        this.load();
+        return this['props'][key];
+    };
+
     MixpanelPersistence.prototype.remove = function() {
         // remove both domain and subdomain cookies
         this.storage.remove(this.name, false, this.cookie_domain);
@@ -3795,6 +3807,8 @@ define(function () { 'use strict';
             if (typeof(default_value) === 'undefined') { default_value = 'None'; }
             this.expire_days = (typeof(days) === 'undefined') ? this.default_expiry : days;
 
+            this.load();
+
             _.each(props, function(val, prop) {
                 if (!this['props'].hasOwnProperty(prop) || this['props'][prop] === default_value) {
                     this['props'][prop] = val;
@@ -3816,8 +3830,8 @@ define(function () { 'use strict';
         if (_.isObject(props)) {
             this.expire_days = (typeof(days) === 'undefined') ? this.default_expiry : days;
 
+            this.load();
             _.extend(this['props'], props);
-
             this.save();
 
             return true;
@@ -3826,6 +3840,7 @@ define(function () { 'use strict';
     };
 
     MixpanelPersistence.prototype.unregister = function(prop) {
+        this.load();
         if (prop in this['props']) {
             delete this['props'][prop];
             this.save();
@@ -3852,19 +3867,6 @@ define(function () { 'use strict';
         });
     };
 
-    // safely fills the passed in object with stored properties,
-    // does not override any properties defined in both
-    // returns the passed in object
-    MixpanelPersistence.prototype.safe_merge = function(props) {
-        _.each(this['props'], function(val, prop) {
-            if (!(prop in props)) {
-                props[prop] = val;
-            }
-        });
-
-        return props;
-    };
-
     MixpanelPersistence.prototype.update_config = function(config) {
         this.default_expiry = this.expire_days = config['cookie_expiration'];
         this.set_disabled(config['disable_persistence']);
@@ -4008,7 +4010,7 @@ define(function () { 'use strict';
     };
 
     MixpanelPersistence.prototype._pop_from_people_queue = function(queue, data) {
-        var q = this._get_queue(queue);
+        var q = this['props'][this._get_queue_key(queue)];
         if (!_.isUndefined(q)) {
             _.each(data, function(v, k) {
                 if (queue === APPEND_ACTION || queue === REMOVE_ACTION) {
@@ -4024,11 +4026,13 @@ define(function () { 'use strict';
                     delete q[k];
                 }
             }, this);
-
-            this.save();
         }
     };
 
+    MixpanelPersistence.prototype.load_queue = function(queue) {
+        return this.load_prop(this._get_queue_key(queue));
+    };
+
     MixpanelPersistence.prototype._get_queue_key = function(queue) {
         if (queue === SET_ACTION) {
             return SET_QUEUE_KEY;
@@ -4049,25 +4053,21 @@ define(function () { 'use strict';
         }
     };
 
-    MixpanelPersistence.prototype._get_queue = function(queue) {
-        return this['props'][this._get_queue_key(queue)];
-    };
     MixpanelPersistence.prototype._get_or_create_queue = function(queue, default_val) {
         var key = this._get_queue_key(queue);
         default_val = _.isUndefined(default_val) ? {} : default_val;
-
         return this['props'][key] || (this['props'][key] = default_val);
     };
 
     MixpanelPersistence.prototype.set_event_timer = function(event_name, timestamp) {
-        var timers = this['props'][EVENT_TIMERS_KEY] || {};
+        var timers = this.load_prop(EVENT_TIMERS_KEY) || {};
         timers[event_name] = timestamp;
         this['props'][EVENT_TIMERS_KEY] = timers;
         this.save();
     };
 
     MixpanelPersistence.prototype.remove_event_timer = function(event_name) {
-        var timers = this['props'][EVENT_TIMERS_KEY] || {};
+        var timers = this.load_prop(EVENT_TIMERS_KEY) || {};
         var timestamp = timers[event_name];
         if (!_.isUndefined(timestamp)) {
             delete this['props'][EVENT_TIMERS_KEY][event_name];
@@ -4138,11 +4138,18 @@ define(function () { 'use strict';
         };
     }
 
+    var DEFAULT_API_ROUTES = {
+        'track': 'track/',
+        'engage': 'engage/',
+        'groups': 'groups/'
+    };
+
     /*
      * Module-level globals
      */
     var DEFAULT_CONFIG = {
         'api_host':                          'https://api-js.mixpanel.com',
+        'api_routes':                        DEFAULT_API_ROUTES,
         'api_method':                        'POST',
         'api_transport':                     'XHR',
         'api_payload_format':                PAYLOAD_TYPE_BASE64,
@@ -4341,6 +4348,10 @@ define(function () { 'use strict';
             if (!_.localStorage.is_supported(true) || !USE_XHR) {
                 this._batch_requests = false;
                 console.log('Turning off Mixpanel request-queueing; needs XHR and localStorage support');
+                _.each(this.get_batcher_configs(), function(batcher_config) {
+                    console.log('Clearing batch queue ' + batcher_config.queue_key);
+                    _.localStorage.remove(batcher_config.queue_key);
+                });
             } else {
                 this.init_batchers();
                 if (sendBeacon && window$1.addEventListener) {
@@ -4688,12 +4699,22 @@ define(function () { 'use strict';
         return !!this.request_batchers.events;
     };
 
+    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'}
+        };
+        return this._batcher_configs;
+    };
+
     MixpanelLib.prototype.init_batchers = function() {
-        var token = this.get_config('token');
         if (!this.are_batchers_initialized()) {
             var batcher_for = _.bind(function(attrs) {
                 return new RequestBatcher(
-                    '__mpq_' + token + attrs.queue_suffix,
+                    attrs.queue_key,
                     {
                         libConfig: this['config'],
                         sendRequestFunc: _.bind(function(data, options, cb) {
@@ -4712,10 +4733,11 @@ define(function () { 'use strict';
                     }
                 );
             }, this);
+            var batcher_configs = this.get_batcher_configs();
             this.request_batchers = {
-                events: batcher_for({type: 'events', endpoint: '/track/', queue_suffix: '_ev'}),
-                people: batcher_for({type: 'people', endpoint: '/engage/', queue_suffix: '_pp'}),
-                groups: batcher_for({type: 'groups', endpoint: '/groups/', queue_suffix: '_gr'})
+                events: batcher_for(batcher_configs.events),
+                people: batcher_for(batcher_configs.people),
+                groups: batcher_for(batcher_configs.groups)
             };
         }
         if (this.get_config('batch_autostart')) {
@@ -4724,6 +4746,7 @@ define(function () { 'use strict';
     };
 
     MixpanelLib.prototype.start_batch_senders = function() {
+        this._batchers_were_started = true;
         if (this.are_batchers_initialized()) {
             this._batch_requests = true;
             _.each(this.request_batchers, function(batcher) {
@@ -4875,7 +4898,7 @@ define(function () { 'use strict';
         }
 
         // set defaults
-        properties = properties || {};
+        properties = _.extend({}, properties);
         properties['token'] = this.get_config('token');
 
         // set $duration if time_event was previously called for this event
@@ -4921,7 +4944,7 @@ define(function () { 'use strict';
         var ret = this._track_or_batch({
             type: 'events',
             data: data,
-            endpoint: this.get_config('api_host') + '/track/',
+            endpoint: this.get_config('api_host') + '/' + this.get_config('api_routes')['track'],
             batcher: this.request_batchers.events,
             should_send_immediately: should_send_immediately,
             send_request_options: options
@@ -4967,13 +4990,14 @@ define(function () { 'use strict';
      */
     MixpanelLib.prototype.add_group = addOptOutCheckMixpanelLib(function(group_key, group_id, callback) {
         var old_values = this.get_property(group_key);
+        var prop = {};
         if (old_values === undefined) {
-            var prop = {};
             prop[group_key] = [group_id];
             this.register(prop);
         } else {
             if (old_values.indexOf(group_id) === -1) {
                 old_values.push(group_id);
+                prop[group_key] = old_values;
                 this.register(prop);
             }
         }
@@ -5518,6 +5542,16 @@ define(function () { 'use strict';
      * The default config is:
      *
      *     {
+     *       // host for requests (customizable for e.g. a local proxy)
+     *       api_host: 'https://api-js.mixpanel.com',
+     *
+     *       // endpoints for different types of requests
+     *       api_routes: {
+     *         track: 'track/',
+     *         engage: 'engage/',
+     *         groups: 'groups/',
+     *       }
+     *
      *       // HTTP method for tracking requests
      *       api_method: 'POST'
      *
@@ -5701,7 +5735,7 @@ define(function () { 'use strict';
      * @param {String} property_name The name of the super property you want to retrieve
      */
     MixpanelLib.prototype.get_property = function(property_name) {
-        return this['persistence']['props'][property_name];
+        return this['persistence'].load_prop([property_name]);
     };
 
     MixpanelLib.prototype.toString = function() {
@@ -5774,9 +5808,13 @@ define(function () { 'use strict';
         }
 
         if (disabled) {
-            _.each(this.request_batchers, function(batcher) {
-                batcher.clear();
-            });
+            this.stop_batch_senders();
+        } else {
+            // only start batchers after opt-in if they have previously been started
+            // in order to avoid unintentionally starting up batching for the first time
+            if (this._batchers_were_started) {
+                this.start_batch_senders();
+            }
         }
     };
 
@@ -5978,37 +6016,38 @@ define(function () { 'use strict';
     // EXPORTS (for closure compiler)
 
     // MixpanelLib Exports
-    MixpanelLib.prototype['init']                               = MixpanelLib.prototype.init;
-    MixpanelLib.prototype['reset']                              = MixpanelLib.prototype.reset;
-    MixpanelLib.prototype['disable']                            = MixpanelLib.prototype.disable;
-    MixpanelLib.prototype['time_event']                         = MixpanelLib.prototype.time_event;
-    MixpanelLib.prototype['track']                              = MixpanelLib.prototype.track;
-    MixpanelLib.prototype['track_links']                        = MixpanelLib.prototype.track_links;
-    MixpanelLib.prototype['track_forms']                        = MixpanelLib.prototype.track_forms;
-    MixpanelLib.prototype['track_pageview']                     = MixpanelLib.prototype.track_pageview;
-    MixpanelLib.prototype['register']                           = MixpanelLib.prototype.register;
-    MixpanelLib.prototype['register_once']                      = MixpanelLib.prototype.register_once;
-    MixpanelLib.prototype['unregister']                         = MixpanelLib.prototype.unregister;
-    MixpanelLib.prototype['identify']                           = MixpanelLib.prototype.identify;
-    MixpanelLib.prototype['alias']                              = MixpanelLib.prototype.alias;
-    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_property']                       = MixpanelLib.prototype.get_property;
-    MixpanelLib.prototype['get_distinct_id']                    = MixpanelLib.prototype.get_distinct_id;
-    MixpanelLib.prototype['toString']                           = MixpanelLib.prototype.toString;
-    MixpanelLib.prototype['opt_out_tracking']                   = MixpanelLib.prototype.opt_out_tracking;
-    MixpanelLib.prototype['opt_in_tracking']                    = MixpanelLib.prototype.opt_in_tracking;
-    MixpanelLib.prototype['has_opted_out_tracking']             = MixpanelLib.prototype.has_opted_out_tracking;
-    MixpanelLib.prototype['has_opted_in_tracking']              = MixpanelLib.prototype.has_opted_in_tracking;
-    MixpanelLib.prototype['clear_opt_in_out_tracking']          = MixpanelLib.prototype.clear_opt_in_out_tracking;
-    MixpanelLib.prototype['get_group']                          = MixpanelLib.prototype.get_group;
-    MixpanelLib.prototype['set_group']                          = MixpanelLib.prototype.set_group;
-    MixpanelLib.prototype['add_group']                          = MixpanelLib.prototype.add_group;
-    MixpanelLib.prototype['remove_group']                       = MixpanelLib.prototype.remove_group;
-    MixpanelLib.prototype['track_with_groups']                  = MixpanelLib.prototype.track_with_groups;
-    MixpanelLib.prototype['start_batch_senders']                = MixpanelLib.prototype.start_batch_senders;
-    MixpanelLib.prototype['stop_batch_senders']                 = MixpanelLib.prototype.stop_batch_senders;
+    MixpanelLib.prototype['init']                      = MixpanelLib.prototype.init;
+    MixpanelLib.prototype['reset']                     = MixpanelLib.prototype.reset;
+    MixpanelLib.prototype['disable']                   = MixpanelLib.prototype.disable;
+    MixpanelLib.prototype['time_event']                = MixpanelLib.prototype.time_event;
+    MixpanelLib.prototype['track']                     = MixpanelLib.prototype.track;
+    MixpanelLib.prototype['track_links']               = MixpanelLib.prototype.track_links;
+    MixpanelLib.prototype['track_forms']               = MixpanelLib.prototype.track_forms;
+    MixpanelLib.prototype['track_pageview']            = MixpanelLib.prototype.track_pageview;
+    MixpanelLib.prototype['register']                  = MixpanelLib.prototype.register;
+    MixpanelLib.prototype['register_once']             = MixpanelLib.prototype.register_once;
+    MixpanelLib.prototype['unregister']                = MixpanelLib.prototype.unregister;
+    MixpanelLib.prototype['identify']                  = MixpanelLib.prototype.identify;
+    MixpanelLib.prototype['alias']                     = MixpanelLib.prototype.alias;
+    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_property']              = MixpanelLib.prototype.get_property;
+    MixpanelLib.prototype['get_distinct_id']           = MixpanelLib.prototype.get_distinct_id;
+    MixpanelLib.prototype['toString']                  = MixpanelLib.prototype.toString;
+    MixpanelLib.prototype['opt_out_tracking']          = MixpanelLib.prototype.opt_out_tracking;
+    MixpanelLib.prototype['opt_in_tracking']           = MixpanelLib.prototype.opt_in_tracking;
+    MixpanelLib.prototype['has_opted_out_tracking']    = MixpanelLib.prototype.has_opted_out_tracking;
+    MixpanelLib.prototype['has_opted_in_tracking']     = MixpanelLib.prototype.has_opted_in_tracking;
+    MixpanelLib.prototype['clear_opt_in_out_tracking'] = MixpanelLib.prototype.clear_opt_in_out_tracking;
+    MixpanelLib.prototype['get_group']                 = MixpanelLib.prototype.get_group;
+    MixpanelLib.prototype['set_group']                 = MixpanelLib.prototype.set_group;
+    MixpanelLib.prototype['add_group']                 = MixpanelLib.prototype.add_group;
+    MixpanelLib.prototype['remove_group']              = MixpanelLib.prototype.remove_group;
+    MixpanelLib.prototype['track_with_groups']         = MixpanelLib.prototype.track_with_groups;
+    MixpanelLib.prototype['start_batch_senders']       = MixpanelLib.prototype.start_batch_senders;
+    MixpanelLib.prototype['stop_batch_senders']        = MixpanelLib.prototype.stop_batch_senders;
+    MixpanelLib.prototype['DEFAULT_API_ROUTES']        = DEFAULT_API_ROUTES;
 
     // MixpanelPersistence Exports
     MixpanelPersistence.prototype['properties']            = MixpanelPersistence.prototype.properties;