mixpanel-browser 2.45.0 → 2.46.0

package/dist/mixpanel.umd.js

@@ -6,7 +6,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
@@ -2299,6 +2299,9 @@
 
         this.stopped = !this.libConfig['batch_autostart'];
         this.consecutiveRemovalFailures = 0;
+
+        // extra client-side dedupe
+        this.itemIdsSentSuccessfully = {};
     };
 
     /**
@@ -2391,7 +2394,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);
@@ -2474,6 +2504,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) {
@@ -3319,24 +3367,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);
@@ -3352,15 +3401,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);
     };
@@ -4049,6 +4099,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:';
 
 
     /*
@@ -4296,7 +4347,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
             }, '');
         }
@@ -5222,7 +5273,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
@@ -5263,7 +5322,7 @@
         this._flags.identify_called = false;
         var uuid = _.UUID();
         this.register_once({
-            'distinct_id': uuid,
+            'distinct_id': DEVICE_ID_PREFIX + uuid,
             '$device_id': uuid
         }, '');
     };
@@ -5388,8 +5447,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

package/doc/readme.io/javascript-full-api-reference.md

@@ -1,5 +1,5 @@
 ---
-category: 5ae0c2c9fa0ec6000345c0ac
+category: 62ec0192a94ae90a45602b13
 title: JavaScript Full API Reference
 ---
 
@@ -450,8 +450,8 @@ The default config is:
   // 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
@@ -538,14 +538,6 @@ The default config is:
   // the format {'Header-Name': value}
   xhr_headers: {}
 
-  // protocol for fetching in-app message resources, e.g.
-  // 'https://' or 'http://'; defaults to '//' (which defers to the
-  // current page's protocol)
-  inapp_protocol: '//'
-
-  // whether to open in-app message link in new tab/window
-  inapp_link_new_window: false
-
   // whether to ignore or respect the web browser's Do Not Track setting
   ignore_dnt: false
 }
@@ -761,24 +753,6 @@ mixpanel.people.append({
 | **callback** | <span class="mp-arg-type">Function</span></br></span><span class="mp-arg-optional">optional</span> | If provided, the callback will be called after tracking the event. |
 
 
-___
-## mixpanel.people.clear_charges
-Permanently clear all revenue report transactions from the  current user's people analytics profile.
-
-
-### Usage:
-
-```javascript
-mixpanel.people.clear_charges();
-```
-
-
-
-| Argument | Type | Description |
-| ------------- | ------------- | ----- |
-| **callback** | <span class="mp-arg-type">Function</span></br></span><span class="mp-arg-optional">optional</span> | If provided, the callback will be called after tracking the event. |
-
-
 ___
 ## mixpanel.people.delete_user
 Permanently deletes the current people analytics profile from  Mixpanel (using the current distinct_id).
@@ -904,32 +878,6 @@ mixpanel.people.set_once({
 | **callback** | <span class="mp-arg-type">Function</span></br></span><span class="mp-arg-optional">optional</span> | If provided, the callback will be called after tracking the event. |
 
 
-___
-## mixpanel.people.track_charge
-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:
-
-```javascript
-// 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')
-});
-```
-
-
-
-| Argument | Type | Description |
-| ------------- | ------------- | ----- |
-| **amount** | <span class="mp-arg-type">Number</span></br></span><span class="mp-arg-required">required</span> | The amount of money charged to the current user |
-| **properties** | <span class="mp-arg-type">Object</span></br></span><span class="mp-arg-optional">optional</span> | An associative array of properties associated with the charge |
-| **callback** | <span class="mp-arg-type">Function</span></br></span><span class="mp-arg-optional">optional</span> | If provided, the callback will be called when the server responds |
-
-
 ___
 ## mixpanel.people.union
 Merge a given list with a list-valued people analytics property,  excluding duplicate values.

package/doc/template.md

@@ -1,5 +1,5 @@
 ---
-category: 5ae0c2c9fa0ec6000345c0ac
+category: 62ec0192a94ae90a45602b13
 title: JavaScript Full API Reference
 ---
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mixpanel-browser",
-  "version": "2.45.0",
+  "version": "2.46.0",
   "description": "The official Mixpanel JavaScript browser client library",
   "main": "dist/mixpanel.cjs.js",
   "directories": {
@@ -12,7 +12,7 @@
     "build-full": "FULL=1 ./build.sh",
     "build-test-polyfill": "webpack tests/vendor/core-js-polyfills.src.js  tests/vendor/core-js-polyfills.js",
     "dox": "node doc/build-docs.js",
-    "dox-publish": "rdme docs doc/readme.io --key=$RDME_API_KEY --version=1.0",
+    "dox-publish": "rdme docs:single doc/readme.io/javascript-full-api-reference.md --key=$RDME_API_KEY --version=$RDME_DOC_VERSION",
     "integration_test": "echo 'Browse to localhost:3000/tests' && node testServer.js",
     "lint": "eslint ./src",
     "prepublishOnly": "npm run build-dist",
@@ -37,19 +37,19 @@
     "babel-preset-es2015": "6.6.0",
     "babelify": "6.1.2",
     "browserify": "10.2.4",
-    "chai": "3.5.0",
+    "chai": "4.0.0",
     "cookie-parser": "1.3.4",
     "core-js": "3.6.5",
     "dox": "0.9.0",
     "eslint": "4.18.2",
     "express": "4.12.2",
-    "jsdom": "11.12.0",
+    "jsdom": "16.5.0",
     "jsdom-global": "3.0.2",
     "localStorage": "1.0.4",
     "lodash": "4.17.21",
     "mocha": "7.1.1",
     "morgan": "1.9.1",
-    "rdme": "4.0.0",
+    "rdme": "7.5.0",
     "request": "2.88.0",
     "rollup": "0.25.8",
     "rollup-plugin-npm": "1.4.0",

package/src/config.js

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

package/src/mixpanel-core.js

@@ -57,6 +57,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:';
 
 
 /*
@@ -304,7 +305,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
         }, '');
     }
@@ -1230,7 +1231,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
@@ -1271,7 +1280,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
     }, '');
 };
@@ -1396,8 +1405,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/src/mixpanel-people.js

@@ -244,24 +244,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);
@@ -277,15 +278,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);
 };

package/src/request-batcher.js

@@ -1,3 +1,4 @@
+import Config from './config';
 import { RequestQueue } from './request-queue';
 import { console_with_prefix, _ } from './utils'; // eslint-disable-line camelcase
 
@@ -30,6 +31,9 @@ var RequestBatcher = function(storageKey, options) {
 
     this.stopped = !this.libConfig['batch_autostart'];
     this.consecutiveRemovalFailures = 0;
+
+    // extra client-side dedupe
+    this.itemIdsSentSuccessfully = {};
 };
 
 /**
@@ -122,7 +126,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);
@@ -205,6 +236,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) {