posthog-js 1.76.0 → 1.77.1

package/lib/src/extensions/toolbar.js

@@ -0,0 +1,151 @@
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+import { _getHashParam, _register_event, loadScript, logger } from '../utils';
+import { POSTHOG_MANAGED_HOSTS } from './cloud';
+var Toolbar = /** @class */ (function () {
+    function Toolbar(instance) {
+        this.instance = instance;
+    }
+    Toolbar.prototype.afterDecideResponse = function (response) {
+        var toolbarParams = response['toolbarParams'] ||
+            response['editorParams'] ||
+            (response['toolbarVersion'] ? { toolbarVersion: response['toolbarVersion'] } : {});
+        if (response['isAuthenticated'] &&
+            toolbarParams['toolbarVersion'] &&
+            toolbarParams['toolbarVersion'].indexOf('toolbar') === 0) {
+            this.loadToolbar(__assign({}, toolbarParams));
+        }
+    };
+    /**
+     * To load the toolbar, we need an access token and other state. That state comes from one of three places:
+     * 1. In the URL hash params
+     * 2. From session storage under the key `toolbarParams` if the toolbar was initialized on a previous page
+     */
+    Toolbar.prototype.maybeLoadToolbar = function (location, localStorage, history) {
+        if (location === void 0) { location = window.location; }
+        if (localStorage === void 0) { localStorage = undefined; }
+        if (history === void 0) { history = window.history; }
+        try {
+            // Before running the code we check if we can access localStorage, if not we opt-out
+            if (!localStorage) {
+                try {
+                    window.localStorage.setItem('test', 'test');
+                    window.localStorage.removeItem('test');
+                }
+                catch (error) {
+                    return false;
+                }
+                // If localStorage was undefined, and localStorage is supported we set the default value
+                localStorage = window.localStorage;
+            }
+            var stateHash = _getHashParam(location.hash, '__posthog') || _getHashParam(location.hash, 'state');
+            var state = stateHash ? JSON.parse(decodeURIComponent(stateHash)) : null;
+            var parseFromUrl = state && state['action'] === 'ph_authorize';
+            var toolbarParams = void 0;
+            if (parseFromUrl) {
+                // happens if they are initializing the toolbar using an old snippet
+                toolbarParams = state;
+                toolbarParams.source = 'url';
+                if (toolbarParams && Object.keys(toolbarParams).length > 0) {
+                    if (state['desiredHash']) {
+                        // hash that was in the url before the redirect
+                        location.hash = state['desiredHash'];
+                    }
+                    else if (history) {
+                        history.replaceState('', document.title, location.pathname + location.search); // completely remove hash
+                    }
+                    else {
+                        location.hash = ''; // clear hash (but leaves # unfortunately)
+                    }
+                }
+            }
+            else {
+                // get credentials from localStorage from a previous initialzation
+                toolbarParams = JSON.parse(localStorage.getItem('_postHogToolbarParams') || '{}');
+                toolbarParams.source = 'localstorage';
+                // delete "add-action" or other intent from toolbarParams, otherwise we'll have the same intent
+                // every time we open the page (e.g. you just visiting your own site an hour later)
+                delete toolbarParams.userIntent;
+            }
+            if (toolbarParams['token'] && this.instance.get_config('token') === toolbarParams['token']) {
+                this.loadToolbar(toolbarParams);
+                return true;
+            }
+            else {
+                return false;
+            }
+        }
+        catch (e) {
+            return false;
+        }
+    };
+    Toolbar.prototype.loadToolbar = function (params) {
+        var _this = this;
+        if (window['_postHogToolbarLoaded']) {
+            return false;
+        }
+        // only load the toolbar once, even if there are multiple instances of PostHogLib
+        ;
+        window['_postHogToolbarLoaded'] = true;
+        // By design array.js, recorder.js, and toolbar.js are served from Django with no or limited caching, not from our CDN
+        // Django respects the query params for caching, returning a 304 if appropriate
+        var host = this.instance.get_config('api_host');
+        var timestampToNearestThirtySeconds = Math.floor(Date.now() / 30000) * 30000;
+        var toolbarUrl = "".concat(host).concat(host.endsWith('/') ? '' : '/', "static/toolbar.js?_ts=").concat(timestampToNearestThirtySeconds);
+        var disableToolbarMetrics = !POSTHOG_MANAGED_HOSTS.includes(this.instance.get_config('api_host')) &&
+            this.instance.get_config('advanced_disable_toolbar_metrics');
+        var toolbarParams = __assign(__assign(__assign({ token: this.instance.get_config('token') }, params), { apiURL: host }), (disableToolbarMetrics ? { instrument: false } : {}));
+        var _discard = toolbarParams.source, paramsToPersist = __rest(toolbarParams, ["source"]); // eslint-disable-line
+        window.localStorage.setItem('_postHogToolbarParams', JSON.stringify(paramsToPersist));
+        loadScript(toolbarUrl, function (err) {
+            if (err) {
+                logger.error('Failed to load toolbar', err);
+                return;
+            }
+            ;
+            (window['ph_load_toolbar'] || window['ph_load_editor'])(toolbarParams, _this.instance);
+        });
+        // Turbolinks doesn't fire an onload event but does replace the entire body, including the toolbar.
+        // Thus, we ensure the toolbar is only loaded inside the body, and then reloaded on turbolinks:load.
+        _register_event(window, 'turbolinks:load', function () {
+            ;
+            window['_postHogToolbarLoaded'] = false;
+            _this.loadToolbar(toolbarParams);
+        });
+        return true;
+    };
+    /** @deprecated Use "loadToolbar" instead. */
+    Toolbar.prototype._loadEditor = function (params) {
+        return this.loadToolbar(params);
+    };
+    /** @deprecated Use "maybeLoadToolbar" instead. */
+    Toolbar.prototype.maybeLoadEditor = function (location, localStorage, history) {
+        if (location === void 0) { location = window.location; }
+        if (localStorage === void 0) { localStorage = undefined; }
+        if (history === void 0) { history = window.history; }
+        return this.maybeLoadToolbar(location, localStorage, history);
+    };
+    return Toolbar;
+}());
+export { Toolbar };
+//# sourceMappingURL=toolbar.js.map

