@statsig/js-local-overrides 3.15.0 → 3.15.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@statsig/js-local-overrides",
-  "version": "3.15.0",
+  "version": "3.15.2",
   "license": "ISC",
   "homepage": "https://github.com/statsig-io/js-client-monorepo",
   "repository": {
@@ -9,7 +9,7 @@
     "directory": "packages/js-local-overrides"
   },
   "dependencies": {
-    "@statsig/client-core": "3.15.0"
+    "@statsig/client-core": "3.15.2"
   },
   "type": "commonjs",
   "main": "./src/index.js",

package/src/LocalOverrideAdapter.d.ts

@@ -10,9 +10,10 @@ export declare class LocalOverrideAdapter implements OverrideAdapter {
     private _sdkKey;
     constructor(sdkKey?: string);
     private _getLocalOverridesStorageKey;
-    private _loadOverridesFromStorage;
+    loadFromStorage(): Promise<void>;
     private _saveOverridesToStorage;
     overrideGate(name: string, value: boolean): void;
+    private _warnIfStorageNotReady;
     removeGateOverride(name: string): void;
     getGateOverride(current: FeatureGate, _user: StatsigUser): FeatureGate | null;
     overrideDynamicConfig(name: string, value: Record<string, unknown>): void;
@@ -27,4 +28,5 @@ export declare class LocalOverrideAdapter implements OverrideAdapter {
     removeAllOverrides(): void;
     getLayerOverride(current: Layer, _user: StatsigUser): Layer | null;
     private _getConfigOverride;
+    private _hasInMemoryOverrides;
 }

package/src/LocalOverrideAdapter.js

@@ -1,4 +1,13 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LocalOverrideAdapter = void 0;
 const client_core_1 = require("@statsig/client-core");
@@ -11,25 +20,51 @@ function _makeEmptyStore() {
         layer: {},
     };
 }
