mixpanel-browser 2.67.0 → 2.68.0

package/dist/mixpanel-with-async-recorder.cjs.js

@@ -2,7 +2,7 @@
 
 var Config = {
     DEBUG: false,
-    LIB_VERSION: '2.67.0'
+    LIB_VERSION: '2.68.0'
 };
 
 // since es6 imports are static and we run unit tests from the console, window won't be defined when importing this file
@@ -2654,6 +2654,38 @@ function shouldTrackValue(value) {
     return true;
 }
 
+/** @const */ var DEFAULT_RAGE_CLICK_THRESHOLD_PX = 30;
+/** @const */ var DEFAULT_RAGE_CLICK_TIMEOUT_MS = 1000;
+/** @const */ var DEFAULT_RAGE_CLICK_CLICK_COUNT = 4;
+
+function RageClickTracker() {
+    this.clicks = [];
+}
+
+RageClickTracker.prototype.isRageClick = function(x, y, options) {
+    options = options || {};
+    var thresholdPx = options['threshold_px'] || DEFAULT_RAGE_CLICK_THRESHOLD_PX;
+    var timeoutMs = options['timeout_ms'] || DEFAULT_RAGE_CLICK_TIMEOUT_MS;
+    var clickCount = options['click_count'] || DEFAULT_RAGE_CLICK_CLICK_COUNT;
+    var timestamp = Date.now();
+
+    var lastClick = this.clicks[this.clicks.length - 1];
+    if (
+        lastClick &&
+        timestamp - lastClick.timestamp < timeoutMs &&
+        Math.sqrt(Math.pow(x - lastClick.x, 2) + Math.pow(y - lastClick.y, 2)) < thresholdPx
+    ) {
+        this.clicks.push({ x: x, y: y, timestamp: timestamp });
+        if (this.clicks.length >= clickCount) {
+            this.clicks = [];
+            return true;
+        }
+    } else {
+        this.clicks = [{ x: x, y: y, timestamp: timestamp }];
+    }
+    return false;
+};
+
 var AUTOCAPTURE_CONFIG_KEY = 'autocapture';
 var LEGACY_PAGEVIEW_CONFIG_KEY = 'track_pageview';
 
@@ -2675,6 +2707,7 @@ var CONFIG_SCROLL_CHECKPOINTS = 'scroll_depth_percent_checkpoints';
 var CONFIG_TRACK_CLICK = 'click';
 var CONFIG_TRACK_INPUT = 'input';
 var CONFIG_TRACK_PAGEVIEW = 'pageview';
+var CONFIG_TRACK_RAGE_CLICK = 'rage_click';
 var CONFIG_TRACK_SCROLL = 'scroll';
 var CONFIG_TRACK_SUBMIT = 'submit';
 
@@ -2692,6 +2725,7 @@ CONFIG_DEFAULTS$1[CONFIG_SCROLL_CHECKPOINTS] = [25, 50, 75, 100];
 CONFIG_DEFAULTS$1[CONFIG_TRACK_CLICK] = true;
 CONFIG_DEFAULTS$1[CONFIG_TRACK_INPUT] = true;
 CONFIG_DEFAULTS$1[CONFIG_TRACK_PAGEVIEW] = PAGEVIEW_OPTION_FULL_URL;
+CONFIG_DEFAULTS$1[CONFIG_TRACK_RAGE_CLICK] = true;
 CONFIG_DEFAULTS$1[CONFIG_TRACK_SCROLL] = true;
 CONFIG_DEFAULTS$1[CONFIG_TRACK_SUBMIT] = true;
 