package/lib/src/extensions/toolbar.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"toolbar.js","sourceRoot":"","sources":["../../../src/extensions/toolbar.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAG7E,OAAO,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAA;AAE/C;IAEI,iBAAY,QAAiB;QACzB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAC5B,CAAC;IAED,qCAAmB,GAAnB,UAAoB,QAAwB;QACxC,IAAM,aAAa,GACf,QAAQ,CAAC,eAAe,CAAC;YACzB,QAAQ,CAAC,cAAc,CAAC;YACxB,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;QACtF,IACI,QAAQ,CAAC,iBAAiB,CAAC;YAC3B,aAAa,CAAC,gBAAgB,CAAC;YAC/B,aAAa,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,EAC1D;YACE,IAAI,CAAC,WAAW,cACT,aAAa,EAClB,CAAA;SACL;IACL,CAAC;IAED;;;;OAIG;IACH,kCAAgB,GAAhB,UACI,QAA0B,EAC1B,YAA6C,EAC7C,OAAwB;QAFxB,yBAAA,EAAA,WAAW,MAAM,CAAC,QAAQ;QAC1B,6BAAA,EAAA,wBAA6C;QAC7C,wBAAA,EAAA,UAAU,MAAM,CAAC,OAAO;QAExB,IAAI;YACA,oFAAoF;YACpF,IAAI,CAAC,YAAY,EAAE;gBACf,IAAI;oBACA,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;oBAC3C,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;iBACzC;gBAAC,OAAO,KAAK,EAAE;oBACZ,OAAO,KAAK,CAAA;iBACf;gBAED,wFAAwF;gBACxF,YAAY,GAAG,MAAM,CAAC,YAAY,CAAA;aACrC;YAED,IAAM,SAAS,GAAG,aAAa,CAAC,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,IAAI,aAAa,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;YACpG,IAAM,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;YAC1E,IAAM,YAAY,GAAG,KAAK,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,cAAc,CAAA;YAChE,IAAI,aAAa,SAAe,CAAA;YAEhC,IAAI,YAAY,EAAE;gBACd,oEAAoE;gBACpE,aAAa,GAAG,KAAK,CAAA;gBACrB,aAAa,CAAC,MAAM,GAAG,KAAK,CAAA;gBAE5B,IAAI,aAAa,IAAI,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;oBACxD,IAAI,KAAK,CAAC,aAAa,CAAC,EAAE;wBACtB,+CAA+C;wBAC/C,QAAQ,CAAC,IAAI,GAAG,KAAK,CAAC,aAAa,CAAC,CAAA;qBACvC;yBAAM,IAAI,OAAO,EAAE;wBAChB,OAAO,CAAC,YAAY,CAAC,EAAE,EAAE,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAA,CAAC,yBAAyB;qBAC1G;yBAAM;wBACH,QAAQ,CAAC,IAAI,GAAG,EAAE,CAAA,CAAC,0CAA0C;qBAChE;iBACJ;aACJ;iBAAM;gBACH,kEAAkE;gBAClE,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,uBAAuB,CAAC,IAAI,IAAI,CAAC,CAAA;gBACjF,aAAa,CAAC,MAAM,GAAG,cAAc,CAAA;gBAErC,+FAA+F;gBAC/F,mFAAmF;gBACnF,OAAO,aAAa,CAAC,UAAU,CAAA;aAClC;YAED,IAAI,aAAa,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,aAAa,CAAC,OAAO,CAAC,EAAE;gBACxF,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,CAAA;gBAC/B,OAAO,IAAI,CAAA;aACd;iBAAM;gBACH,OAAO,KAAK,CAAA;aACf;SACJ;QAAC,OAAO,CAAC,EAAE;YACR,OAAO,KAAK,CAAA;SACf;IACL,CAAC;IAED,6BAAW,GAAX,UAAY,MAAsB;QAAlC,iBA0CC;QAzCG,IAAK,MAAc,CAAC,uBAAuB,CAAC,EAAE;YAC1C,OAAO,KAAK,CAAA;SACf;QACD,iFAAiF;QACjF,CAAC;QAAC,MAAc,CAAC,uBAAuB,CAAC,GAAG,IAAI,CAAA;QAEhD,sHAAsH;QACtH,+EAA+E;QAC/E,IAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,CAAA;QACjD,IAAM,+BAA+B,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,GAAG,KAAK,CAAA;QAC9E,IAAM,UAAU,GAAG,UAAG,IAAI,SACtB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,mCACR,+BAA+B,CAAE,CAAA;QAC1D,IAAM,qBAAqB,GACvB,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YACrE,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,kCAAkC,CAAC,CAAA;QAEhE,IAAM,aAAa,gCACf,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,IACrC,MAAM,KACT,MAAM,EAAE,IAAI,KACT,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAC1D,CAAA;QAEO,IAAQ,QAAQ,GAAyB,aAAa,OAAtC,EAAK,eAAe,UAAK,aAAa,EAAxD,UAAwC,CAAF,CAAkB,CAAC,sBAAsB;QACrF,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,uBAAuB,EAAE,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,CAAA;QAErF,UAAU,CAAC,UAAU,EAAE,UAAC,GAAG;YACvB,IAAI,GAAG,EAAE;gBACL,MAAM,CAAC,KAAK,CAAC,wBAAwB,EAAE,GAAG,CAAC,CAAA;gBAC3C,OAAM;aACT;YACD,CAAC;YAAA,CAAE,MAAc,CAAC,iBAAiB,CAAC,IAAK,MAAc,CAAC,gBAAgB,CAAC,CAAC,CAAC,aAAa,EAAE,KAAI,CAAC,QAAQ,CAAC,CAAA;QAC5G,CAAC,CAAC,CAAA;QACF,mGAAmG;QACnG,oGAAoG;QACpG,eAAe,CAAC,MAAM,EAAE,iBAAiB,EAAE;YACvC,CAAC;YAAC,MAAc,CAAC,uBAAuB,CAAC,GAAG,KAAK,CAAA;YACjD,KAAI,CAAC,WAAW,CAAC,aAAa,CAAC,CAAA;QACnC,CAAC,CAAC,CAAA;QACF,OAAO,IAAI,CAAA;IACf,CAAC;IAED,6CAA6C;IAC7C,6BAAW,GAAX,UAAY,MAAqB;QAC7B,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;IACnC,CAAC;IAED,kDAAkD;IAClD,iCAAe,GAAf,UACI,QAA0B,EAC1B,YAA6C,EAC7C,OAAwB;QAFxB,yBAAA,EAAA,WAAW,MAAM,CAAC,QAAQ;QAC1B,6BAAA,EAAA,wBAA6C;QAC7C,wBAAA,EAAA,UAAU,MAAM,CAAC,OAAO;QAExB,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,YAAY,EAAE,OAAO,CAAC,CAAA;IACjE,CAAC;IACL,cAAC;AAAD,CAAC,AAhJD,IAgJC","sourcesContent":["import { _getHashParam, _register_event, loadScript, logger } from '../utils'\nimport { PostHog } from '../posthog-core'\nimport { DecideResponse, ToolbarParams } from '../types'\nimport { POSTHOG_MANAGED_HOSTS } from './cloud'\n\nexport class Toolbar {\n    instance: PostHog\n    constructor(instance: PostHog) {\n        this.instance = instance\n    }\n\n    afterDecideResponse(response: DecideResponse) {\n        const toolbarParams: ToolbarParams =\n            response['toolbarParams'] ||\n            response['editorParams'] ||\n            (response['toolbarVersion'] ? { toolbarVersion: response['toolbarVersion'] } : {})\n        if (\n            response['isAuthenticated'] &&\n            toolbarParams['toolbarVersion'] &&\n            toolbarParams['toolbarVersion'].indexOf('toolbar') === 0\n        ) {\n            this.loadToolbar({\n                ...toolbarParams,\n            })\n        }\n    }\n\n    /**\n     * To load the toolbar, we need an access token and other state. That state comes from one of three places:\n     * 1. In the URL hash params\n     * 2. From session storage under the key `toolbarParams` if the toolbar was initialized on a previous page\n     */\n    maybeLoadToolbar(\n        location = window.location,\n        localStorage: Storage | undefined = undefined,\n        history = window.history\n    ): boolean {\n        try {\n            // Before running the code we check if we can access localStorage, if not we opt-out\n            if (!localStorage) {\n                try {\n                    window.localStorage.setItem('test', 'test')\n                    window.localStorage.removeItem('test')\n                } catch (error) {\n                    return false\n                }\n\n                // If localStorage was undefined, and localStorage is supported we set the default value\n                localStorage = window.localStorage\n            }\n\n            const stateHash = _getHashParam(location.hash, '__posthog') || _getHashParam(location.hash, 'state')\n            const state = stateHash ? JSON.parse(decodeURIComponent(stateHash)) : null\n            const parseFromUrl = state && state['action'] === 'ph_authorize'\n            let toolbarParams: ToolbarParams\n\n            if (parseFromUrl) {\n                // happens if they are initializing the toolbar using an old snippet\n                toolbarParams = state\n                toolbarParams.source = 'url'\n\n                if (toolbarParams && Object.keys(toolbarParams).length > 0) {\n                    if (state['desiredHash']) {\n                        // hash that was in the url before the redirect\n                        location.hash = state['desiredHash']\n                    } else if (history) {\n                        history.replaceState('', document.title, location.pathname + location.search) // completely remove hash\n                    } else {\n                        location.hash = '' // clear hash (but leaves # unfortunately)\n                    }\n                }\n            } else {\n                // get credentials from localStorage from a previous initialzation\n                toolbarParams = JSON.parse(localStorage.getItem('_postHogToolbarParams') || '{}')\n                toolbarParams.source = 'localstorage'\n\n                // delete \"add-action\" or other intent from toolbarParams, otherwise we'll have the same intent\n                // every time we open the page (e.g. you just visiting your own site an hour later)\n                delete toolbarParams.userIntent\n            }\n\n            if (toolbarParams['token'] && this.instance.get_config('token') === toolbarParams['token']) {\n                this.loadToolbar(toolbarParams)\n                return true\n            } else {\n                return false\n            }\n        } catch (e) {\n            return false\n        }\n    }\n\n    loadToolbar(params?: ToolbarParams): boolean {\n        if ((window as any)['_postHogToolbarLoaded']) {\n            return false\n        }\n        // only load the toolbar once, even if there are multiple instances of PostHogLib\n        ;(window as any)['_postHogToolbarLoaded'] = true\n\n        // By design array.js, recorder.js, and toolbar.js are served from Django with no or limited caching, not from our CDN\n        // Django respects the query params for caching, returning a 304 if appropriate\n        const host = this.instance.get_config('api_host')\n        const timestampToNearestThirtySeconds = Math.floor(Date.now() / 30000) * 30000\n        const toolbarUrl = `${host}${\n            host.endsWith('/') ? '' : '/'\n        }static/toolbar.js?_ts=${timestampToNearestThirtySeconds}`\n        const disableToolbarMetrics =\n            !POSTHOG_MANAGED_HOSTS.includes(this.instance.get_config('api_host')) &&\n            this.instance.get_config('advanced_disable_toolbar_metrics')\n\n        const toolbarParams = {\n            token: this.instance.get_config('token'),\n            ...params,\n            apiURL: host, // defaults to api_host from the instance config if nothing else set\n            ...(disableToolbarMetrics ? { instrument: false } : {}),\n        }\n\n        const { source: _discard, ...paramsToPersist } = toolbarParams // eslint-disable-line\n        window.localStorage.setItem('_postHogToolbarParams', JSON.stringify(paramsToPersist))\n\n        loadScript(toolbarUrl, (err) => {\n            if (err) {\n                logger.error('Failed to load toolbar', err)\n                return\n            }\n            ;((window as any)['ph_load_toolbar'] || (window as any)['ph_load_editor'])(toolbarParams, this.instance)\n        })\n        // Turbolinks doesn't fire an onload event but does replace the entire body, including the toolbar.\n        // Thus, we ensure the toolbar is only loaded inside the body, and then reloaded on turbolinks:load.\n        _register_event(window, 'turbolinks:load', () => {\n            ;(window as any)['_postHogToolbarLoaded'] = false\n            this.loadToolbar(toolbarParams)\n        })\n        return true\n    }\n\n    /** @deprecated Use \"loadToolbar\" instead. */\n    _loadEditor(params: ToolbarParams): boolean {\n        return this.loadToolbar(params)\n    }\n\n    /** @deprecated Use \"maybeLoadToolbar\" instead. */\n    maybeLoadEditor(\n        location = window.location,\n        localStorage: Storage | undefined = undefined,\n        history = window.history\n    ): boolean {\n        return this.maybeLoadToolbar(location, localStorage, history)\n    }\n}\n"]}

