mixpanel-browser 2.56.0 → 2.58.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mixpanel-browser",
-  "version": "2.56.0",
+  "version": "2.58.0",
   "description": "The official Mixpanel JavaScript browser client library",
   "main": "dist/mixpanel.cjs.js",
   "module": "dist/mixpanel.module.js",

package/src/config.js

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

package/src/externs.js

@@ -0,0 +1,14 @@
+/**
+ * @fileoverview Externs for Promise polyfill so that closure compiler does not try to rename methods.
+ * https://developers.google.com/closure/compiler/docs/externs-and-exports
+ * @externs
+ */
+var Promise = {};
+
+Promise.resolve = function() {};
+Promise.reject = function() {};
+Promise.race = function() {};
+Promise.all = function() {};
+
+Promise.prototype.then = function() {};
+Promise.prototype.catch = function() {};

package/src/gdpr-utils.js

@@ -11,7 +11,8 @@
  * These functions are used internally by the SDK and are not intended to be publicly exposed.
  */
 
-import { _, console, window } from './utils';
+import { _, console } from './utils';
+import { window } from './window';
 
 /**
  * A function used to track a Mixpanel event (e.g. MixpanelLib.track)

package/src/mixpanel-core.js

@@ -1,6 +1,7 @@
 /* eslint camelcase: "off" */
 import Config from './config';
-import { MAX_RECORDING_MS, _, console, userAgent, window, document, navigator, slice } from './utils';
+import { MAX_RECORDING_MS, _, console, userAgent, document, navigator, slice } from './utils';
+import { window } from './window';
 import { FormTracker, LinkTracker } from './dom-trackers';
 import { RequestBatcher } from './request-batcher';
 import { MixpanelGroup } from './mixpanel-group';