@@ -2701,6 +2735,7 @@ var DEFAULT_PROPS = {
 
 var MP_EV_CLICK = '$mp_click';
 var MP_EV_INPUT = '$mp_input_change';
+var MP_EV_RAGE_CLICK = '$mp_rage_click';
 var MP_EV_SCROLL = '$mp_scroll';
 var MP_EV_SUBMIT = '$mp_submit';
 
@@ -2723,6 +2758,7 @@ Autocapture.prototype.init = function() {
     this.initInputTracking();
     this.initScrollTracking();
     this.initSubmitTracking();
+    this.initRageClickTracking();
 };
 
 Autocapture.prototype.getFullConfig = function() {
@@ -2801,6 +2837,11 @@ Autocapture.prototype.trackDomEvent = function(ev, mpEventName) {
         return;
     }
 
+    var isCapturedForHeatMap = this.mp.is_recording_heatmap_data() && (
+        (mpEventName === MP_EV_CLICK && !this.getConfig(CONFIG_TRACK_CLICK)) ||
+        (mpEventName === MP_EV_RAGE_CLICK && !this._getRageClickConfig())
+    );
+
     var props = getPropsForDOMEvent(ev, {
         allowElementCallback: this.getConfig(CONFIG_ALLOW_ELEMENT_CALLBACK),
         allowSelectors: this.getConfig(CONFIG_ALLOW_SELECTORS),
@@ -2809,7 +2850,7 @@ Autocapture.prototype.trackDomEvent = function(ev, mpEventName) {
         blockSelectors: this.getConfig(CONFIG_BLOCK_SELECTORS),
         captureExtraAttrs: this.getConfig(CONFIG_CAPTURE_EXTRA_ATTRS),
         captureTextContent: this.getConfig(CONFIG_CAPTURE_TEXT_CONTENT),
-        capturedForHeatMap: mpEventName === MP_EV_CLICK && !this.getConfig(CONFIG_TRACK_CLICK) && this.mp.is_recording_heatmap_data(),
+        capturedForHeatMap: isCapturedForHeatMap,
     });
     if (props) {
         _.extend(props, DEFAULT_PROPS);
@@ -2817,6 +2858,24 @@ Autocapture.prototype.trackDomEvent = function(ev, mpEventName) {
     }
 };
 
+Autocapture.prototype._getRageClickConfig = function() {
+    var config = this.getConfig(CONFIG_TRACK_RAGE_CLICK);
+
+    if (!config) {
+        return null; // rage click tracking disabled
+    }
+
+    if (config === true) {
+        return {}; // use defaults
+    }
+
+    if (typeof config === 'object') {
+        return config; // use custom configuration
+    }
+
+    return {}; // fallback to defaults for any other truthy value
+};
+
 Autocapture.prototype.initClickTracking = function() {
     win.removeEventListener(EV_CLICK, this.listenerClick);
 
@@ -2918,6 +2977,36 @@ Autocapture.prototype.initPageviewTracking = function() {
     }.bind(this)));
 };
 
+Autocapture.prototype.initRageClickTracking = function() {
+    win.removeEventListener(EV_CLICK, this.listenerRageClick);
+
+    var rageClickConfig = this._getRageClickConfig();
+    if (!rageClickConfig && !this.mp.get_config('record_heatmap_data')) {
+        return;
+    }
+
+    logger$4.log('Initializing rage click tracking');
+    if (!this._rageClickTracker) {
+        this._rageClickTracker = new RageClickTracker();
+    }
+
+    this.listenerRageClick = function(ev) {
+        var currentRageClickConfig = this._getRageClickConfig();
+        if (!currentRageClickConfig && !this.mp.is_recording_heatmap_data()) {
+            return;
+        }
+
+        if (this.currentUrlBlocked()) {
+            return;
+        }
+
+        if (this._rageClickTracker.isRageClick(ev['pageX'], ev['pageY'], currentRageClickConfig)) {
+            this.trackDomEvent(ev, MP_EV_RAGE_CLICK);
+        }
+    }.bind(this);
+    win.addEventListener(EV_CLICK, this.listenerRageClick);
+};
+
 Autocapture.prototype.initScrollTracking = function() {
     win.removeEventListener(EV_SCROLLEND, this.listenerScroll);
 
@@ -3004,6 +3093,7 @@ CONFIG_DEFAULTS[CONFIG_CONTEXT] = {};
 var FeatureFlagManager = function(initOptions) {
     this.getFullApiRoute = initOptions.getFullApiRoute;
     this.getMpConfig = initOptions.getConfigFunc;
+    this.setMpConfig = initOptions.setConfigFunc;
     this.getMpProperty = initOptions.getPropertyFunc;
     this.track = initOptions.trackingFunc;
 };
@@ -3041,6 +3131,23 @@ FeatureFlagManager.prototype.isSystemEnabled = function() {
     return !!this.getMpConfig(FLAGS_CONFIG_KEY);
 };
 
+FeatureFlagManager.prototype.updateContext = function(newContext, options) {
+    if (!this.isSystemEnabled()) {
+        logger$3.critical('Feature Flags not enabled, cannot update context');
+        return Promise.resolve();
+    }
+
+    var ffConfig = this.getMpConfig(FLAGS_CONFIG_KEY);
+    if (!_.isObject(ffConfig)) {
+        ffConfig = {};
+    }
+    var oldContext = (options && options['replace']) ? {} : this.getConfig(CONFIG_CONTEXT);
+    ffConfig[CONFIG_CONTEXT] = _.extend({}, oldContext, newContext);
+
+    this.setMpConfig(FLAGS_CONFIG_KEY, ffConfig);
+    return this.fetchFlags();
+};
+
 FeatureFlagManager.prototype.areFlagsReady = function() {
     if (!this.isSystemEnabled()) {
         logger$3.error('Feature Flags not enabled');
@@ -3050,7 +3157,7 @@ FeatureFlagManager.prototype.areFlagsReady = function() {
 
 FeatureFlagManager.prototype.fetchFlags = function() {
     if (!this.isSystemEnabled()) {
-        return;
+        return Promise.resolve();
     }
 
     var distinctId = this.getMpProperty('distinct_id');
@@ -3090,6 +3197,8 @@ FeatureFlagManager.prototype.fetchFlags = function() {
         this.markFetchComplete();
         logger$3.error(error);
     }.bind(this));
+
+    return this.fetchPromise;
 };
 
 FeatureFlagManager.prototype.markFetchComplete = function() {
@@ -3202,6 +3311,7 @@ FeatureFlagManager.prototype['get_variant_value'] = FeatureFlagManager.prototype
 FeatureFlagManager.prototype['get_variant_value_sync'] = FeatureFlagManager.prototype.getVariantValueSync;
 FeatureFlagManager.prototype['is_enabled'] = FeatureFlagManager.prototype.isEnabled;
 FeatureFlagManager.prototype['is_enabled_sync'] = FeatureFlagManager.prototype.isEnabledSync;
+FeatureFlagManager.prototype['update_context'] = FeatureFlagManager.prototype.updateContext;
 
 // Deprecated method
 FeatureFlagManager.prototype['get_feature_data'] = FeatureFlagManager.prototype.getFeatureData;
@@ -5973,7 +6083,7 @@ var DEFAULT_CONFIG = {
     'batch_autostart':                   true,
     'hooks':                             {},
     'record_block_class':                new RegExp('^(mp-block|fs-exclude|amp-block|rr-block|ph-no-capture)$'),
-    'record_block_selector':             'img, video',
+    'record_block_selector':             'img, video, audio',
     'record_canvas':                     false,
     'record_collect_fonts':              false,
     'record_heatmap_data':               false,
@@ -6197,6 +6307,7 @@ MixpanelLib.prototype._init = function(token, config, name) {
             return this.get_api_host('flags') + '/' + this.get_config('api_routes')['flags'];
         }, this),
         getConfigFunc: _.bind(this.get_config, this),
+        setConfigFunc: _.bind(this.set_config, this),
         getPropertyFunc: _.bind(this.get_property, this),
         trackingFunc: _.bind(this.track, this)
     });

package/dist/mixpanel-with-recorder.js

@@ -13945,7 +13945,7 @@
 
     var Config = {
         DEBUG: false,
-        LIB_VERSION: '2.67.0'
+        LIB_VERSION: '2.68.0'
     };
 
     /* eslint camelcase: "off", eqeqeq: "off" */
@@ -18230,6 +18230,38 @@
         return true;
     }
 
+    /** @const */ var DEFAULT_RAGE_CLICK_THRESHOLD_PX = 30;
+    /** @const */ var DEFAULT_RAGE_CLICK_TIMEOUT_MS = 1000;
+    /** @const */ var DEFAULT_RAGE_CLICK_CLICK_COUNT = 4;
+
+    function RageClickTracker() {
+        this.clicks = [];
+    }
+
+    RageClickTracker.prototype.isRageClick = function(x, y, options) {
+        options = options || {};
+        var thresholdPx = options['threshold_px'] || DEFAULT_RAGE_CLICK_THRESHOLD_PX;
+        var timeoutMs = options['timeout_ms'] || DEFAULT_RAGE_CLICK_TIMEOUT_MS;
+        var clickCount = options['click_count'] || DEFAULT_RAGE_CLICK_CLICK_COUNT;
+        var timestamp = Date.now();
+
+        var lastClick = this.clicks[this.clicks.length - 1];
+        if (
+            lastClick &&
+            timestamp - lastClick.timestamp < timeoutMs &&
+            Math.sqrt(Math.pow(x - lastClick.x, 2) + Math.pow(y - lastClick.y, 2)) < thresholdPx
+        ) {
+            this.clicks.push({ x: x, y: y, timestamp: timestamp });
+            if (this.clicks.length >= clickCount) {
+                this.clicks = [];
+                return true;
+            }
+        } else {
+            this.clicks = [{ x: x, y: y, timestamp: timestamp }];
+        }
+        return false;
+    };
+
     var AUTOCAPTURE_CONFIG_KEY = 'autocapture';
     var LEGACY_PAGEVIEW_CONFIG_KEY = 'track_pageview';
 
@@ -18251,6 +18283,7 @@
     var CONFIG_TRACK_CLICK = 'click';
     var CONFIG_TRACK_INPUT = 'input';
     var CONFIG_TRACK_PAGEVIEW = 'pageview';
+    var CONFIG_TRACK_RAGE_CLICK = 'rage_click';
     var CONFIG_TRACK_SCROLL = 'scroll';
     var CONFIG_TRACK_SUBMIT = 'submit';
 
@@ -18268,6 +18301,7 @@
     CONFIG_DEFAULTS$1[CONFIG_TRACK_CLICK] = true;
     CONFIG_DEFAULTS$1[CONFIG_TRACK_INPUT] = true;
     CONFIG_DEFAULTS$1[CONFIG_TRACK_PAGEVIEW] = PAGEVIEW_OPTION_FULL_URL;
+    CONFIG_DEFAULTS$1[CONFIG_TRACK_RAGE_CLICK] = true;
     CONFIG_DEFAULTS$1[CONFIG_TRACK_SCROLL] = true;
     CONFIG_DEFAULTS$1[CONFIG_TRACK_SUBMIT] = true;
 
@@ -18277,6 +18311,7 @@
 
     var MP_EV_CLICK = '$mp_click';
     var MP_EV_INPUT = '$mp_input_change';
+    var MP_EV_RAGE_CLICK = '$mp_rage_click';
     var MP_EV_SCROLL = '$mp_scroll';
     var MP_EV_SUBMIT = '$mp_submit';
 
@@ -18299,6 +18334,7 @@
         this.initInputTracking();
         this.initScrollTracking();
         this.initSubmitTracking();
+        this.initRageClickTracking();
     };
 
     Autocapture.prototype.getFullConfig = function() {
@@ -18377,6 +18413,11 @@
             return;
         }
 
+        var isCapturedForHeatMap = this.mp.is_recording_heatmap_data() && (
+            (mpEventName === MP_EV_CLICK && !this.getConfig(CONFIG_TRACK_CLICK)) ||
+            (mpEventName === MP_EV_RAGE_CLICK && !this._getRageClickConfig())
+        );
+
         var props = getPropsForDOMEvent(ev, {
             allowElementCallback: this.getConfig(CONFIG_ALLOW_ELEMENT_CALLBACK),
             allowSelectors: this.getConfig(CONFIG_ALLOW_SELECTORS),
@@ -18385,7 +18426,7 @@
             blockSelectors: this.getConfig(CONFIG_BLOCK_SELECTORS),
             captureExtraAttrs: this.getConfig(CONFIG_CAPTURE_EXTRA_ATTRS),
             captureTextContent: this.getConfig(CONFIG_CAPTURE_TEXT_CONTENT),
-            capturedForHeatMap: mpEventName === MP_EV_CLICK && !this.getConfig(CONFIG_TRACK_CLICK) && this.mp.is_recording_heatmap_data(),
+            capturedForHeatMap: isCapturedForHeatMap,
         });
         if (props) {
             _.extend(props, DEFAULT_PROPS);
@@ -18393,6 +18434,24 @@
         }
     };
 
