mixpanel-browser 2.48.0 → 2.49.0

package/src/loaders/mixpanel-js-wrapper.md

@@ -0,0 +1,114 @@
+# Mixpanel JavaScript SDK wrapper for Google Tag Manager
+The purpose of this wrapper is to provide a JavaScript interface for interacting with the `window.mixpanel` interface.
+
+The wrapper has been designed with [Google Tag Manager](https://tagmanager.google.com) in mind. GTM's [custom templates](https://developers.google.com/tag-manager/templates) offer a way to deploy custom JavaScript without having to resort to Custom HTML tags and with the ability to craft a user interface for the scripts within Google Tag Manager.
+
+However, one of the defining features of custom templates is their [sandboxed JavaScript API](https://developers.google.com/tag-manager/templates/sandboxed-javascript) inventory, which severely restricts what type of browser JavaScript can be executed in the template code.
+
+Mixpanel's [JavaScript SDK](https://developer.mixpanel.com/docs/javascript-full-api-reference) makes use of JavaScript features which are not permitted by the sandbox of GTM's custom templates (e.g. object instances initiated with the `new` keyword, `this` and `prototype`, etc.).
+
+Thus, in order to interact with Mixpanel's JavaScript SDK via Google Tag Manager's custom templates (or any other context where the aforementioned JavaScript features cannot be used), this wrapper is required. [The template loads this wrapper](https://github.com/mixpanel/mixpanel-gtm-template/blob/2f577d826acc7d96d138367db339035b8f9df359/src/template.tpl#L1383) in the sandboxed template code.
+
+# Deployment
+The wrapper is served by the Mixpanel CDN at https://cdn.mxpnl.com/libs/mixpanel-js-wrapper.js
+
+# How it works
+When the wrapper JavaScript is loaded in the browser, the global method `window._mixpanel()` is created for interacting with the wrapper.
+
+This namespace includes all the methods supported by the [JavaScript SDK](https://developer.mixpanel.com/docs/javascript-full-api-reference) with some exceptions (see below). Each method can be invoked by passing the command name as the first argument of the call to `window._mixpanel()`.
+
+If this command name is prefixed with `<string>.`, then `<string>` will be used as the [library name](https://developer.mixpanel.com/docs/javascript-full-api-reference#mixpanelinit). After the command, all additional arguments are processed as arguments to the command method itself.
+
+For example, to dispatch an event named `Add To Cart` using a custom library name, you could use this command:
+
+```
+window._mixpanel(
+    'myTracker.track', // Run the track command and utilize the library name "myTracker"
+    'Add To Cart', // Event name is the first argument to the track command
+    {product_id: 'shirt123'} // (optional) Event parameters are the second argument to the track command
+);
+```
+
+## `group`
+[Link to specification](https://developer.mixpanel.com/docs/javascript-full-api-reference#mixpanelgroup)
+
+Use this command to interact with group properties.
+
+Syntax:
+
+`window._mixpanel('<library_name.>group.<group_command>', ['<group_key>', '<group_id>'], <parameters>)`
+
+Example:
+```
+// Union a property for a group
+window._mixpanel(
+    'group.union',
+    ['my_group_key', 'my_group_id'],
+    'location',
+    ['San Francisco', 'London']
+);
+```
+
+| Parameter name | Description |
+|----------------|-------------|
+| `library_name` | (Optional) target a specific library/instance name with this command |
+| `group_command` | (Required) one of `set`, `set_once`, `remove`, `union`, `unset` |
+| `parameters` | All the parameters you want to submit to the `group` command. |
+
+## `people`
+[Link to specification](https://developer.mixpanel.com/docs/javascript-full-api-reference#mixpanelpeople)
+
+Interact with the people analytics property.
+
+Syntax:
+
+`window._mixpanel('<library_name.>people.<people_command>', <parameters>)`
+
+Example:
+```
+// Set the "gender" property "n/a"
+window._mixpanel(
+    'people.set',
+    'gender',
+    'n/a'
+);
+```
+
+| Parameter name | Description |
+|----------------|-------------|
+| `library_name` | (Optional) target a specific library/instance name with this command |
+| `people_command` | (Required) one of `append`, `clear_charge`, `delete_user`, `increment`, `remove`, `set`, `set_once`, `track_charge`, `union`, `unset` |
+| `parameters` | All the parameters you want to submit to the `people` command. |
+
+## Other commands
+
+All other commands can be sent to the `_mixpanel` interface like this:
+
+`window._mixpanel('<library_name.><command_name>', <parameters>)`
+
+Example:
+
+```
+window._mixpanel(
+    'my_mixpanel.register',
+    {'Account Type': 'Free'}
+);
+```
+
+## Exceptions
+
+Because the wrapper only pipes commands to the actual `window.mixpanel` interface, the wrapper cannot be used for get-methods. So the following commands **are not** supported by the wrapper:
+
+`get_config`
+`get_distinct_id`
+`get_group`
+`get_property`
+`has_opted_in_tracking`
+`has_opted_out_tracking`
+
+The following commands are also disabled due to not being relevant with the wrapper:
+
+`push`
+`init`
+
+Initialization is done with the `window.mixpanel` interface directly, and `push` is already used by the wrapper to forward calls to the main interface.

package/src/mixpanel-core.js

@@ -106,10 +106,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,
@@ -343,8 +345,9 @@ 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);
     }
 };
 
@@ -353,13 +356,26 @@ 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.referrer);
-    if (this.get_config('store_google')) {
-        this.register(_.info.campaignParams(), {persistent: false});
+    if (this.get_config('store_google') && !this.get_config('stop_utm_persistence')) {
+        this.register(_.info.campaignParams());
     }
     if (this.get_config('save_referrer')) {
         this['persistence'].update_referrer_info(document.referrer);
@@ -396,6 +412,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)) {
+        window.addEventListener('popstate', function() {
+            window.dispatchEvent(new Event('mp_locationchange'));
+        });
+        window.addEventListener('hashchange', function() {
+            window.dispatchEvent(new Event('mp_locationchange'));
+        });
+        var nativePushState = window.history.pushState;
+        if (typeof nativePushState === 'function') {
+            window.history.pushState = function(state, unused, url) {
+                nativePushState.call(window.history, state, unused, url);
+                window.dispatchEvent(new Event('mp_locationchange'));
+            };
+        }
+        var nativeReplaceState = window.history.replaceState;
+        if (typeof nativeReplaceState === 'function') {
+            window.history.replaceState = function(state, unused, url) {
+                nativeReplaceState.call(window.history, state, unused, url);
+                window.dispatchEvent(new Event('mp_locationchange'));
+            };
+        }
+        window.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.
@@ -864,7 +929,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,
@@ -1028,10 +1093,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();
@@ -1048,6 +1112,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
@@ -1798,7 +1879,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();
@@ -1838,7 +1919,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();
@@ -1879,7 +1960,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
@@ -1896,7 +1977,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
@@ -1913,7 +1994,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();

package/src/mixpanel-people.js

@@ -57,7 +57,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);

package/src/utils.js

@@ -899,6 +899,7 @@ _.UUID = (function() {
 // sending false tracking data
 var BLOCKED_UA_STRS = [
     'ahrefsbot',
+    'ahrefssiteaudit',
     'baiduspider',
     'bingbot',
     'bingpreview',
@@ -1619,7 +1620,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),
@@ -1627,7 +1635,7 @@ _.info = {
             '$referring_domain': _.info.referringDomain(document.referrer),
             '$device': _.info.device(userAgent)
         }), {
-            '$current_url': win.location.href,
+            '$current_url': _.info.currentUrl(),
             '$browser_version': _.info.browserVersion(userAgent, navigator.vendor, windowOpera),
             '$screen_height': screen.height,
             '$screen_width': screen.width,
@@ -1635,7 +1643,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() {

package/src/loader-globals.js

@@ -1,4 +0,0 @@
-/* eslint camelcase: "off" */
-import { init_from_snippet } from './mixpanel-core';
-
-init_from_snippet();