@@ -146,6 +147,7 @@ var DEFAULT_CONFIG = {
     'hooks':                             {},
     'record_block_class':                new RegExp('^(mp-block|fs-exclude|amp-block|rr-block|ph-no-capture)$'),
     'record_block_selector':             'img, video',
+    'record_canvas':                     false,
     'record_collect_fonts':              false,
     'record_idle_timeout_ms':            30 * 60 * 1000, // 30 minutes
     'record_mask_text_class':            new RegExp('^(mp-mask|fs-mask|amp-mask|rr-mask|ph-mask)$'),
@@ -923,7 +925,7 @@ MixpanelLib.prototype._track_or_batch = function(options, callback) {
     }, this);
 
     if (this._batch_requests && !should_send_immediately) {
-        batcher.enqueue(truncated_data, function(succeeded) {
+        batcher.enqueue(truncated_data).then(function(succeeded) {
             if (succeeded) {
                 callback(1, truncated_data);
             } else {

package/src/promise-polyfill.js

@@ -0,0 +1,379 @@
+import { window } from './window';
+/**
+ * Promise polyfill sourced from https://github.com/getify/native-promise-only.
+ * Modified to
+ *  - remove UMD wrapper and export as an object, so that we don't globally polyfill Promise.
+ *  - rename access notation for dynamically referenced props to avoid minification, e.g. this.__NPO__ -> this['__NPO__']
+*/
+
+/*! Native Promise Only
+    v0.8.1 (c) Kyle Simpson
+    MIT License: http://getify.mit-license.org
+*/
+
+/*jshint validthis:true */
+'use strict';
+
+var setImmediate = window['setImmediate'];
+var builtInProp, cycle, schedulingQueue,
+    ToString = Object.prototype.toString,
+    timer = (typeof setImmediate !== 'undefined') ?
+        function timer(fn) { return setImmediate(fn); } :
+        setTimeout;
+
+// dammit, IE8.
+try {
+    Object.defineProperty({},'x',{});
+    builtInProp = function builtInProp(obj,name,val,config) {
+        return Object.defineProperty(obj,name,{
+            value: val,
+            writable: true,
+            configurable: config !== false
+        });
+    };
+}
+catch (err) {
+    builtInProp = function builtInProp(obj,name,val) {
+        obj[name] = val;
+        return obj;
+    };
+}
+
+// Note: using a queue instead of array for efficiency
+schedulingQueue = (function Queue() {
+    var first, last, item;
+
+    function Item(fn,self) {
+        this.fn = fn;
+        this.self = self;
+        this.next = void 0;
+    }
+
+    return {
+        add: function add(fn,self) {
+            item = new Item(fn,self);
+            if (last) {
+                last.next = item;
+            }
+            else {
+                first = item;
+            }
+            last = item;
+            item = void 0;
+        },
+        drain: function drain() {
+            var f = first;
+            first = last = cycle = void 0;
+
+            while (f) {
+                f.fn.call(f.self);
+                f = f.next;
+            }
+        }
+    };
+})();
+
+function schedule(fn,self) {
+    schedulingQueue.add(fn,self);
+    if (!cycle) {
+        cycle = timer(schedulingQueue.drain);
+    }
+}
+
+// promise duck typing
+function isThenable(o) {
+    var _then, oType = typeof o;
+
+    if (o !== null && (oType === 'object' || oType === 'function')) {
+        _then = o.then;
+    }
+    return typeof _then === 'function' ? _then : false;
+}
+
+function notify() {
+    for (var i=0; i<this.chain.length; i++) {
+        notifyIsolated(
+            this,
+            (this.state === 1) ? this.chain[i].success : this.chain[i].failure,
+            this.chain[i]
+        );
+    }
+    this.chain.length = 0;
+}
+
+// NOTE: This is a separate function to isolate
+// the `try..catch` so that other code can be
+// optimized better
+function notifyIsolated(self,cb,chain) {
+    var ret, _then;
+    try {
+        if (cb === false) {
+            chain.reject(self.msg);
+        }
+        else {
+            if (cb === true) {
+                ret = self.msg;
+            }
+            else {
+                ret = cb.call(void 0,self.msg);
+            }
+
+            if (ret === chain.promise) {
+                chain.reject(TypeError('Promise-chain cycle'));
+            }
+            // eslint-disable-next-line no-cond-assign
+            else if (_then = isThenable(ret)) {
+                _then.call(ret,chain.resolve,chain.reject);
+            }
+            else {
+                chain.resolve(ret);
+            }
+        }
+    }
+    catch (err) {
+        chain.reject(err);
+    }
+}
+
+function resolve(msg) {
+    var _then, self = this;
+
+    // already triggered?
+    if (self.triggered) { return; }
+
+    self.triggered = true;
+
+    // unwrap
+    if (self.def) {
+        self = self.def;
+    }
+
+    try {
+        // eslint-disable-next-line no-cond-assign
+        if (_then = isThenable(msg)) {
+            schedule(function(){
+                var defWrapper = new MakeDefWrapper(self);
+                try {
+                    _then.call(msg,
+                        function $resolve$(){ resolve.apply(defWrapper,arguments); },
+                        function $reject$(){ reject.apply(defWrapper,arguments); }
+                    );
+                }
+                catch (err) {
+                    reject.call(defWrapper,err);
+                }
+            });
+        }
+        else {
+            self.msg = msg;
+            self.state = 1;
+            if (self.chain.length > 0) {
+                schedule(notify,self);
+            }
+        }
+    }
+    catch (err) {
+        reject.call(new MakeDefWrapper(self),err);
+    }
+}
+
+function reject(msg) {
+    var self = this;
+
+    // already triggered?
+    if (self.triggered) { return; }
+
+    self.triggered = true;
+
+    // unwrap
+    if (self.def) {
+        self = self.def;
+    }
+
+    self.msg = msg;
+    self.state = 2;
+    if (self.chain.length > 0) {
+        schedule(notify,self);
+    }
+}
+
+function iteratePromises(Constructor,arr,resolver,rejecter) {
+    for (var idx=0; idx<arr.length; idx++) {
+        (function IIFE(idx){
+            Constructor.resolve(arr[idx])
+                .then(
+                    function $resolver$(msg){
+                        resolver(idx,msg);
+                    },
+                    rejecter
+                );
+        })(idx);
+    }
+}
+
+function MakeDefWrapper(self) {
+    this.def = self;
+    this.triggered = false;
+}
+
+function MakeDef(self) {
+    this.promise = self;
+    this.state = 0;
+    this.triggered = false;
+    this.chain = [];
+    this.msg = void 0;
+}
+
+function NpoPromise(executor) {
+    if (typeof executor !== 'function') {
+        throw TypeError('Not a function');
+    }
+
+    if (this['__NPO__'] !== 0) {
+        throw TypeError('Not a promise');
+    }
+
+    // instance shadowing the inherited "brand"
+    // to signal an already "initialized" promise
+    this['__NPO__'] = 1;
+
+    var def = new MakeDef(this);
+
+    this['then'] = function then(success,failure) {
+        var o = {
+            success: typeof success === 'function' ? success : true,
+            failure: typeof failure === 'function' ? failure : false
+        };
+            // Note: `then(..)` itself can be borrowed to be used against
+            // a different promise constructor for making the chained promise,
+            // by substituting a different `this` binding.
+        o.promise = new this.constructor(function extractChain(resolve,reject) {
+            if (typeof resolve !== 'function' || typeof reject !== 'function') {
+                throw TypeError('Not a function');
+            }
+
+            o.resolve = resolve;
+            o.reject = reject;
+        });
+        def.chain.push(o);
+
+        if (def.state !== 0) {
+            schedule(notify,def);
+        }
+
+        return o.promise;
+    };
+    this['catch'] = function $catch$(failure) {
+        return this.then(void 0,failure);
+    };
+
+    try {
+        executor.call(
+            void 0,
+            function publicResolve(msg){
+                resolve.call(def,msg);
+            },
+            function publicReject(msg) {
+                reject.call(def,msg);
+            }
+        );
+    }
+    catch (err) {
+        reject.call(def,err);
+    }
+}
+
+var PromisePrototype = builtInProp({},'constructor',NpoPromise,
+    /*configurable=*/false
+);
+
+    // Note: Android 4 cannot use `Object.defineProperty(..)` here
+NpoPromise.prototype = PromisePrototype;
+
+// built-in "brand" to signal an "uninitialized" promise
+builtInProp(PromisePrototype,'__NPO__',0,
+    /*configurable=*/false
+);
+
+builtInProp(NpoPromise,'resolve',function Promise$resolve(msg) {
+    var Constructor = this;
+
+    // spec mandated checks
+    // note: best "isPromise" check that's practical for now
+    if (msg && typeof msg === 'object' && msg['__NPO__'] === 1) {
+        return msg;
+    }
+
+    return new Constructor(function executor(resolve,reject){
+        if (typeof resolve !== 'function' || typeof reject !== 'function') {
+            throw TypeError('Not a function');
+        }
+
+        resolve(msg);
+    });
+});
+
+builtInProp(NpoPromise,'reject',function Promise$reject(msg) {
+    return new this(function executor(resolve,reject){
+        if (typeof resolve !== 'function' || typeof reject !== 'function') {
+            throw TypeError('Not a function');
+        }
+
+        reject(msg);
+    });
+});
+
+builtInProp(NpoPromise,'all',function Promise$all(arr) {
+    var Constructor = this;
+
+    // spec mandated checks
+    if (ToString.call(arr) !== '[object Array]') {
+        return Constructor.reject(TypeError('Not an array'));
+    }
+    if (arr.length === 0) {
+        return Constructor.resolve([]);
+    }
+
+    return new Constructor(function executor(resolve,reject){
+        if (typeof resolve !== 'function' || typeof reject !== 'function') {
+            throw TypeError('Not a function');
+        }
+
+        var len = arr.length, msgs = Array(len), count = 0;
+
+        iteratePromises(Constructor,arr,function resolver(idx,msg) {
+            msgs[idx] = msg;
+            if (++count === len) {
+                resolve(msgs);
+            }
+        },reject);
+    });
+});
+
+builtInProp(NpoPromise,'race',function Promise$race(arr) {
+    var Constructor = this;
+
+    // spec mandated checks
+    if (ToString.call(arr) !== '[object Array]') {
+        return Constructor.reject(TypeError('Not an array'));
+    }
+
+    return new Constructor(function executor(resolve,reject){
+        if (typeof resolve !== 'function' || typeof reject !== 'function') {
+            throw TypeError('Not a function');
+        }
+
+        iteratePromises(Constructor,arr,function resolver(idx,msg){
+            resolve(msg);
+        },reject);
+    });
+});
+
+var PromisePolyfill;
+if (typeof Promise !== 'undefined' && Promise.toString().indexOf('[native code]') !== -1) {
+    PromisePolyfill = Promise;
+} else {
+    PromisePolyfill = NpoPromise;
+}
+
+export { PromisePolyfill as Promise, NpoPromise };

package/src/recorder/index.js

@@ -1,7 +1,8 @@
 import {record} from 'rrweb';
 
 import { SessionRecording } from './session-recording';
-import { console_with_prefix, _, window} from '../utils'; // eslint-disable-line camelcase
+import { console_with_prefix, _ } from '../utils'; // eslint-disable-line camelcase
+import { window } from '../window';
 
 var logger = console_with_prefix('recorder');
 

package/src/recorder/session-recording.js

@@ -1,6 +1,7 @@
 import { IncrementalSource, EventType } from '@rrweb/types';
 
-import { MAX_RECORDING_MS, MAX_VALUE_FOR_MIN_RECORDING_MS, console_with_prefix, _, window} from '../utils'; // eslint-disable-line camelcase
+import { MAX_RECORDING_MS, MAX_VALUE_FOR_MIN_RECORDING_MS, console_with_prefix, _} from '../utils'; // eslint-disable-line camelcase
+import { window } from '../window';
 import { addOptOutCheckMixpanelLib } from '../gdpr-utils';
 import { RequestBatcher } from '../request-batcher';
 import Config from '../config';
@@ -52,6 +53,7 @@ var SessionRecording = function(options) {
 
     this.seqNo = 0;
     this.replayStartTime = null;
+    this.replayStartUrl = null;
     this.batchStartUrl = null;
 
     this.idleTimeoutId = null;
@@ -103,6 +105,7 @@ SessionRecording.prototype.startRecording = function (shouldStopBatcher) {
 
     this.replayStartTime = new Date().getTime();
     this.batchStartUrl = _.info.currentUrl();
+    this.replayStartUrl = _.info.currentUrl();
 
     if (shouldStopBatcher || this.recordMinMs > 0) {
         // the primary case for shouldStopBatcher is when we're starting recording after a reset
@@ -139,9 +142,17 @@ SessionRecording.prototype.startRecording = function (shouldStopBatcher) {
         'blockClass': this.getConfig('record_block_class'),
         'blockSelector': blockSelector,
         'collectFonts': this.getConfig('record_collect_fonts'),
+        'dataURLOptions': { // canvas image options (https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toDataURL)
+            'type': 'image/webp',
+            'quality': 0.6
+        },
         'maskAllInputs': true,
         'maskTextClass': this.getConfig('record_mask_text_class'),
-        'maskTextSelector': this.getConfig('record_mask_text_selector')
+        'maskTextSelector': this.getConfig('record_mask_text_selector'),
+        'recordCanvas': this.getConfig('record_canvas'),
+        'sampling': {
+            'canvas': 15
+        }
     });
 
     if (typeof this._stopRecording !== 'function') {
@@ -259,6 +270,7 @@ SessionRecording.prototype._flushEvents = addOptOutCheckMixpanelLib(function (da
             'replay_id': replayId,
             'replay_length_ms': replayLengthMs,
             'replay_start_time': this.replayStartTime / 1000,
+            'replay_start_url': this.replayStartUrl,
             'seq': this.seqNo
         };
         var eventsJson = _.JSONEncode(data);