@statsig/client-core 3.13.0 → 3.14.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@statsig/client-core",
-  "version": "3.13.0",
+  "version": "3.14.1",
   "dependencies": {},
   "type": "commonjs",
   "main": "./src/index.js",

package/src/ErrorBoundary.js

@@ -93,7 +93,7 @@ class ErrorBoundary {
                 const sdkType = SDKType_1.SDKType._get(this._sdkKey);
                 const statsigMetadata = StatsigMetadata_1.StatsigMetadataProvider.get();
                 const info = isError ? unwrapped.stack : _getDescription(unwrapped);
-                const body = JSON.stringify(Object.assign({ tag, exception: name, info }, Object.assign(Object.assign({}, statsigMetadata), { sdkType })));
+                const body = Object.assign({ tag, exception: name, info, statsigOptions: _getStatsigOptionLoggingCopy(this._options) }, Object.assign(Object.assign({}, statsigMetadata), { sdkType }));
                 const func = (_f = (_e = (_d = this._options) === null || _d === void 0 ? void 0 : _d.networkConfig) === null || _e === void 0 ? void 0 : _e.networkOverrideFunc) !== null && _f !== void 0 ? _f : fetch;
                 yield func(exports.EXCEPTION_ENDPOINT, {
                     method: 'POST',
@@ -103,7 +103,7 @@ class ErrorBoundary {
                         'STATSIG-SDK-VERSION': String(statsigMetadata.sdkVersion),
                         'Content-Type': 'application/json',
                     },
-                    body,
+                    body: JSON.stringify(body),
                 });
                 (_g = this._emitter) === null || _g === void 0 ? void 0 : _g.call(this, {
                     name: 'error',
@@ -155,3 +155,41 @@ function _getAllInstanceMethodNames(instance) {
     }
     return Array.from(names);
 }
+function _getStatsigOptionLoggingCopy(options) {
+    if (!options) {
+        return {};
+    }
+    const loggingCopy = {};
+    Object.entries(options).forEach(([option, value]) => {
+        const valueType = typeof value;
+        switch (valueType) {
+            case 'number':
+            case 'bigint':
+            case 'boolean':
+                loggingCopy[String(option)] = value;
+                break;
+            case 'string':
+                if (value.length < 50) {
+                    loggingCopy[String(option)] = value;
+                }
+                else {
+                    loggingCopy[String(option)] = 'set';
+                }
+                break;
+            case 'object':
+                if (option === 'environment') {
+                    loggingCopy['environment'] = value;
+                }
+                else if (option === 'networkConfig') {
+                    loggingCopy['networkConfig'] = value;
+                }
+                else {
+                    loggingCopy[String(option)] = value != null ? 'set' : 'unset';
+                }
+                break;
+            default:
+            // Ignore other fields
+        }
+    });
+    return loggingCopy;
+}

package/src/NetworkCore.js

@@ -230,13 +230,7 @@ class NetworkCore {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const body = args.body;
-            if (!args.isCompressable ||
-                this._options.disableCompression ||
-                typeof body !== 'string' ||
-                SDKFlags_1.SDKFlags.get(args.sdkKey, 'enable_log_event_compression') !== true ||
-                (0, __StatsigGlobal_1._getStatsigGlobalFlag)('no-compress') != null ||
-                typeof CompressionStream === 'undefined' ||
-                typeof TextEncoder === 'undefined') {
+            if (typeof body !== 'string' || !_allowCompression(args, this._options)) {
                 return;
             }
             try {
@@ -295,6 +289,24 @@ const _populateRequestBody = (args, data) => {
             sdkType,
             fallbackUrl }) }));
 };
