feat: 🎸 Added scope to the storage interface

kostysh · kostysh · commit 2a06610780b2 · 2023-06-29T18:48:07.000+02:00
diff --git a/src/storage/abstract.ts b/src/storage/abstract.ts
@@ -15,7 +15,9 @@ export abstract class Storage {
   >;
 }
 
-export type GenericStorageOptions = Record<string, unknown>;
+export interface GenericStorageOptions {
+  scope?: string;
+}
 
 /**
  * Storage initializer type
diff --git a/src/storage/local.ts b/src/storage/local.ts
@@ -1,5 +1,9 @@
-import { stringify } from 'viem';
-import { Storage, StorageInitializerFunction } from './abstract.js';
+import { stringify, parse } from 'superjson';
+import {
+  GenericStorageOptions,
+  Storage,
+  StorageInitializerFunction,
+} from './abstract.js';
 import { createLogger } from '../utils/logger.js';
 
 const logger = createLogger('LocalStorage');
@@ -18,7 +22,7 @@ export interface WindowStorage {
 /**
  * Local storage options type
  */
-export interface LocalStorageOptions {
+export interface LocalStorageOptions extends GenericStorageOptions {
   session?: boolean;
 }
 
@@ -30,6 +34,7 @@ export interface LocalStorageOptions {
  */
 export class LocalStorage extends Storage {
   db: WindowStorage;
+  scopeIdsKey?: string;
 
   /**
    * Creates an instance of LocalStorage.
@@ -44,6 +49,11 @@ export class LocalStorage extends Storage {
     // @todo Validate LocalStorageOptions
 
     this.db = options.session ? sessionStorage : localStorage;
+
+    if (options.scope) {
+      this.scopeIdsKey = `local_storage_scope_${options.scope}_ids`;
+    }
+
     logger.trace('Local storage initialized');
   }
 
@@ -55,7 +65,7 @@ export class LocalStorage extends Storage {
    * @returns {string}
    * @memberof LocalStorage
    */
-  serialize<ValueType>(value: ValueType): string {
+  private serialize<ValueType>(value: ValueType): string {
     return stringify(value);
   }
   /**
@@ -66,8 +76,54 @@ export class LocalStorage extends Storage {
    * @returns {ValueType}
    * @memberof LocalStorage
    */
-  deserialize<ValueType>(value: string): ValueType {
-    return JSON.parse(value) as ValueType;
+  private deserialize<ValueType>(value: string): ValueType {
+    return parse<ValueType>(value);
+  }
+
+  private getScopeIds(): Set<string> {
+    if (!this.scopeIdsKey) {
+      return new Set();
+    }
+
+    return new Set(
+      this.deserialize<string[]>(this.db.getItem(this.scopeIdsKey) ?? '[]'),
+    );
+  }
+
+  private saveScopeIds(ids: Set<string>) {
+    if (!this.scopeIdsKey) {
+      return;
+    }
+
+    this.db.setItem(this.scopeIdsKey, this.serialize(Array.from(ids)));
+  }
+
+  private addScopeId(id: string) {
+    try {
+      if (!this.scopeIdsKey) {
+        return;
+      }
+
+      const ids = this.getScopeIds();
+      ids.add(id);
+      this.saveScopeIds(ids);
+    } catch (error) {
+      logger.error('addScopeId', error);
+    }
+  }
+
+  private deleteScopeId(id: string) {
+    try {
+      if (!this.scopeIdsKey) {
+        return;
+      }
+
+      const ids = this.getScopeIds();
+      ids.delete(id);
+      this.saveScopeIds(ids);
+    } catch (error) {
+      logger.error('addScopeId', error);
+    }
   }
 
   /**
@@ -81,6 +137,7 @@ export class LocalStorage extends Storage {
   // eslint-disable-next-line @typescript-eslint/require-await
   async set<ValueType>(key: string, value: ValueType) {
     this.db.setItem(key, this.serialize(value));
+    this.addScopeId(key);
   }
 
   /**
@@ -94,9 +151,11 @@ export class LocalStorage extends Storage {
   // eslint-disable-next-line @typescript-eslint/require-await
   async get<ValueType>(key: string): Promise<ValueType | undefined> {
     const value = this.db.getItem(key);
+
     if (value !== null) {
       return this.deserialize<ValueType>(value);
     }
+
     return;
   }
 
@@ -110,7 +169,13 @@ export class LocalStorage extends Storage {
   // eslint-disable-next-line @typescript-eslint/require-await
   async delete(key: string): Promise<boolean> {
     this.db.removeItem(key);
-    return this.db.getItem(key) === null;
+    const isDeleted = this.db.getItem(key) === null;
+
+    if (isDeleted) {
+      this.deleteScopeId(key);
+    }
+
+    return isDeleted;
   }
 
   /**
@@ -123,13 +188,19 @@ export class LocalStorage extends Storage {
   entries<ValueType>(): IterableIterator<[string, ValueType]> {
     // eslint-disable-next-line @typescript-eslint/no-this-alias
     const source = this;
+    const scopeEnabled = Boolean(this.scopeIdsKey);
+    const ids = this.getScopeIds();
 
     function* entriesIterator(): IterableIterator<[string, ValueType]> {
       let index = 0;
 
       while (index < source.db.length) {
         const key = source.db.key(index++);
 
+        if (scopeEnabled && key && !ids.has(key)) {
+          continue;
+        }
+
         if (key === null) {
           return;
         }
diff --git a/src/storage/memory.ts b/src/storage/memory.ts
@@ -1,12 +1,16 @@
-import { Storage, StorageInitializerFunction } from './abstract.js';
+import {
+  GenericStorageOptions,
+  Storage,
+  StorageInitializerFunction,
+} from './abstract.js';
 import { createLogger } from '../utils/logger.js';
 
 const logger = createLogger('MemoryStorage');
 
 /**
  * Memory storage options type
  */
-export interface MemoryStorageOptions {
+export interface MemoryStorageOptions extends GenericStorageOptions {
   entries?: Array<[string, unknown]>;
 }
 
@@ -19,6 +23,8 @@ export interface MemoryStorageOptions {
 export class MemoryStorage extends Storage {
   /** Map as in-memory key-value storage */
   private db: Map<string, unknown>;
+  /** Key for storing ids included in the scope */
+  scopeIdsKey?: string;
 
   /**
    * Creates an instance of MemoryStorage.
@@ -33,9 +39,102 @@ export class MemoryStorage extends Storage {
     // Validate MemoryStorageOptions
 
     this.db = new Map<string, unknown>(options?.entries);
+
+    if (options.scope) {
+      this.scopeIdsKey = `memory_storage_scope_${options.scope}_ids`;
+    }
+
     logger.trace('Memory storage initialized');
   }
 
+  /**
+   * Retrieves Ids from scope
+   *
+   * @private
+   * @returns {Set<string>}
+   * @memberof MemoryStorage
+   */
+  private getScopeIds(): Set<string> {
+    if (!this.scopeIdsKey) {
+      return new Set<string>();
+    }
+
+    return (this.db.get(this.scopeIdsKey) as Set<string>) ?? new Set<string>();
+  }
+
+  /**
+   * Saves Ids to scope
+   *
+   * @private
+   * @param {Set<string>} ids
+   * @returns
+   * @memberof MemoryStorage
+   */
+  private saveScopeIds(ids: Set<string>) {
+    if (!this.scopeIdsKey) {
+      return;
+    }
+
+    this.db.set(this.scopeIdsKey, ids);
+  }
+
+  /**
+   * Adds Id to scope
+   *
+   * @private
+   * @param {string} id
+   * @returns
+   * @memberof MemoryStorage
+   */
+  private addScopeId(id: string) {
+    try {
+      if (!this.scopeIdsKey) {
+        return;
+      }
+
+      const ids = this.getScopeIds();
+      ids.add(id);
+      this.saveScopeIds(ids);
+    } catch (error) {
+      logger.error('addScopeId', error);
+    }
+  }
+
+  /**
+   * Deletes Id from scope
+   *
+   * @private
+   * @param {string} id
+   * @returns
+   * @memberof MemoryStorage
+   */
+  private deleteScopeId(id: string) {
+    try {
+      if (!this.scopeIdsKey) {
+        return;
+      }
+
+      const ids = this.getScopeIds();
+      ids.delete(id);
+      this.saveScopeIds(ids);
+    } catch (error) {
+      logger.error('addScopeId', error);
+    }
+  }
+
+  /**
+   * Resets the db
+   *
+   * @internal
+   *
+   * @template ValueType
+   * @memberof MemoryStorage
+   */
+  // eslint-disable-next-line @typescript-eslint/require-await
+  async reset<ValueType>() {
+    this.db = new Map<string, ValueType>();
+  }
+
   /**
    * Sets the key to the storage
    *
@@ -47,6 +146,7 @@ export class MemoryStorage extends Storage {
   // eslint-disable-next-line @typescript-eslint/require-await
   async set<ValueType>(key: string, value: ValueType) {
     this.db.set(key, value);
+    this.addScopeId(key);
   }
 
   /**
@@ -71,7 +171,13 @@ export class MemoryStorage extends Storage {
    */
   // eslint-disable-next-line @typescript-eslint/require-await
   async delete(key: string) {
-    return this.db.delete(key);
+    const isDeleted = this.db.delete(key);
+
+    if (isDeleted) {
+      this.deleteScopeId(key);
+    }
+
+    return isDeleted;
   }
 
   /**
@@ -82,7 +188,34 @@ export class MemoryStorage extends Storage {
    * @memberof MemoryStorage
    */
   entries<ValueType>(): IterableIterator<[string, ValueType]> {
-    return this.db.entries() as IterableIterator<[string, ValueType]>;
+    // eslint-disable-next-line @typescript-eslint/no-this-alias
+    const source = this;
+    const scopeEnabled = Boolean(this.scopeIdsKey);
+    const ids = Array.from(this.getScopeIds());
+
+    function* entriesIterator(): IterableIterator<[string, ValueType]> {
+      let index = 0;
+
+      while (index < source.db.size) {
+        const key = ids[index++];
+
+        if (!key) {
+          return;
+        }
+
+        const value = source.db.get(key) as ValueType | undefined;
+
+        if (!value) {
+          return;
+        }
+
+        yield [key, value];
+      }
+    }
+
+    return scopeEnabled
+      ? entriesIterator()
+      : (this.db.entries() as IterableIterator<[string, ValueType]>);
   }
 }
 

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,9 @@ export abstract class Storage {`
`15`	`15`	`>;`
`16`	`16`	`}`
`17`	`17`
`18`		`-export type GenericStorageOptions = Record<string, unknown>;`
	`18`	`+export interface GenericStorageOptions {`
	`19`	`+ scope?: string;`
	`20`	`+}`
`19`	`21`
`20`	`22`	`/**`
`21`	`23`	`* Storage initializer type`