mixpanel-browser 2.48.1 → 2.50.0

package/dist/mixpanel.cjs.js

@@ -2,16 +2,18 @@
 
 var Config = {
     DEBUG: false,
-    LIB_VERSION: '2.48.1'
+    LIB_VERSION: '2.50.0'
 };
 
+/* eslint camelcase: "off", eqeqeq: "off" */
+
 // since es6 imports are static and we run unit tests from the console, window won't be defined when importing this file
-var window$1;
+var win;
 if (typeof(window) === 'undefined') {
     var loc = {
         hostname: ''
     };
-    window$1 = {
+    win = {
         navigator: { userAgent: '' },
         document: {
             location: loc,
@@ -21,32 +23,37 @@ if (typeof(window) === 'undefined') {
         location: loc
     };
 } else {
-    window$1 = window;
+    win = window;
 }
 
+// Maximum allowed session recording length
+var MAX_RECORDING_MS = 24 * 60 * 60 * 1000; // 24 hours
+
 /*
  * Saved references to long variable names, so that closure compiler can
  * minimize file size.
  */
 
-var ArrayProto = Array.prototype;
-var FuncProto = Function.prototype;
-var ObjProto = Object.prototype;
-var slice = ArrayProto.slice;
-var toString = ObjProto.toString;
-var hasOwnProperty = ObjProto.hasOwnProperty;
-var windowConsole = window$1.console;
-var navigator = window$1.navigator;
-var document$1 = window$1.document;
-var windowOpera = window$1.opera;
-var screen = window$1.screen;
-var userAgent = navigator.userAgent;
-var nativeBind = FuncProto.bind;
-var nativeForEach = ArrayProto.forEach;
-var nativeIndexOf = ArrayProto.indexOf;
-var nativeMap = ArrayProto.map;
-var nativeIsArray = Array.isArray;
-var breaker = {};
+var ArrayProto = Array.prototype,
+    FuncProto = Function.prototype,
+    ObjProto = Object.prototype,
+    slice = ArrayProto.slice,
+    toString = ObjProto.toString,
+    hasOwnProperty = ObjProto.hasOwnProperty,
+    windowConsole = win.console,
+    navigator = win.navigator,
+    document$1 = win.document,
+    windowOpera = win.opera,
+    screen = win.screen,
+    userAgent = navigator.userAgent;
+
+var nativeBind = FuncProto.bind,
+    nativeForEach = ArrayProto.forEach,
+    nativeIndexOf = ArrayProto.indexOf,
+    nativeMap = ArrayProto.map,
+    nativeIsArray = Array.isArray,
+    breaker = {};
+
 var _ = {
     trim: function(str) {
         // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/Trim#Polyfill
@@ -836,8 +843,8 @@ _.UUID = (function() {
     var T = function() {
         var time = 1 * new Date(); // cross-browser version of Date.now()
         var ticks;
-        if (window$1.performance && window$1.performance.now) {
-            ticks = window$1.performance.now();
+        if (win.performance && win.performance.now) {
+            ticks = win.performance.now();
         } else {
             // fall back to busy loop
             ticks = 0;
@@ -901,6 +908,7 @@ _.UUID = (function() {
 // sending false tracking data
 var BLOCKED_UA_STRS = [
     'ahrefsbot',
+    'ahrefssiteaudit',
     'baiduspider',
     'bingbot',
     'bingpreview',
@@ -1621,7 +1629,14 @@ _.info = {
         return '';
     },
 
-    properties: function() {
+    currentUrl: function() {
+        return win.location.href;
+    },
+
+    properties: function(extra_props) {
+        if (typeof extra_props !== 'object') {
+            extra_props = {};
+        }
         return _.extend(_.strip_empty_properties({
             '$os': _.info.os(),
             '$browser': _.info.browser(userAgent, navigator.vendor, windowOpera),
@@ -1629,7 +1644,7 @@ _.info = {
             '$referring_domain': _.info.referringDomain(document$1.referrer),
             '$device': _.info.device(userAgent)
         }), {
-            '$current_url': window$1.location.href,
+            '$current_url': _.info.currentUrl(),
             '$browser_version': _.info.browserVersion(userAgent, navigator.vendor, windowOpera),
             '$screen_height': screen.height,
             '$screen_width': screen.width,
@@ -1637,7 +1652,7 @@ _.info = {
             '$lib_version': Config.LIB_VERSION,
             '$insert_id': cheap_guid(),
             'time': _.timestamp() / 1000 // epoch time in seconds
-        });
+        }, _.strip_empty_properties(extra_props));
     },
 
     people_properties: function() {
@@ -1652,10 +1667,10 @@ _.info = {
     mpPageViewProperties: function() {
         return _.strip_empty_properties({
             'current_page_title': document$1.title,
-            'current_domain': window$1.location.hostname,
-            'current_url_path': window$1.location.pathname,
-            'current_url_protocol': window$1.location.protocol,
-            'current_url_search': window$1.location.search
+            'current_domain': win.location.hostname,
+            'current_url_path': win.location.pathname,
+            'current_url_protocol': win.location.protocol,
+            'current_url_search': win.location.search
         });
     }
 };
@@ -1693,8 +1708,7 @@ var extract_domain = function(hostname) {
     return matches ? matches[0] : '';
 };
 
-var JSONStringify = null;
-var JSONParse = null;
+var JSONStringify = null, JSONParse = null;
 if (typeof JSON !== 'undefined') {
     JSONStringify = JSON.stringify;
     JSONParse = JSON.parse;
@@ -1715,6 +1729,8 @@ _['info']['browser']        = _.info.browser;
 _['info']['browserVersion'] = _.info.browserVersion;
 _['info']['properties']     = _.info.properties;
 
+/* eslint camelcase: "off" */
+
 /**
  * DomTracker Object
  * @constructor
@@ -1864,8 +1880,6 @@ FormTracker.prototype.after_track_handler = function(props, options) {
     }, 0);
 };
 
-// eslint-disable-line camelcase
-
 var logger$2 = console_with_prefix('lock');
 
 /**
@@ -2012,8 +2026,6 @@ SharedLock.prototype.withLock = function(lockedCB, errorCB, pid) {
     }
 };
 
-// eslint-disable-line camelcase
-
 var logger$1 = console_with_prefix('batch');
 
 /**
@@ -2291,8 +2303,6 @@ RequestQueue.prototype.clear = function() {
     this.storage.removeItem(this.storageKey);
 };
 
-// eslint-disable-line camelcase
-
 // maximum interval between request retries after exponential backoff
 var MAX_RETRY_INTERVAL_MS = 10 * 60 * 1000; // 10 minutes
 
@@ -2587,6 +2597,19 @@ RequestBatcher.prototype.reportError = function(msg, err) {
     }
 };
 
+/**
+ * GDPR utils
+ *
+ * The General Data Protection Regulation (GDPR) is a regulation in EU law on data protection
+ * and privacy for all individuals within the European Union. It addresses the export of personal
+ * data outside the EU. The GDPR aims primarily to give control back to citizens and residents
+ * over their personal data and to simplify the regulatory environment for international business
+ * by unifying the regulation within the EU.
+ *
+ * This set of utilities is intended to enable opt in/out functionality in the Mixpanel JS SDK.
+ * These functions are used internally by the SDK and are not intended to be publicly exposed.
+ */
+
 /**
  * A function used to track a Mixpanel event (e.g. MixpanelLib.track)
  * @callback trackFunction
@@ -2772,14 +2795,14 @@ function _hasDoNotTrackFlagOn(options) {
     if (options && options.ignoreDnt) {
         return false;
     }
-    var win = (options && options.window) || window$1;
-    var nav = win['navigator'] || {};
+    var win$1 = (options && options.window) || win;
+    var nav = win$1['navigator'] || {};
     var hasDntOn = false;
 
     _.each([
         nav['doNotTrack'], // standard
         nav['msDoNotTrack'],
-        win['doNotTrack']
+        win$1['doNotTrack']
     ], function(dntValue) {
         if (_.includes([true, 1, '1', 'yes'], dntValue)) {
             hasDntOn = true;
@@ -2873,6 +2896,8 @@ function _addOptOutCheck(method, getConfigValue) {
     };
 }
 
+/* eslint camelcase: "off" */
+
 /** @const */ var SET_ACTION      = '$set';
 /** @const */ var SET_ONCE_ACTION = '$set_once';
 /** @const */ var UNSET_ACTION    = '$unset';
@@ -2990,6 +3015,8 @@ var apiActions = {
     }
 };
 
+/* eslint camelcase: "off" */
+
 /**
  * Mixpanel Group Object
  * @constructor
@@ -3158,6 +3185,8 @@ MixpanelGroup.prototype['union']    = MixpanelGroup.prototype.union;
 MixpanelGroup.prototype['unset']    = MixpanelGroup.prototype.unset;
 MixpanelGroup.prototype['toString'] = MixpanelGroup.prototype.toString;
 
+/* eslint camelcase: "off" */
+
 /**
  * Mixpanel People Object
  * @constructor
@@ -3203,7 +3232,6 @@ MixpanelPeople.prototype.set = addOptOutCheckMixpanelPeople(function(prop, to, c
     data[SET_ACTION] = _.extend(
         {},
         _.info.people_properties(),
-        this._mixpanel['persistence'].get_referrer_info(),
         data[SET_ACTION]
     );
     return this._send_request(data, callback);
@@ -3627,6 +3655,8 @@ MixpanelPeople.prototype['clear_charges'] = MixpanelPeople.prototype.clear_charg
 MixpanelPeople.prototype['delete_user']   = MixpanelPeople.prototype.delete_user;
 MixpanelPeople.prototype['toString']      = MixpanelPeople.prototype.toString;
 
+/* eslint camelcase: "off" */
+
 /*
  * Constants
  */
@@ -4076,6 +4106,8 @@ MixpanelPersistence.prototype.remove_event_timer = function(event_name) {
     return timestamp;
 };
 
+/* eslint camelcase: "off" */
+
 /*
  * Mixpanel JS Library
  *
@@ -4122,7 +4154,7 @@ var NOOP_FUNC = function() {};
  */
 // http://hacks.mozilla.org/2009/07/cross-site-xmlhttprequest-with-cors/
 // https://developer.mozilla.org/en-US/docs/DOM/XMLHttpRequest#withCredentials
-var USE_XHR = (window$1.XMLHttpRequest && 'withCredentials' in new XMLHttpRequest());
+var USE_XHR = (win.XMLHttpRequest && 'withCredentials' in new XMLHttpRequest());
 
 // IE<10 does not support cross-origin XHR's but script tags
 // with defer won't block window.onload; ENQUEUE_REQUESTS
@@ -4141,7 +4173,8 @@ if (navigator['sendBeacon']) {
 var DEFAULT_API_ROUTES = {
     'track': 'track/',
     'engage': 'engage/',
-    'groups': 'groups/'
+    'groups': 'groups/',
+    'record': 'record/'
 };
 
 /*
@@ -4163,10 +4196,12 @@ var DEFAULT_CONFIG = {
     'cookie_domain':                     '',
     'cookie_name':                       '',
     'loaded':                            NOOP_FUNC,
+    'mp_loader':                         null,
     'track_marketing':                   true,
     'track_pageview':                    false,
     'skip_first_touch_marketing':        false,
     'store_google':                      true,
+    'stop_utm_persistence':              false,
     'save_referrer':                     true,
     'test':                              false,
     'verbose':                           false,
@@ -4191,7 +4226,12 @@ var DEFAULT_CONFIG = {
     'batch_flush_interval_ms':           5000,
     'batch_request_timeout_ms':          90000,
     'batch_autostart':                   true,
-    'hooks':                             {}
+    'hooks':                             {},
+    'record_sessions_percent':           0,
+    'record_idle_timeout_ms':            30 * 60 * 1000, // 30 minutes
+    'record_max_ms':                     MAX_RECORDING_MS,
+    'record_mask_text_selector':         '*',
+    'recorder_src':                      'https://cdn.mxpnl.com/libs/mixpanel-recorder.min.js'
 };
 
 var DOM_LOADED = false;
@@ -4354,7 +4394,7 @@ MixpanelLib.prototype._init = function(token, config, name) {
             });
         } else {
             this.init_batchers();
-            if (sendBeacon && window$1.addEventListener) {
+            if (sendBeacon && win.addEventListener) {
                 // Before page closes or hides (user tabs away etc), attempt to flush any events
                 // queued up via navigator.sendBeacon. Since sendBeacon doesn't report success/failure,
                 // events will not be removed from the persistent store; if the site is loaded again,
@@ -4371,12 +4411,12 @@ MixpanelLib.prototype._init = function(token, config, name) {
                         this.request_batchers.events.flush({unloading: true});
                     }
                 }, this);
-                window$1.addEventListener('pagehide', function(ev) {
+                win.addEventListener('pagehide', function(ev) {
                     if (ev['persisted']) {
                         flush_on_unload();
                     }
                 });
-                window$1.addEventListener('visibilitychange', function() {
+                win.addEventListener('visibilitychange', function() {
                     if (document$1['visibilityState'] === 'hidden') {
                         flush_on_unload();
                     }
@@ -4400,8 +4440,44 @@ MixpanelLib.prototype._init = function(token, config, name) {
         }, '');
     }
 
-    if (this.get_config('track_pageview')) {
-        this.track_pageview();
+    var track_pageview_option = this.get_config('track_pageview');
+    if (track_pageview_option) {
+        this._init_url_change_tracking(track_pageview_option);
+    }
+
+    if (this.get_config('record_sessions_percent') > 0 && Math.random() * 100 <= this.get_config('record_sessions_percent')) {
+        this.start_session_recording();
+    }
+};
+
+MixpanelLib.prototype.start_session_recording = addOptOutCheckMixpanelLib(function () {
+    if (!win['MutationObserver']) {
+        console.critical('Browser does not support MutationObserver; skipping session recording');
+        return;
+    }
+
+    var handleLoadedRecorder = _.bind(function() {
+        this._recorder = this._recorder || new win['__mp_recorder'](this);
+        this._recorder['startRecording']();
+    }, this);
+
+    if (_.isUndefined(win['__mp_recorder'])) {
+        var scriptEl = document$1.createElement('script');
+        scriptEl.type = 'text/javascript';
+        scriptEl.async = true;
+        scriptEl.onload = handleLoadedRecorder;
+        scriptEl.src = this.get_config('recorder_src');
+        document$1.head.appendChild(scriptEl);
+    } else {
+        handleLoadedRecorder();
+    }
+});
+
+MixpanelLib.prototype.stop_session_recording = function () {
+    if (this._recorder) {
+        this._recorder['stopRecording']();
+    } else {
+        console.critical('Session recorder module not loaded');
     }
 };
 
@@ -4410,12 +4486,25 @@ MixpanelLib.prototype._init = function(token, config, name) {
 MixpanelLib.prototype._loaded = function() {
     this.get_config('loaded')(this);
     this._set_default_superprops();
+    this['people'].set_once(this['persistence'].get_referrer_info());
+
+    // The original 'store_google' functionality will be deprecated and the config will be
+    // used to clear previously managed UTM parameters from persistence.
+    // stop_utm_persistence is `false` by default now but will be default `true` in the future.
+    if (this.get_config('store_google') && this.get_config('stop_utm_persistence')) {
+        var utm_params = _.info.campaignParams(null);
+        _.each(utm_params, function(_utm_value, utm_key) {
+            // We need to unregister persisted UTM parameters so old values
+            // are not mixed with the new UTM parameters
+            this.unregister(utm_key);
+        }.bind(this));
+    }
 };
 
 // update persistence with info on referrer, UTM params, etc
 MixpanelLib.prototype._set_default_superprops = function() {
     this['persistence'].update_search_keyword(document$1.referrer);
-    if (this.get_config('store_google')) {
+    if (this.get_config('store_google') && !this.get_config('stop_utm_persistence')) {
         this.register(_.info.campaignParams());
     }
     if (this.get_config('save_referrer')) {
@@ -4453,6 +4542,55 @@ MixpanelLib.prototype._track_dom = function(DomClass, args) {
     return dt.track.apply(dt, args);
 };
 
+MixpanelLib.prototype._init_url_change_tracking = function(track_pageview_option) {
+    var previous_tracked_url = '';
+    var tracked = this.track_pageview();
+    if (tracked) {
+        previous_tracked_url = _.info.currentUrl();
+    }
+
+    if (_.include(['full-url', 'url-with-path-and-query-string', 'url-with-path'], track_pageview_option)) {
+        win.addEventListener('popstate', function() {
+            win.dispatchEvent(new Event('mp_locationchange'));
+        });
+        win.addEventListener('hashchange', function() {
+            win.dispatchEvent(new Event('mp_locationchange'));
+        });
+        var nativePushState = win.history.pushState;
+        if (typeof nativePushState === 'function') {
+            win.history.pushState = function(state, unused, url) {
+                nativePushState.call(win.history, state, unused, url);
+                win.dispatchEvent(new Event('mp_locationchange'));
+            };
+        }
+        var nativeReplaceState = win.history.replaceState;
+        if (typeof nativeReplaceState === 'function') {
+            win.history.replaceState = function(state, unused, url) {
+                nativeReplaceState.call(win.history, state, unused, url);
+                win.dispatchEvent(new Event('mp_locationchange'));
+            };
+        }
+        win.addEventListener('mp_locationchange', function() {
+            var current_url = _.info.currentUrl();
+            var should_track = false;
+            if (track_pageview_option === 'full-url') {
+                should_track = current_url !== previous_tracked_url;
+            } else if (track_pageview_option === 'url-with-path-and-query-string') {
+                should_track = current_url.split('#')[0] !== previous_tracked_url.split('#')[0];
+            } else if (track_pageview_option === 'url-with-path') {
+                should_track = current_url.split('#')[0].split('?')[0] !== previous_tracked_url.split('#')[0].split('?')[0];
+            }
+
+            if (should_track) {
+                var tracked = this.track_pageview();
+                if (tracked) {
+                    previous_tracked_url = current_url;
+                }
+            }
+        }.bind(this));
+    }
+};
+
 /**
  * _prepare_callback() should be called by callers of _send_request for use
  * as the callback argument.
@@ -4914,6 +5052,13 @@ MixpanelLib.prototype.track = addOptOutCheckMixpanelLib(function(event_name, pro
         ? _.info.marketingParams()
         : {};
 
+    if (this._recorder) {
+        var replay_id = this._recorder['replayId'];
+        if (replay_id) {
+            properties['$mp_replay_id'] = replay_id;
+        }
+    }
+
     // note: extend writes to the first object, so lets make sure we
     // don't write to the persistence properties object and info
     // properties object by passing in a new object
@@ -4921,7 +5066,7 @@ MixpanelLib.prototype.track = addOptOutCheckMixpanelLib(function(event_name, pro
     // update properties with pageview info and super-properties
     properties = _.extend(
         {},
-        _.info.properties(),
+        _.info.properties({'mp_loader': this.get_config('mp_loader')}),
         marketing_properties,
         this['persistence'].properties(),
         this.unpersisted_superprops,
@@ -5085,10 +5230,9 @@ MixpanelLib.prototype.get_group = function (group_key, group_id) {
 
 /**
  * Track a default Mixpanel page view event, which includes extra default event properties to
- * improve page view data. The `config.track_pageview` option for <a href="#mixpanelinit">mixpanel.init()</a>
- * may be turned on for tracking page loads automatically.
+ * improve page view data.
  *
- * ### Usage
+ * ### Usage:
  *
  *     // track a default $mp_web_page_view event
  *     mixpanel.track_pageview();
@@ -5105,6 +5249,23 @@ MixpanelLib.prototype.get_group = function (group_key, group_id) {
  *     // views on different products or internal applications that are considered completely separate
  *     mixpanel.track_pageview({'page': 'customer-search'}, {'event_name': '[internal] Admin Page View'});
  *
+ * ### Notes:
+ *
+ * The `config.track_pageview` option for <a href="#mixpanelinit">mixpanel.init()</a>
+ * may be turned on for tracking page loads automatically.
+ *
+ *     // track only page loads
+ *     mixpanel.init(PROJECT_TOKEN, {track_pageview: true});
+ *
+ *     // track when the URL changes in any manner
+ *     mixpanel.init(PROJECT_TOKEN, {track_pageview: 'full-url'});
+ *
+ *     // track when the URL changes, ignoring any changes in the hash part
+ *     mixpanel.init(PROJECT_TOKEN, {track_pageview: 'url-with-path-and-query-string'});
+ *
+ *     // track when the path changes, ignoring any query parameter or hash changes
+ *     mixpanel.init(PROJECT_TOKEN, {track_pageview: 'url-with-path'});
+ *
  * @param {Object} [properties] An optional set of additional properties to send with the page view event
  * @param {Object} [options] Page view tracking options
  * @param {String} [options.event_name] - Alternate name for the tracking event
@@ -5855,7 +6016,7 @@ MixpanelLib.prototype._gdpr_call_func = function(func, options) {
 /**
  * Opt the user in to data tracking and cookies/localstorage for this Mixpanel instance
  *
- * ### Usage
+ * ### Usage:
  *
  *     // opt user in
  *     mixpanel.opt_in_tracking();
@@ -5895,7 +6056,7 @@ MixpanelLib.prototype.opt_in_tracking = function(options) {
 /**
  * Opt the user out of data tracking and cookies/localstorage for this Mixpanel instance
  *
- * ### Usage
+ * ### Usage:
  *
  *     // opt user out
  *     mixpanel.opt_out_tracking();
@@ -5936,7 +6097,7 @@ MixpanelLib.prototype.opt_out_tracking = function(options) {
 /**
  * Check whether the user has opted in to data tracking and cookies/localstorage for this Mixpanel instance
  *
- * ### Usage
+ * ### Usage:
  *
  *     var has_opted_in = mixpanel.has_opted_in_tracking();
  *     // use has_opted_in value
@@ -5953,7 +6114,7 @@ MixpanelLib.prototype.has_opted_in_tracking = function(options) {
 /**
  * Check whether the user has opted out of data tracking and cookies/localstorage for this Mixpanel instance
  *
- * ### Usage
+ * ### Usage:
  *
  *     var has_opted_out = mixpanel.has_opted_out_tracking();
  *     // use has_opted_out value
@@ -5970,7 +6131,7 @@ MixpanelLib.prototype.has_opted_out_tracking = function(options) {
 /**
  * Clear the user's opt in/out status of data tracking and cookies/localstorage for this Mixpanel instance
  *
- * ### Usage
+ * ### Usage:
  *
  *     // clear user's opt-in/out status
  *     mixpanel.clear_opt_in_out_tracking();
@@ -6047,6 +6208,8 @@ MixpanelLib.prototype['remove_group']              = MixpanelLib.prototype.remov
 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['start_session_recording']   = MixpanelLib.prototype.start_session_recording;
+MixpanelLib.prototype['stop_session_recording']    = MixpanelLib.prototype.stop_session_recording;
 MixpanelLib.prototype['DEFAULT_API_ROUTES']        = DEFAULT_API_ROUTES;
 
 // MixpanelPersistence Exports
@@ -6094,7 +6257,7 @@ var override_mp_init_func = function() {
 
             mixpanel_master = instance;
             if (init_type === INIT_SNIPPET) {
-                window$1[PRIMARY_INSTANCE_NAME] = mixpanel_master;
+                win[PRIMARY_INSTANCE_NAME] = mixpanel_master;
             }
             extend_mp();
         }
@@ -6144,7 +6307,7 @@ var add_dom_loaded_handler = function() {
         // check to make sure we arn't in a frame
         var toplevel = false;
         try {
-            toplevel = window$1.frameElement === null;
+            toplevel = win.frameElement === null;
         } catch(e) {
             // noop
         }
@@ -6155,7 +6318,7 @@ var add_dom_loaded_handler = function() {
     }
 
     // fallback handler, always will work
-    _.register_event(window$1, 'load', dom_loaded_handler, true);
+    _.register_event(win, 'load', dom_loaded_handler, true);
 };
 
 function init_as_module() {
@@ -6169,6 +6332,8 @@ function init_as_module() {
     return mixpanel_master;
 }
 
+/* eslint camelcase: "off" */
+
 var mixpanel = init_as_module();
 
-module.exports = mixpanel;
+module.exports = mixpanel;