refactor: rename Storage interface to StorageWrapper for clarity and consistency

Author: EmilianoSanchez

src/storages/inLocalStorage/__tests__/index.spec.ts

@@ -35,12 +35,12 @@ describe('IN LOCAL STORAGE', () => {
     expect(storage).toBe(fakeInMemoryStorage);
 
     // @ts-expect-error Provided storage is invalid
-    storageFactory = InLocalStorage({ prefix: 'prefix', storage: {} });
+    storageFactory = InLocalStorage({ prefix: 'prefix', wrapper: {} });
     storage = storageFactory(internalSdkParams);
     expect(storage).toBe(fakeInMemoryStorage);
 
     // Provided storage is valid
-    storageFactory = InLocalStorage({ prefix: 'prefix', storage: { getItem: () => Promise.resolve(null), setItem: () => Promise.resolve(), removeItem: () => Promise.resolve() } });
+    storageFactory = InLocalStorage({ prefix: 'prefix', wrapper: { getItem: () => Promise.resolve(null), setItem: () => Promise.resolve(), removeItem: () => Promise.resolve() } });
     storage = storageFactory(internalSdkParams);
     expect(storage).not.toBe(fakeInMemoryStorage);
 

src/storages/inLocalStorage/__tests__/wrapper.mock.ts

@@ -4,7 +4,7 @@ import { loggerMock } from '../../../logger/__tests__/sdkLogger.mock';
 
 export const PREFIX = 'SPLITIO';
 
-export function createMemoryStorage(): SplitIO.Storage {
+export function createMemoryStorage(): SplitIO.StorageWrapper {
   let cache: Record<string, string> = {};
   return {
     getItem(key: string) {

src/storages/inLocalStorage/index.ts

@@ -4,7 +4,7 @@ import { EventsCacheInMemory } from '../inMemory/EventsCacheInMemory';
 import { IStorageFactoryParams, IStorageSync, IStorageSyncFactory } from '../types';
 import { validatePrefix } from '../KeyBuilder';
 import { KeyBuilderCS, myLargeSegmentsKeyBuilder } from '../KeyBuilderCS';
-import { isLocalStorageAvailable, isStorageValid } from '../../utils/env/isLocalStorageAvailable';
+import { isLocalStorageAvailable, isStorageWrapperValid } from '../../utils/env/isLocalStorageAvailable';
 import { SplitsCacheInLocal } from './SplitsCacheInLocal';
 import { RBSegmentsCacheInLocal } from './RBSegmentsCacheInLocal';
 import { MySegmentsCacheInLocal } from './MySegmentsCacheInLocal';
@@ -34,23 +34,23 @@ function isTillKey(key: string) {
   return key.endsWith('.till');
 }
 
-export function storageAdapter(log: ILogger, prefix: string, storage: SplitIO.Storage): StorageAdapter {
+export function storageAdapter(log: ILogger, prefix: string, wrapper: SplitIO.StorageWrapper): StorageAdapter {
   let cache: Record<string, string> = {};
 
   let connectPromise: Promise<void> | undefined;
   let disconnectPromise = Promise.resolve();
 
   return {
     load() {
-      return connectPromise || (connectPromise = storage.getItem(prefix).then((storedCache) => {
+      return connectPromise || (connectPromise = wrapper.getItem(prefix).then((storedCache) => {
         cache = JSON.parse(storedCache || '{}');
       }).catch((e) => {
         log.error(LOG_PREFIX + 'Rejected promise calling storage getItem, with error: ' + e);
       }));
     },
     save() {
       return disconnectPromise = disconnectPromise.then(() => {
-        return storage.setItem(prefix, JSON.stringify(cache)).catch((e) => {
+        return wrapper.setItem(prefix, JSON.stringify(cache)).catch((e) => {
           log.error(LOG_PREFIX + 'Rejected promise calling storage setItem, with error: ' + e);
         });
       });
@@ -76,9 +76,9 @@ export function storageAdapter(log: ILogger, prefix: string, storage: SplitIO.St
   };
 }
 
-function validateStorage(log: ILogger, prefix: string, storage?: SplitIO.Storage): StorageAdapter | undefined {
-  if (storage) {
-    if (isStorageValid(storage)) return storageAdapter(log, prefix, storage);
+function validateStorage(log: ILogger, prefix: string, wrapper?: SplitIO.StorageWrapper): StorageAdapter | undefined {
+  if (wrapper) {
+    if (isStorageWrapperValid(wrapper)) return storageAdapter(log, prefix, wrapper);
     log.warn(LOG_PREFIX + 'Invalid storage provided. Falling back to LocalStorage API');
   }
 
@@ -97,7 +97,7 @@ export function InLocalStorage(options: SplitIO.InLocalStorageOptions = {}): ISt
   function InLocalStorageCSFactory(params: IStorageFactoryParams): IStorageSync {
     const { settings, settings: { log, scheduler: { impressionsQueueSize, eventsQueueSize } } } = params;
 
-    const storage = validateStorage(log, prefix, options.storage);
+    const storage = validateStorage(log, prefix, options.wrapper);
     if (!storage) return InMemoryStorageCSFactory(params);
 
     const matchingKey = getMatching(settings.core.key);

src/utils/env/isLocalStorageAvailable.ts

@@ -1,18 +1,18 @@
 export function isLocalStorageAvailable(): boolean {
   try {
     // eslint-disable-next-line no-undef
-    return isStorageValid(localStorage);
+    return isStorageWrapperValid(localStorage);
   } catch (e) {
     return false;
   }
 }
 
-export function isStorageValid(storage: any): boolean {
+export function isStorageWrapperValid(wrapper: any): boolean {
   var mod = '__SPLITSOFTWARE__';
   try {
-    storage.setItem(mod, mod);
-    storage.getItem(mod);
-    storage.removeItem(mod);
+    wrapper.setItem(mod, mod);
+    wrapper.getItem(mod);
+    wrapper.removeItem(mod);
     return true;
   } catch (e) {
     return false;

types/splitio.d.ts

@@ -449,7 +449,7 @@ interface IClientSideSyncSharedSettings extends IClientSideSharedSettings, ISync
  */
 declare namespace SplitIO {
 
-  interface Storage {
+  interface StorageWrapper {
     /**
      * Returns a promise that resolves to the current value associated with the given key, or null if the given key does not exist.
      */
@@ -979,11 +979,11 @@ declare namespace SplitIO {
      */
     clearOnInit?: boolean;
     /**
-     * Optional storage API to persist rollout plan related data. If not provided, the SDK will use the default localStorage Web API.
+     * Optional storage wrapper to persist rollout plan related data. If not provided, the SDK will use the default localStorage Web API.
      *
      * @defaultValue `window.localStorage`
      */
-    storage?: Storage;
+    wrapper?: StorageWrapper;
   }
   /**
    * Storage for asynchronous (consumer) SDK.
@@ -1325,11 +1325,11 @@ declare namespace SplitIO {
        */
       clearOnInit?: boolean;
       /**
-       * Optional storage API to persist rollout plan related data. If not provided, the SDK will use the default localStorage Web API.
+       * Optional storage wrapper to persist rollout plan related data. If not provided, the SDK will use the default localStorage Web API.
        *
        * @defaultValue `window.localStorage`
        */
-      storage?: Storage;
+      wrapper?: StorageWrapper;
     };
   }
   /**