@statsig/web-analytics 3.21.0 → 3.22.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@statsig/web-analytics",
-  "version": "3.21.0",
+  "version": "3.22.0",
   "license": "ISC",
   "homepage": "https://github.com/statsig-io/js-client-monorepo",
   "repository": {
@@ -9,8 +9,8 @@
     "directory": "packages/web-analytics"
   },
   "dependencies": {
-    "@statsig/client-core": "3.21.0",
-    "@statsig/js-client": "3.21.0",
+    "@statsig/client-core": "3.22.0",
+    "@statsig/js-client": "3.22.0",
     "web-vitals": "5.0.3"
   },
   "jsdelivr": "./build/statsig-web-analytics.min.js",

package/src/AutoCapture.d.ts

@@ -36,4 +36,5 @@ export declare class AutoCapture {
     private _flushImmediately;
     private _isNewSession;
     private _getSessionFromClient;
+    static getAllMetadata(): Record<string, string | number>;
 }

package/src/AutoCapture.js

@@ -118,6 +118,12 @@ class AutoCapture {
                 this._tryLogPageView();
             },
         });
+        window.history.replaceState = new Proxy(window.history.replaceState, {
+            apply: (target, thisArg, [state, unused, url]) => {
+                target.apply(thisArg, [state, unused, url]);
+                this._tryLogPageView();
+            },
+        });
         this._tryLogPageView();
     }
     _autoLogEvent(event) {
@@ -192,7 +198,7 @@ class AutoCapture {
             if (!this._isNewSession(session)) {
                 return;
             }
-            this._enqueueAutoCapture(AutoCaptureEvent_1.AutoCaptureEventName.SESSION_START, (0, commonUtils_1._getSanitizedPageUrl)(), { sessionID: session.data.sessionID }, { flushImmediately: true });
+            this._enqueueAutoCapture(AutoCaptureEvent_1.AutoCaptureEventName.SESSION_START, (0, commonUtils_1._getSanitizedPageUrl)(), Object.assign({ sessionID: session.data.sessionID }, (0, metadataUtils_1._gatherAllMetadata)((0, commonUtils_1._getSafeUrl)())), { flushImmediately: true });
         }
         catch (err) {
             this._errorBoundary.logError('AC::logSession', err);
@@ -271,6 +277,9 @@ class AutoCapture {
     }
     _enqueueAutoCapture(eventName, value, metadata, options) {
         var _a, _b, _c;
+        if (!value) {
+            return;
+        }
         const subname = eventName.slice('auto_capture::'.length);
         if (this._disabledEvents[eventName] || this._disabledEvents[subname]) {
             return;
@@ -316,5 +325,8 @@ class AutoCapture {
     _getSessionFromClient() {
         return this._client.getContext().session;
     }
+    static getAllMetadata() {
+        return (0, metadataUtils_1._gatherAllMetadata)((0, commonUtils_1._getSafeUrl)());
+    }
 }
 exports.AutoCapture = AutoCapture;

package/src/AutoCaptureOptions.d.ts

@@ -1,14 +1,11 @@
-import { LogLevel } from '@statsig/client-core';
 import { AutoCaptureEvent } from './AutoCaptureEvent';
+import { ConsoleLogLevel } from './ConsoleLogManager';
 export type AutoCaptureOptions = {
     eventFilterFunc?: (event: AutoCaptureEvent) => boolean;
     consoleLogAutoCaptureSettings?: ConsoleLogAutoCaptureSettings;
 };
 export type ConsoleLogAutoCaptureSettings = {
     enabled: boolean;
-    logLevel?: LogLevel;
-    serviceName?: string;
-    serviceVersion?: string;
+    logLevel?: ConsoleLogLevel;
     sampleRate?: number;
-    resourceMetadata?: Record<string, string | number | boolean>;
 };

package/src/ConsoleLogManager.d.ts

@@ -1,21 +1,13 @@
 import { AutoCaptureEventName } from './AutoCaptureEvent';
 import { ConsoleLogAutoCaptureSettings } from './AutoCaptureOptions';
-export type LogLevel = 'log' | 'info' | 'warn' | 'error' | 'debug';
-export type ConsoleLogEvent = {
-    eventName: 'statsig::console_log';
-    value: string;
-    metadata: {
-        timestamp: string;
-        log_level: LogLevel;
-        payload: string[];
-        trace: string[];
-    };
-};
+export type ConsoleLogLevel = 'log' | 'info' | 'warn' | 'error' | 'debug' | 'trace';
 export declare class ConsoleLogManager {
     private _enqueueFn;
     private _options;
     private _restoreFns;
     private _isTracking;
+    private _logLevel;
+    private readonly __source;
     constructor(_enqueueFn: (eventName: AutoCaptureEventName, value: string, metadata: Record<string, unknown>) => void, _options: ConsoleLogAutoCaptureSettings);
     startTracking(): void;
     stopTracking(): void;

package/src/ConsoleLogManager.js

@@ -6,12 +6,24 @@ const client_core_1 = require("@statsig/client-core");
 const AutoCaptureEvent_1 = require("./AutoCaptureEvent");
 const commonUtils_1 = require("./utils/commonUtils");
 const metadataUtils_1 = require("./utils/metadataUtils");
+const ConsoleLogPriority = {
+    trace: 10,
+    debug: 20,
+    log: 30, // log & info are the same priority
+    info: 30,
+    warn: 40,
+    error: 50,
+};
 class ConsoleLogManager {
     constructor(_enqueueFn, _options) {
+        var _a;
         this._enqueueFn = _enqueueFn;
         this._options = _options;
         this._restoreFns = [];
         this._isTracking = false;
+        this._logLevel = 'info';
+        this.__source = 'js-auto-capture';
+        this._logLevel = (_a = this._options.logLevel) !== null && _a !== void 0 ? _a : 'info';
     }
     startTracking() {
         if (this._isTracking || !this._options.enabled)
@@ -30,7 +42,9 @@ class ConsoleLogManager {
         this._isTracking = false;
     }
     _patchConsole() {
-        ['log', 'info', 'warn', 'error', 'debug'].forEach((level) => {
+        Object.entries(ConsoleLogPriority).forEach(([level, priority]) => {
+            if (priority < ConsoleLogPriority[this._logLevel])
+                return;
             if (!console[level])
                 return;
             const original = console[level].bind(console);
@@ -58,12 +72,11 @@ class ConsoleLogManager {
         });
     }
     _enqueueConsoleLog(level, payload, trace) {
-        var _a, _b, _c;
         if (!this._shouldLog())
             return;
-        const metadata = Object.assign(Object.assign({ log_level: level, payload,
-            trace, timestamp: Date.now(), serviceName: (_a = this._options.serviceName) !== null && _a !== void 0 ? _a : '', serviceVersion: (_b = this._options.serviceVersion) !== null && _b !== void 0 ? _b : '' }, ((_c = this._options.resourceMetadata) !== null && _c !== void 0 ? _c : {})), (0, metadataUtils_1._gatherAllMetadata)((0, commonUtils_1._getSafeUrl)()));
-        this._enqueueFn(AutoCaptureEvent_1.AutoCaptureEventName.CONSOLE_LOG, (0, commonUtils_1._getSafeUrlString)(), metadata);
+        const metadata = Object.assign({ status: level === 'log' ? 'info' : level, log_level: level, payload,
+            trace, timestamp: Date.now(), source: this.__source }, (0, metadataUtils_1._gatherAllMetadata)((0, commonUtils_1._getSafeUrl)()));
+        this._enqueueFn(AutoCaptureEvent_1.AutoCaptureEventName.CONSOLE_LOG, payload.join(' '), metadata);
     }
     _shouldLog() {
         if (!this._options.sampleRate ||

package/src/DeadClickManager.js

@@ -5,6 +5,7 @@ const client_core_1 = require("@statsig/client-core");
 const AutoCaptureEvent_1 = require("./AutoCaptureEvent");
 const commonUtils_1 = require("./utils/commonUtils");
 const eventUtils_1 = require("./utils/eventUtils");
+const metadataUtils_1 = require("./utils/metadataUtils");
 exports.DeadClickConfig = {
     CLICK_CHECK_TIMEOUT: 1000,
     SCROLL_DELAY_MS: 100,
@@ -143,7 +144,10 @@ class DeadClickManager {
     }
     _logDeadClick(click, extraMetadata) {
         const { value, metadata } = (0, eventUtils_1._gatherEventData)(click.eventTarget);
-        this._enqueueFn(AutoCaptureEvent_1.AutoCaptureEventName.DEAD_CLICK, value, Object.assign(Object.assign(Object.assign({}, metadata), extraMetadata), { scrollDelayMs: click.scrollDelayMs, selectionChangeDelayMs: click.selectionChangeDelayMs, mutationDelayMs: click.mutationDelayMs, absoluteDelayMs: click.absoluteDelayMs }));
+        if (!value) {
+            return;
+        }
+        this._enqueueFn(AutoCaptureEvent_1.AutoCaptureEventName.DEAD_CLICK, value, Object.assign(Object.assign(Object.assign(Object.assign({}, metadata), extraMetadata), (0, metadataUtils_1._gatherCommonMetadata)((0, commonUtils_1._getSafeUrl)())), { scrollDelayMs: click.scrollDelayMs, selectionChangeDelayMs: click.selectionChangeDelayMs, mutationDelayMs: click.mutationDelayMs, absoluteDelayMs: click.absoluteDelayMs }));
     }
     _updateClickDelayMs(click) {
         if (!click.mutationDelayMs &&

package/src/__tests__/utils.d.ts

@@ -0,0 +1,5 @@
+export declare function getLastEvent(requests: Record<string, any>[], eventName: string): Record<string, any>;
+export declare function getLastPageViewEvent(requests: Record<string, any>[]): Record<string, any>;
+export declare function getLastPageViewEndEvent(requests: Record<string, any>[]): Record<string, any>;
+export declare function getLastSessionStartEvent(requests: Record<string, any>[]): Record<string, any>;
+export declare function getLastPerformanceEvent(requests: Record<string, any>[]): Record<string, any>;

package/src/__tests__/utils.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLastPerformanceEvent = exports.getLastSessionStartEvent = exports.getLastPageViewEndEvent = exports.getLastPageViewEvent = exports.getLastEvent = void 0;
+function getLastEvent(requests, eventName) {
+    for (let ii = requests.length - 1; ii >= 0; ii--) {
+        const req = requests[ii];
+        if (req['events']) {
+            for (let jj = req['events'].length - 1; jj >= 0; jj--) {
+                const evt = req['events'][jj];
+                if (evt.eventName === eventName) {
+                    return evt;
+                }
+            }
+        }
+    }
+    return {};
+}
+exports.getLastEvent = getLastEvent;
+function getLastPageViewEvent(requests) {
+    return getLastEvent(requests, 'auto_capture::page_view');
+}
+exports.getLastPageViewEvent = getLastPageViewEvent;
+function getLastPageViewEndEvent(requests) {
+    return getLastEvent(requests, 'auto_capture::page_view_end');
+}
+exports.getLastPageViewEndEvent = getLastPageViewEndEvent;
+function getLastSessionStartEvent(requests) {
+    return getLastEvent(requests, 'auto_capture::session_start');
+}
+exports.getLastSessionStartEvent = getLastSessionStartEvent;
+function getLastPerformanceEvent(requests) {
+    return getLastEvent(requests, 'auto_capture::performance');
+}
+exports.getLastPerformanceEvent = getLastPerformanceEvent;

package/src/utils/eventUtils.d.ts

@@ -1,5 +1,5 @@
 export declare function _gatherEventData(target: Element): {
-    value: string;
+    value: string | null;
     metadata: Record<string, unknown>;
 };
 export declare function _gatherCopyEventData(e: Event): Record<string, unknown>;

package/src/utils/eventUtils.js

@@ -7,17 +7,19 @@ const MAX_ATTRIBUTE_LENGTH = 1000;
 const MAX_CLASS_LIST_LENGTH = 100;
 const MAX_SELECTOR_DEPTH = 50;
 function _gatherEventData(target) {
+    if (_isSensitiveElement(target)) {
+        return { value: null, metadata: {} };
+    }
     const tagName = target.tagName.toLowerCase();
     const metadata = {};
-    const value = (0, client_core_1._getCurrentPageUrlSafe)() || '';
+    const value = (0, commonUtils_1._getSanitizedPageUrl)() || '';
     metadata['tagName'] = tagName;
     const elementMetadata = _getMetadataFromElement(target);
     Object.assign(metadata, elementMetadata);
     if (tagName === 'form') {
         Object.assign(metadata, _getFormMetadata(target));
     }
-    if (['input', 'select', 'textarea'].includes(tagName) &&
-        target.getAttribute('type') !== 'password') {
+    if (tagName === 'input') {
         Object.assign(metadata, _getInputMetadata(target));
     }
     const anchor = (0, commonUtils_1._getAnchorNodeInHierarchy)(target);
@@ -40,6 +42,13 @@ function _gatherCopyEventData(e) {
     return metadata;
 }
 exports._gatherCopyEventData = _gatherCopyEventData;
+function _isSensitiveElement(target) {
+    return ((target.tagName.toLowerCase() === 'input' &&
+        ['button', 'checkbox', 'submit', 'reset'].includes(target.getAttribute('type') || '')) ||
+        target.tagName.toLowerCase() === 'textarea' ||
+        target.tagName.toLowerCase() === 'select' ||
+        target.getAttribute('contenteditable') === 'true');
+}
 function _getFormMetadata(target) {
     var _a;
     const metadata = {};

package/src/utils/metadataUtils.js

@@ -10,7 +10,7 @@ function _gatherCommonMetadata(url) {
     return (0, commonUtils_1._stripEmptyValues)(Object.assign({ title: safeDoc === null || safeDoc === void 0 ? void 0 : safeDoc.title, current_url: (_a = safeWnd === null || safeWnd === void 0 ? void 0 : safeWnd.location) === null || _a === void 0 ? void 0 : _a.href, user_agent: ((_b = safeWnd === null || safeWnd === void 0 ? void 0 : safeWnd.navigator) === null || _b === void 0 ? void 0 : _b.userAgent) &&
             ((_d = (_c = safeWnd === null || safeWnd === void 0 ? void 0 : safeWnd.navigator) === null || _c === void 0 ? void 0 : _c.userAgent) === null || _d === void 0 ? void 0 : _d.length) > 200
             ? safeWnd.navigator.userAgent.substring(0, 200)
-            : (_e = safeWnd === null || safeWnd === void 0 ? void 0 : safeWnd.navigator) === null || _e === void 0 ? void 0 : _e.userAgent, locale: (_f = safeWnd === null || safeWnd === void 0 ? void 0 : safeWnd.navigator) === null || _f === void 0 ? void 0 : _f.language, hostname: url.hostname, pathname: url.pathname, screen_width: (_g = safeWnd === null || safeWnd === void 0 ? void 0 : safeWnd.screen) === null || _g === void 0 ? void 0 : _g.width, screen_height: (_h = safeWnd === null || safeWnd === void 0 ? void 0 : safeWnd.screen) === null || _h === void 0 ? void 0 : _h.height, viewport_width: safeWnd === null || safeWnd === void 0 ? void 0 : safeWnd.innerWidth, viewport_height: safeWnd === null || safeWnd === void 0 ? void 0 : safeWnd.innerHeight, timestamp: Date.now(), timezone: (0, commonUtils_1._getSafeTimezone)(), timezone_offset: (0, commonUtils_1._getSafeTimezoneOffset)() }, _getNetworkInfo()));
+            : (_e = safeWnd === null || safeWnd === void 0 ? void 0 : safeWnd.navigator) === null || _e === void 0 ? void 0 : _e.userAgent, locale: (_f = safeWnd === null || safeWnd === void 0 ? void 0 : safeWnd.navigator) === null || _f === void 0 ? void 0 : _f.language, hostname: url.hostname, pathname: url.pathname, screen_width: (_g = safeWnd === null || safeWnd === void 0 ? void 0 : safeWnd.screen) === null || _g === void 0 ? void 0 : _g.width, screen_height: (_h = safeWnd === null || safeWnd === void 0 ? void 0 : safeWnd.screen) === null || _h === void 0 ? void 0 : _h.height, viewport_width: safeWnd === null || safeWnd === void 0 ? void 0 : safeWnd.innerWidth, viewport_height: safeWnd === null || safeWnd === void 0 ? void 0 : safeWnd.innerHeight, viewport: `${safeWnd === null || safeWnd === void 0 ? void 0 : safeWnd.innerWidth}x${safeWnd === null || safeWnd === void 0 ? void 0 : safeWnd.innerHeight}`, timestamp: Date.now(), timezone: (0, commonUtils_1._getSafeTimezone)(), timezone_offset: (0, commonUtils_1._getSafeTimezoneOffset)() }, _getNetworkInfo()));
 }
 exports._gatherCommonMetadata = _gatherCommonMetadata;
 function _gatherAllMetadata(url) {