@statsig/client-core 0.0.1-beta.30 → 0.0.1-beta.32

package/package.json

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

package/src/$_StatsigGlobal.d.ts

@@ -5,7 +5,7 @@ export type StatsigGlobal = {
     lastInstance?: StatsigClientInterface;
     acInstances?: Record<string, unknown>;
     srInstances?: Record<string, unknown>;
-    instance?: (sdkKey: string) => StatsigClientInterface | undefined;
+    instance: (sdkKey?: string) => StatsigClientInterface | undefined;
 };
 declare global {
     let __STATSIG__: StatsigGlobal | undefined;
@@ -14,3 +14,4 @@ declare global {
     }
 }
 export declare const _getStatsigGlobal: () => StatsigGlobal;
+export declare const _getInstance: (sdkKey: string) => StatsigClientInterface | undefined;

package/src/$_StatsigGlobal.js

@@ -2,16 +2,23 @@
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
 var _a, _b, _c;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._getStatsigGlobal = void 0;
+exports._getInstance = exports._getStatsigGlobal = void 0;
+const _getStatsigGlobal = () => {
+    return __STATSIG__ !== null && __STATSIG__ !== void 0 ? __STATSIG__ : statsigGlobal;
+};
+exports._getStatsigGlobal = _getStatsigGlobal;
+const _getInstance = (sdkKey) => {
+    var _a;
+    return sdkKey ? (_a = __STATSIG__ === null || __STATSIG__ === void 0 ? void 0 : __STATSIG__.instances) === null || _a === void 0 ? void 0 : _a[sdkKey] : __STATSIG__ === null || __STATSIG__ === void 0 ? void 0 : __STATSIG__.lastInstance;
+};
+exports._getInstance = _getInstance;
 const GLOBAL_KEY = '__STATSIG__';
 const _window = typeof window !== 'undefined' ? window : {};
 const _global = typeof global !== 'undefined' ? global : {};
 const _globalThis = typeof globalThis !== 'undefined' ? globalThis : {};
-const statsigGlobal = (_c = (_b = (_a = _window[GLOBAL_KEY]) !== null && _a !== void 0 ? _a : _global[GLOBAL_KEY]) !== null && _b !== void 0 ? _b : _globalThis[GLOBAL_KEY]) !== null && _c !== void 0 ? _c : {};
+const statsigGlobal = (_c = (_b = (_a = _window[GLOBAL_KEY]) !== null && _a !== void 0 ? _a : _global[GLOBAL_KEY]) !== null && _b !== void 0 ? _b : _globalThis[GLOBAL_KEY]) !== null && _c !== void 0 ? _c : {
+    instance: exports._getInstance,
+};
 _window[GLOBAL_KEY] = statsigGlobal;
 _global[GLOBAL_KEY] = statsigGlobal;
 _globalThis[GLOBAL_KEY] = statsigGlobal;
-const _getStatsigGlobal = () => {
-    return __STATSIG__ !== null && __STATSIG__ !== void 0 ? __STATSIG__ : statsigGlobal;
-};
-exports._getStatsigGlobal = _getStatsigGlobal;

package/src/DataAdapterCore.d.ts

@@ -1,5 +1,5 @@
 import { ErrorBoundary } from './ErrorBoundary';