+function _mergeOverrides(currentValues, newValues) {
+    return {
+        gate: Object.assign({}, currentValues.gate, newValues.gate),
+        dynamicConfig: Object.assign({}, currentValues.dynamicConfig, newValues.dynamicConfig),
+        experiment: Object.assign({}, currentValues.experiment, newValues.experiment),
+        layer: Object.assign({}, currentValues.layer, newValues.layer),
+    };
+}
 class LocalOverrideAdapter {
     constructor(sdkKey) {
         this._overrides = _makeEmptyStore();
         this._sdkKey = sdkKey !== null && sdkKey !== void 0 ? sdkKey : null;
-        this._overrides = this._loadOverridesFromStorage();
     }
     _getLocalOverridesStorageKey(sdkKey) {
         return `statsig.local-overrides.${(0, client_core_1._getStorageKey)(sdkKey)}`;
     }
-    _loadOverridesFromStorage() {
-        if (this._sdkKey == null) {
-            return _makeEmptyStore();
-        }
-        const storageKey = this._getLocalOverridesStorageKey(this._sdkKey);
-        const storedOverrides = client_core_1.Storage.getItem(storageKey);
-        return storedOverrides ? JSON.parse(storedOverrides) : _makeEmptyStore();
+    loadFromStorage() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this._sdkKey == null) {
+                return;
+            }
+            if (!client_core_1.Storage.isReady()) {
+                yield client_core_1.Storage.isReadyResolver();
+            }
+            const storageKey = this._getLocalOverridesStorageKey(this._sdkKey);
+            const storedOverrides = client_core_1.Storage.getItem(storageKey);
+            const overrides = storedOverrides
+                ? (0, client_core_1._typedJsonParse)(storedOverrides, 'gate', 'LocalOverrideAdapter overrides')
+                : null;
+            const hasInMemoryOverrides = this._hasInMemoryOverrides();
+            if (overrides) {
+                // Merge overrides in memory with stored overrides.
+                // WARN: This is a union of overrides. Trying to remove an override
+                // before storage is ready won't remove the override in storage.
+                this._overrides = hasInMemoryOverrides
+                    ? _mergeOverrides(overrides, this._overrides)
+                    : overrides;
+            }
+            if (hasInMemoryOverrides) {
+                this._saveOverridesToStorage();
+            }
+        });
     }
     _saveOverridesToStorage() {
-        if (this._sdkKey == null) {
+        if (this._sdkKey == null || !client_core_1.Storage.isReady()) {
             return;
         }
         const storageKey = this._getLocalOverridesStorageKey(this._sdkKey);
@@ -40,7 +75,13 @@ class LocalOverrideAdapter {
         this._overrides.gate[(0, client_core_1._DJB2)(name)] = value;
         this._saveOverridesToStorage();
     }
+    _warnIfStorageNotReady() {
+        if (!client_core_1.Storage.isReady()) {
+            client_core_1.Log.warn('Storage is not ready. Override removal may not persist.');
+        }
+    }
     removeGateOverride(name) {
+        this._warnIfStorageNotReady();
         delete this._overrides.gate[name];
         delete this._overrides.gate[(0, client_core_1._DJB2)(name)];
         this._saveOverridesToStorage();
@@ -59,6 +100,7 @@ class LocalOverrideAdapter {
         this._saveOverridesToStorage();
     }
     removeDynamicConfigOverride(name) {
+        this._warnIfStorageNotReady();
         delete this._overrides.dynamicConfig[name];
         delete this._overrides.dynamicConfig[(0, client_core_1._DJB2)(name)];
         this._saveOverridesToStorage();
@@ -72,6 +114,7 @@ class LocalOverrideAdapter {
         this._saveOverridesToStorage();
     }
     removeExperimentOverride(name) {
+        this._warnIfStorageNotReady();
         delete this._overrides.experiment[name];
         delete this._overrides.experiment[(0, client_core_1._DJB2)(name)];
         this._saveOverridesToStorage();
@@ -85,6 +128,7 @@ class LocalOverrideAdapter {
         this._saveOverridesToStorage();
     }
     removeLayerOverride(name) {
+        this._warnIfStorageNotReady();
         delete this._overrides.layer[name];
         delete this._overrides.layer[(0, client_core_1._DJB2)(name)];
         this._saveOverridesToStorage();
@@ -93,6 +137,7 @@ class LocalOverrideAdapter {
         return JSON.parse(JSON.stringify(this._overrides));
     }
     removeAllOverrides() {
+        this._warnIfStorageNotReady();
         this._overrides = _makeEmptyStore();
         this._saveOverridesToStorage();
     }
@@ -112,5 +157,11 @@ class LocalOverrideAdapter {
         }
         return Object.assign(Object.assign({}, current), { value: overridden, get: (0, client_core_1._makeTypedGet)(current.name, overridden), details: Object.assign(Object.assign({}, current.details), { reason: LOCAL_OVERRIDE_REASON }) });
     }
+    _hasInMemoryOverrides() {
+        return (Object.keys(this._overrides.gate).length > 0 ||
+            Object.keys(this._overrides.dynamicConfig).length > 0 ||
+            Object.keys(this._overrides.experiment).length > 0 ||
+            Object.keys(this._overrides.layer).length > 0);
+    }
 }
 exports.LocalOverrideAdapter = LocalOverrideAdapter;

package/src/__tests__/MockStorageProvider.d.ts

@@ -0,0 +1,17 @@
+import { StorageProvider } from '@statsig/client-core';
+export declare class MockStorageProvider implements StorageProvider {
+    private ready;
+    data: Record<string, string>;
+    private _readyPromise;
+    private _resolveReady;
+    constructor(ready?: boolean);
+    getItem(key: string): string | null;
+    setItem(key: string, value: string): void;
+    isReady(): boolean;
+    getProviderName(): string;
+    removeItem(key: string): void;
+    getAllKeys(): readonly string[];
+    isReadyResolver(): Promise<void>;
+    setReady(ready: boolean): void;
+    reset(): void;
+}

package/src/__tests__/MockStorageProvider.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MockStorageProvider = void 0;
+class MockStorageProvider {
+    constructor(ready = true) {
+        this.ready = ready;
+        this.data = {};
+        this._resolveReady = null;
+        this._readyPromise = new Promise((resolve) => {
+            if (this.ready) {
+                resolve();
+            }
+            else {
+                this._resolveReady = resolve;
+            }
+        });
+    }
+    getItem(key) {
+        return this.data[key] || null;
+    }
+    setItem(key, value) {
+        this.data[key] = value;
+    }
+    isReady() {
+        return this.ready;
+    }
+    getProviderName() {
+        return 'MockStorage';
+    }
+    removeItem(key) {
+        delete this.data[key];
+    }
+    getAllKeys() {
+        return Object.keys(this.data);
+    }
+    isReadyResolver() {
+        return this._readyPromise;
+    }
+    setReady(ready) {
+        this.ready = ready;
+        if (ready && this._resolveReady) {
+            this._resolveReady();
+            this._resolveReady = null;
+        }
+    }
+    reset() {
+        this.data = {};
+        this.ready = true;
+        this._resolveReady = null;
+        this._readyPromise = Promise.resolve();
+    }
+}
+exports.MockStorageProvider = MockStorageProvider;