support for multiple delegated stores

Author: jollytoad

.github/workflows/ci.yml

@@ -20,7 +20,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Install Deno
-        uses: denoland/setup-deno@v1
+        uses: denoland/setup-deno@v2
 
       - name: Verify formatting
         run: deno fmt --check
@@ -29,7 +29,7 @@ jobs:
         run: deno task lint
 
       - name: Run TypeScript checking
-        run: deno task check
+        run: deno check
 
       - name: Run tests
         run: deno task test

.github/workflows/publish.yml

@@ -21,7 +21,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Install Deno
-        uses: denoland/setup-deno@v1
+        uses: denoland/setup-deno@v2
 
       - name: Publish package
         run: deno publish

CHANGELOG.md

@@ -6,6 +6,17 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.5.0]
+
+### Added
+
+- [store] support for multiple delegated storage modules, based on the key
+  prefix
+
+### Changed
+
+- update to Deno 2+
+
 ## [0.4.0]
 
 ### Changed

deno.json

@@ -4,12 +4,9 @@
   ],
   "tasks": {
     "test": "deno test --allow-env --allow-read --allow-write --allow-net --allow-sys",
-    "reload": "deno cache --reload **/*.ts jsr:@check/deps",
-    "check": "deno check **/*.ts",
     "lint": "deno lint && deno doc --lint **/*.ts",
-    "ok": "deno fmt && deno task lint && deno task check && deno task test && deno publish --dry-run --allow-dirty",
-    "outdated": "deno run --allow-read=. --allow-net=jsr.io,registry.npmjs.org jsr:@check/deps",
-    "lock": "rm -f deno.lock && deno task check"
+    "ok": "deno fmt && deno task lint && deno check && deno task test && deno publish --dry-run --allow-dirty",
+    "lock": "rm -f deno.lock && deno install --reload && deno check"
   },
   "compilerOptions": {
     "noUncheckedIndexedAccess": true,
@@ -26,16 +23,15 @@
     "./store"
   ],
   "imports": {
-    "@jollytoad/store": "jsr:@jollytoad/store@^0.4.0",
-    "@jollytoad/store-common": "jsr:@jollytoad/store-common@^0.4.0",
-    "@jollytoad/store-deno-fs": "jsr:@jollytoad/store-deno-fs@^0.4.0",
-    "@jollytoad/store-deno-kv": "jsr:@jollytoad/store-deno-kv@^0.4.0",
-    "@jollytoad/store-deno-kv-fs": "jsr:@jollytoad/store-deno-kv-fs@^0.4.0",
-    "@jollytoad/store-no-op": "jsr:@jollytoad/store-no-op@^0.4.0",
-    "@jollytoad/store-web-storage": "jsr:@jollytoad/store-web-storage@^0.4.0",
-    "@std/assert": "jsr:@std/assert@^1.0.0",
-    "@std/fs": "jsr:@std/fs@^1.0.0-rc.4",
-    "@std/path": "jsr:@std/path@^1.0.0-rc.4",
-    "@types/node": "npm:@types/node@^20.14.10"
+    "@jollytoad/store": "jsr:@jollytoad/store@^0.5.0",
+    "@jollytoad/store-common": "jsr:@jollytoad/store-common@^0.5.0",
+    "@jollytoad/store-deno-fs": "jsr:@jollytoad/store-deno-fs@^0.5.0",
+    "@jollytoad/store-deno-kv": "jsr:@jollytoad/store-deno-kv@^0.5.0",
+    "@jollytoad/store-deno-kv-fs": "jsr:@jollytoad/store-deno-kv-fs@^0.5.0",
+    "@jollytoad/store-no-op": "jsr:@jollytoad/store-no-op@^0.5.0",
+    "@jollytoad/store-web-storage": "jsr:@jollytoad/store-web-storage@^0.5.0",
+    "@std/assert": "jsr:@std/assert@^1.0.14",
+    "@std/fs": "jsr:@std/fs@^1.0.19",
+    "@std/path": "jsr:@std/path@^1.1.2"
   }
 }

deno.lock

