@statsig/js-client 3.9.1 → 3.11.0

package/src/StatsigClient.d.ts

@@ -1,10 +1,11 @@
-import { DataAdapterAsyncOptions, DataAdapterSyncOptions, EvaluationsDataAdapter, ExperimentEvaluationOptions, FeatureGateEvaluationOptions, PrecomputedEvaluationsContext, PrecomputedEvaluationsInterface, StatsigClientBase, StatsigEvent, StatsigUser } from '@statsig/client-core';
+import { DataAdapterAsyncOptions, DataAdapterSyncOptions, EvaluationsDataAdapter, ExperimentEvaluationOptions, FeatureGateEvaluationOptions, PrecomputedEvaluationsContext, PrecomputedEvaluationsInterface, StatsigClientBase, StatsigEvent, StatsigUpdateDetails, StatsigUser } from '@statsig/client-core';
 import type { StatsigOptions } from './StatsigOptions';
 type AsyncUpdateOptions = DataAdapterAsyncOptions;
 type SyncUpdateOptions = DataAdapterSyncOptions;
 export default class StatsigClient extends StatsigClientBase<EvaluationsDataAdapter> implements PrecomputedEvaluationsInterface {
     private _store;
     private _user;
+    private _network;
     /**
      * Retrieves an instance of the StatsigClient based on the provided SDK key.
      *  If no SDK key is provided, the method returns the most recently created instance of the StatsigClient.
@@ -29,7 +30,7 @@ export default class StatsigClient extends StatsigClientBase<EvaluationsDataAdap
      *
      * @see {@link initializeAsync} for the asynchronous version of this method.
      */
-    initializeSync(options?: SyncUpdateOptions): void;
+    initializeSync(options?: SyncUpdateOptions): StatsigUpdateDetails;
     /**
      * Initializes the StatsigClient asynchronously by first using cached values and then updating to the latest values from the network.
      * Once the network values are fetched, they replace the existing cached values. If this method's promise is not awaited,
@@ -40,7 +41,7 @@ export default class StatsigClient extends StatsigClientBase<EvaluationsDataAdap
      * @returns {Promise<void>} A promise that resolves once the client is fully initialized with the latest values from the network or a timeout (if set) is hit.
      * @see {@link initializeSync} for the synchronous version of this method.
      */
-    initializeAsync(options?: AsyncUpdateOptions): Promise<void>;
+    initializeAsync(options?: AsyncUpdateOptions): Promise<StatsigUpdateDetails>;
     /**
      * Synchronously updates the user in the Statsig client and switches the internal state to use cached values for the newly specified user.
      * After the initial switch to cached values, this method updates these values in the background, preparing them for future sessions or subsequent calls to updateUser.
@@ -49,7 +50,7 @@ export default class StatsigClient extends StatsigClientBase<EvaluationsDataAdap
      * @param {StatsigUser} user - The new StatsigUser for which the client should update its internal state.
      * @see {@link updateUserAsync} for the asynchronous version of this method.
      */
-    updateUserSync(user: StatsigUser, options?: SyncUpdateOptions): void;
+    updateUserSync(user: StatsigUser, options?: SyncUpdateOptions): StatsigUpdateDetails;
     /**
      * Asynchronously updates the user in the Statsig client by initially using cached values and then fetching the latest values from the network.
      * When the latest values are fetched, they replace the cached values. If the promise returned by this method is not awaited,
@@ -61,7 +62,7 @@ export default class StatsigClient extends StatsigClientBase<EvaluationsDataAdap
      * @returns {Promise<void>} A promise that resolves once the client is fully updated with the latest values from the network or a timeout (if set) is hit.
      * @see {@link updateUserSync} for the synchronous version of this method.
      */
-    updateUserAsync(user: StatsigUser, options?: AsyncUpdateOptions): Promise<void>;
+    updateUserAsync(user: StatsigUser, options?: AsyncUpdateOptions): Promise<StatsigUpdateDetails>;
     /**
      * Retrieves a synchronous context containing data currently being used by the SDK. Represented as a {@link PrecomputedEvaluationsContext} object.
      *

package/src/StatsigClient.js

@@ -54,7 +54,7 @@ class StatsigClient extends client_core_1.StatsigClientBase {
          * @param {FeatureGateEvaluationOptions} [options] - Optional. Additional options to customize the method call.
          * @returns {FeatureGate} - The {@link FeatureGate} object representing the gate's current evaluation results for the user.
          */
-        this.getFeatureGate = this._memoize(this._getFeatureGateImpl.bind(this));
+        this.getFeatureGate = this._memoize(client_core_1.MemoPrefix._gate, this._getFeatureGateImpl.bind(this));
         /**
          * Retrieves the value of a dynamic config for the current user.
          *
@@ -62,7 +62,7 @@ class StatsigClient extends client_core_1.StatsigClientBase {
          * @param {DynamicConfigEvaluationOptions} [options] - Optional. Additional options to customize the method call.
          * @returns {DynamicConfig} - The {@link DynamicConfig} object representing the dynamic configs's current evaluation results for the user.
          */
-        this.getDynamicConfig = this._memoize(this._getDynamicConfigImpl.bind(this));
+        this.getDynamicConfig = this._memoize(client_core_1.MemoPrefix._dynamicConfig, this._getDynamicConfigImpl.bind(this));
         /**
          * Retrieves the value of a experiment for the current user.
          *
@@ -70,7 +70,7 @@ class StatsigClient extends client_core_1.StatsigClientBase {
          * @param {ExperimentEvaluationOptions} [options] - Optional. Additional options to customize the method call.
          * @returns {Experiment} - The {@link Experiment} object representing the experiments's current evaluation results for the user.
          */
-        this.getExperiment = this._memoize(this._getExperimentImpl.bind(this));
+        this.getExperiment = this._memoize(client_core_1.MemoPrefix._experiment, this._getExperimentImpl.bind(this));
         /**
          * Retrieves the value of a layer for the current user.
          *
@@ -78,7 +78,7 @@ class StatsigClient extends client_core_1.StatsigClientBase {
          * @param {LayerEvaluationOptions} [options] - Optional. Additional options to customize the method call.
          * @returns {Layer} - The {@link Layer} object representing the layers's current evaluation results for the user.
          */
-        this.getLayer = this._memoize(this._getLayerImpl.bind(this));
+        this.getLayer = this._memoize(client_core_1.MemoPrefix._layer, this._getLayerImpl.bind(this));
         /**
          * Retrieves the value of a parameter store for the current user.
          *
@@ -86,8 +86,9 @@ class StatsigClient extends client_core_1.StatsigClientBase {
          * @param {ParameterStoreEvaluationOptions} [options] - Optional. Additional options to customize the method call.
          * @returns {ParameterStore} - The {@link ParameterStore} object representing the parameter store's current mappings for the user.
          */
-        this.getParameterStore = this._memoize(this._getParameterStoreImpl.bind(this));
+        this.getParameterStore = this._memoize(client_core_1.MemoPrefix._paramStore, this._getParameterStoreImpl.bind(this));
         this._store = new EvaluationStore_1.default(sdkKey);
+        this._network = network;
         this._user = this._configureUser(user, options);
         const plugins = (_b = options === null || options === void 0 ? void 0 : options.plugins) !== null && _b !== void 0 ? _b : [];
         for (const plugin of plugins) {
@@ -102,11 +103,12 @@ class StatsigClient extends client_core_1.StatsigClientBase {
      * @see {@link initializeAsync} for the asynchronous version of this method.
      */
     initializeSync(options) {
+        var _a;
         if (this.loadingStatus !== 'Uninitialized') {
-            return;
+            return (0, client_core_1.createUpdateDetails)(true, this._store.getSource(), -1, null, null, ['MultipleInitializations', ...((_a = this._store.getWarnings()) !== null && _a !== void 0 ? _a : [])]);
         }
         this._logger.start();
-        this.updateUserSync(this._user, options);
+        return this.updateUserSync(this._user, options);
     }
     /**
      * Initializes the StatsigClient asynchronously by first using cached values and then updating to the latest values from the network.
@@ -136,16 +138,23 @@ class StatsigClient extends client_core_1.StatsigClientBase {
      * @see {@link updateUserAsync} for the asynchronous version of this method.
      */
     updateUserSync(user, options) {
+        var _a;
+        const startTime = performance.now();
+        const warnings = [...((_a = this._store.getWarnings()) !== null && _a !== void 0 ? _a : [])];
         this._resetForUser(user);
         const result = this.dataAdapter.getDataSync(this._user);
+        if (result == null) {
+            warnings.push('NoCachedValues');
+        }
         this._store.setValues(result, this._user);
         this._finalizeUpdate(result);
         const disable = options === null || options === void 0 ? void 0 : options.disableBackgroundCacheRefresh;
         if (disable === true ||
             (disable == null && (result === null || result === void 0 ? void 0 : result.source) === 'Bootstrap')) {
-            return;
+            return (0, client_core_1.createUpdateDetails)(true, this._store.getSource(), performance.now() - startTime, this._errorBoundary.getLastSeenErrorAndReset(), this._network.getLastUsedInitUrlAndReset(), warnings);
         }
         this._runPostUpdate(result !== null && result !== void 0 ? result : null, this._user);
+        return (0, client_core_1.createUpdateDetails)(true, this._store.getSource(), performance.now() - startTime, this._errorBoundary.getLastSeenErrorAndReset(), this._network.getLastUsedInitUrlAndReset(), warnings);
     }
     /**
      * Asynchronously updates the user in the Statsig client by initially using cached values and then fetching the latest values from the network.
@@ -169,7 +178,7 @@ class StatsigClient extends client_core_1.StatsigClientBase {
             result = yield this.dataAdapter.getDataAsync(result, initiator, options);
             // ensure the user hasn't changed while we were waiting
             if (initiator !== this._user) {
-                return;
+                return (0, client_core_1.createUpdateDetails)(false, this._store.getSource(), -1, new Error('User changed during update'), this._network.getLastUsedInitUrlAndReset());
             }
             let isUsingNetworkValues = false;
             if (result != null) {
@@ -181,10 +190,12 @@ class StatsigClient extends client_core_1.StatsigClientBase {
             }
             this._finalizeUpdate(result);
             if (!isUsingNetworkValues) {
+                this._errorBoundary.attachErrorIfNoneExists(client_core_1.UPDATE_DETAIL_ERROR_MESSAGES.NO_NETWORK_DATA);
                 this.$emt({ name: 'initialization_failure' });
             }
             client_core_1.Diagnostics._markInitOverallEnd(this._sdkKey, isUsingNetworkValues, this._store.getCurrentSourceDetails());
-            client_core_1.Diagnostics._enqueueDiagnosticsEvent(this._user, this._logger, this._sdkKey, this._options);
+            const initDuration = client_core_1.Diagnostics._enqueueDiagnosticsEvent(this._user, this._logger, this._sdkKey, this._options);
+            return (0, client_core_1.createUpdateDetails)(isUsingNetworkValues, this._store.getSource(), initDuration, this._errorBoundary.getLastSeenErrorAndReset(), this._network.getLastUsedInitUrlAndReset(), this._store.getWarnings());
         });
     }
     /**