mixpanel-browser 2.45.0 → 2.46.0

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+**2.46.0** (20 Mar 2023)
+- Updates for new identity management system
+- More aggressive deduplication within batch sender
+
 **2.45.0** (17 Feb 2022)
 - Remove all code related to in-app messaging feature
 - Add `error_reporter` config option for user-configurable handling of errors
@@ -5,7 +9,7 @@
 - Fixes for some batch/retry edge cases where localStorage write failures resulted in duplicate sends
 
 **2.43.0** (5 Jan 2022)
-- Support plain JSON tracking payloads (no base64-encoding) and use as default when sendinig to *.mixpanel.com API hosts
+- Support plain JSON tracking payloads (no base64-encoding) and use as default when sending to *.mixpanel.com API hosts
 
 **2.42.1** (20 Dec 2021)
 - Add new crawler user agents to blocked list (ahrefsbot, petalbot)

package/README.md

@@ -72,7 +72,7 @@ Mixpanel production releases are tested against a large matrix of browsers and o
 ## Generating and publishing documentation
 - Create bundled source build: `npm run build-dist`
 - Generate Markdown: `npm run dox` (result is at `doc/readme.io/javascript-full-api-reference.md`)
-- Publish to readme.io via the [rdme](https://www.npmjs.com/package/rdme) util: `RDME_API_KEY=<API_KEY> npm run dox-publish`
+- Publish to readme.io via the [rdme](https://www.npmjs.com/package/rdme) util: `RDME_API_KEY=<API_KEY> RDME_DOC_VERSION=<version> npm run dox-publish`
 
 ## Thanks
 For patches and support: @bohanyang, @dehau, @drubin, @D1plo1d, @feychenie, @mogstad, @pfhayes, @sandorfr, @stefansedich, @gfx, @pkaminski, @austince, @danielbaker, @mkdai, @wolever, @dpraul, @chriszamierowski, @JoaoGomesTW

package/build.sh

@@ -1,5 +1,7 @@
 #!/bin/bash
 
+set -e
+
 # building with $DIST=1 also implies $FULL=1
 if [ ! -z "$DIST" ]; then
     export FULL=1

package/dist/mixpanel.amd.js

@@ -2,7 +2,7 @@ define(function () { 'use strict';
 
     var Config = {
         DEBUG: false,
-        LIB_VERSION: '2.45.0'
+        LIB_VERSION: '2.46.0'
     };
 
     // since es6 imports are static and we run unit tests from the console, window won't be defined when importing this file
@@ -2295,6 +2295,9 @@ define(function () { 'use strict';
 
         this.stopped = !this.libConfig['batch_autostart'];
         this.consecutiveRemovalFailures = 0;
+
+        // extra client-side dedupe
+        this.itemIdsSentSuccessfully = {};
     };
 
     /**
@@ -2387,7 +2390,34 @@ define(function () { 'use strict';
                     payload = this.beforeSendHook(payload);
                 }
                 if (payload) {
-                    dataForRequest.push(payload);
+                    // mp_sent_by_lib_version prop captures which lib version actually
+                    // sends each event (regardless of which version originally queued
+                    // it for sending)
+                    if (payload['event'] && payload['properties']) {
+                        payload['properties'] = _.extend(
+                            {},
+                            payload['properties'],
+                            {'mp_sent_by_lib_version': Config.LIB_VERSION}
+                        );
+                    }
+                    var addPayload = true;
+                    var itemId = item['id'];
+                    if (itemId) {
+                        if ((this.itemIdsSentSuccessfully[itemId] || 0) > 5) {
+                            this.reportError('[dupe] item ID sent too many times, not sending', {
+                                item: item,
+                                batchSize: batch.length,
+                                timesSent: this.itemIdsSentSuccessfully[itemId]
+                            });
+                            addPayload = false;
+                        }
+                    } else {
+                        this.reportError('[dupe] found item with no ID', {item: item});
+                    }
+
+                    if (addPayload) {
+                        dataForRequest.push(payload);
+                    }
                 }
                 transformedItems[item['id']] = payload;
             }, this);
@@ -2470,6 +2500,24 @@ define(function () { 'use strict';
                                 }
                             }, this)
                         );
+
+                        // client-side dedupe
+                        _.each(batch, _.bind(function(item) {
+                            var itemId = item['id'];
+                            if (itemId) {
+                                this.itemIdsSentSuccessfully[itemId] = this.itemIdsSentSuccessfully[itemId] || 0;
+                                this.itemIdsSentSuccessfully[itemId]++;
+                                if (this.itemIdsSentSuccessfully[itemId] > 5) {
+                                    this.reportError('[dupe] item ID sent too many times', {
+                                        item: item,
+                                        batchSize: batch.length,
+                                        timesSent: this.itemIdsSentSuccessfully[itemId]
+                                    });
+                                }
+                            } else {
+                                this.reportError('[dupe] found item with no ID while removing', {item: item});
+                            }
+                        }, this));
                     }
 
                 } catch(err) {
@@ -3315,24 +3363,25 @@ define(function () { 'use strict';
     });
 
     /*
-    * Record that you have charged the current user a certain amount
-    * of money. Charges recorded with track_charge() will appear in the
-    * Mixpanel revenue report.
-    *
-    * ### Usage:
-    *
-    *     // charge a user $50
-    *     mixpanel.people.track_charge(50);
-    *
-    *     // charge a user $30.50 on the 2nd of january
-    *     mixpanel.people.track_charge(30.50, {
-    *         '$time': new Date('jan 1 2012')
-    *     });
-    *
-    * @param {Number} amount The amount of money charged to the current user
-    * @param {Object} [properties] An associative array of properties associated with the charge
-    * @param {Function} [callback] If provided, the callback will be called when the server responds
-    */
+     * Record that you have charged the current user a certain amount
+     * of money. Charges recorded with track_charge() will appear in the
+     * Mixpanel revenue report.
+     *
+     * ### Usage:
+     *
+     *     // charge a user $50
+     *     mixpanel.people.track_charge(50);
+     *
+     *     // charge a user $30.50 on the 2nd of january
+     *     mixpanel.people.track_charge(30.50, {
+     *         '$time': new Date('jan 1 2012')
+     *     });
+     *
+     * @param {Number} amount The amount of money charged to the current user
+     * @param {Object} [properties] An associative array of properties associated with the charge
+     * @param {Function} [callback] If provided, the callback will be called when the server responds
+     * @deprecated
+     */
     MixpanelPeople.prototype.track_charge = addOptOutCheckMixpanelPeople(function(amount, properties, callback) {
         if (!_.isNumber(amount)) {
             amount = parseFloat(amount);
@@ -3348,15 +3397,16 @@ define(function () { 'use strict';
     });
 
     /*
-    * Permanently clear all revenue report transactions from the
-    * current user's people analytics profile.
-    *
-    * ### Usage:
-    *
-    *     mixpanel.people.clear_charges();
-    *
-    * @param {Function} [callback] If provided, the callback will be called after tracking the event.
-    */
+     * Permanently clear all revenue report transactions from the
+     * current user's people analytics profile.
+     *
+     * ### Usage:
+     *
+     *     mixpanel.people.clear_charges();
+     *
+     * @param {Function} [callback] If provided, the callback will be called after tracking the event.
+     * @deprecated
+     */
     MixpanelPeople.prototype.clear_charges = function(callback) {
         return this.set('$transactions', [], callback);
     };
@@ -4045,6 +4095,7 @@ define(function () { 'use strict';
     /** @const */ var PRIMARY_INSTANCE_NAME = 'mixpanel';
     /** @const */ var PAYLOAD_TYPE_BASE64   = 'base64';
     /** @const */ var PAYLOAD_TYPE_JSON     = 'json';
+    /** @const */ var DEVICE_ID_PREFIX      = '$device:';
 
 
     /*
@@ -4292,7 +4343,7 @@ define(function () { 'use strict';
             // or the device id if something was already stored
             // in the persitence
             this.register_once({
-                'distinct_id': uuid,
+                'distinct_id': DEVICE_ID_PREFIX + uuid,
                 '$device_id': uuid
             }, '');
         }
@@ -5218,7 +5269,15 @@ define(function () { 'use strict';
         //  _unset_callback:function  A callback to be run if and when the People unset queue is flushed
 
         var previous_distinct_id = this.get_distinct_id();
-        this.register({'$user_id': new_distinct_id});
+        if (new_distinct_id && previous_distinct_id !== new_distinct_id) {
+            // we allow the following condition if previous distinct_id is same as new_distinct_id
+            // so that you can force flush people updates for anonymous profiles.
+            if (typeof new_distinct_id === 'string' && new_distinct_id.indexOf(DEVICE_ID_PREFIX) === 0) {
+                this.report_error('distinct_id cannot have $device: prefix');
+                return -1;
+            }
+            this.register({'$user_id': new_distinct_id});
+        }
 
         if (!this.get_property('$device_id')) {
             // The persisted distinct id might not actually be a device id at all
@@ -5259,7 +5318,7 @@ define(function () { 'use strict';
         this._flags.identify_called = false;
         var uuid = _.UUID();
         this.register_once({
-            'distinct_id': uuid,
+            'distinct_id': DEVICE_ID_PREFIX + uuid,
             '$device_id': uuid
         }, '');
     };
@@ -5384,8 +5443,8 @@ define(function () { 'use strict';
      *       // batching or retry mechanisms.
      *       api_transport: 'XHR'
      *
-     *       // turn on request-batching/queueing/retry
-     *       batch_requests: false,
+     *       // request-batching/queueing/retry
+     *       batch_requests: true,
      *
      *       // maximum number of events/updates to send in a single
      *       // network request

package/dist/mixpanel.cjs.js

@@ -2,7 +2,7 @@
 
 var Config = {
     DEBUG: false,
-    LIB_VERSION: '2.45.0'
+    LIB_VERSION: '2.46.0'
 };
 
 // since es6 imports are static and we run unit tests from the console, window won't be defined when importing this file
@@ -2295,6 +2295,9 @@ var RequestBatcher = function(storageKey, options) {
 
     this.stopped = !this.libConfig['batch_autostart'];
     this.consecutiveRemovalFailures = 0;
+
+    // extra client-side dedupe
+    this.itemIdsSentSuccessfully = {};
 };
 
 /**
@@ -2387,7 +2390,34 @@ RequestBatcher.prototype.flush = function(options) {
                 payload = this.beforeSendHook(payload);
             }
             if (payload) {
-                dataForRequest.push(payload);
+                // mp_sent_by_lib_version prop captures which lib version actually
+                // sends each event (regardless of which version originally queued
+                // it for sending)
+                if (payload['event'] && payload['properties']) {
+                    payload['properties'] = _.extend(
+                        {},
+                        payload['properties'],
+                        {'mp_sent_by_lib_version': Config.LIB_VERSION}
+                    );
+                }
+                var addPayload = true;
+                var itemId = item['id'];
+                if (itemId) {
+                    if ((this.itemIdsSentSuccessfully[itemId] || 0) > 5) {
+                        this.reportError('[dupe] item ID sent too many times, not sending', {
+                            item: item,
+                            batchSize: batch.length,
+                            timesSent: this.itemIdsSentSuccessfully[itemId]
+                        });
+                        addPayload = false;
+                    }
+                } else {
+                    this.reportError('[dupe] found item with no ID', {item: item});
+                }
+
+                if (addPayload) {
+                    dataForRequest.push(payload);
+                }
             }
             transformedItems[item['id']] = payload;
         }, this);
@@ -2470,6 +2500,24 @@ RequestBatcher.prototype.flush = function(options) {
                             }
                         }, this)
                     );
+
+                    // client-side dedupe
+                    _.each(batch, _.bind(function(item) {
+                        var itemId = item['id'];
+                        if (itemId) {
+                            this.itemIdsSentSuccessfully[itemId] = this.itemIdsSentSuccessfully[itemId] || 0;
+                            this.itemIdsSentSuccessfully[itemId]++;
+                            if (this.itemIdsSentSuccessfully[itemId] > 5) {
+                                this.reportError('[dupe] item ID sent too many times', {
+                                    item: item,
+                                    batchSize: batch.length,
+                                    timesSent: this.itemIdsSentSuccessfully[itemId]
+                                });
+                            }
+                        } else {
+                            this.reportError('[dupe] found item with no ID while removing', {item: item});
+                        }
+                    }, this));
                 }
 
             } catch(err) {
@@ -3315,24 +3363,25 @@ MixpanelPeople.prototype.union = addOptOutCheckMixpanelPeople(function(list_name
 });
 
 /*
-* Record that you have charged the current user a certain amount
-* of money. Charges recorded with track_charge() will appear in the
-* Mixpanel revenue report.
-*
-* ### Usage:
-*
-*     // charge a user $50
-*     mixpanel.people.track_charge(50);
-*
-*     // charge a user $30.50 on the 2nd of january
-*     mixpanel.people.track_charge(30.50, {
-*         '$time': new Date('jan 1 2012')
-*     });
-*
-* @param {Number} amount The amount of money charged to the current user
-* @param {Object} [properties] An associative array of properties associated with the charge
-* @param {Function} [callback] If provided, the callback will be called when the server responds
-*/
+ * Record that you have charged the current user a certain amount
+ * of money. Charges recorded with track_charge() will appear in the
+ * Mixpanel revenue report.
+ *
+ * ### Usage:
+ *
+ *     // charge a user $50
+ *     mixpanel.people.track_charge(50);
+ *
+ *     // charge a user $30.50 on the 2nd of january
+ *     mixpanel.people.track_charge(30.50, {
+ *         '$time': new Date('jan 1 2012')
+ *     });
+ *
+ * @param {Number} amount The amount of money charged to the current user
+ * @param {Object} [properties] An associative array of properties associated with the charge
+ * @param {Function} [callback] If provided, the callback will be called when the server responds
+ * @deprecated
+ */
 MixpanelPeople.prototype.track_charge = addOptOutCheckMixpanelPeople(function(amount, properties, callback) {
     if (!_.isNumber(amount)) {
         amount = parseFloat(amount);
@@ -3348,15 +3397,16 @@ MixpanelPeople.prototype.track_charge = addOptOutCheckMixpanelPeople(function(am
 });
 
 /*
-* Permanently clear all revenue report transactions from the
-* current user's people analytics profile.
-*
-* ### Usage:
-*
-*     mixpanel.people.clear_charges();
-*
-* @param {Function} [callback] If provided, the callback will be called after tracking the event.
-*/
+ * Permanently clear all revenue report transactions from the
+ * current user's people analytics profile.
+ *
+ * ### Usage:
+ *
+ *     mixpanel.people.clear_charges();
+ *
+ * @param {Function} [callback] If provided, the callback will be called after tracking the event.
+ * @deprecated
+ */
 MixpanelPeople.prototype.clear_charges = function(callback) {
     return this.set('$transactions', [], callback);
 };
@@ -4045,6 +4095,7 @@ var NOOP_FUNC = function() {};
 /** @const */ var PRIMARY_INSTANCE_NAME = 'mixpanel';
 /** @const */ var PAYLOAD_TYPE_BASE64   = 'base64';
 /** @const */ var PAYLOAD_TYPE_JSON     = 'json';
+/** @const */ var DEVICE_ID_PREFIX      = '$device:';
 
 
 /*
@@ -4292,7 +4343,7 @@ MixpanelLib.prototype._init = function(token, config, name) {
         // or the device id if something was already stored
         // in the persitence
         this.register_once({
-            'distinct_id': uuid,
+            'distinct_id': DEVICE_ID_PREFIX + uuid,
             '$device_id': uuid
         }, '');
     }
@@ -5218,7 +5269,15 @@ MixpanelLib.prototype.identify = function(
     //  _unset_callback:function  A callback to be run if and when the People unset queue is flushed
 
     var previous_distinct_id = this.get_distinct_id();
-    this.register({'$user_id': new_distinct_id});
+    if (new_distinct_id && previous_distinct_id !== new_distinct_id) {
+        // we allow the following condition if previous distinct_id is same as new_distinct_id
+        // so that you can force flush people updates for anonymous profiles.
+        if (typeof new_distinct_id === 'string' && new_distinct_id.indexOf(DEVICE_ID_PREFIX) === 0) {
+            this.report_error('distinct_id cannot have $device: prefix');
+            return -1;
+        }
+        this.register({'$user_id': new_distinct_id});
+    }
 
     if (!this.get_property('$device_id')) {
         // The persisted distinct id might not actually be a device id at all
@@ -5259,7 +5318,7 @@ MixpanelLib.prototype.reset = function() {
     this._flags.identify_called = false;
     var uuid = _.UUID();
     this.register_once({
-        'distinct_id': uuid,
+        'distinct_id': DEVICE_ID_PREFIX + uuid,
         '$device_id': uuid
     }, '');
 };
@@ -5384,8 +5443,8 @@ MixpanelLib.prototype.name_tag = function(name_tag) {
  *       // batching or retry mechanisms.
  *       api_transport: 'XHR'
  *
- *       // turn on request-batching/queueing/retry
- *       batch_requests: false,
+ *       // request-batching/queueing/retry
+ *       batch_requests: true,
  *
  *       // maximum number of events/updates to send in a single
  *       // network request

package/dist/mixpanel.globals.js

@@ -3,7 +3,7 @@
 
     var Config = {
         DEBUG: false,
-        LIB_VERSION: '2.45.0'
+        LIB_VERSION: '2.46.0'
     };
 
     // since es6 imports are static and we run unit tests from the console, window won't be defined when importing this file
@@ -2296,6 +2296,9 @@
 
         this.stopped = !this.libConfig['batch_autostart'];
         this.consecutiveRemovalFailures = 0;
+
+        // extra client-side dedupe
+        this.itemIdsSentSuccessfully = {};
     };
 
     /**
@@ -2388,7 +2391,34 @@
                     payload = this.beforeSendHook(payload);
                 }
                 if (payload) {
-                    dataForRequest.push(payload);
+                    // mp_sent_by_lib_version prop captures which lib version actually
+                    // sends each event (regardless of which version originally queued
+                    // it for sending)
+                    if (payload['event'] && payload['properties']) {
+                        payload['properties'] = _.extend(
+                            {},
+                            payload['properties'],
+                            {'mp_sent_by_lib_version': Config.LIB_VERSION}
+                        );
+                    }
+                    var addPayload = true;
+                    var itemId = item['id'];
+                    if (itemId) {
+                        if ((this.itemIdsSentSuccessfully[itemId] || 0) > 5) {
+                            this.reportError('[dupe] item ID sent too many times, not sending', {
+                                item: item,
+                                batchSize: batch.length,
+                                timesSent: this.itemIdsSentSuccessfully[itemId]
+                            });
+                            addPayload = false;
+                        }
+                    } else {
+                        this.reportError('[dupe] found item with no ID', {item: item});
+                    }
+
+                    if (addPayload) {
+                        dataForRequest.push(payload);
+                    }
                 }
                 transformedItems[item['id']] = payload;
             }, this);
@@ -2471,6 +2501,24 @@
                                 }
                             }, this)
                         );
+
+                        // client-side dedupe
+                        _.each(batch, _.bind(function(item) {
+                            var itemId = item['id'];
+                            if (itemId) {
+                                this.itemIdsSentSuccessfully[itemId] = this.itemIdsSentSuccessfully[itemId] || 0;
+                                this.itemIdsSentSuccessfully[itemId]++;
+                                if (this.itemIdsSentSuccessfully[itemId] > 5) {
+                                    this.reportError('[dupe] item ID sent too many times', {
+                                        item: item,
+                                        batchSize: batch.length,
+                                        timesSent: this.itemIdsSentSuccessfully[itemId]
+                                    });
+                                }
+                            } else {
+                                this.reportError('[dupe] found item with no ID while removing', {item: item});
+                            }
+                        }, this));
                     }
 
                 } catch(err) {
@@ -3316,24 +3364,25 @@
     });
 
     /*
-    * Record that you have charged the current user a certain amount
-    * of money. Charges recorded with track_charge() will appear in the
-    * Mixpanel revenue report.
-    *
-    * ### Usage:
-    *
-    *     // charge a user $50
-    *     mixpanel.people.track_charge(50);
-    *
-    *     // charge a user $30.50 on the 2nd of january
-    *     mixpanel.people.track_charge(30.50, {
-    *         '$time': new Date('jan 1 2012')
-    *     });
-    *
-    * @param {Number} amount The amount of money charged to the current user
-    * @param {Object} [properties] An associative array of properties associated with the charge
-    * @param {Function} [callback] If provided, the callback will be called when the server responds
-    */
+     * Record that you have charged the current user a certain amount
+     * of money. Charges recorded with track_charge() will appear in the
+     * Mixpanel revenue report.
+     *
+     * ### Usage:
+     *
+     *     // charge a user $50
+     *     mixpanel.people.track_charge(50);
+     *
+     *     // charge a user $30.50 on the 2nd of january
+     *     mixpanel.people.track_charge(30.50, {
+     *         '$time': new Date('jan 1 2012')
+     *     });
+     *
+     * @param {Number} amount The amount of money charged to the current user
+     * @param {Object} [properties] An associative array of properties associated with the charge
+     * @param {Function} [callback] If provided, the callback will be called when the server responds
+     * @deprecated
+     */
     MixpanelPeople.prototype.track_charge = addOptOutCheckMixpanelPeople(function(amount, properties, callback) {
         if (!_.isNumber(amount)) {
             amount = parseFloat(amount);
@@ -3349,15 +3398,16 @@
     });
 
     /*
-    * Permanently clear all revenue report transactions from the
-    * current user's people analytics profile.
-    *
-    * ### Usage:
-    *
-    *     mixpanel.people.clear_charges();
-    *
-    * @param {Function} [callback] If provided, the callback will be called after tracking the event.
-    */
+     * Permanently clear all revenue report transactions from the
+     * current user's people analytics profile.
+     *
+     * ### Usage:
+     *
+     *     mixpanel.people.clear_charges();
+     *
+     * @param {Function} [callback] If provided, the callback will be called after tracking the event.
+     * @deprecated
+     */
     MixpanelPeople.prototype.clear_charges = function(callback) {
         return this.set('$transactions', [], callback);
     };
@@ -4046,6 +4096,7 @@
     /** @const */ var PRIMARY_INSTANCE_NAME = 'mixpanel';
     /** @const */ var PAYLOAD_TYPE_BASE64   = 'base64';
     /** @const */ var PAYLOAD_TYPE_JSON     = 'json';
+    /** @const */ var DEVICE_ID_PREFIX      = '$device:';
 
 
     /*
@@ -4293,7 +4344,7 @@
             // or the device id if something was already stored
             // in the persitence
             this.register_once({
-                'distinct_id': uuid,
+                'distinct_id': DEVICE_ID_PREFIX + uuid,
                 '$device_id': uuid
             }, '');
         }
@@ -5219,7 +5270,15 @@
         //  _unset_callback:function  A callback to be run if and when the People unset queue is flushed
 
         var previous_distinct_id = this.get_distinct_id();
-        this.register({'$user_id': new_distinct_id});
+        if (new_distinct_id && previous_distinct_id !== new_distinct_id) {
+            // we allow the following condition if previous distinct_id is same as new_distinct_id
+            // so that you can force flush people updates for anonymous profiles.
+            if (typeof new_distinct_id === 'string' && new_distinct_id.indexOf(DEVICE_ID_PREFIX) === 0) {
+                this.report_error('distinct_id cannot have $device: prefix');
+                return -1;
+            }
+            this.register({'$user_id': new_distinct_id});
+        }
 
         if (!this.get_property('$device_id')) {
             // The persisted distinct id might not actually be a device id at all
@@ -5260,7 +5319,7 @@
         this._flags.identify_called = false;
         var uuid = _.UUID();
         this.register_once({
-            'distinct_id': uuid,
+            'distinct_id': DEVICE_ID_PREFIX + uuid,
             '$device_id': uuid
         }, '');
     };
@@ -5385,8 +5444,8 @@
      *       // batching or retry mechanisms.
      *       api_transport: 'XHR'
      *
-     *       // turn on request-batching/queueing/retry
-     *       batch_requests: false,
+     *       // request-batching/queueing/retry
+     *       batch_requests: true,
      *
      *       // maximum number of events/updates to send in a single
      *       // network request