-import { DataAdapterResult } from './StatsigDataAdapter';
+import { DataAdapterAsyncOptions, DataAdapterResult } from './StatsigDataAdapter';
 import { AnyStatsigOptions } from './StatsigOptionsCommon';
 import { StatsigUser } from './StatsigUser';
 export declare abstract class DataAdapterCore {
@@ -12,8 +12,6 @@ export declare abstract class DataAdapterCore {
     protected constructor(_adapterName: string, _cacheSuffix: string);
     attach(sdkKey: string, _options: AnyStatsigOptions | null): void;
     getDataSync(user?: StatsigUser | undefined): DataAdapterResult | null;
-    getDataAsync(current: DataAdapterResult | null, user?: StatsigUser): Promise<DataAdapterResult | null>;
-    prefetchData(user?: StatsigUser | undefined): Promise<void>;
     setData(data: string, user?: StatsigUser): void;
     /**
      * (Internal Use Only) - Used by \@statsig/react-native-bindings to prime the cache from AsyncStorage
@@ -21,6 +19,8 @@ export declare abstract class DataAdapterCore {
      * @param {Record<string, DataAdapterResult>} cache The values to merge into _inMemoryCache
      */
     __primeInMemoryCache(cache: Record<string, DataAdapterResult>): void;
+    protected _getDataAsyncImpl(current: DataAdapterResult | null, user?: StatsigUser, options?: DataAdapterAsyncOptions): Promise<DataAdapterResult | null>;
+    protected _prefetchDataImpl(user?: StatsigUser, options?: DataAdapterAsyncOptions): Promise<void>;
     protected abstract _fetchFromNetwork(current: string | null, user?: StatsigUser): Promise<string | null>;
     private _fetchLatest;
     protected _getSdkKey(): string;

package/src/DataAdapterCore.js

@@ -45,31 +45,6 @@ class DataAdapterCore {
         }
         return null;
     }
-    getDataAsync(current, user) {
-        var _a;
-        return __awaiter(this, void 0, void 0, function* () {
-            const cache = current !== null && current !== void 0 ? current : this.getDataSync(user);
-            const latest = yield this._fetchLatest((_a = cache === null || cache === void 0 ? void 0 : cache.data) !== null && _a !== void 0 ? _a : null, user);
-            const cacheKey = this._getCacheKey(user);
-            if (latest) {
-                this._addToInMemoryCache(cacheKey, latest);
-            }
-            if ((latest === null || latest === void 0 ? void 0 : latest.source) === 'Network' ||
-                (latest === null || latest === void 0 ? void 0 : latest.source) === 'NetworkNotModified') {
-                yield this._writeToCache(cacheKey, latest);
-            }
-            return latest;
-        });
-    }
-    prefetchData(user) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const cacheKey = this._getCacheKey(user);
-            const result = yield this.getDataAsync(null, user);
-            if (result) {
-                this._addToInMemoryCache(cacheKey, Object.assign(Object.assign({}, result), { source: 'Prefetch' }));
-            }
-        });
-    }
     setData(data, user) {
         const cacheKey = this._getCacheKey(user);
         this._addToInMemoryCache(cacheKey, {
@@ -86,6 +61,29 @@ class DataAdapterCore {
     __primeInMemoryCache(cache) {
         this._inMemoryCache = Object.assign(Object.assign({}, this._inMemoryCache), cache);
     }
+    _getDataAsyncImpl(current, user, options) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const cache = current !== null && current !== void 0 ? current : this.getDataSync(user);
+            const ops = [this._fetchLatest((_a = cache === null || cache === void 0 ? void 0 : cache.data) !== null && _a !== void 0 ? _a : null, user)];
+            if (options === null || options === void 0 ? void 0 : options.timeoutMs) {
+                ops.push(new Promise((r) => setTimeout(r, options.timeoutMs)).then(() => {
+                    Log_1.Log.debug('Fetching latest value timed out');
+                    return null;
+                }));
+            }
+            return yield Promise.race(ops);
+        });
+    }
+    _prefetchDataImpl(user, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const cacheKey = this._getCacheKey(user);
+            const result = yield this._getDataAsyncImpl(null, user, options);
+            if (result) {
+                this._addToInMemoryCache(cacheKey, Object.assign(Object.assign({}, result), { source: 'Prefetch' }));
+            }
+        });
+    }
     _fetchLatest(current, user) {
         return __awaiter(this, void 0, void 0, function* () {
             const latest = yield this._fetchFromNetwork(current, user);
@@ -94,17 +92,24 @@ class DataAdapterCore {
                 return null;
             }
             const response = (0, TypedJsonParse_1.typedJsonParse)(latest, 'has_updates', 'Failure while attempting to persist latest value');
-            if (current && (response === null || response === void 0 ? void 0 : response.has_updates) === false) {
-                return {
+            let result = null;
+            if ((response === null || response === void 0 ? void 0 : response.has_updates) === true) {
+                result = { source: 'Network', data: latest, receivedAt: Date.now() };
+            }
+            else if (current && (response === null || response === void 0 ? void 0 : response.has_updates) === false) {
+                result = {
                     source: 'NetworkNotModified',
                     data: current,
                     receivedAt: Date.now(),
                 };
             }
-            if ((response === null || response === void 0 ? void 0 : response.has_updates) !== true) {
+            if (!result) {
                 return null;
             }
-            return { source: 'Network', data: latest, receivedAt: Date.now() };
+            const cacheKey = this._getCacheKey(user);
+            this._addToInMemoryCache(cacheKey, result);
+            yield this._writeToCache(cacheKey, result);
+            return result;
         });
     }
     _getSdkKey() {

package/src/EventLogger.js

@@ -14,6 +14,7 @@ const Hashing_1 = require("./Hashing");
 const Log_1 = require("./Log");
 const NetworkDefaults_1 = require("./NetworkDefaults");
 const NetworkParams_1 = require("./NetworkParams");
+const SafeJs_1 = require("./SafeJs");
 const StatsigEvent_1 = require("./StatsigEvent");
 const StorageProvider_1 = require("./StorageProvider");
 const TypedJsonParse_1 = require("./TypedJsonParse");
@@ -249,15 +250,7 @@ class EventLogger {
         if (((_a = this._options) === null || _a === void 0 ? void 0 : _a.includeCurrentPageUrlWithEvents) === false) {
             return;
         }
-        if (typeof window === 'undefined' || typeof window.location !== 'object') {
-            return;
-        }
-        try {
-            return window.location.href.split(/[?#]/)[0];
-        }
-        catch (_b) {
-            return;
-        }
+        return (0, SafeJs_1._getCurrentPageUrlSafe)();
     }
 }
 exports.EventLogger = EventLogger;

package/src/NetworkCore.js

@@ -42,6 +42,9 @@ class NetworkCore {
     }
     beacon(args) {
         return __awaiter(this, void 0, void 0, function* () {
+            if (!_ensureValidSdkKey(args)) {
+                return false;
+            }
             const url = yield this._getPopulatedURL(args);
             const body = yield this._getPopulatedBody(args);
             return navigator.sendBeacon(url, body);
@@ -50,6 +53,9 @@ class NetworkCore {
     _sendRequest(args) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
+            if (!_ensureValidSdkKey(args)) {
+                return null;
+            }
             const { method, body, retries } = args;
             const controller = new AbortController();
             const handle = setTimeout(() => controller.abort(`Timeout of ${this._timeout}ms expired.`), this._timeout);
@@ -131,6 +137,13 @@ class NetworkCore {
     }
 }
 exports.NetworkCore = NetworkCore;
+const _ensureValidSdkKey = (args) => {
+    if (!args.sdkKey) {
+        Log_1.Log.warn('Unable to make request without an SDK key');
+        return false;
+    }
+    return true;
+};
 function _getErrorMessage(controller, error) {
     if (controller.signal.aborted &&
         typeof controller.signal.reason === 'string') {

package/src/SafeJs.d.ts

@@ -1,4 +1,6 @@
 export declare const _getWindowSafe: () => Window | null;
 export declare const _getDocumentSafe: () => Document | null;
+export declare const _isBrowserEnv: () => 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;

package/src/SafeJs.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._addDocumentEventListenerSafe = exports._addWindowEventListenerSafe = exports._getDocumentSafe = exports._getWindowSafe = void 0;
+exports._getCurrentPageUrlSafe = exports._addDocumentEventListenerSafe = exports._addWindowEventListenerSafe = exports._isBrowserEnv = exports._getDocumentSafe = exports._getWindowSafe = void 0;
 const _getWindowSafe = () => {
     return typeof window !== 'undefined' ? window : null;
 };
@@ -11,6 +11,10 @@ const _getDocumentSafe = () => {
     return (_a = win === null || win === void 0 ? void 0 : win.document) !== null && _a !== void 0 ? _a : null;
 };
 exports._getDocumentSafe = _getDocumentSafe;
+const _isBrowserEnv = () => {
+    return (0, exports._getDocumentSafe)() != null;
+};
+exports._isBrowserEnv = _isBrowserEnv;
 const _addWindowEventListenerSafe = (key, listener) => {
     const win = (0, exports._getWindowSafe)();
     if (typeof (win === null || win === void 0 ? void 0 : win.addEventListener) === 'function') {
@@ -25,3 +29,13 @@ const _addDocumentEventListenerSafe = (key, listener) => {
     }
 };
 exports._addDocumentEventListenerSafe = _addDocumentEventListenerSafe;
+const _getCurrentPageUrlSafe = () => {
+    var _a;
+    try {
+        return (_a = (0, exports._getWindowSafe)()) === null || _a === void 0 ? void 0 : _a.location.href.split(/[?#]/)[0];
+    }
+    catch (_b) {
+        return;
+    }
+};
+exports._getCurrentPageUrlSafe = _getCurrentPageUrlSafe;

package/src/StatsigClientBase.d.ts

@@ -4,11 +4,11 @@ import { EvaluationOptionsCommon } from './EvaluationOptions';
 import { EventLogger } from './EventLogger';
 import { NetworkCore } from './NetworkCore';
 import { OverrideAdapter } from './OverrideAdapter';
-import { StatsigClientEvent, StatsigClientEventCallback, StatsigClientEventEmitterInterface, StatsigClientEventName, StatsigLoadingStatus } from './StatsigClientEventEmitter';
+import { AnyStatsigClientEvent, StatsigClientEventCallback, StatsigClientEventEmitterInterface, StatsigClientEventName, StatsigLoadingStatus } from './StatsigClientEventEmitter';
 import { DataAdapterResult, EvaluationsDataAdapter, SpecsDataAdapter } from './StatsigDataAdapter';
 import { StatsigEventInternal } from './StatsigEvent';
 import { AnyStatsigOptions, StatsigRuntimeMutableOptions } from './StatsigOptionsCommon';
-export type StatsigClientEmitEventFunc = (event: StatsigClientEvent) => void;
+export type StatsigClientEmitEventFunc = (event: AnyStatsigClientEvent) => void;
 export type StatsigContext = {
     sdkKey: string;
     options: AnyStatsigOptions;
@@ -60,7 +60,7 @@ export declare abstract class StatsigClientBase<TAdapter extends EvaluationsData
      */
     off<T extends StatsigClientEventName>(event: T, listener: StatsigClientEventCallback<T>): void;
     __on<T extends StatsigClientEventName>(event: T, listener: StatsigClientEventCallback<T>): void;
-    protected _emit(event: StatsigClientEvent): void;
+    protected _emit(event: AnyStatsigClientEvent): void;
     protected _setStatus(newStatus: StatsigLoadingStatus, values: DataAdapterResult | null): void;
     protected _enqueueExposure(name: string, exposure: StatsigEventInternal, options?: EvaluationOptionsCommon): void;
 }

package/src/StatsigClientBase.js

@@ -11,9 +11,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StatsigClientBase = void 0;
 require("./$_StatsigGlobal");
+const __StatsigGlobal_1 = require("./$_StatsigGlobal");
 const ErrorBoundary_1 = require("./ErrorBoundary");
 const EventLogger_1 = require("./EventLogger");
 const Log_1 = require("./Log");
+const SafeJs_1 = require("./SafeJs");
 const SessionID_1 = require("./SessionID");
 const StableID_1 = require("./StableID");
 const StorageProvider_1 = require("./StorageProvider");
@@ -34,8 +36,11 @@ class StatsigClientBase {
             this._emit({ name: 'session_expired' });
         }, sdkKey);
         this._errorBoundary = new ErrorBoundary_1.ErrorBoundary(sdkKey);
-        const statsigGlobal = __STATSIG__ !== null && __STATSIG__ !== void 0 ? __STATSIG__ : {};
+        const statsigGlobal = (0, __StatsigGlobal_1._getStatsigGlobal)();
         const instances = (_c = statsigGlobal.instances) !== null && _c !== void 0 ? _c : {};
+        if (instances[sdkKey] != null && (0, SafeJs_1._isBrowserEnv)()) {
+            Log_1.Log.warn('Creating multiple Statsig clients with the same SDK key can lead to unexpected behavior. Multi-instance support requires different SDK keys.');
+        }
         const inst = this;
         instances[sdkKey] = inst;
         statsigGlobal.lastInstance = inst;

package/src/StatsigClientEventEmitter.d.ts

@@ -47,16 +47,17 @@ type EventNameToEventDataMap = {
  *
  * `layer_evaluation` - Fired when any layer is checked from the Statsig client.
  */
-export type StatsigClientEvent = Flatten<{
+export type AnyStatsigClientEvent = Flatten<{
     [K in keyof EventNameToEventDataMap]: {
         name: K;
     } & EventNameToEventDataMap[K];
 }[keyof EventNameToEventDataMap]>;
-export type AnyStatsigClientEventListener = StatsigClientEventCallback<StatsigClientEventName>;
-export type StatsigClientEventName = StatsigClientEvent['name'] | '*';
-export type StatsigClientEventCallback<T extends StatsigClientEventName> = (event: T extends '*' ? StatsigClientEvent : Extract<StatsigClientEvent, {
+export type StatsigClientEvent<T> = Extract<AnyStatsigClientEvent, {
     name: T;
-}>) => void;
+}>;
+export type AnyStatsigClientEventListener = StatsigClientEventCallback<StatsigClientEventName>;
+export type StatsigClientEventName = AnyStatsigClientEvent['name'] | '*';
+export type StatsigClientEventCallback<T extends StatsigClientEventName> = (event: T extends '*' ? AnyStatsigClientEvent : StatsigClientEvent<T>) => void;
 export interface StatsigClientEventEmitterInterface {
     readonly loadingStatus: StatsigLoadingStatus;
     on<T extends StatsigClientEventName>(event: T, listener: StatsigClientEventCallback<T>): void;

package/src/StatsigDataAdapter.d.ts

@@ -1,4 +1,4 @@
-import { AnyStatsigOptions } from './StatsigOptionsCommon';
+import type { AnyStatsigOptions, NetworkConfigCommon } from './StatsigOptionsCommon';
 import { StatsigUser } from './StatsigUser';
 export type DataSource = 'Uninitialized' | 'Loading' | 'NoValues' | 'Cache' | 'Network' | 'NetworkNotModified' | 'Bootstrap' | 'Prefetch';
 export type DataAdapterResult = {
@@ -6,12 +6,21 @@ export type DataAdapterResult = {
     readonly data: string;
     readonly receivedAt: number;
 };
+export type DataAdapterAsyncOptions = {
+    /**
+     * The maximum amount of time (in milliseconds) this operation is permitted to run.
+     * If the timeout is hit, null is returned but any in-flight requests are kept alive with results going to cache for future updates.
+     *
+     * Note: If no timeout is given, the {@link NetworkConfigCommon.networkTimeoutMs|StatsigOptions.networkConfig.networkTimeoutMs} is used.
+     */
+    readonly timeoutMs?: NetworkConfigCommon['networkTimeoutMs'];
+};
 export declare const DataAdapterCachePrefix = "statsig.cached";
 /**
  * Describes a type that is used during intialize/update operations of a Statsig client.
  *
  * See below to find the default adapters, but know that it is possible to create your
- * own StatsigDataAdapter and provide it via {@link StatsigOptionsCommon.dataAdapter}.
+ * own StatsigDataAdapter and provide it via {@link AnyStatsigOptions.dataAdapter}.
  *
  * Defaults:
  *
@@ -49,13 +58,13 @@ export type EvaluationsDataAdapter = DataAdapterCommon & {
      * @param {StatsigUser} user The StatsigUser to get data for.
      * @returns {DataAdapterResult | null} The data that was found for the given StatsigUser.
      */
-    readonly getDataAsync: (current: DataAdapterResult | null, user: StatsigUser) => Promise<DataAdapterResult | null>;
+    readonly getDataAsync: (current: DataAdapterResult | null, user: StatsigUser, options?: DataAdapterAsyncOptions) => Promise<DataAdapterResult | null>;
     /**
      * Manually trigger a fetch for new evaluations data for the given user.
      *
      * @param {StatsigUser} user The StatsigUser to get data for.
      */
-    readonly prefetchData: (user: StatsigUser) => Promise<void>;
+    readonly prefetchData: (user: StatsigUser, options?: DataAdapterAsyncOptions) => Promise<void>;
     /**
      * Manually set evaluations data for the given user.
      *
@@ -76,11 +85,11 @@ export type SpecsDataAdapter = DataAdapterCommon & {
      * @param {DataAdapterResult | null} current The data that was found synchronously (Cache). Will be used as fallback if getDataAsync fails
      * @returns {DataAdapterResult | null} The data that was found for the given StatsigUser.
      */
-    readonly getDataAsync: (current: DataAdapterResult | null) => Promise<DataAdapterResult | null>;
+    readonly getDataAsync: (current: DataAdapterResult | null, options?: DataAdapterAsyncOptions) => Promise<DataAdapterResult | null>;
     /**
      * Manually trigger a fetch for new specs data.
      */
-    readonly prefetchData: () => Promise<void>;
+    readonly prefetchData: (options?: DataAdapterAsyncOptions) => Promise<void>;
     /**
      * Manually set specs data (Bootstrap).
      */

package/src/StatsigMetadata.d.ts

@@ -1,4 +1,4 @@
-export declare const SDK_VERSION = "0.0.1-beta.30";
+export declare const SDK_VERSION = "0.0.1-beta.32";
 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 = '0.0.1-beta.30';
+exports.SDK_VERSION = '0.0.1-beta.32';
 let metadata = {
     sdkVersion: exports.SDK_VERSION,
     sdkType: 'js-mono', // js-mono is overwritten by Precomp and OnDevice clients

package/src/StatsigOptionsCommon.d.ts

@@ -3,12 +3,12 @@ import { OverrideAdapter } from './OverrideAdapter';
 /** Options that can be set at init and updated during runtime. */
 export type StatsigRuntimeMutableOptions = {
     /**
-     * Prevents writing anything to storage.
-     * Note: caching will not work if storage is disabled
+     * Prevents sending any events over the network.
      */
     disableLogging?: boolean;
     /**
      * Prevents writing anything to storage.
+     *
      * Note: caching will not work if storage is disabled
      */
     disableStorage?: boolean;