+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;
+    }
+    if ((0, __StatsigGlobal_1._getStatsigGlobalFlag)('no-compress') != null ||
+        typeof CompressionStream === 'undefined' ||
+        typeof TextEncoder === 'undefined') {
+        return false;
+    }
+    return true;
+}
 function _getErrorMessage(controller, error) {
     if ((controller === null || controller === void 0 ? void 0 : controller.signal.aborted) &&
         typeof controller.signal.reason === 'string') {

package/src/NetworkFallbackResolver.d.ts

@@ -13,7 +13,6 @@ export declare class NetworkFallbackResolver {
     setErrorBoundary(errorBoundary: ErrorBoundary): void;
     tryBumpExpiryTime(sdkKey: string, urlConfig: UrlConfiguration): void;
     getActiveFallbackUrl(sdkKey: string, urlConfig: UrlConfiguration): string | null;
-    getFallbackFromProvided(url: string): string | null;
     tryFetchUpdatedFallbackInfo(sdkKey: string, urlConfig: UrlConfiguration, errorMessage: string | null, timedOut: boolean): Promise<boolean>;
     private _updateFallbackInfoWithNewUrl;
     private _tryFetchFallbackUrlsFromNetwork;

package/src/NetworkFallbackResolver.js

@@ -38,13 +38,18 @@ class NetworkFallbackResolver {
     }
     getActiveFallbackUrl(sdkKey, urlConfig) {
         var _a, _b;
+        if (urlConfig.customUrl != null && urlConfig.fallbackUrls != null) {
+            return null;
+        }
         let info = this._fallbackInfo;
         if (info == null) {
             info = (_a = _readFallbackInfoFromCache(sdkKey)) !== null && _a !== void 0 ? _a : {};
             this._fallbackInfo = info;
         }
         const entry = info[urlConfig.endpoint];
-        if (!entry || Date.now() > ((_b = entry.expiryTime) !== null && _b !== void 0 ? _b : 0)) {
+        if (!entry ||
+            Date.now() > ((_b = entry.expiryTime) !== null && _b !== void 0 ? _b : 0) ||
+            urlConfig.getChecksum() !== entry.urlConfigChecksum) {
             delete info[urlConfig.endpoint];
             this._fallbackInfo = info;
             _tryWriteFallbackInfoToCache(sdkKey, this._fallbackInfo);
@@ -55,13 +60,6 @@ class NetworkFallbackResolver {
         }
         return null;
     }
-    getFallbackFromProvided(url) {
-        const path = _extractPathFromUrl(url);
-        if (path) {
-            return url.replace(path, '');
-        }
-        return null;
-    }
     tryFetchUpdatedFallbackInfo(sdkKey, urlConfig, errorMessage, timedOut) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
@@ -77,7 +75,7 @@ class NetworkFallbackResolver {
                 if (!newUrl) {
                     return false;
                 }
-                this._updateFallbackInfoWithNewUrl(sdkKey, urlConfig.endpoint, newUrl);
+                this._updateFallbackInfoWithNewUrl(sdkKey, urlConfig, newUrl);
                 return true;
             }
             catch (error) {
@@ -86,13 +84,15 @@ class NetworkFallbackResolver {
             }
         });
     }
-    _updateFallbackInfoWithNewUrl(sdkKey, endpoint, newUrl) {
+    _updateFallbackInfoWithNewUrl(sdkKey, urlConfig, newUrl) {
         var _a, _b, _c;
         const newFallbackInfo = {
+            urlConfigChecksum: urlConfig.getChecksum(),
             url: newUrl,
             expiryTime: Date.now() + DEFAULT_TTL_MS,
             previous: [],
         };
+        const endpoint = urlConfig.endpoint;
         const previousInfo = (_a = this._fallbackInfo) === null || _a === void 0 ? void 0 : _a[endpoint];
         if (previousInfo) {
             newFallbackInfo.previous.push(...previousInfo.previous);

package/src/SafeJs.d.ts

@@ -4,3 +4,4 @@ export declare const _isServerEnv: () => boolean;
 export declare const _addWindowEventListenerSafe: (key: string, listener: () => void) => void;
 export declare const _addDocumentEventListenerSafe: (key: string, listener: () => void) => void;
 export declare const _getCurrentPageUrlSafe: () => string | undefined;
+export declare const _getUnloadEvent: () => string;

package/src/SafeJs.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._getCurrentPageUrlSafe = exports._addDocumentEventListenerSafe = exports._addWindowEventListenerSafe = exports._isServerEnv = exports._getDocumentSafe = exports._getWindowSafe = void 0;
+exports._getUnloadEvent = exports._getCurrentPageUrlSafe = exports._addDocumentEventListenerSafe = exports._addWindowEventListenerSafe = exports._isServerEnv = exports._getDocumentSafe = exports._getWindowSafe = void 0;
 const _getWindowSafe = () => {
     return typeof window !== 'undefined' ? window : null;
 };
@@ -46,3 +46,12 @@ const _getCurrentPageUrlSafe = () => {
     }
 };
 exports._getCurrentPageUrlSafe = _getCurrentPageUrlSafe;
+const _getUnloadEvent = () => {
+    const win = (0, exports._getWindowSafe)();
+    if (!win) {
+        return 'beforeunload';
+    }
+    const eventType = 'onpagehide' in win ? 'pagehide' : 'beforeunload';
+    return eventType;
+};
+exports._getUnloadEvent = _getUnloadEvent;

package/src/StatsigMetadata.d.ts

@@ -1,4 +1,4 @@
-export declare const SDK_VERSION = "3.13.0";
+export declare const SDK_VERSION = "3.14.1";
 export type StatsigMetadata = {
     readonly [key: string]: string | undefined;
     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.13.0';
+exports.SDK_VERSION = '3.14.1';
 let metadata = {
     sdkVersion: exports.SDK_VERSION,
     sdkType: 'js-mono', // js-mono is overwritten by Precomp and OnDevice clients

package/src/UrlConfiguration.d.ts

@@ -8,4 +8,5 @@ export declare class UrlConfiguration {
     readonly fallbackUrls: string[] | null;
     constructor(endpoint: Endpoint, customUrl: string | undefined | null, customApi: string | undefined | null, fallbackUrls: string[] | undefined | null);
     getUrl(): string;
+    getChecksum(): string;
 }

package/src/UrlConfiguration.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UrlConfiguration = void 0;
+const Hashing_1 = require("./Hashing");
 const NetworkConfig_1 = require("./NetworkConfig");
 const ENDPOINT_DNS_KEY_MAP = {
     [NetworkConfig_1.Endpoint._initialize]: 'i',
@@ -31,5 +32,10 @@ class UrlConfiguration {
         var _a;
         return (_a = this.customUrl) !== null && _a !== void 0 ? _a : this.defaultUrl;
     }
+    getChecksum() {
+        var _a;
+        const fallbacks = ((_a = this.fallbackUrls) !== null && _a !== void 0 ? _a : []).sort().join(',');
+        return (0, Hashing_1._DJB2)(this.customUrl + fallbacks);
+    }
 }
 exports.UrlConfiguration = UrlConfiguration;

package/src/VisibilityObserving.js

@@ -30,14 +30,10 @@ exports._notifyVisibilityChanged = _notifyVisibilityChanged;
     (0, exports._notifyVisibilityChanged)(FOREGROUND);
 });
 (0, SafeJs_1._addWindowEventListenerSafe)('blur', () => (0, exports._notifyVisibilityChanged)(BACKGROUND));
-(0, SafeJs_1._addWindowEventListenerSafe)('beforeunload', () => {
-    isUnloading = true;
-    (0, exports._notifyVisibilityChanged)(BACKGROUND);
-});
 (0, SafeJs_1._addDocumentEventListenerSafe)('visibilitychange', () => {
     (0, exports._notifyVisibilityChanged)(document.visibilityState === 'visible' ? FOREGROUND : BACKGROUND);
 });
-(0, SafeJs_1._addDocumentEventListenerSafe)('pagehide', () => {
+(0, SafeJs_1._addWindowEventListenerSafe)((0, SafeJs_1._getUnloadEvent)(), () => {
     isUnloading = true;
     (0, exports._notifyVisibilityChanged)(BACKGROUND);
 });

package/src/__tests__/MockOverrideAdapter.d.ts

@@ -0,0 +1,16 @@
+import { DynamicConfigEvaluationOptions, ExperimentEvaluationOptions, FeatureGateEvaluationOptions, LayerEvaluationOptions, ParameterStoreEvaluationOptions } from '../EvaluationOptions';
+import { EvaluationDetails } from '../EvaluationTypes';
+import { OverrideAdapter } from '../OverrideAdapter';
+import { ParamStoreConfig } from '../ParamStoreTypes';
+import { DynamicConfig, Experiment, FeatureGate, Layer, ParameterStore } from '../StatsigTypes';
+import { StatsigUser } from '../StatsigUser';
+export declare class MockOverrideAdapter implements OverrideAdapter {
+    getGateOverride(_current: FeatureGate, _user: StatsigUser, _options?: FeatureGateEvaluationOptions): FeatureGate | null;
+    getDynamicConfigOverride(_current: DynamicConfig, _user: StatsigUser, _options?: DynamicConfigEvaluationOptions): DynamicConfig | null;
+    getExperimentOverride(_current: Experiment, _user: StatsigUser, _options?: ExperimentEvaluationOptions): Experiment | null;
+    getLayerOverride(_current: Layer, _user: StatsigUser, _options?: LayerEvaluationOptions): Layer | null;
+    getParamStoreOverride(_current: ParameterStore, _options?: ParameterStoreEvaluationOptions): {
+        config: ParamStoreConfig;
+        details: EvaluationDetails;
+    } | null;
+}

package/src/__tests__/MockOverrideAdapter.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MockOverrideAdapter = void 0;
+class MockOverrideAdapter {
+    getGateOverride(_current, _user, _options) {
+        return null;
+    }
+    getDynamicConfigOverride(_current, _user, _options) {
+        return null;
+    }
+    getExperimentOverride(_current, _user, _options) {
+        return null;
+    }
+    getLayerOverride(_current, _user, _options) {
+        return null;
+    }
+    getParamStoreOverride(_current, _options) {
+        return null;
+    }
+}
+exports.MockOverrideAdapter = MockOverrideAdapter;