@statsig/web-analytics 3.20.4 → 3.21.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@statsig/web-analytics",
-  "version": "3.20.4",
+  "version": "3.21.1",
   "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.20.4",
-    "@statsig/js-client": "3.20.4",
+    "@statsig/client-core": "3.21.1",
+    "@statsig/js-client": "3.21.1",
     "web-vitals": "5.0.3"
   },
   "jsdelivr": "./build/statsig-web-analytics.min.js",

package/src/AutoCapture.d.ts

@@ -1,8 +1,5 @@
 import { PrecomputedEvaluationsInterface, StatsigPlugin } from '@statsig/client-core';
-import { AutoCaptureEvent } from './AutoCaptureEvent';
-export type AutoCaptureOptions = {
-    eventFilterFunc?: (event: AutoCaptureEvent) => boolean;
-};
+import { AutoCaptureOptions } from './AutoCaptureOptions';
 export declare class StatsigAutoCapturePlugin implements StatsigPlugin<PrecomputedEvaluationsInterface> {
     private _options?;
     readonly __plugin = "auto-capture";
@@ -22,6 +19,7 @@ export declare class AutoCapture {
     private _pageViewLogged;
     private _webVitalsManager;
     private _deadClickManager;
+    private _consoleLogManager;
     constructor(_client: PrecomputedEvaluationsInterface, options?: AutoCaptureOptions);
     private _addEventHandlers;
     private _addPageViewTracking;

package/src/AutoCapture.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AutoCapture = exports.runStatsigAutoCapture = exports.StatsigAutoCapturePlugin = void 0;
 const client_core_1 = require("@statsig/client-core");
 const AutoCaptureEvent_1 = require("./AutoCaptureEvent");
+const ConsoleLogManager_1 = require("./ConsoleLogManager");
 const DeadClickManager_1 = require("./DeadClickManager");
 const EngagementManager_1 = require("./EngagementManager");
 const RageClickManager_1 = require("./RageClickManager");
@@ -41,7 +42,7 @@ function runStatsigAutoCapture(client, options) {
 exports.runStatsigAutoCapture = runStatsigAutoCapture;
 class AutoCapture {
     constructor(_client, options) {
-        var _a, _b, _c;
+        var _a, _b, _c, _d;
         this._client = _client;
         this._disabledEvents = {};
         this._previousLoggedPageViewUrl = null;
@@ -61,11 +62,12 @@ class AutoCapture {
         this._rageClickManager = new RageClickManager_1.default();
         this._webVitalsManager = new WebVitalsManager_1.WebVitalsManager(this._enqueueAutoCapture.bind(this));
         this._deadClickManager = new DeadClickManager_1.default(this._enqueueAutoCapture.bind(this));
+        this._consoleLogManager = new ConsoleLogManager_1.ConsoleLogManager(this._enqueueAutoCapture.bind(this), (_c = options === null || options === void 0 ? void 0 : options.consoleLogAutoCaptureSettings) !== null && _c !== void 0 ? _c : { enabled: false });
         this._eventFilterFunc = options === null || options === void 0 ? void 0 : options.eventFilterFunc;
         const doc = (0, client_core_1._getDocumentSafe)();
         if (!(0, client_core_1._isServerEnv)()) {
             __STATSIG__ = (0, client_core_1._getStatsigGlobal)();
-            const instances = (_c = __STATSIG__.acInstances) !== null && _c !== void 0 ? _c : {};
+            const instances = (_d = __STATSIG__.acInstances) !== null && _d !== void 0 ? _d : {};
             instances[sdkKey] = this;
             __STATSIG__.acInstances = instances;
         }
@@ -155,6 +157,7 @@ class AutoCapture {
     _initialize() {
         this._webVitalsManager.startTracking();
         this._deadClickManager.startTracking();
+        this._consoleLogManager.startTracking();
         this._engagementManager.startInactivityTracking(() => this._tryLogPageViewEnd(true));
         this._addEventHandlers();
         this._addPageViewTracking();

package/src/AutoCaptureEvent.d.ts

@@ -11,6 +11,7 @@ export declare const AutoCaptureEventName: {
     readonly WEB_VITALS: "auto_capture::web_vitals";
     readonly DEAD_CLICK: "auto_capture::dead_click";
     readonly COPY: "auto_capture::copy";
+    readonly CONSOLE_LOG: "statsig::log_line";
 };
 export type AutoCaptureEventName = (typeof AutoCaptureEventName)[keyof typeof AutoCaptureEventName] & string;
 export type AutoCaptureEvent = StatsigEvent & {

package/src/AutoCaptureEvent.js

@@ -13,4 +13,6 @@ exports.AutoCaptureEventName = {
     WEB_VITALS: 'auto_capture::web_vitals',
     DEAD_CLICK: 'auto_capture::dead_click',
     COPY: 'auto_capture::copy',
+    // log line is a special event name used to populate logs metrics explorer
+    CONSOLE_LOG: 'statsig::log_line',
 };

package/src/AutoCaptureOptions.d.ts

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

package/src/AutoCaptureOptions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/ConsoleLogManager.d.ts

@@ -0,0 +1,19 @@
+import { AutoCaptureEventName } from './AutoCaptureEvent';
+import { ConsoleLogAutoCaptureSettings } from './AutoCaptureOptions';
+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;
+    private _patchConsole;
+    private _enqueueConsoleLog;
+    private _shouldLog;
+    private _safeStringify;
+    private _getStackTrace;
+}

package/src/ConsoleLogManager.js

@@ -0,0 +1,113 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConsoleLogManager = void 0;
+/* eslint-disable no-console */
+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)
+            return;
+        const win = (0, client_core_1._getWindowSafe)();
+        if (!win)
+            return;
+        this._isTracking = true;
+        this._patchConsole();
+    }
+    stopTracking() {
+        if (!this._isTracking)
+            return;
+        this._restoreFns.forEach((restore) => restore());
+        this._restoreFns = [];
+        this._isTracking = false;
+    }
+    _patchConsole() {
+        Object.entries(ConsoleLogPriority).forEach(([level, priority]) => {
+            if (priority < ConsoleLogPriority[this._logLevel])
+                return;
+            if (!console[level])
+                return;
+            const original = console[level].bind(console);
+            let inStack = false;
+            const restore = (0, commonUtils_1.patch)(console, level, (originalFn) => {
+                return (...args) => {
+                    originalFn(...args);
+                    if (inStack)
+                        return;
+                    inStack = true;
+                    try {
+                        const payload = args.map((a) => this._safeStringify(a));
+                        const trace = this._getStackTrace();
+                        this._enqueueConsoleLog(level, payload, trace);
+                    }
+                    catch (err) {
+                        original('console observer error:', err, ...args);
+                    }
+                    finally {
+                        inStack = false;
+                    }
+                };
+            });
+            this._restoreFns.push(restore);
+        });
+    }
+    _enqueueConsoleLog(level, payload, trace) {
+        var _a, _b, _c;
+        if (!this._shouldLog())
+            return;
+        const metadata = Object.assign(Object.assign({ status: level === 'log' ? 'info' : level, log_level: level, payload,
+            trace, timestamp: Date.now(), service: (_a = this._options.service) !== null && _a !== void 0 ? _a : '', version: (_b = this._options.version) !== null && _b !== void 0 ? _b : '', source: this.__source }, ((_c = this._options.resourceMetadata) !== null && _c !== void 0 ? _c : {})), (0, metadataUtils_1._gatherAllMetadata)((0, commonUtils_1._getSafeUrl)()));
+        this._enqueueFn(AutoCaptureEvent_1.AutoCaptureEventName.CONSOLE_LOG, payload.join(' '), metadata);
+    }
+    _shouldLog() {
+        if (!this._options.sampleRate ||
+            typeof this._options.sampleRate !== 'number' ||
+            this._options.sampleRate <= 0 ||
+            this._options.sampleRate >= 1) {
+            return true;
+        }
+        return Math.random() < this._options.sampleRate;
+    }
+    _safeStringify(val) {
+        try {
+            if (typeof val === 'string')
+                return val;
+            if (typeof val === 'object' && val !== null)
+                return JSON.stringify(val);
+            return String(val);
+        }
+        catch (_a) {
+            return '[Unserializable]';
+        }
+    }
+    _getStackTrace() {
+        var _a, _b;
+        try {
+            return (_b = (_a = new Error().stack) === null || _a === void 0 ? void 0 : _a.split('\n').slice(2)) !== null && _b !== void 0 ? _b : [];
+        }
+        catch (_c) {
+            return [];
+        }
+    }
+}
+exports.ConsoleLogManager = ConsoleLogManager;

package/src/utils/commonUtils.d.ts

@@ -18,4 +18,5 @@ export declare function _getSafeTimezoneOffset(): number | null;
 export declare function _getAnchorNodeInHierarchy(node: Element | null): Element | null;
 export declare function _sanitizeString(maybeString: string | null | undefined): string | null;
 export declare function throttle<T extends (...args: unknown[]) => void>(fn: T, limit: number): T;
+export declare function patch(source: Record<string, unknown>, name: string, replacement: (original: (...args: unknown[]) => void) => (...args: unknown[]) => void): () => void;
 export {};

package/src/utils/commonUtils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.throttle = exports._sanitizeString = exports._getAnchorNodeInHierarchy = exports._getSafeTimezoneOffset = exports._getSafeTimezone = exports._getSafeNetworkInformation = exports._registerEventHandler = exports._getSanitizedPageUrl = exports._getSafeUrlString = exports._getSafeUrl = exports._shouldLogEvent = exports._getTargetNode = exports._stripEmptyValues = exports.interactiveElements = void 0;
+exports.patch = exports.throttle = exports._sanitizeString = exports._getAnchorNodeInHierarchy = exports._getSafeTimezoneOffset = exports._getSafeTimezone = exports._getSafeNetworkInformation = exports._registerEventHandler = exports._getSanitizedPageUrl = exports._getSafeUrlString = exports._getSafeUrl = exports._shouldLogEvent = exports._getTargetNode = exports._stripEmptyValues = exports.interactiveElements = void 0;
 const client_core_1 = require("@statsig/client-core");
 const coreCCPattern = `(4[0-9]{12}(?:[0-9]{3})?)|(5[1-5][0-9]{14})|(6(?:011|5[0-9]{2})[0-9]{12})|(3[47][0-9]{13})|(3(?:0[0-5]|[68][0-9])[0-9]{11})|((?:2131|1800|35[0-9]{3})[0-9]{11})`;
 const CC_REGEX = new RegExp(`^(?:${coreCCPattern})$`);
@@ -186,3 +186,38 @@ function throttle(fn, limit) {
     };
 }
 exports.throttle = throttle;
+// copy from https://github.com/getsentry/sentry-javascript/blob/b2109071975af8bf0316d3b5b38f519bdaf5dc15/packages/utils/src/object.ts
+function patch(source, name, replacement) {
+    try {
+        if (!source[name])
+            return () => {
+                // noop
+            };
+        const original = source[name];
+        const wrapped = replacement(original);
+        // Make sure it's a function first, as we need to attach an empty prototype for `defineProperties` to work
+        // otherwise it'll throw "TypeError: Object.defineProperties called on non-object"
+        if (typeof wrapped === 'function') {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            wrapped.prototype = wrapped.prototype || {};
+            Object.defineProperties(wrapped, {
+                __statsig_original__: {
+                    enumerable: false,
+                    value: original,
+                },
+            });
+        }
+        source[name] = wrapped;
+        return () => {
+            source[name] = original;
+        };
+    }
+    catch (err) {
+        return () => {
+            // noop
+        };
+        // This can throw if multiple fill happens on a global object like XMLHttpRequest
+        // Fixes https://github.com/getsentry/sentry-javascript/issues/2043
+    }
+}
+exports.patch = patch;