+    Autocapture.prototype._getRageClickConfig = function() {
+        var config = this.getConfig(CONFIG_TRACK_RAGE_CLICK);
+
+        if (!config) {
+            return null; // rage click tracking disabled
+        }
+
+        if (config === true) {
+            return {}; // use defaults
+        }
+
+        if (typeof config === 'object') {
+            return config; // use custom configuration
+        }
+
+        return {}; // fallback to defaults for any other truthy value
+    };
+
     Autocapture.prototype.initClickTracking = function() {
         win.removeEventListener(EV_CLICK, this.listenerClick);
 
@@ -18494,6 +18553,36 @@
         }.bind(this)));
     };
 
+    Autocapture.prototype.initRageClickTracking = function() {
+        win.removeEventListener(EV_CLICK, this.listenerRageClick);
+
+        var rageClickConfig = this._getRageClickConfig();
+        if (!rageClickConfig && !this.mp.get_config('record_heatmap_data')) {
+            return;
+        }
+
+        logger$1.log('Initializing rage click tracking');
+        if (!this._rageClickTracker) {
+            this._rageClickTracker = new RageClickTracker();
+        }
+
+        this.listenerRageClick = function(ev) {
+            var currentRageClickConfig = this._getRageClickConfig();
+            if (!currentRageClickConfig && !this.mp.is_recording_heatmap_data()) {
+                return;
+            }
+
+            if (this.currentUrlBlocked()) {
+                return;
+            }
+
+            if (this._rageClickTracker.isRageClick(ev['pageX'], ev['pageY'], currentRageClickConfig)) {
+                this.trackDomEvent(ev, MP_EV_RAGE_CLICK);
+            }
+        }.bind(this);
+        win.addEventListener(EV_CLICK, this.listenerRageClick);
+    };
+
     Autocapture.prototype.initScrollTracking = function() {
         win.removeEventListener(EV_SCROLLEND, this.listenerScroll);
 
@@ -18580,6 +18669,7 @@
     var FeatureFlagManager = function(initOptions) {
         this.getFullApiRoute = initOptions.getFullApiRoute;
         this.getMpConfig = initOptions.getConfigFunc;
+        this.setMpConfig = initOptions.setConfigFunc;
         this.getMpProperty = initOptions.getPropertyFunc;
         this.track = initOptions.trackingFunc;
     };
@@ -18617,6 +18707,23 @@
         return !!this.getMpConfig(FLAGS_CONFIG_KEY);
     };
 
