feat(KVPeer): add prefix option (#165)

MyUnisoft · Jan 9, 2025 · d9da206 · d9da206
1 parent 4d12f5b
commit d9da206
Show file tree

Hide file tree

Showing 3 changed files with 53 additions and 4 deletions.
diff --git a/docs/KVPeer.md b/docs/KVPeer.md
@@ -25,6 +25,8 @@ export interface KVOptions<T extends StringOrObject = Record<string, any>, K ext
   adapter: DatabaseConnection;
   type?: KVType;
   mapValue?: KVMapper<T, K>;
+  prefix?: string;
+  prefixSeparator?: string;
 }
 
 export type KVPeerSetValueOptions<T extends StringOrObject = StringOrObject> = Omit<

diff --git a/src/class/KVPeer.class.ts b/src/class/KVPeer.class.ts
@@ -24,6 +24,8 @@ export interface KVOptions<T extends StringOrObject = Record<string, any>, K ext
   adapter: DatabaseConnection;
   type?: KVType;
   mapValue?: KVMapper<T, K>;
+  prefix?: string;
+  prefixSeparator?: string;
 }
 
 export type KVPeerSetValueOptions<T extends StringOrObject = StringOrObject> = Omit<
@@ -47,13 +49,17 @@ export class KVPeer<T extends StringOrObject = StringOrObject, K extends Record<
   protected type: KVType;
   protected mapValue: KVMapper<T, K>;
   protected adapter: DatabaseConnection;
+  protected prefix: string;
+  protected prefixSeparator: string;
 
   constructor(options: KVOptions<T, K>) {
     super();
 
-    const { type, mapValue, adapter } = options;
+    const { type, mapValue, adapter, prefix = "", prefixSeparator = "-" } = options;
 
     this.adapter = adapter;
+    this.prefix = prefix;
+    this.prefixSeparator = prefix.length ? prefixSeparator : "";
 
     this.type = type ?? kDefaultKVType;
     this.mapValue = mapValue ?? this.defaultMapValue;
@@ -63,25 +69,29 @@ export class KVPeer<T extends StringOrObject = StringOrObject, K extends Record<
     const { key, value, ...rest } = options;
 
     return this.adapter.setValue({
-      key,
+      key: this.keyWithPrefix(key),
       value,
       type: this.type,
       ...rest
     });
   }
 
   async getValue(key: KeyType): Promise<MappedValue<T, K> | null> {
-    const result = await this.adapter.getValue(key, this.type);
+    const result = await this.adapter.getValue(this.keyWithPrefix(key), this.type);
 
     return result === null ? null : this.mapValue(result as T);
   }
 
   async deleteValue(key: KeyType): Promise<number> {
-    return this.adapter.deleteValue(key);
+    return this.adapter.deleteValue(this.keyWithPrefix(key));
   }
 
   private defaultMapValue(value: T): MappedValue<T, K> {
     return value as MappedValue<T, K>;
   }
+
+  protected keyWithPrefix(key: KeyType) {
+    return `${this.prefix}${this.prefixSeparator}${key}`;
+  }
 }
 
diff --git a/test/class/KVPeer.spec.ts b/test/class/KVPeer.spec.ts
@@ -205,6 +205,43 @@ describe("KVPeer", () => {
         });
       });
     });
+
+    test("With prefix", async() => {
+      const kvPeer = new KVPeer({
+        type: "raw",
+        adapter: redisAdapter,
+        prefix: "super-prefix"
+      });
+      await kvPeer.setValue({ key: "super-key", value: "boo" });
+
+      const valueWithNoPrefix = await redisAdapter.getValue("super-key", "raw");
+      assert.strictEqual(valueWithNoPrefix, null);
+
+      const valueWithPrefix = await redisAdapter.getValue("super-prefix-super-key", "raw");
+      assert.strictEqual(valueWithPrefix, "boo");
+
+      const valueFromKVPeer = await kvPeer.getValue("super-key");
+      assert.strictEqual(valueFromKVPeer, "boo");
+    });
+
+    test("With prefix and prefixSeparator", async() => {
+      const kvPeer = new KVPeer({
+        type: "raw",
+        adapter: redisAdapter,
+        prefix: "super-prefix",
+        prefixSeparator: ":::"
+      });
+      await kvPeer.setValue({ key: "super-key", value: "boo" });
+
+      const valueWithNoPrefix = await redisAdapter.getValue("super-key", "raw");
+      assert.strictEqual(valueWithNoPrefix, null);
+
+      const valueWithPrefix = await redisAdapter.getValue("super-prefix:::super-key", "raw");
+      assert.strictEqual(valueWithPrefix, "boo");
+
+      const valueFromKVPeer = await kvPeer.getValue("super-key");
+      assert.strictEqual(valueFromKVPeer, "boo");
+    });
   });
 
   describe("MemoryAdapter", () => {