refactor: rename save method to whenSaved

Author: EmilianoSanchez

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

@@ -21,38 +21,45 @@ test.each([
 
   const storage = storageAdapter(loggerMock, 'prefix', wrapper);
 
-  await storage.load!();
+  expect(storage.length).toBe(0);
 
-  expect(wrapper.getItem).toHaveBeenCalledWith('prefix');
+  // Load cache from storage wrapper
+  await storage.load();
 
+  expect(wrapper.getItem).toHaveBeenCalledWith('prefix');
   expect(storage.length).toBe(1);
   expect(storage.key(0)).toBe('key1');
   expect(storage.getItem('key1')).toBe('value1');
 
+  // Set item
   storage.setItem('key2', 'value2');
   expect(storage.getItem('key2')).toBe('value2');
   expect(storage.length).toBe(2);
 
+  // Remove item
   storage.removeItem('key1');
   expect(storage.getItem('key1')).toBe(null);
   expect(storage.length).toBe(1);
 
-  await storage.save!();
+  // Until a till key is set/removed, changes should not be saved/persisted
+  await storage.whenSaved();
   expect(wrapper.setItem).not.toHaveBeenCalled();
 
+  // When setting a till key, changes should be saved/persisted immediately
   storage.setItem('.till', '1');
   expect(storage.length).toBe(2);
   expect(storage.key(0)).toBe('key2');
   expect(storage.key(1)).toBe('.till');
 
-  await storage.save!();
+  await storage.whenSaved();
   expect(wrapper.setItem).toHaveBeenCalledWith('prefix', JSON.stringify({ key2: 'value2', '.till': '1' }));
 
+  // When removing a till key, changes should be saved/persisted immediately
   storage.removeItem('.till');
 
-  await storage.save!();
+  await storage.whenSaved();
   expect(wrapper.setItem).toHaveBeenCalledWith('prefix', JSON.stringify({ key2: 'value2' }));
 
-  await storage.save!();
+  await storage.whenSaved();
   expect(wrapper.setItem).toHaveBeenCalledTimes(2);
 });

src/storages/inLocalStorage/index.ts

@@ -68,7 +68,7 @@ export function InLocalStorage(options: SplitIO.InLocalStorageOptions = {}): ISt
       },
 
       destroy() {
-        return storage.save && storage.save();
+        return storage.whenSaved && storage.whenSaved();
       },
 
       // When using shared instantiation with MEMORY we reuse everything but segments (they are customer per key).

src/storages/inLocalStorage/storageAdapter.ts

@@ -7,7 +7,7 @@ function isTillKey(key: string) {
   return key.endsWith('.till');
 }
 
-export function storageAdapter(log: ILogger, prefix: string, wrapper: SplitIO.StorageWrapper): StorageAdapter {
+export function storageAdapter(log: ILogger, prefix: string, wrapper: SplitIO.StorageWrapper): Required<StorageAdapter> {
   let keys: string[] = [];
   let values: string[] = [];
 
@@ -38,7 +38,7 @@ export function storageAdapter(log: ILogger, prefix: string, wrapper: SplitIO.St
         log.error(LOG_PREFIX + 'Rejected promise calling wrapper `getItem` method, with error: ' + e);
       }));
     },
-    save() {
+    whenSaved() {
       return savePromise;
     },
 

src/storages/types.ts

@@ -11,11 +11,11 @@ import { ISettings } from '../types';
 export interface StorageAdapter {
   // Methods to support async storages
   load?: () => Promise<void>;
-  save?: () => Promise<void>;
+  whenSaved?: () => Promise<void>;
   // Methods based on https://developer.mozilla.org/en-US/docs/Web/API/Storage
   readonly length: number;
-  getItem(key: string): string | null;
   key(index: number): string | null;
+  getItem(key: string): string | null;
   removeItem(key: string): void;
   setItem(key: string, value: string): void;
 }