@@ -1,6 +1,6 @@
 {
   "name": "@jollytoad/store-common",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "exports": {
     "./key-utils": "./key-utils.ts",
     "./test-storage-module": "./test-storage-module.ts",

store-common/deno.json

@@ -4,7 +4,7 @@ import {
   assertEquals,
   assertStringIncludes,
 } from "@std/assert";
-import type { StorageModule } from "./types.ts";
+import type { DelegatedStore, StorageModule } from "./types.ts";
 
 /**
  * Test the url() function of the given storage module.
@@ -21,17 +21,40 @@ export async function testUrl(
   });
 }
 
+/**
+ * Test the url() function of the given delegated storage module with a key prefix.
+ */
+export async function testUrlForPrefix(
+  t: Deno.TestContext,
+  { url }: DelegatedStore,
+  includes: string,
+  prefix: string,
+) {
+  await t.step(
+    `url contains "${includes}" for keys prefixed with "${prefix}"`,
+    async () => {
+      const actualUrl = await url(prefix);
+      console.log("StorageModule URL:", actualUrl);
+      assertStringIncludes(actualUrl, includes);
+    },
+  );
+}
+
 /**
  * Test the isWriteable() function of the given storage module.
  */
 export async function testIsWriteable(
   t: Deno.TestContext,
   { isWritable }: StorageModule,
   expected = true,
+  prefix?: string,
 ) {
-  await t.step(`isWriteable() to be ${expected}`, async () => {
-    assertEquals(await isWritable(), expected);
-  });
+  await t.step(
+    `isWriteable(${prefix ? `["${prefix}"]` : ""}) to be ${expected}`,
+    async () => {
+      assertEquals(await isWritable(prefix ? [prefix] : undefined), expected);
+    },
+  );
 }
 
 /**

store-common/test-storage-module.ts

@@ -65,21 +65,33 @@ export interface StorageModule<T = unknown> {
 }
 
 /**
- * Additional functions for a store that delegates to another store
+ * Additional functions for a store that delegates to one or more other stores
  */
 export interface DelegatedStore {
   /**
    * Set the storage module to which all function calls are delegated
    *
    * @param storageModule may be the store, promise of the store, or undefined to remove any delegate store
+   * @param prefix delegate only for StorageKeys starting with this prefix
    */
-  setStore(storageModule?: StorageModule | Promise<StorageModule>): void;
+  setStore(
+    storageModule?: StorageModule | Promise<StorageModule>,
+    prefix?: string,
+  ): void;
 
   /**
    * Get the delegate store previously set via `setStore` or obtained via another mechanism (eg. env vars)
    *
+   * @param key get the store specific to this key or prefix
    * @returns the promise of the store to which all operations are delegated
    * @throws if no store has been set or can be loaded
    */
-  getStore(): Promise<StorageModule>;
+  getStore(key?: StorageKey | string): Promise<StorageModule>;
+
+  /**
+   * Returns the `import.meta.url` of the module.
+   *
+   * @param key get the store specific to this key or prefix
+   */
+  url(key?: StorageKey | string): Promise<string>;
 }

store-common/types.ts

@@ -1,6 +1,6 @@
 {
   "name": "@jollytoad/store-deno-fs",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "exports": {
     ".": "./mod.ts"
   }

store-deno-fs/deno.json

@@ -56,7 +56,7 @@ export async function getItem<T>(key: StorageKey): Promise<T | undefined> {
   try {
     return JSON.parse(await Deno.readTextFile(filepath(key)));
   } catch (e) {
-    if (e.code === "ENOENT") {
+    if (isNotFound(e)) {
       return undefined;
     } else {
       throw e;
@@ -118,7 +118,7 @@ export async function* listItems<T>(
       }
     }
   } catch (e) {
-    if (e.code === "ENOENT") {
+    if (isNotFound(e)) {
       return;
     } else {
       throw e;
@@ -134,7 +134,7 @@ export async function clearItems(keyPrefix: StorageKey): Promise<void> {
   try {
     await Deno.remove(dirpath(keyPrefix), { recursive: true });
   } catch (e) {
-    if (e.code === "ENOENT") {
+    if (isNotFound(e)) {
       return;
     } else {
       throw e;
@@ -158,3 +158,8 @@ function dirpath(key: StorageKey = []) {
   const root = Deno.env.get("STORE_FS_ROOT") ?? ".store";
   return resolve(root, ...toStrKey(key));
 }
+
+// deno-lint-ignore no-explicit-any
+function isNotFound(e: any) {
+  return e && "code" in e && e.code === "ENOENT";
+}