@statsig/client-core 3.15.4 → 3.16.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@statsig/client-core",
-  "version": "3.15.4",
+  "version": "3.16.0",
   "license": "ISC",
   "homepage": "https://github.com/statsig-io/js-client-monorepo",
   "repository": {

package/src/EventLogger.d.ts

@@ -1,7 +1,7 @@
 import { NetworkCore } from './NetworkCore';
 import { StatsigClientEmitEventFunc } from './StatsigClientBase';
 import { StatsigEventInternal } from './StatsigEvent';
-import { NetworkConfigCommon, StatsigOptionsCommon } from './StatsigOptionsCommon';
+import { LogEventCompressionMode, LoggingEnabledOption, NetworkConfigCommon, StatsigOptionsCommon } from './StatsigOptionsCommon';
 export declare class EventLogger {
     private _sdkKey;
     private _emitter;
@@ -14,12 +14,13 @@ export declare class EventLogger {
     private _maxQueueSize;
     private _hasRunQuickFlush;
     private _creationTime;
-    private _isLoggingDisabled;
+    private _loggingEnabled;
     private _logEventUrlConfig;
     private static _safeFlushAndForget;
     private static _safeRetryFailedLogs;
     constructor(_sdkKey: string, _emitter: StatsigClientEmitEventFunc, _network: NetworkCore, _options: StatsigOptionsCommon<NetworkConfigCommon> | null);
-    setLoggingDisabled(isDisabled: boolean): void;
+    setLogEventCompressionMode(mode: LogEventCompressionMode): void;
+    setLoggingEnabled(loggingEnabled: LoggingEnabledOption): void;
     enqueue(event: StatsigEventInternal): void;
     incrementNonExposureCount(name: string): void;
     reset(): void;

package/src/EventLogger.js

@@ -16,6 +16,7 @@ const Log_1 = require("./Log");
 const NetworkConfig_1 = require("./NetworkConfig");
 const SafeJs_1 = require("./SafeJs");
 const StatsigEvent_1 = require("./StatsigEvent");
+const StatsigOptionsCommon_1 = require("./StatsigOptionsCommon");
 const StorageProvider_1 = require("./StorageProvider");
 const UrlConfiguration_1 = require("./UrlConfiguration");
 const VisibilityObserving_1 = require("./VisibilityObserving");
@@ -42,7 +43,7 @@ class EventLogger {
         (_a = EVENT_LOGGER_MAP[sdkKey]) === null || _a === void 0 ? void 0 : _a._retryFailedLogs(RetryFailedLogsTrigger.GainedFocus);
     }
     constructor(_sdkKey, _emitter, _network, _options) {
-        var _a;
+        var _a, _b;
         this._sdkKey = _sdkKey;
         this._emitter = _emitter;
         this._network = _network;
@@ -52,13 +53,22 @@ class EventLogger {
         this._nonExposedChecks = {};
         this._hasRunQuickFlush = false;
         this._creationTime = Date.now();
-        this._isLoggingDisabled = (_options === null || _options === void 0 ? void 0 : _options.disableLogging) === true;
-        this._maxQueueSize = (_a = _options === null || _options === void 0 ? void 0 : _options.loggingBufferMaxSize) !== null && _a !== void 0 ? _a : DEFAULT_QUEUE_SIZE;
+        this._loggingEnabled =
+            (_a = _options === null || _options === void 0 ? void 0 : _options.loggingEnabled) !== null && _a !== void 0 ? _a : ((_options === null || _options === void 0 ? void 0 : _options.disableLogging) === true
+                ? StatsigOptionsCommon_1.LoggingEnabledOption.disabled
+                : StatsigOptionsCommon_1.LoggingEnabledOption.browserOnly);
+        if ((_options === null || _options === void 0 ? void 0 : _options.loggingEnabled) && _options.disableLogging !== undefined) {
+            Log_1.Log.warn('Detected both loggingEnabled and disableLogging options. loggingEnabled takes precedence - please remove disableLogging.');
+        }
+        this._maxQueueSize = (_b = _options === null || _options === void 0 ? void 0 : _options.loggingBufferMaxSize) !== null && _b !== void 0 ? _b : DEFAULT_QUEUE_SIZE;
         const config = _options === null || _options === void 0 ? void 0 : _options.networkConfig;
         this._logEventUrlConfig = new UrlConfiguration_1.UrlConfiguration(NetworkConfig_1.Endpoint._rgstr, config === null || config === void 0 ? void 0 : config.logEventUrl, config === null || config === void 0 ? void 0 : config.api, config === null || config === void 0 ? void 0 : config.logEventFallbackUrls);
     }
-    setLoggingDisabled(isDisabled) {
-        this._isLoggingDisabled = isDisabled;
+    setLogEventCompressionMode(mode) {
+        this._network.setLogEventCompressionMode(mode);
+    }
+    setLoggingEnabled(loggingEnabled) {
+        this._loggingEnabled = loggingEnabled;
     }
     enqueue(event) {
         if (!this._shouldLogEvent(event)) {
@@ -79,18 +89,22 @@ class EventLogger {
         this._lastExposureTimeMap = {};
     }
     start() {
-        if ((0, SafeJs_1._isServerEnv)()) {
-            return; // do not run in server environments
+        var _a;
+        const isServerEnv = (0, SafeJs_1._isServerEnv)();
+        if (isServerEnv && ((_a = this._options) === null || _a === void 0 ? void 0 : _a.loggingEnabled) !== 'always') {
+            return;
         }
         EVENT_LOGGER_MAP[this._sdkKey] = this;
-        (0, VisibilityObserving_1._subscribeToVisiblityChanged)((visibility) => {
-            if (visibility === 'background') {
-                EventLogger._safeFlushAndForget(this._sdkKey);
-            }
-            else if (visibility === 'foreground') {
-                EventLogger._safeRetryFailedLogs(this._sdkKey);
-            }
-        });
+        if (!isServerEnv) {
+            (0, VisibilityObserving_1._subscribeToVisiblityChanged)((visibility) => {
+                if (visibility === 'background') {
+                    EventLogger._safeFlushAndForget(this._sdkKey);
+                }
+                else if (visibility === 'foreground') {
+                    EventLogger._safeRetryFailedLogs(this._sdkKey);
+                }
+            });
+        }
         this._retryFailedLogs(RetryFailedLogsTrigger.Startup);
         this._startBackgroundFlushInterval();
     }
@@ -130,8 +144,9 @@ class EventLogger {
         setTimeout(() => EventLogger._safeFlushAndForget(this._sdkKey), QUICK_FLUSH_WINDOW_MS);
     }
     _shouldLogEvent(event) {
-        if ((0, SafeJs_1._isServerEnv)()) {
-            return false; // do not run in server environments
+        var _a;
+        if (((_a = this._options) === null || _a === void 0 ? void 0 : _a.loggingEnabled) !== 'always' && (0, SafeJs_1._isServerEnv)()) {
+            return false;
         }
         if (!(0, StatsigEvent_1._isExposureEvent)(event)) {
             return true;
@@ -164,7 +179,7 @@ class EventLogger {
     _sendEvents(events) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
-            if (this._isLoggingDisabled) {
+            if (this._loggingEnabled === 'disabled') {
                 this._saveFailedLogsToStorage(events);
                 return false;
             }

package/src/NetworkCore.d.ts

@@ -2,7 +2,7 @@ import './$_StatsigGlobal';
 import { ErrorBoundary } from './ErrorBoundary';
 import { NetworkPriority } from './NetworkConfig';
 import { StatsigClientEmitEventFunc } from './StatsigClientBase';
-import { AnyStatsigOptions } from './StatsigOptionsCommon';
+import { AnyStatsigOptions, LogEventCompressionMode } from './StatsigOptionsCommon';
 import { Flatten } from './TypingUtils';
 import { UrlConfiguration } from './UrlConfiguration';
 type RequestArgs = {
@@ -37,6 +37,7 @@ export declare class NetworkCore {
     private _leakyBucket;
     private _lastUsedInitUrl;
     constructor(options: AnyStatsigOptions | null, _emitter?: StatsigClientEmitEventFunc | undefined);
+    setLogEventCompressionMode(mode: LogEventCompressionMode): void;
     setErrorBoundary(errorBoundary: ErrorBoundary): void;
     isBeaconSupported(): boolean;
     getLastUsedInitUrlAndReset(): string | null;
@@ -44,6 +45,7 @@ export declare class NetworkCore {
     post(args: RequestArgsWithData): Promise<NetworkResponse | null>;
     get(args: RequestArgs): Promise<NetworkResponse | null>;
     private _sendRequest;
+    private _getLogEventCompressionMode;
     private _isRateLimited;
     private _getPopulatedURL;
     private _tryEncodeBody;

package/src/NetworkCore.js

@@ -23,6 +23,7 @@ const SessionID_1 = require("./SessionID");
 const StableID_1 = require("./StableID");
 const StatsigClientEventEmitter_1 = require("./StatsigClientEventEmitter");
 const StatsigMetadata_1 = require("./StatsigMetadata");
+const StatsigOptionsCommon_1 = require("./StatsigOptionsCommon");
 const VisibilityObserving_1 = require("./VisibilityObserving");
 const DEFAULT_TIMEOUT_MS = 10000;
 const BACKOFF_BASE_MS = 500;
@@ -50,6 +51,10 @@ class NetworkCore {
             this._timeout = this._netConfig.networkTimeoutMs;
         }
         this._fallbackResolver = new NetworkFallbackResolver_1.NetworkFallbackResolver(this._options);
+        this.setLogEventCompressionMode(this._getLogEventCompressionMode(options));
+    }
+    setLogEventCompressionMode(mode) {
+        this._options.logEventCompressionMode = mode;
     }
     setErrorBoundary(errorBoundary) {
         this._errorBoundary = errorBoundary;
@@ -172,6 +177,18 @@ class NetworkCore {
             }
         });
     }
+    _getLogEventCompressionMode(options) {
+        // Handle backward compatibility for deprecated disableCompression flag
+        let compressionMode = options === null || options === void 0 ? void 0 : options.logEventCompressionMode;
+        if (!compressionMode && (options === null || options === void 0 ? void 0 : options.disableCompression) === true) {
+            compressionMode = StatsigOptionsCommon_1.LogEventCompressionMode.Disabled;
+        }
+        // Default to enabled if unset
+        if (!compressionMode) {
+            compressionMode = StatsigOptionsCommon_1.LogEventCompressionMode.Enabled;
+        }
+        return compressionMode;
+    }
     _isRateLimited(endpoint) {
         var _a;
         const now = Date.now();
@@ -293,19 +310,28 @@ function _allowCompression(args, options) {
     if (!args.isCompressable) {
         return false;
     }
-    if (options.disableCompression) {
-        return false;
-    }
-    if ((args.urlConfig.customUrl != null || args.urlConfig.fallbackUrls != null) &&
-        SDKFlags_1.SDKFlags.get(args.sdkKey, 'enable_log_event_compression') !== true) {
-        return false;
-    }
+    // Never compress if 'no-compress' is set globally or required APIs are unavailable
     if ((0, __StatsigGlobal_1._getStatsigGlobalFlag)('no-compress') != null ||
         typeof CompressionStream === 'undefined' ||
         typeof TextEncoder === 'undefined') {
         return false;
     }
-    return true;
+    const isProxy = args.urlConfig.customUrl != null || args.urlConfig.fallbackUrls != null;
+    const flagEnabled = SDKFlags_1.SDKFlags.get(args.sdkKey, 'enable_log_event_compression') === true;
+    switch (options.logEventCompressionMode) {
+        case StatsigOptionsCommon_1.LogEventCompressionMode.Disabled:
+            return false;
+        case StatsigOptionsCommon_1.LogEventCompressionMode.Enabled:
+            // Only compress through proxy if flag is explicitly on
+            if (isProxy && !flagEnabled) {
+                return false;
+            }
+            return true;
+        case StatsigOptionsCommon_1.LogEventCompressionMode.Forced:
+            return true;
+        default:
+            return false;
+    }
 }
 function _getErrorMessage(controller, error) {
     if ((controller === null || controller === void 0 ? void 0 : controller.signal.aborted) &&

package/src/StatsigClientBase.js

@@ -19,6 +19,7 @@ const MemoKey_1 = require("./MemoKey");
 const SafeJs_1 = require("./SafeJs");
 const SessionID_1 = require("./SessionID");
 const StableID_1 = require("./StableID");
+const StatsigOptionsCommon_1 = require("./StatsigOptionsCommon");
 const StorageProvider_1 = require("./StorageProvider");
 const MAX_MEMO_CACHE_SIZE = 3000;
 class StatsigClientBase {
@@ -59,9 +60,13 @@ class StatsigClientBase {
      * @param {StatsigRuntimeMutableOptions} options - The configuration options that dictate the runtime behavior of the SDK.
      */
     updateRuntimeOptions(options) {
-        if (options.disableLogging != null) {
+        if (options.loggingEnabled) {
+            this._options.loggingEnabled = options.loggingEnabled;
+            this._logger.setLoggingEnabled(options.loggingEnabled);
+        }
+        else if (options.disableLogging != null) {
             this._options.disableLogging = options.disableLogging;
-            this._logger.setLoggingDisabled(options.disableLogging);
+            this._logger.setLoggingEnabled(options.disableLogging ? 'disabled' : 'browser-only');
         }
         if (options.disableStorage != null) {
             this._options.disableStorage = options.disableStorage;
@@ -71,6 +76,12 @@ class StatsigClientBase {
             this._options.enableCookies = options.enableCookies;
             StableID_1.StableID._setCookiesEnabled(this._sdkKey, options.enableCookies);
         }
+        if (options.logEventCompressionMode) {
+            this._logger.setLogEventCompressionMode(options.logEventCompressionMode);
+        }
+        else if (options.disableCompression) {
+            this._logger.setLogEventCompressionMode(StatsigOptionsCommon_1.LogEventCompressionMode.Disabled);
+        }
     }
     /**
      * Flushes any currently queued events.

package/src/StatsigMetadata.d.ts

@@ -1,4 +1,4 @@
-export declare const SDK_VERSION = "3.15.4";
+export declare const SDK_VERSION = "3.16.0";
 export type StatsigMetadata = {
     readonly [key: string]: string | undefined | null;
     readonly appVersion?: string;

package/src/StatsigMetadata.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StatsigMetadataProvider = exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = '3.15.4';
+exports.SDK_VERSION = '3.16.0';
 let metadata = {
     sdkVersion: exports.SDK_VERSION,
     sdkType: 'js-mono', // js-mono is overwritten by Precomp and OnDevice clients

package/src/StatsigOptionsCommon.d.ts

@@ -6,8 +6,18 @@ import { StorageProvider } from './StorageProvider';
 export type StatsigRuntimeMutableOptions = {
     /**
      * Prevents sending any events over the network.
+     * @deprecated Set {@link StatsigRuntimeMutableOptions.loggingEnabled} to "disabled" instead
      */
     disableLogging?: boolean;
+    /**
+     * Controls when to enable or disable logging:
+     * - "disabled": Prevents sending any events over the network.
+     * - "browser-only": Only sends events in browser environments.
+     * - "always": Skip browser checks and always logs events
+     *
+     * @default "browser-only"
+     */
+    loggingEnabled?: LoggingEnabledOption;
     /**
      * Prevents writing anything to storage.
      *
@@ -15,6 +25,7 @@ export type StatsigRuntimeMutableOptions = {
      */
     disableStorage?: boolean;
     /**
+     * @deprecated Use `logEventCompressionMode` instead.
      * Whether or not Statsig should compress JSON bodies for network requests where possible.
      *
      * default: `false`
@@ -24,6 +35,15 @@ export type StatsigRuntimeMutableOptions = {
      * Opt in cookie usage.
      */
     enableCookies?: boolean;
+    /**
+     * Controls JSON body compression for network requests.
+     * - `disabled`: Never compress
+     * - `enabled`: Compress unless using a proxy
+     * - `forced`: Always compress, even with a proxy
+     *
+     * default: `enabled`
+     */
+    logEventCompressionMode?: LogEventCompressionMode;
 };
 export type NetworkConfigCommon = {
     /**
@@ -67,12 +87,6 @@ export type NetworkConfigCommon = {
 };
 /** Options for configuring a Statsig client. */
 export type StatsigOptionsCommon<NetworkConfig extends NetworkConfigCommon> = StatsigRuntimeMutableOptions & {
-    /**
-     * Whether or not Statsig should compress JSON bodies for network requests where possible.
-     *
-     * default: `false`
-     */
-    disableCompression?: boolean;
     /**
      * When true, the SDK will not generate a stableID for the user. Useful when bootstrapping from a server without a StableID.
      *
@@ -149,3 +163,18 @@ export type StatsigEnvironment = {
     tier?: string;
     [key: string]: string | undefined;
 };
+export declare const LogEventCompressionMode: {
+    /** Do not compress request bodies */
+    readonly Disabled: "d";
+    /** Compress request bodies unless a network proxy is configured */
+    readonly Enabled: "e";
+    /** Always compress request bodies, even when a proxy is configured */
+    readonly Forced: "f";
+};
+export type LogEventCompressionMode = (typeof LogEventCompressionMode)[keyof typeof LogEventCompressionMode];
+export declare const LoggingEnabledOption: {
+    readonly disabled: "disabled";
+    readonly browserOnly: "browser-only";
+    readonly always: "always";
+};
+export type LoggingEnabledOption = (typeof LoggingEnabledOption)[keyof typeof LoggingEnabledOption];

package/src/StatsigOptionsCommon.js

@@ -1,2 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.LoggingEnabledOption = exports.LogEventCompressionMode = void 0;
+exports.LogEventCompressionMode = {
+    /** Do not compress request bodies */
+    Disabled: 'd',
+    /** Compress request bodies unless a network proxy is configured */
+    Enabled: 'e',
+    /** Always compress request bodies, even when a proxy is configured */
+    Forced: 'f',
+};
+exports.LoggingEnabledOption = {
+    disabled: 'disabled',
+    browserOnly: 'browser-only',
+    always: 'always',
+};

package/src/StorageProvider.js

@@ -39,15 +39,20 @@ catch (error) {
 }
 let _main = _localStorageProvider !== null && _localStorageProvider !== void 0 ? _localStorageProvider : _inMemoryProvider;
 let _current = _main;
-function _inMemoryBreaker(get) {
+function _inMemoryBreaker(action) {
     try {
-        return get();
+        return action();
     }
     catch (error) {
         if (error instanceof Error && error.name === 'SecurityError') {
             exports.Storage._setProvider(_inMemoryProvider);
             return null;
         }
+        if (error instanceof Error && error.name === 'QuotaExceededError') {
+            const allKeys = exports.Storage.getAllKeys();
+            const statsigKeys = allKeys.filter((key) => key.startsWith('statsig.'));
+            error.message = `${error.message}. Statsig Keys: ${statsigKeys.length}`;
+        }
         throw error;
     }
 }
@@ -56,7 +61,7 @@ exports.Storage = {
     isReadyResolver: () => _current.isReadyResolver(),
     getProviderName: () => _current.getProviderName(),
     getItem: (key) => _inMemoryBreaker(() => _current.getItem(key)),
-    setItem: (key, value) => _current.setItem(key, value),
+    setItem: (key, value) => _inMemoryBreaker(() => _current.setItem(key, value)),
     removeItem: (key) => _current.removeItem(key),
     getAllKeys: () => _current.getAllKeys(),
     // StorageProviderManagment