JS Server: support updatedBlobs in /verifyDocuments

Author: snej

servers/javascript/src/snapshot.test.ts

@@ -4,6 +4,8 @@ import * as cbl from "@couchbase/lite-js";
 import { beforeEach, test, describe, expect, afterEach } from "vitest";
 
 
+/* eslint-disable @typescript-eslint/require-await */
+
 cbl.Database.useIndexedDB(indexedDB, IDBKeyRange);
 
 
@@ -24,6 +26,11 @@ afterEach( async() => {
 });
 
 
+async function noBlobLoader(_url: string): Promise<cbl.NewBlob> {
+    throw Error("Should not be called");
+}
+
+
 describe("Snapshot", () => {
 
     test("doc wasn't created", async () => {
@@ -34,7 +41,7 @@ describe("Snapshot", () => {
             type: 'UPDATE',
             collection: "red",
             documentID: cbl.DocID("nose"),
-        }]);
+        }], noBlobLoader);
         expect(response).toMatchInlineSnapshot(`
           {
             "description": "Document nose in collection red was not found",
@@ -62,7 +69,7 @@ describe("Snapshot", () => {
                 name: "Santa",
                 reindeer: ["Dasher", "Prancer", "etc."],
             }],
-        }]);
+        }], noBlobLoader);
         expect(response).toEqual({result: true});
     });
 
@@ -83,7 +90,7 @@ describe("Snapshot", () => {
             collection: "red",
             documentID: cbl.DocID("nose"),
             type: 'DELETE',
-        }]);
+        }], noBlobLoader);
         expect(response).toEqual({result: true});
     });
 
@@ -102,7 +109,7 @@ describe("Snapshot", () => {
             collection: "red",
             documentID: cbl.DocID("nose"),
             type: 'DELETE',
-        }]);
+        }], noBlobLoader);
         expect(response).toEqual({
             "result": false,
             "description": "Document nose in collection red was not deleted",
@@ -135,7 +142,7 @@ describe("Snapshot", () => {
                 name: "Santa",
                 reindeer: ["Dasher", "Prancer", "etc."],
             }],
-        }]);
+        }], noBlobLoader);
 
         expect(response).toEqual({
             "result": false,
@@ -165,6 +172,7 @@ describe("Snapshot", () => {
         await snapshot.record("red", cbl.DocID("nose"));
 
         (nose.reindeer as string[])[2] = "Rudolph";
+        await red.save(nose);
 
         const response = await snapshot.verify([{
             collection: "red",
@@ -173,22 +181,41 @@ describe("Snapshot", () => {
             updatedProperties: [{
                 "reindeer[2]": "Rudolph",
             }],
-        }]);
+        }], noBlobLoader);
 
-        expect(response).toEqual({
-            "result": false,
-            "description": "Document nose in collection red had unexpected properties at .reindeer[2]",
-            "expected": "Rudolph",
-            "actual": "etc.",
-            "document": {
-                "name": "Santa",
-                "reindeer": [
-                    "Dasher",
-                    "Prancer",
-                    "etc.",
-                ],
-            },
+        expect(response).toEqual({"result": true});
+    });
+
+
+    test("doc added a blob", async () => {
+        const nose = red.createDocument(cbl.DocID("nose"), {
+            name: "Santa",
+            reindeer: ["Dasher", "Prancer", "etc."],
         });
+        await red.save(nose);
+
+        const snapshot = new Snapshot(db);
+        await snapshot.record("red", cbl.DocID("nose"));
+
+        const hohoho = new TextEncoder().encode("Ho ho ho!");
+        nose.hohoho = new cbl.NewBlob(hohoho, "text/plain");
+        await red.save(nose);
+
+        const blobLoader = async (url: string): Promise<cbl.NewBlob> => {
+            expect(url).toBe("x/y/hohoho.txt");
+            return new cbl.NewBlob(hohoho, "text/plain");
+        };
+
+        const response = await snapshot.verify([{
+            collection: "red",
+            documentID: cbl.DocID("nose"),
+            type: 'UPDATE',
+            updatedBlobs: {
+                "hohoho": "x/y/hohoho.txt",
+            },
+        }], blobLoader);
+
+        expect(response).toEqual({"result": true});
     });
 
 
@@ -210,7 +237,7 @@ describe("Snapshot", () => {
             updatedProperties: [{
                 "reindeer[2]": "Rudolph",
             }],
-        }]);
+        }], noBlobLoader);
 
         expect(response).toEqual({
             "result": false,

servers/javascript/src/snapshot.ts

@@ -16,6 +16,9 @@ import type * as tdk from "./tdkSchema";
 import type * as cbl from "@couchbase/lite-js";
 
 
+export type BlobLoader = (blobURL: string) => Promise<cbl.NewBlob>;
+
+
 /** Creates and verifies TDK database snapshots. */
 export class Snapshot {
     constructor(readonly db: cbl.Database) { }
@@ -29,7 +32,8 @@ export class Snapshot {
 
     /** Verifies the current database against the snapshot and a list of updates.
      *  @warning  This can only be called once, as it mutates the stored state. */
-    async verify(changes: readonly tdk.DatabaseUpdateItem[]): Promise<tdk.VerifyDocumentsResponse> {
+    async verify(changes: readonly tdk.DatabaseUpdateItem[],
+                 blobLoader: BlobLoader): Promise<tdk.VerifyDocumentsResponse> {
         // Index the updates in a map for quick lookup:
         const updates = new DocumentMap<tdk.DatabaseUpdateItem>();
         for (const u of changes) {
@@ -46,10 +50,13 @@ export class Snapshot {
                 let expected: cbl.CBLDocument | undefined;
                 // Update the old document with the changes listed in the DatabaseUpdateItem:
                 if (oldDoc) {
-                    expected = update ? this.#applyUpdate(oldDoc, update) : oldDoc;
+                    if (update)
+                        expected = await this.#applyUpdate(oldDoc, update, blobLoader);
+                    else
+                        expected = oldDoc;
                 } else {
                     oldDoc = this.#getCollection(collection).createDocument(id);
-                    expected = this.#applyUpdate(oldDoc, update!!);
+                    expected = await this.#applyUpdate(oldDoc, update!!, blobLoader);
                 }
                 // Compare the updated oldDoc against the database's current document:
                 const newDoc = await this.#getCollection(collection).getDocument(id);
@@ -79,31 +86,31 @@ export class Snapshot {
 
 
     /** Applies the changes described in a `DatabaseUpdateItem` to a `CBLDocument`. */
-    #applyUpdate(doc: cbl.CBLDocument, update: tdk.DatabaseUpdateItem)
-        : cbl.CBLDocument | undefined
+    async #applyUpdate(doc: cbl.CBLDocument,
+                       update: tdk.DatabaseUpdateItem,
+                       blobLoader: BlobLoader) : Promise<cbl.CBLDocument | undefined>
     {
         if (update.type !== 'UPDATE')
             return undefined;
+
+        const patch = (key: string, value: cbl.CBLValue | undefined) => {
+            if (!KeyPathCache.path(key).write(doc, value))
+                throw new HTTPError(400, `Type mismatch traversing path ${key}`);
+        };
+
         if (update.updatedProperties !== undefined) {
             for (const updates of update.updatedProperties) {
-                for (const key of Object.getOwnPropertyNames(updates)) {
-                    if (!KeyPathCache.path(key).write(doc, updates[key])) {
-                        throw new HTTPError(400, `Type mismatch traversing path ${key}`);
-                    }
-                }
+                for (const key of Object.getOwnPropertyNames(updates))
+                    patch(key,  updates[key]);
             }
         }
         if (update.removedProperties !== undefined) {
-            for (const key of update.removedProperties) {
-                if (!KeyPathCache.path(key).write(doc, undefined)) {
-                    throw new HTTPError(400, `Type mismatch traversing path ${key}`);
-                }
-            }
+            for (const key of update.removedProperties)
+                patch(key,  undefined);
         }
         if (update.updatedBlobs !== undefined) {
-            for (const _key of Object.getOwnPropertyNames(update.updatedBlobs)) {
-                throw new HTTPError(501, `updatedBlobs is not supported yet`);
-            }
+            for (const key of Object.getOwnPropertyNames(update.updatedBlobs))
+                patch(key, await blobLoader(update.updatedBlobs[key]));
         }
         return doc;
     }

servers/javascript/src/tdk.ts

@@ -332,7 +332,7 @@ export class TDKImpl implements tdk.TDK, AsyncDisposable {
             throw new HTTPError(400, `Snapshot is of a different database, ${db.name}`);
         this.#snapshots.delete(rq.snapshot);
 
-        return await snap.verify(rq.changes);
+        return await snap.verify(rq.changes, this.#downloadBlob.bind(this));
     }