@statsig/client-core 3.9.1 → 3.10.0

package/package.json

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

package/src/ClientInterfaces.d.ts

@@ -8,11 +8,12 @@ import { EvaluationsDataAdapter, SpecsDataAdapter } from './StatsigDataAdapter';
 import { StatsigEvent } from './StatsigEvent';
 import { AnyStatsigOptions, StatsigRuntimeMutableOptions } from './StatsigOptionsCommon';
 import { DynamicConfig, Experiment, FeatureGate, Layer, ParameterStore } from './StatsigTypes';
+import { StatsigUpdateDetails } from './StatsigUpdateDetails';
 import { StatsigUser } from './StatsigUser';
 import { Flatten } from './TypingUtils';
 export interface StatsigClientCommonInterface extends StatsigClientEventEmitterInterface {
-    initializeSync(): void;
-    initializeAsync(): Promise<void>;
+    initializeSync(): StatsigUpdateDetails;
+    initializeAsync(): Promise<StatsigUpdateDetails>;
     shutdown(): Promise<void>;
     flush(): Promise<void>;
     updateRuntimeOptions(options: StatsigRuntimeMutableOptions): void;
@@ -45,8 +46,8 @@ export type PrecomputedEvaluationsContext = Flatten<CommonContext & {
 export interface PrecomputedEvaluationsInterface extends StatsigClientCommonInterface {
     readonly dataAdapter: EvaluationsDataAdapter;
     getContext(): PrecomputedEvaluationsContext;
-    updateUserSync(user: StatsigUser): void;
-    updateUserAsync(user: StatsigUser): Promise<void>;
+    updateUserSync(user: StatsigUser): StatsigUpdateDetails;
+    updateUserAsync(user: StatsigUser): Promise<StatsigUpdateDetails>;
     checkGate(name: string, options?: FeatureGateEvaluationOptions): boolean;
     getFeatureGate(name: string, options?: FeatureGateEvaluationOptions): FeatureGate;
     getDynamicConfig(name: string, options?: DynamicConfigEvaluationOptions): DynamicConfig;

package/src/Diagnostics.d.ts

@@ -42,7 +42,7 @@ export declare const Diagnostics: {
         attempt: number;
         error?: Record<string, unknown> | undefined;
     };
-    _enqueueDiagnosticsEvent(user: StatsigUserInternal | null, logger: EventLogger, sdk: string, options: StatsigOptionsCommon<NetworkConfigCommon> | null): void;
+    _enqueueDiagnosticsEvent(user: StatsigUserInternal | null, logger: EventLogger, sdk: string, options: StatsigOptionsCommon<NetworkConfigCommon> | null): number;
 };
 interface InitializeDataType {
     process: {

package/src/Diagnostics.js

@@ -60,8 +60,9 @@ exports.Diagnostics = {
     _enqueueDiagnosticsEvent(user, logger, sdk, options) {
         const markers = exports.Diagnostics._getMarkers(sdk);
         if (markers == null || markers.length <= 0) {
-            return;
+            return -1;
         }
+        const overallInitDuration = markers[markers.length - 1].timestamp - markers[0].timestamp;
         exports.Diagnostics._clearMarkers(sdk);
         const event = _makeDiagnosticsEvent(user, {
             context: 'initialize',
@@ -69,6 +70,7 @@ exports.Diagnostics = {
             statsigOptions: options,
         });
         logger.enqueue(event);
+        return overallInitDuration;
     },
 };
 function _createMarker(data, action, key, step) {

package/src/ErrorBoundary.d.ts

@@ -5,10 +5,13 @@ export declare class ErrorBoundary {
     private _sdkKey;
     private _options;
     private _emitter?;
+    private _lastSeenError?;
     private _seen;
-    constructor(_sdkKey: string, _options: AnyStatsigOptions | null, _emitter?: StatsigClientEmitEventFunc | undefined);
+    constructor(_sdkKey: string, _options: AnyStatsigOptions | null, _emitter?: StatsigClientEmitEventFunc | undefined, _lastSeenError?: Error | undefined);
     wrap(instance: unknown): void;
     logError(tag: string, error: unknown): void;
+    getLastSeenErrorAndReset(): Error | null;
+    attachErrorIfNoneExists(error: unknown): void;
     private _capture;
     private _onError;
 }

package/src/ErrorBoundary.js

@@ -16,10 +16,11 @@ const StatsigMetadata_1 = require("./StatsigMetadata");
 exports.EXCEPTION_ENDPOINT = 'https://statsigapi.net/v1/sdk_exception';
 const UNKNOWN_ERROR = '[Statsig] UnknownError';
 class ErrorBoundary {
-    constructor(_sdkKey, _options, _emitter) {
+    constructor(_sdkKey, _options, _emitter, _lastSeenError) {
         this._sdkKey = _sdkKey;
         this._options = _options;
         this._emitter = _emitter;
+        this._lastSeenError = _lastSeenError;
         this._seen = new Set();
     }
     wrap(instance) {
@@ -43,6 +44,17 @@ class ErrorBoundary {
     logError(tag, error) {
         this._onError(tag, error);
     }
+    getLastSeenErrorAndReset() {
+        const tempError = this._lastSeenError;
+        this._lastSeenError = undefined;
+        return tempError !== null && tempError !== void 0 ? tempError : null;
+    }
+    attachErrorIfNoneExists(error) {
+        if (this._lastSeenError) {
+            return;
+        }
+        this._lastSeenError = _resolveError(error);
+    }
     _capture(tag, task) {
         try {
             const res = task();
@@ -64,6 +76,8 @@ class ErrorBoundary {
                 const unwrapped = (error ? error : Error(UNKNOWN_ERROR));
                 const isError = unwrapped instanceof Error;
                 const name = isError ? unwrapped.name : 'No Name';
+                const resolvedError = _resolveError(unwrapped);
+                this._lastSeenError = resolvedError;
                 if (this._seen.has(name)) {
                     return;
                 }
@@ -111,6 +125,17 @@ class ErrorBoundary {
     }
 }
 exports.ErrorBoundary = ErrorBoundary;
+function _resolveError(error) {
+    if (error instanceof Error) {
+        return error;
+    }
+    else if (typeof error === 'string') {
+        return new Error(error);
+    }
+    else {
+        return new Error('An unknown error occurred.');
+    }
+}
 function _getDescription(obj) {
     try {
         return JSON.stringify(obj);

package/src/EvaluationTypes.d.ts

@@ -35,12 +35,12 @@ export type EvaluationDetails = {
     reason: string;
     lcut?: number;
     receivedAt?: number;
-    warnings?: EvaluationWarning[];
+    warnings?: StatsigWarnings[];
     bootstrapMetadata?: BootstrapMetadata;
 };
 export type DetailedStoreResult<T extends AnyEvaluation | ParamStoreConfig> = {
     result: T | null;
     details: EvaluationDetails;
 };
-export type EvaluationWarning = 'PartialUserMatch' | 'StableIDMismatch';
+export type StatsigWarnings = 'PartialUserMatch' | 'StableIDMismatch' | 'MultipleInitializations' | 'NoCachedValues';
 export {};

package/src/NetworkCore.d.ts

@@ -26,15 +26,17 @@ type NetworkResponse = {
 };
 export declare class NetworkCore {
     private _emitter?;
+    protected _errorBoundary: ErrorBoundary | null;
     private readonly _timeout;
     private readonly _netConfig;
     private readonly _options;
     private readonly _fallbackResolver;
     private _leakyBucket;
-    private _errorBoundary;
+    private _lastUsedInitUrl;
     constructor(options: AnyStatsigOptions | null, _emitter?: StatsigClientEmitEventFunc | undefined);
     setErrorBoundary(errorBoundary: ErrorBoundary): void;
     isBeaconSupported(): boolean;
+    getLastUsedInitUrlAndReset(): string | null;
     beacon(args: BeaconRequestArgs): Promise<boolean>;
     post(args: RequestArgsWithData): Promise<NetworkResponse | null>;
     get(args: RequestArgs): Promise<NetworkResponse | null>;

package/src/NetworkCore.js

@@ -33,11 +33,12 @@ const RETRYABLE_CODES = new Set([408, 500, 502, 503, 504, 522, 524, 599]);
 class NetworkCore {
     constructor(options, _emitter) {
         this._emitter = _emitter;
+        this._errorBoundary = null;
         this._timeout = DEFAULT_TIMEOUT_MS;
         this._netConfig = {};
         this._options = {};
         this._leakyBucket = {};
-        this._errorBoundary = null;
+        this._lastUsedInitUrl = null;
         if (options) {
             this._options = options;
         }
@@ -59,6 +60,11 @@ class NetworkCore {
         return (typeof navigator !== 'undefined' &&
             typeof navigator.sendBeacon === 'function');
     }
+    getLastUsedInitUrlAndReset() {
+        const tempUrl = this._lastUsedInitUrl;
+        this._lastUsedInitUrl = null;
+        return tempUrl;
+    }
     beacon(args) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!_ensureValidSdkKey(args)) {
@@ -86,7 +92,7 @@ class NetworkCore {
         return this._sendRequest(argsInternal);
     }
     _sendRequest(args) {
-        var _a, _b, _c;
+        var _a, _b, _c, _d;
         return __awaiter(this, void 0, void 0, function* () {
             if (!_ensureValidSdkKey(args)) {
                 return null;
@@ -157,7 +163,9 @@ class NetworkCore {
                         tag: StatsigClientEventEmitter_1.ErrorTag.NetworkError,
                         requestArgs: args,
                     });
-                    Log_1.Log.error(`A networking error occured during ${method} request to ${populatedUrl}.`, errorMessage, error);
+                    const formattedErrorMsg = `A networking error occurred during ${method} request to ${populatedUrl}.`;
+                    Log_1.Log.error(formattedErrorMsg, errorMessage, error);
+                    (_d = this._errorBoundary) === null || _d === void 0 ? void 0 : _d.attachErrorIfNoneExists(formattedErrorMsg);
                     return null;
                 }
                 yield _exponentialBackoff(currentAttempt);
@@ -187,6 +195,10 @@ class NetworkCore {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const url = (_a = args.fallbackUrl) !== null && _a !== void 0 ? _a : args.urlConfig.getUrl();
+            if (args.urlConfig.endpoint === NetworkConfig_1.Endpoint._initialize ||
+                args.urlConfig.endpoint === NetworkConfig_1.Endpoint._download_config_specs) {
+                this._lastUsedInitUrl = url;
+            }
             const params = Object.assign({ [NetworkConfig_1.NetworkParam.SdkKey]: args.sdkKey, [NetworkConfig_1.NetworkParam.SdkType]: SDKType_1.SDKType._get(args.sdkKey), [NetworkConfig_1.NetworkParam.SdkVersion]: StatsigMetadata_1.SDK_VERSION, [NetworkConfig_1.NetworkParam.Time]: String(Date.now()), [NetworkConfig_1.NetworkParam.SessionID]: SessionID_1.SessionID.get(args.sdkKey) }, args.params);
             const query = Object.keys(params)
                 .map((key) => {

package/src/StatsigClientBase.d.ts

@@ -8,6 +8,7 @@ import { AnyStatsigClientEvent, StatsigClientEventCallback, StatsigClientEventEm
 import { DataAdapterResult, EvaluationsDataAdapter, SpecsDataAdapter } from './StatsigDataAdapter';
 import { StatsigEventInternal } from './StatsigEvent';
 import { AnyStatsigOptions, StatsigRuntimeMutableOptions } from './StatsigOptionsCommon';
+import { StatsigUpdateDetails } from './StatsigUpdateDetails';
 import { StorageProvider } from './StorageProvider';
 export type StatsigClientEmitEventFunc = (event: AnyStatsigClientEvent) => void;
 export type StatsigContext = {
@@ -25,7 +26,7 @@ export declare abstract class StatsigClientBase<TAdapter extends EvaluationsData
     protected readonly _options: AnyStatsigOptions;
     protected readonly _errorBoundary: ErrorBoundary;
     protected readonly _logger: EventLogger;
-    protected _initializePromise: Promise<void> | null;
+    protected _initializePromise: Promise<StatsigUpdateDetails> | null;
     protected _memoCache: Record<string, unknown>;
     private _listeners;
     constructor(sdkKey: string, adapter: TAdapter, network: NetworkCore, options: AnyStatsigOptions | null);

package/src/StatsigMetadata.d.ts

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

package/src/StatsigUpdateDetails.d.ts

@@ -0,0 +1,14 @@
+import { StatsigWarnings } from './EvaluationTypes';
+import { DataSource } from './StatsigDataAdapter';
+export type StatsigUpdateDetails = {
+    duration: number;
+    source: DataSource;
+    success: boolean;
+    error: Error | null;
+    sourceUrl: string | null;
+    warnings?: StatsigWarnings[];
+};
+export declare const createUpdateDetails: (success: boolean, source: DataSource, initDuration: number, error: Error | null, sourceUrl: string | null, warnings?: StatsigWarnings[]) => StatsigUpdateDetails;
+export declare const UPDATE_DETAIL_ERROR_MESSAGES: {
+    NO_NETWORK_DATA: string;
+};

package/src/StatsigUpdateDetails.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UPDATE_DETAIL_ERROR_MESSAGES = exports.createUpdateDetails = void 0;
+const createUpdateDetails = (success, source, initDuration, error, sourceUrl, warnings) => {
+    return {
+        duration: initDuration,
+        source,
+        success,
+        error,
+        sourceUrl,
+        warnings,
+    };
+};
+exports.createUpdateDetails = createUpdateDetails;
+exports.UPDATE_DETAIL_ERROR_MESSAGES = {
+    NO_NETWORK_DATA: 'No data was returned from the network. This may be due to a network timeout if a timeout value was specified in the options or ad blocker error.',
+};

package/src/index.d.ts

@@ -40,4 +40,5 @@ export * from './TypingUtils';
 export * from './UrlConfiguration';
 export * from './UUID';
 export * from './VisibilityObserving';
+export * from './StatsigUpdateDetails';
 export { EventLogger, Storage, Log, Diagnostics };

package/src/index.js

@@ -62,5 +62,6 @@ __exportStar(require("./TypingUtils"), exports);
 __exportStar(require("./UrlConfiguration"), exports);
 __exportStar(require("./UUID"), exports);
 __exportStar(require("./VisibilityObserving"), exports);
+__exportStar(require("./StatsigUpdateDetails"), exports);
 __STATSIG__ = Object.assign(Object.assign({}, (__STATSIG__ !== null && __STATSIG__ !== void 0 ? __STATSIG__ : {})), { Log: Log_1.Log,
     SDK_VERSION: StatsigMetadata_1.SDK_VERSION });