@freqhole/reliquary 0.2.14 → 0.2.15

package/dist/blobs/db.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"db.d.ts","sourceRoot":"","sources":["../../src/blobs/db.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AA8F7C,wBAAsB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAcjF;AAED,wBAAsB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAS1F;AAkBD,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAE5F;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAE5F;AAED,wBAAsB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAchF;AAED,wBAAsB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAchE;AAQD,wBAAsB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAcrG;AAED,wBAAsB,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAcxG;AAED,wBAAsB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAYrF;AAED,wBAAsB,4BAA4B,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAuBrG;AAED,wBAAsB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAcnE;AAaD,MAAM,WAAW,gBAAgB;IAC/B,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,YAAY,CAAC;IAC1C,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAC3B;mDAC+C;IAC/C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,kFAAkF;IAClF,UAAU,EAAE,MAAM,CAAC;IACnB,+EAA+E;IAC/E,SAAS,EAAE,MAAM,CAAC;CACnB;AAOD,wBAAsB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,gBAAqB,GAAG,OAAO,CAAC,aAAa,CAAC,CA8EtG"}
+{"version":3,"file":"db.d.ts","sourceRoot":"","sources":["../../src/blobs/db.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AA6I7C,wBAAsB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAcjF;AAED,wBAAsB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAS1F;AA4BD,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAE5F;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAE5F;AAED,wBAAsB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAchF;AAED,wBAAsB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAchE;AAQD,wBAAsB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAcrG;AAED,wBAAsB,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAcxG;AAED,wBAAsB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAYrF;AAED,wBAAsB,4BAA4B,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAuBrG;AAED,wBAAsB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAcnE;AAaD,MAAM,WAAW,gBAAgB;IAC/B,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,YAAY,CAAC;IAC1C,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAC3B;mDAC+C;IAC/C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,kFAAkF;IAClF,UAAU,EAAE,MAAM,CAAC;IACnB,+EAA+E;IAC/E,SAAS,EAAE,MAAM,CAAC;CACnB;AAOD,wBAAsB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,gBAAqB,GAAG,OAAO,CAAC,aAAa,CAAC,CA8EtG"}

package/dist/blobs/db.js

@@ -10,6 +10,12 @@
 const STORE_NAME = "blobs";
 const REFS_STORE_NAME = "blob_canvas_refs";
 const DB_VERSION = 3;
+// kept in sync with the createIndex calls in onupgradeneeded below - used
+// by openDb's version-fallback path to detect an already-existing database
+// that's missing an index added by a newer db.ts than whatever build last
+// touched it.
+const BLOB_INDEXES = ["sha256", "blake3", "blob_type", "parent_blob_id", "size", "created_at"];
+const REFS_INDEXES = ["blob_id", "canvas_doc_id"];
 function openVersioned(dbName, version) {
     return new Promise((resolve, reject) => {
         const req = indexedDB.open(dbName, version);
@@ -18,26 +24,26 @@ function openVersioned(dbName, version) {
             let store;
             if (!db.objectStoreNames.contains(STORE_NAME)) {
                 store = db.createObjectStore(STORE_NAME, { keyPath: "blob_id" });
-                store.createIndex("sha256", "sha256", { unique: false });
-                store.createIndex("blake3", "blake3", { unique: false });
-                store.createIndex("blob_type", "blob_type", { unique: false });
-                store.createIndex("parent_blob_id", "parent_blob_id", { unique: false });
             }
             else {
-                // pre-existing store from an earlier DB_VERSION - new indexes can
-                // still be added via the in-flight version-change transaction
+                // pre-existing store from an earlier DB_VERSION - or, for an app
+                // that used this same store/db name before adopting reliquary at
+                // all, a store that never had ANY of these indexes. new indexes
+                // can still be added via the in-flight version-change transaction
                 // (`req.transaction`), they just can't be added outside
-                // onupgradeneeded. without this branch a version bump would silently
-                // never add the index for anyone who already has a v1/v2 database.
+                // onupgradeneeded.
                 store = req.transaction.objectStore(STORE_NAME);
             }
-            // added in v3 - supports sorting the local-files list (filez tab 2)
-            // by size without a full-store scan.
-            if (!store.indexNames.contains("size")) {
-                store.createIndex("size", "size", { unique: false });
-            }
-            if (!store.indexNames.contains("created_at")) {
-                store.createIndex("created_at", "created_at", { unique: false });
+            // every index gets the "add if missing" treatment (not just the
+            // v3 ones below) - a pre-reliquary store sharing this db/store name
+            // would otherwise hit the `else` branch above with none of these
+            // indexes present, and every `.index(...)` lookup would throw
+            // "the specified index was not found" instead of falling through
+            // the resolver chain the way a missing record does.
+            for (const name of BLOB_INDEXES) {
+                if (!store.indexNames.contains(name)) {
+                    store.createIndex(name, name, { unique: false });
+                }
             }
             if (!db.objectStoreNames.contains(REFS_STORE_NAME)) {
                 // tracks which canvas documents currently have a widget
@@ -46,8 +52,18 @@ function openVersioned(dbName, version) {
                 // canvas. composite key so re-adding an existing ref is a no-op
                 // (put with the same key overwrites, add() would throw).
                 const refs = db.createObjectStore(REFS_STORE_NAME, { keyPath: ["blob_id", "canvas_doc_id"] });
-                refs.createIndex("blob_id", "blob_id", { unique: false });
-                refs.createIndex("canvas_doc_id", "canvas_doc_id", { unique: false });
+                for (const name of REFS_INDEXES) {
+                    refs.createIndex(name, name, { unique: false });
+                }
+            }
+            else {
+                // same "add if missing" treatment for the refs store's own indexes.
+                const refs = req.transaction.objectStore(REFS_STORE_NAME);
+                for (const name of REFS_INDEXES) {
+                    if (!refs.indexNames.contains(name)) {
+                        refs.createIndex(name, name, { unique: false });
+                    }
+                }
             }
         };
         req.onsuccess = () => resolve(req.result);
@@ -64,35 +80,63 @@ function openVersioned(dbName, version) {
 // open per operation, matching the "open fresh, close when done" pattern
 // used throughout this module.
 const resolvedVersions = new Map();
+// true only if both stores exist AND every index in BLOB_INDEXES/
+// REFS_INDEXES is present on them. used to detect a database that's
+// already sitting at the version we're about to (re)open with but never
+// actually got every index this file expects - reopening at the exact
+// same version is a no-op in indexedDB (onupgradeneeded only fires when
+// the requested version is HIGHER than the database's current one), so
+// that case has to be caught explicitly rather than left to
+// onupgradeneeded's own "add if missing" logic.
+function hasAllIndexes(db) {
+    if (!db.objectStoreNames.contains(STORE_NAME) || !db.objectStoreNames.contains(REFS_STORE_NAME)) {
+        return false;
+    }
+    const tx = db.transaction([STORE_NAME, REFS_STORE_NAME], "readonly");
+    const blobIndexes = tx.objectStore(STORE_NAME).indexNames;
+    const refsIndexes = tx.objectStore(REFS_STORE_NAME).indexNames;
+    return (BLOB_INDEXES.every((name) => blobIndexes.contains(name)) &&
+        REFS_INDEXES.every((name) => refsIndexes.contains(name)));
+}
 async function openDb(dbName) {
     const cachedVersion = resolvedVersions.get(dbName);
     if (cachedVersion !== undefined) {
         return openVersioned(dbName, cachedVersion);
     }
+    let db;
+    let currentVersion;
     try {
-        const db = await openVersioned(dbName, DB_VERSION);
-        resolvedVersions.set(dbName, DB_VERSION);
-        return db;
+        db = await openVersioned(dbName, DB_VERSION);
+        currentVersion = DB_VERSION;
     }
     catch (err) {
         if (!(err instanceof DOMException) || err.name !== "VersionError")
             throw err;
-        // the database already exists at some higher version - open it
-        // version-less to discover what that is, then reopen at that exact
-        // version (creating the store if a pre-existing database somehow
-        // never had one).
+        // the database already exists at some higher version than DB_VERSION -
+        // open it version-less to discover what that is, then reopen at that
+        // exact version.
         const probe = await new Promise((resolve, reject) => {
             const req = indexedDB.open(dbName);
             req.onsuccess = () => resolve(req.result);
             req.onerror = () => reject(req.error);
         });
-        const currentVersion = probe.version;
-        const hasStore = probe.objectStoreNames.contains(STORE_NAME) && probe.objectStoreNames.contains(REFS_STORE_NAME);
+        currentVersion = probe.version;
         probe.close();
-        const targetVersion = hasStore ? currentVersion : currentVersion + 1;
-        resolvedVersions.set(dbName, targetVersion);
-        return openVersioned(dbName, targetVersion);
+        db = await openVersioned(dbName, currentVersion);
+    }
+    // a database can reach `currentVersion` under an earlier build that
+    // didn't yet create every index this file expects - opening at that
+    // exact same version again (either branch above) never fires
+    // onupgradeneeded, so the "add index if missing" repair in
+    // onupgradeneeded never gets a chance to run. detect that case here and
+    // force a real upgrade by reopening one version higher.
+    if (!hasAllIndexes(db)) {
+        db.close();
+        currentVersion += 1;
+        db = await openVersioned(dbName, currentVersion);
     }
+    resolvedVersions.set(dbName, currentVersion);
+    return db;
 }
 export async function putRecord(dbName, record) {
     const db = await openDb(dbName);
@@ -125,7 +169,17 @@ async function getByIndex(dbName, indexName, value) {
     const db = await openDb(dbName);
     return new Promise((resolve, reject) => {
         const tx = db.transaction(STORE_NAME, "readonly");
-        const req = tx.objectStore(STORE_NAME).index(indexName).get(value);
+        const store = tx.objectStore(STORE_NAME);
+        // belt-and-suspenders: openDb's upgrade path should always ensure this
+        // index exists, but if it's somehow still missing, fall through the
+        // resolver chain (return null) rather than throwing - matches the
+        // "missing record" behavior every other step of resolveBlob already has.
+        if (!store.indexNames.contains(indexName)) {
+            tx.oncomplete = () => db.close();
+            resolve(null);
+            return;
+        }
+        const req = store.index(indexName).get(value);
         req.onsuccess = () => resolve(req.result ?? null);
         req.onerror = () => reject(req.error);
         tx.oncomplete = () => db.close();

package/dist/blobs/db.test.js

@@ -148,6 +148,44 @@ describe("pre-existing database at a higher version", () => {
         expect(await getRecord(dbName, record.blob_id)).toEqual(record);
         expect(await getRecordByBlake3(dbName, record.blake3)).toEqual(record);
     });
+    it("repairs a missing index even when both stores already exist at DB_VERSION", async () => {
+        // reproduces a real-world case: a database that reached DB_VERSION
+        // under an earlier build of this module - one that created both
+        // stores but not yet the "sha256" index added later. since both
+        // stores already exist and the version already matches, naively
+        // reusing that version would never fire onupgradeneeded again,
+        // permanently leaving the missing index unrepaired - getRecordBySha256
+        // would then always report a miss instead of finding the record
+        // (getByIndex falls through gracefully rather than throwing, so a
+        // silent "never repaired" regression wouldn't otherwise be caught).
+        const dbName = "already-at-version-missing-index-db";
+        await new Promise((resolve, reject) => {
+            const req = indexedDB.open(dbName, 3);
+            req.onupgradeneeded = () => {
+                const db = req.result;
+                const store = db.createObjectStore("blobs", { keyPath: "blob_id" });
+                // deliberately missing: "sha256" index.
+                store.createIndex("blake3", "blake3", { unique: false });
+                store.createIndex("blob_type", "blob_type", { unique: false });
+                store.createIndex("parent_blob_id", "parent_blob_id", { unique: false });
+                store.createIndex("size", "size", { unique: false });
+                store.createIndex("created_at", "created_at", { unique: false });
+                const refs = db.createObjectStore("blob_canvas_refs", {
+                    keyPath: ["blob_id", "canvas_doc_id"],
+                });
+                refs.createIndex("blob_id", "blob_id", { unique: false });
+                refs.createIndex("canvas_doc_id", "canvas_doc_id", { unique: false });
+            };
+            req.onsuccess = () => {
+                req.result.close();
+                resolve();
+            };
+            req.onerror = () => reject(req.error);
+        });
+        const record = makeRecord();
+        await putRecord(dbName, record);
+        expect(await getRecordBySha256(dbName, record.sha256)).toEqual(record);
+    });
 });
 describe("listBlobs", () => {
     async function seedThree() {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@freqhole/reliquary",
-    "version": "0.2.14",
+    "version": "0.2.15",
     "private": false,
     "type": "module",
     "description": "freqhole media blob storage domain: content-addressed blobs, transfer, worker, solid helpers",