package/lib/src/extensions/web-performance.d.ts

@@ -0,0 +1,20 @@
+import { PostHog } from '../posthog-core';
+import { DecideResponse } from '../types';
+export declare class WebPerformanceObserver {
+    instance: PostHog;
+    remoteEnabled: boolean | undefined;
+    observer: PerformanceObserver | undefined;
+    _forceAllowLocalhost: boolean;
+    constructor(instance: PostHog);
+    startObservingIfEnabled(): void;
+    startObserving(): void;
+    stopObserving(): void;
+    isObserving(): boolean;
+    isEnabled(): boolean;
+    afterDecideResponse(response: DecideResponse): void;
+    _capturePerformanceEvent(event: PerformanceEntry): void;
+    /**
+     * :TRICKY: Make sure we batch these requests, and don't truncate the strings.
+     */
+    private capturePerformanceEvent;
+}

package/lib/src/extensions/web-performance.js

@@ -0,0 +1,245 @@
+var __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
+import { isLocalhost, logger } from '../utils';
+var PERFORMANCE_EVENTS_MAPPING = {
+    // BASE_PERFORMANCE_EVENT_COLUMNS
+    entryType: 0,
+    timeOrigin: 1,
+    name: 2,
+    // RESOURCE_EVENT_COLUMNS
+    startTime: 3,
+    redirectStart: 4,
+    redirectEnd: 5,
+    workerStart: 6,
+    fetchStart: 7,
+    domainLookupStart: 8,
+    domainLookupEnd: 9,
+    connectStart: 10,
+    secureConnectionStart: 11,
+    connectEnd: 12,
+    requestStart: 13,
+    responseStart: 14,
+    responseEnd: 15,
+    decodedBodySize: 16,
+    encodedBodySize: 17,
+    initiatorType: 18,
+    nextHopProtocol: 19,
+    renderBlockingStatus: 20,
+    responseStatus: 21,
+    transferSize: 22,
+    // LARGEST_CONTENTFUL_PAINT_EVENT_COLUMNS
+    element: 23,
+    renderTime: 24,
+    loadTime: 25,
+    size: 26,
+    id: 27,
+    url: 28,
+    // NAVIGATION_EVENT_COLUMNS
+    domComplete: 29,
+    domContentLoadedEvent: 30,
+    domInteractive: 31,
+    loadEventEnd: 32,
+    loadEventStart: 33,
+    redirectCount: 34,
+    navigationType: 35,
+    unloadEventEnd: 36,
+    unloadEventStart: 37,
+    // Added after v1
+    duration: 39,
+    timestamp: 40,
+    // NOTE: CURRENTLY UNSUPPORTED
+    // EVENT_TIMING_EVENT_COLUMNS
+    // processingStart: null,
+    // processingEnd: null,
+    // MARK_AND_MEASURE_EVENT_COLUMNS
+    // detail: null,
+};
+var ENTRY_TYPES_TO_OBSERVE = [
+    // 'event', // This is too noisy as it covers all browser events
+    'first-input',
+    // 'mark', // Mark is used too liberally. We would need to filter for specific marks
+    // 'measure', // Measure is used too liberally. We would need to filter for specific measures
+    'navigation',
+    'paint',
+    'resource',
+];
+var PERFORMANCE_INGESTION_ENDPOINT = '/e/';
+// Don't monitor posthog paths because then events cause performance events which are events and the snake eats its tail 😱
+var POSTHOG_PATHS_TO_IGNORE = ['/s/', PERFORMANCE_INGESTION_ENDPOINT];
+var WebPerformanceObserver = /** @class */ (function () {
+    function WebPerformanceObserver(instance) {
+        // Util to help developers working on this feature manually override
+        this._forceAllowLocalhost = false;
+        this.instance = instance;
+    }
+    WebPerformanceObserver.prototype.startObservingIfEnabled = function () {
+        if (this.isEnabled()) {
+            this.startObserving();
+        }
+        else {
+            this.stopObserving();
+        }
+    };
+    WebPerformanceObserver.prototype.startObserving = function () {
+        var _this = this;
+        var _a;
+        if (this.observer) {
+            return;
+        }
+        if (((_a = window === null || window === void 0 ? void 0 : window.PerformanceObserver) === null || _a === void 0 ? void 0 : _a.supportedEntryTypes) === undefined) {
+            logger.log('PostHog Performance observer not started because PerformanceObserver is not supported by this browser.');
+            return;
+        }
+        if (isLocalhost() && !this._forceAllowLocalhost) {
+            logger.log('PostHog Peformance observer not started because we are on localhost.');
+            return;
+        }
+        try {
+            // compat checked above with early return
+            // eslint-disable-next-line compat/compat
+            this.observer = new PerformanceObserver(function (list) {
+                list.getEntries().forEach(function (entry) {
+                    _this._capturePerformanceEvent(entry);
+                });
+            });
+            // compat checked above with early return
+            // eslint-disable-next-line compat/compat
+            var entryTypes = PerformanceObserver.supportedEntryTypes.filter(function (x) { return ENTRY_TYPES_TO_OBSERVE.includes(x); });
+            entryTypes.forEach(function (entryType) {
+                var _a;
+                (_a = _this.observer) === null || _a === void 0 ? void 0 : _a.observe({ type: entryType, buffered: true });
+            });
+        }
+        catch (e) {
+            console.error('PostHog failed to start performance observer', e);
+            this.stopObserving();
+        }
+    };
+    WebPerformanceObserver.prototype.stopObserving = function () {
+        if (this.observer) {
+            this.observer.disconnect();
+            this.observer = undefined;
+        }
+    };
+    WebPerformanceObserver.prototype.isObserving = function () {
+        return !!this.observer;
+    };
+    WebPerformanceObserver.prototype.isEnabled = function () {
+        var _a, _b;
+        return (_b = (_a = this.instance.get_config('capture_performance')) !== null && _a !== void 0 ? _a : this.remoteEnabled) !== null && _b !== void 0 ? _b : false;
+    };
+    WebPerformanceObserver.prototype.afterDecideResponse = function (response) {
+        this.remoteEnabled = response.capturePerformance || false;
+        if (this.isEnabled()) {
+            this.startObserving();
+        }
+    };
+    WebPerformanceObserver.prototype._capturePerformanceEvent = function (event) {
+        // NOTE: We don't want to capture our own request events.
+        var e_1, _a, _b;
+        if (event.name.indexOf(this.instance.get_config('api_host')) === 0) {
+            var path_1 = event.name.replace(this.instance.get_config('api_host'), '');
+            if (POSTHOG_PATHS_TO_IGNORE.find(function (x) { return path_1.indexOf(x) === 0; })) {
+                return;
+            }
+        }
+        // NOTE: This is minimal atm but will include more options when we move to the
+        // built-in rrweb network recorder
+        var networkRequest = {
+            url: event.name,
+        };
+        var userSessionRecordingOptions = this.instance.get_config('session_recording');
+        if (userSessionRecordingOptions.maskNetworkRequestFn) {
+            networkRequest = userSessionRecordingOptions.maskNetworkRequestFn(networkRequest);
+        }
+        if (!networkRequest) {
+            return;
+        }
+        var eventJson = event.toJSON();
+        eventJson.name = networkRequest.url;
+        var properties = {};
+        // kudos to sentry javascript sdk for excellent background on why to use Date.now() here
+        // https://github.com/getsentry/sentry-javascript/blob/e856e40b6e71a73252e788cd42b5260f81c9c88e/packages/utils/src/time.ts#L70
+        // can't start observer if performance.now() is not available
+        // eslint-disable-next-line compat/compat
+        var timeOrigin = Math.floor(Date.now() - performance.now());
+        properties[PERFORMANCE_EVENTS_MAPPING['timeOrigin']] = timeOrigin;
+        // clickhouse can't ingest timestamps that are floats
+        // (in this case representing fractions of a millisecond we don't care about anyway)
+        properties[PERFORMANCE_EVENTS_MAPPING['timestamp']] = Math.floor(timeOrigin + event.startTime);
+        for (var key in PERFORMANCE_EVENTS_MAPPING) {
+            if (eventJson[key] !== undefined) {
+                properties[PERFORMANCE_EVENTS_MAPPING[key]] = eventJson[key];
+            }
+        }
+        this.capturePerformanceEvent(properties);
+        if (exposesServerTiming(event)) {
+            try {
+                for (var _c = __values(event.serverTiming || []), _d = _c.next(); !_d.done; _d = _c.next()) {
+                    var timing = _d.value;
+                    this.capturePerformanceEvent((_b = {},
+                        _b[PERFORMANCE_EVENTS_MAPPING['timeOrigin']] = timeOrigin,
+                        _b[PERFORMANCE_EVENTS_MAPPING['timestamp']] = Math.floor(timeOrigin + event.startTime),
+                        _b[PERFORMANCE_EVENTS_MAPPING['name']] = timing.name,
+                        _b[PERFORMANCE_EVENTS_MAPPING['duration']] = timing.duration,
+                        // the spec has a closed list of possible types
+                        // https://developer.mozilla.org/en-US/docs/Web/API/PerformanceEntry/entryType
+                        // but, we need to know this was a server timing so that we know to
+                        // match it to the appropriate navigation or resource timing
+                        // that matching will have to be on timestamp and $current_url
+                        _b[PERFORMANCE_EVENTS_MAPPING['entryType']] = 'serverTiming',
+                        _b));
+                }
+            }
+            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            finally {
+                try {
+                    if (_d && !_d.done && (_a = _c.return)) _a.call(_c);
+                }
+                finally { if (e_1) throw e_1.error; }
+            }
+        }
+    };
+    /**
+     * :TRICKY: Make sure we batch these requests, and don't truncate the strings.
+     */
+    WebPerformanceObserver.prototype.capturePerformanceEvent = function (properties) {
+        var _a;
+        var timestamp = properties[PERFORMANCE_EVENTS_MAPPING['timestamp']];
+        (_a = this.instance.sessionRecording) === null || _a === void 0 ? void 0 : _a.onRRwebEmit({
+            type: 6,
+            data: {
+                plugin: 'posthog/network@1',
+                payload: properties,
+            },
+            timestamp: timestamp,
+        });
+        // this.instance.capture('$performance_event', properties, {
+        //     transport: 'XHR',
+        //     method: 'POST',
+        //     endpoint: PERFORMANCE_INGESTION_ENDPOINT,
+        //     _noTruncate: true,
+        //     _batchKey: 'performanceEvent',
+        // })
+    };
+    return WebPerformanceObserver;
+}());
+export { WebPerformanceObserver };
+/**
+ *  Check if this PerformanceEntry is either a PerformanceResourceTiming or a PerformanceNavigationTiming
+ *  NB PerformanceNavigationTiming extends PerformanceResourceTiming
+ *  Here we don't care which interface it implements as both expose `serverTimings`
+ */
+var exposesServerTiming = function (event) {
+    return event.entryType === 'navigation' || event.entryType === 'resource';
+};
+//# sourceMappingURL=web-performance.js.map