+    FeatureFlagManager.prototype.updateContext = function(newContext, options) {
+        if (!this.isSystemEnabled()) {
+            logger.critical('Feature Flags not enabled, cannot update context');
+            return Promise.resolve();
+        }
+
+        var ffConfig = this.getMpConfig(FLAGS_CONFIG_KEY);
+        if (!_.isObject(ffConfig)) {
+            ffConfig = {};
+        }
+        var oldContext = (options && options['replace']) ? {} : this.getConfig(CONFIG_CONTEXT);
+        ffConfig[CONFIG_CONTEXT] = _.extend({}, oldContext, newContext);
+
+        this.setMpConfig(FLAGS_CONFIG_KEY, ffConfig);
+        return this.fetchFlags();
+    };
+
     FeatureFlagManager.prototype.areFlagsReady = function() {
         if (!this.isSystemEnabled()) {
             logger.error('Feature Flags not enabled');
@@ -18626,7 +18733,7 @@
 
     FeatureFlagManager.prototype.fetchFlags = function() {
         if (!this.isSystemEnabled()) {
-            return;
+            return Promise.resolve();
         }
 
         var distinctId = this.getMpProperty('distinct_id');
@@ -18666,6 +18773,8 @@
             this.markFetchComplete();
             logger.error(error);
         }.bind(this));
+
+        return this.fetchPromise;
     };
 
     FeatureFlagManager.prototype.markFetchComplete = function() {
@@ -18778,6 +18887,7 @@
     FeatureFlagManager.prototype['get_variant_value_sync'] = FeatureFlagManager.prototype.getVariantValueSync;
     FeatureFlagManager.prototype['is_enabled'] = FeatureFlagManager.prototype.isEnabled;
     FeatureFlagManager.prototype['is_enabled_sync'] = FeatureFlagManager.prototype.isEnabledSync;
+    FeatureFlagManager.prototype['update_context'] = FeatureFlagManager.prototype.updateContext;
 
     // Deprecated method
     FeatureFlagManager.prototype['get_feature_data'] = FeatureFlagManager.prototype.getFeatureData;
@@ -20238,7 +20348,7 @@
         'batch_autostart':                   true,
         'hooks':                             {},
         'record_block_class':                new RegExp('^(mp-block|fs-exclude|amp-block|rr-block|ph-no-capture)$'),
-        'record_block_selector':             'img, video',
+        'record_block_selector':             'img, video, audio',
         'record_canvas':                     false,
         'record_collect_fonts':              false,
         'record_heatmap_data':               false,
@@ -20462,6 +20572,7 @@
                 return this.get_api_host('flags') + '/' + this.get_config('api_routes')['flags'];
             }, this),
             getConfigFunc: _.bind(this.get_config, this),
+            setConfigFunc: _.bind(this.set_config, this),
             getPropertyFunc: _.bind(this.get_property, this),
             trackingFunc: _.bind(this.track, this)
         });