package/lib/src/extensions/web-performance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web-performance.js","sourceRoot":"","sources":["../../../src/extensions/web-performance.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAI9C,IAAM,0BAA0B,GAA8B;IAC1D,iCAAiC;IACjC,SAAS,EAAE,CAAC;IACZ,UAAU,EAAE,CAAC;IACb,IAAI,EAAE,CAAC;IAEP,yBAAyB;IACzB,SAAS,EAAE,CAAC;IACZ,aAAa,EAAE,CAAC;IAChB,WAAW,EAAE,CAAC;IACd,WAAW,EAAE,CAAC;IACd,UAAU,EAAE,CAAC;IACb,iBAAiB,EAAE,CAAC;IACpB,eAAe,EAAE,CAAC;IAClB,YAAY,EAAE,EAAE;IAChB,qBAAqB,EAAE,EAAE;IACzB,UAAU,EAAE,EAAE;IACd,YAAY,EAAE,EAAE;IAChB,aAAa,EAAE,EAAE;IACjB,WAAW,EAAE,EAAE;IACf,eAAe,EAAE,EAAE;IACnB,eAAe,EAAE,EAAE;IACnB,aAAa,EAAE,EAAE;IACjB,eAAe,EAAE,EAAE;IACnB,oBAAoB,EAAE,EAAE;IACxB,cAAc,EAAE,EAAE;IAClB,YAAY,EAAE,EAAE;IAEhB,yCAAyC;IACzC,OAAO,EAAE,EAAE;IACX,UAAU,EAAE,EAAE;IACd,QAAQ,EAAE,EAAE;IACZ,IAAI,EAAE,EAAE;IACR,EAAE,EAAE,EAAE;IACN,GAAG,EAAE,EAAE;IAEP,2BAA2B;IAC3B,WAAW,EAAE,EAAE;IACf,qBAAqB,EAAE,EAAE;IACzB,cAAc,EAAE,EAAE;IAClB,YAAY,EAAE,EAAE;IAChB,cAAc,EAAE,EAAE;IAClB,aAAa,EAAE,EAAE;IACjB,cAAc,EAAE,EAAE;IAClB,cAAc,EAAE,EAAE;IAClB,gBAAgB,EAAE,EAAE;IAEpB,iBAAiB;IACjB,QAAQ,EAAE,EAAE;IACZ,SAAS,EAAE,EAAE;IAEb,8BAA8B;IAC9B,6BAA6B;IAC7B,yBAAyB;IACzB,uBAAuB;IAEvB,iCAAiC;IACjC,gBAAgB;CACnB,CAAA;AAED,IAAM,sBAAsB,GAAG;IAC3B,gEAAgE;IAChE,aAAa;IACb,oFAAoF;IACpF,6FAA6F;IAC7F,YAAY;IACZ,OAAO;IACP,UAAU;CACb,CAAA;AAED,IAAM,8BAA8B,GAAG,KAAK,CAAA;AAC5C,2HAA2H;AAC3H,IAAM,uBAAuB,GAAG,CAAC,KAAK,EAAE,8BAA8B,CAAC,CAAA;AAEvE;IAQI,gCAAY,QAAiB;QAH7B,oEAAoE;QACpE,yBAAoB,GAAG,KAAK,CAAA;QAGxB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAC5B,CAAC;IAED,wDAAuB,GAAvB;QACI,IAAI,IAAI,CAAC,SAAS,EAAE,EAAE;YAClB,IAAI,CAAC,cAAc,EAAE,CAAA;SACxB;aAAM;YACH,IAAI,CAAC,aAAa,EAAE,CAAA;SACvB;IACL,CAAC;IAED,+CAAc,GAAd;QAAA,iBAqCC;;QApCG,IAAI,IAAI,CAAC,QAAQ,EAAE;YACf,OAAM;SACT;QAED,IAAI,CAAA,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,mBAAmB,0CAAE,mBAAmB,MAAK,SAAS,EAAE;YAChE,MAAM,CAAC,GAAG,CACN,wGAAwG,CAC3G,CAAA;YACD,OAAM;SACT;QAED,IAAI,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE;YAC7C,MAAM,CAAC,GAAG,CAAC,sEAAsE,CAAC,CAAA;YAClF,OAAM;SACT;QAED,IAAI;YACA,yCAAyC;YACzC,yCAAyC;YACzC,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAmB,CAAC,UAAC,IAAI;gBACzC,IAAI,CAAC,UAAU,EAAE,CAAC,OAAO,CAAC,UAAC,KAAK;oBAC5B,KAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAA;gBACxC,CAAC,CAAC,CAAA;YACN,CAAC,CAAC,CAAA;YAEF,yCAAyC;YACzC,yCAAyC;YACzC,IAAM,UAAU,GAAG,mBAAmB,CAAC,mBAAmB,CAAC,MAAM,CAAC,UAAC,CAAC,IAAK,OAAA,sBAAsB,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAlC,CAAkC,CAAC,CAAA;YAE5G,UAAU,CAAC,OAAO,CAAC,UAAC,SAAS;;gBACzB,MAAA,KAAI,CAAC,QAAQ,0CAAE,OAAO,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAA;YAC/D,CAAC,CAAC,CAAA;SACL;QAAC,OAAO,CAAC,EAAE;YACR,OAAO,CAAC,KAAK,CAAC,8CAA8C,EAAE,CAAC,CAAC,CAAA;YAChE,IAAI,CAAC,aAAa,EAAE,CAAA;SACvB;IACL,CAAC;IAED,8CAAa,GAAb;QACI,IAAI,IAAI,CAAC,QAAQ,EAAE;YACf,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAA;YAC1B,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAA;SAC5B;IACL,CAAC;IAED,4CAAW,GAAX;QACI,OAAO,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAA;IAC1B,CAAC;IAED,0CAAS,GAAT;;QACI,OAAO,MAAA,MAAA,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,qBAAqB,CAAC,mCAAI,IAAI,CAAC,aAAa,mCAAI,KAAK,CAAA;IACzF,CAAC;IAED,oDAAmB,GAAnB,UAAoB,QAAwB;QACxC,IAAI,CAAC,aAAa,GAAG,QAAQ,CAAC,kBAAkB,IAAI,KAAK,CAAA;QACzD,IAAI,IAAI,CAAC,SAAS,EAAE,EAAE;YAClB,IAAI,CAAC,cAAc,EAAE,CAAA;SACxB;IACL,CAAC;IAED,yDAAwB,GAAxB,UAAyB,KAAuB;QAC5C,yDAAyD;;QAEzD,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,EAAE;YAChE,IAAM,MAAI,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC,CAAA;YAEzE,IAAI,uBAAuB,CAAC,IAAI,CAAC,UAAC,CAAC,IAAK,OAAA,MAAI,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,EAArB,CAAqB,CAAC,EAAE;gBAC5D,OAAM;aACT;SACJ;QAED,8EAA8E;QAC9E,kCAAkC;QAClC,IAAI,cAAc,GAAsC;YACpD,GAAG,EAAE,KAAK,CAAC,IAAI;SAClB,CAAA;QAED,IAAM,2BAA2B,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAA;QAEjF,IAAI,2BAA2B,CAAC,oBAAoB,EAAE;YAClD,cAAc,GAAG,2BAA2B,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAA;SACpF;QAED,IAAI,CAAC,cAAc,EAAE;YACjB,OAAM;SACT;QAED,IAAM,SAAS,GAAG,KAAK,CAAC,MAAM,EAAE,CAAA;QAChC,SAAS,CAAC,IAAI,GAAG,cAAc,CAAC,GAAG,CAAA;QACnC,IAAM,UAAU,GAA2B,EAAE,CAAA;QAC7C,wFAAwF;QACxF,8HAA8H;QAC9H,6DAA6D;QAC7D,yCAAyC;QACzC,IAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC,CAAA;QAC7D,UAAU,CAAC,0BAA0B,CAAC,YAAY,CAAC,CAAC,GAAG,UAAU,CAAA;QACjE,qDAAqD;QACrD,oFAAoF;QACpF,UAAU,CAAC,0BAA0B,CAAC,WAAW,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,SAAS,CAAC,CAAA;QAC9F,KAAK,IAAM,GAAG,IAAI,0BAA0B,EAAE;YAC1C,IAAI,SAAS,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE;gBAC9B,UAAU,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,CAAA;aAC/D;SACJ;QAED,IAAI,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAA;QAExC,IAAI,mBAAmB,CAAC,KAAK,CAAC,EAAE;;gBAC5B,KAAqB,IAAA,KAAA,SAAA,KAAK,CAAC,YAAY,IAAI,EAAE,CAAA,gBAAA,4BAAE;oBAA1C,IAAM,MAAM,WAAA;oBACb,IAAI,CAAC,uBAAuB;wBACxB,GAAC,0BAA0B,CAAC,YAAY,CAAC,IAAG,UAAU;wBACtD,GAAC,0BAA0B,CAAC,WAAW,CAAC,IAAG,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,SAAS,CAAC;wBACnF,GAAC,0BAA0B,CAAC,MAAM,CAAC,IAAG,MAAM,CAAC,IAAI;wBACjD,GAAC,0BAA0B,CAAC,UAAU,CAAC,IAAG,MAAM,CAAC,QAAQ;wBACzD,+CAA+C;wBAC/C,8EAA8E;wBAC9E,mEAAmE;wBACnE,4DAA4D;wBAC5D,8DAA8D;wBAC9D,GAAC,0BAA0B,CAAC,WAAW,CAAC,IAAG,cAAc;4BAC3D,CAAA;iBACL;;;;;;;;;SACJ;IACL,CAAC;IAED;;OAEG;IACK,wDAAuB,GAA/B,UAAgC,UAAkC;;QAC9D,IAAM,SAAS,GAAG,UAAU,CAAC,0BAA0B,CAAC,WAAW,CAAC,CAAC,CAAA;QAErE,MAAA,IAAI,CAAC,QAAQ,CAAC,gBAAgB,0CAAE,WAAW,CAAC;YACxC,IAAI,EAAE,CAAC;YACP,IAAI,EAAE;gBACF,MAAM,EAAE,mBAAmB;gBAC3B,OAAO,EAAE,UAAU;aACtB;YACD,SAAS,WAAA;SACZ,CAAC,CAAA;QAEF,4DAA4D;QAC5D,wBAAwB;QACxB,sBAAsB;QACtB,gDAAgD;QAChD,yBAAyB;QACzB,qCAAqC;QACrC,KAAK;IACT,CAAC;IACL,6BAAC;AAAD,CAAC,AAzKD,IAyKC;;AAED;;;;GAIG;AACH,IAAM,mBAAmB,GAAG,UAAC,KAAuB;IAChD,OAAA,KAAK,CAAC,SAAS,KAAK,YAAY,IAAI,KAAK,CAAC,SAAS,KAAK,UAAU;AAAlE,CAAkE,CAAA","sourcesContent":["import { isLocalhost, logger } from '../utils'\nimport { PostHog } from '../posthog-core'\nimport { DecideResponse, NetworkRequest } from '../types'\n\nconst PERFORMANCE_EVENTS_MAPPING: { [key: string]: number } = {\n    // BASE_PERFORMANCE_EVENT_COLUMNS\n    entryType: 0,\n    timeOrigin: 1,\n    name: 2,\n\n    // RESOURCE_EVENT_COLUMNS\n    startTime: 3,\n    redirectStart: 4,\n    redirectEnd: 5,\n    workerStart: 6,\n    fetchStart: 7,\n    domainLookupStart: 8,\n    domainLookupEnd: 9,\n    connectStart: 10,\n    secureConnectionStart: 11,\n    connectEnd: 12,\n    requestStart: 13,\n    responseStart: 14,\n    responseEnd: 15,\n    decodedBodySize: 16,\n    encodedBodySize: 17,\n    initiatorType: 18,\n    nextHopProtocol: 19,\n    renderBlockingStatus: 20,\n    responseStatus: 21,\n    transferSize: 22,\n\n    // LARGEST_CONTENTFUL_PAINT_EVENT_COLUMNS\n    element: 23,\n    renderTime: 24,\n    loadTime: 25,\n    size: 26,\n    id: 27,\n    url: 28,\n\n    // NAVIGATION_EVENT_COLUMNS\n    domComplete: 29,\n    domContentLoadedEvent: 30,\n    domInteractive: 31,\n    loadEventEnd: 32,\n    loadEventStart: 33,\n    redirectCount: 34,\n    navigationType: 35,\n    unloadEventEnd: 36,\n    unloadEventStart: 37,\n\n    // Added after v1\n    duration: 39,\n    timestamp: 40,\n\n    // NOTE: CURRENTLY UNSUPPORTED\n    // EVENT_TIMING_EVENT_COLUMNS\n    // processingStart: null,\n    // processingEnd: null,\n\n    // MARK_AND_MEASURE_EVENT_COLUMNS\n    // detail: null,\n}\n\nconst ENTRY_TYPES_TO_OBSERVE = [\n    // 'event', // This is too noisy as it covers all browser events\n    'first-input',\n    // 'mark', // Mark is used too liberally. We would need to filter for specific marks\n    // 'measure', // Measure is used too liberally. We would need to filter for specific measures\n    'navigation',\n    'paint',\n    'resource',\n]\n\nconst PERFORMANCE_INGESTION_ENDPOINT = '/e/'\n// Don't monitor posthog paths because then events cause performance events which are events and the snake eats its tail 😱\nconst POSTHOG_PATHS_TO_IGNORE = ['/s/', PERFORMANCE_INGESTION_ENDPOINT]\n\nexport class WebPerformanceObserver {\n    instance: PostHog\n    remoteEnabled: boolean | undefined\n    observer: PerformanceObserver | undefined\n\n    // Util to help developers working on this feature manually override\n    _forceAllowLocalhost = false\n\n    constructor(instance: PostHog) {\n        this.instance = instance\n    }\n\n    startObservingIfEnabled() {\n        if (this.isEnabled()) {\n            this.startObserving()\n        } else {\n            this.stopObserving()\n        }\n    }\n\n    startObserving() {\n        if (this.observer) {\n            return\n        }\n\n        if (window?.PerformanceObserver?.supportedEntryTypes === undefined) {\n            logger.log(\n                'PostHog Performance observer not started because PerformanceObserver is not supported by this browser.'\n            )\n            return\n        }\n\n        if (isLocalhost() && !this._forceAllowLocalhost) {\n            logger.log('PostHog Peformance observer not started because we are on localhost.')\n            return\n        }\n\n        try {\n            // compat checked above with early return\n            // eslint-disable-next-line compat/compat\n            this.observer = new PerformanceObserver((list) => {\n                list.getEntries().forEach((entry) => {\n                    this._capturePerformanceEvent(entry)\n                })\n            })\n\n            // compat checked above with early return\n            // eslint-disable-next-line compat/compat\n            const entryTypes = PerformanceObserver.supportedEntryTypes.filter((x) => ENTRY_TYPES_TO_OBSERVE.includes(x))\n\n            entryTypes.forEach((entryType) => {\n                this.observer?.observe({ type: entryType, buffered: true })\n            })\n        } catch (e) {\n            console.error('PostHog failed to start performance observer', e)\n            this.stopObserving()\n        }\n    }\n\n    stopObserving() {\n        if (this.observer) {\n            this.observer.disconnect()\n            this.observer = undefined\n        }\n    }\n\n    isObserving() {\n        return !!this.observer\n    }\n\n    isEnabled() {\n        return this.instance.get_config('capture_performance') ?? this.remoteEnabled ?? false\n    }\n\n    afterDecideResponse(response: DecideResponse) {\n        this.remoteEnabled = response.capturePerformance || false\n        if (this.isEnabled()) {\n            this.startObserving()\n        }\n    }\n\n    _capturePerformanceEvent(event: PerformanceEntry) {\n        // NOTE: We don't want to capture our own request events.\n\n        if (event.name.indexOf(this.instance.get_config('api_host')) === 0) {\n            const path = event.name.replace(this.instance.get_config('api_host'), '')\n\n            if (POSTHOG_PATHS_TO_IGNORE.find((x) => path.indexOf(x) === 0)) {\n                return\n            }\n        }\n\n        // NOTE: This is minimal atm but will include more options when we move to the\n        // built-in rrweb network recorder\n        let networkRequest: NetworkRequest | null | undefined = {\n            url: event.name,\n        }\n\n        const userSessionRecordingOptions = this.instance.get_config('session_recording')\n\n        if (userSessionRecordingOptions.maskNetworkRequestFn) {\n            networkRequest = userSessionRecordingOptions.maskNetworkRequestFn(networkRequest)\n        }\n\n        if (!networkRequest) {\n            return\n        }\n\n        const eventJson = event.toJSON()\n        eventJson.name = networkRequest.url\n        const properties: { [key: number]: any } = {}\n        // kudos to sentry javascript sdk for excellent background on why to use Date.now() here\n        // https://github.com/getsentry/sentry-javascript/blob/e856e40b6e71a73252e788cd42b5260f81c9c88e/packages/utils/src/time.ts#L70\n        // can't start observer if performance.now() is not available\n        // eslint-disable-next-line compat/compat\n        const timeOrigin = Math.floor(Date.now() - performance.now())\n        properties[PERFORMANCE_EVENTS_MAPPING['timeOrigin']] = timeOrigin\n        // clickhouse can't ingest timestamps that are floats\n        // (in this case representing fractions of a millisecond we don't care about anyway)\n        properties[PERFORMANCE_EVENTS_MAPPING['timestamp']] = Math.floor(timeOrigin + event.startTime)\n        for (const key in PERFORMANCE_EVENTS_MAPPING) {\n            if (eventJson[key] !== undefined) {\n                properties[PERFORMANCE_EVENTS_MAPPING[key]] = eventJson[key]\n            }\n        }\n\n        this.capturePerformanceEvent(properties)\n\n        if (exposesServerTiming(event)) {\n            for (const timing of event.serverTiming || []) {\n                this.capturePerformanceEvent({\n                    [PERFORMANCE_EVENTS_MAPPING['timeOrigin']]: timeOrigin,\n                    [PERFORMANCE_EVENTS_MAPPING['timestamp']]: Math.floor(timeOrigin + event.startTime),\n                    [PERFORMANCE_EVENTS_MAPPING['name']]: timing.name,\n                    [PERFORMANCE_EVENTS_MAPPING['duration']]: timing.duration,\n                    // the spec has a closed list of possible types\n                    // https://developer.mozilla.org/en-US/docs/Web/API/PerformanceEntry/entryType\n                    // but, we need to know this was a server timing so that we know to\n                    // match it to the appropriate navigation or resource timing\n                    // that matching will have to be on timestamp and $current_url\n                    [PERFORMANCE_EVENTS_MAPPING['entryType']]: 'serverTiming',\n                })\n            }\n        }\n    }\n\n    /**\n     * :TRICKY: Make sure we batch these requests, and don't truncate the strings.\n     */\n    private capturePerformanceEvent(properties: { [key: number]: any }) {\n        const timestamp = properties[PERFORMANCE_EVENTS_MAPPING['timestamp']]\n\n        this.instance.sessionRecording?.onRRwebEmit({\n            type: 6, // EventType.Plugin,\n            data: {\n                plugin: 'posthog/network@1',\n                payload: properties,\n            },\n            timestamp,\n        })\n\n        // this.instance.capture('$performance_event', properties, {\n        //     transport: 'XHR',\n        //     method: 'POST',\n        //     endpoint: PERFORMANCE_INGESTION_ENDPOINT,\n        //     _noTruncate: true,\n        //     _batchKey: 'performanceEvent',\n        // })\n    }\n}\n\n/**\n *  Check if this PerformanceEntry is either a PerformanceResourceTiming or a PerformanceNavigationTiming\n *  NB PerformanceNavigationTiming extends PerformanceResourceTiming\n *  Here we don't care which interface it implements as both expose `serverTimings`\n */\nconst exposesServerTiming = (event: PerformanceEntry): event is PerformanceResourceTiming =>\n    event.entryType === 'navigation' || event.entryType === 'resource'\n"]}

package/lib/src/gdpr-utils.d.ts

@@ -0,0 +1,80 @@
+/**
+ * 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 PostHog JS SDK.
+ * These functions are used internally by the SDK and are not intended to be publicly exposed.
+ */
+import { GDPROptions } from './types';
+import { PostHog } from './posthog-core';
+/**
+ * Opt the user in to data capturing and cookies/localstorage for the given token
+ * @param {string} token - PostHog project capturing token
+ * @param {Object} [options]
+ * @param {captureFunction} [options.capture] - function used for capturing a PostHog event to record the opt-in action
+ * @param {string} [options.captureEventName] - event name to be used for capturing the opt-in action
+ * @param {Object} [options.captureProperties] - set of properties to be captured along with the opt-in action
+ * @param {string} [options.persistenceType] Persistence mechanism used - cookie or localStorage
+ * @param {string} [options.persistencePrefix=__ph_opt_in_out] - custom prefix to be used in the cookie/localstorage name
+ * @param {Number} [options.cookieExpiration] - number of days until the opt-in cookie expires
+ * @param {boolean} [options.crossSubdomainCookie] - whether the opt-in cookie is set as cross-subdomain or not
+ * @param {boolean} [options.secureCookie] - whether the opt-in cookie is set as secure or not
+ */
+export declare function optIn(token: string, options: GDPROptions): void;
+/**
+ * Opt the user out of data capturing and cookies/localstorage for the given token
+ * @param {string} token - PostHog project capturing token
+ * @param {Object} [options]
+ * @param {string} [options.persistenceType] Persistence mechanism used - cookie or localStorage
+ * @param {string} [options.persistencePrefix=__ph_opt_in_out] - custom prefix to be used in the cookie/localstorage name
+ * @param {Number} [options.cookieExpiration] - number of days until the opt-out cookie expires
+ * @param {boolean} [options.crossSubdomainCookie] - whether the opt-out cookie is set as cross-subdomain or not
+ * @param {boolean} [options.secureCookie] - whether the opt-out cookie is set as secure or not
+ */
+export declare function optOut(token: string, options: GDPROptions): void;
+/**
+ * Check whether the user has opted in to data capturing and cookies/localstorage for the given token
+ * @param {string} token - PostHog project capturing token
+ * @param {Object} [options]
+ * @param {string} [options.persistenceType] Persistence mechanism used - cookie or localStorage
+ * @param {string} [options.persistencePrefix=__ph_opt_in_out] - custom prefix to be used in the cookie/localstorage name
+ * @returns {boolean} whether the user has opted in to the given opt type
+ */
+export declare function hasOptedIn(token: string, options: GDPROptions): boolean;
+/**
+ * Check whether the user has opted out of data capturing and cookies/localstorage for the given token
+ * @param {string} token - PostHog project capturing token
+ * @param {Object} [options]
+ * @param {string} [options.persistenceType] Persistence mechanism used - cookie or localStorage
+ * @param {string} [options.persistencePrefix=__ph_opt_in_out] - custom prefix to be used in the cookie/localstorage name
+ * @param {boolean} [options.respectDnt] - flag to take browser DNT setting into account
+ * @returns {boolean} whether the user has opted out of the given opt type
+ */
+export declare function hasOptedOut(token: string, options: Partial<GDPROptions>): boolean;
+/**
+ * Clear the user's opt in/out status of data capturing and cookies/localstorage for the given token
+ * @param {string} token - PostHog project capturing token
+ * @param {Object} [options]
+ * @param {string} [options.persistenceType] Persistence mechanism used - cookie or localStorage
+ * @param {string} [options.persistencePrefix=__ph_opt_in_out] - custom prefix to be used in the cookie/localstorage name
+ * @param {Number} [options.cookieExpiration] - number of days until the opt-in cookie expires
+ * @param {boolean} [options.crossSubdomainCookie] - whether the opt-in cookie is set as cross-subdomain or not
+ * @param {boolean} [options.secureCookie] - whether the opt-in cookie is set as secure or not
+ */
+export declare function clearOptInOut(token: string, options: GDPROptions): void;
+export declare function userOptedOut(posthog: PostHog, silenceErrors: boolean | undefined): boolean;
+/**
+ * Wrap a method with a check for whether the user is opted out of data capturing and cookies/localstorage for the given token
+ * If the user has opted out, return early instead of executing the method.
+ * If a callback argument was provided, execute it passing the 0 error code.
+ * @param {PostHog} posthog - the posthog instance
+ * @param {function} method - wrapped method to be executed if the user has not opted out
+ * @param silenceErrors
+ * @returns {*} the result of executing method OR undefined if the user has opted out
+ */
+export declare function addOptOutCheck<M extends (...args: any[]) => any = (...args: any[]) => any>(posthog: PostHog, method: M, silenceErrors?: boolean): M;