JS Server: Normalize collection names everywhere

i.e. convert `_default._default` to `_default`

Author: snej

servers/javascript/src/keyPath.ts

@@ -11,7 +11,7 @@
 //
 
 import type { CBLDictionary, CBLValue } from "@couchbase/lite-js";
-import { HTTPError } from "./httpError";
+import { HTTPError } from "./utils";
 
 type KeyPathComponents = Array<string | number>;
 

servers/javascript/src/snapshot.ts

@@ -10,7 +10,7 @@
 // the file licenses/APL2.txt.
 //
 
-import { HTTPError } from "./httpError";
+import { HTTPError, normalizeCollectionID } from "./utils";
 import { KeyPath, KeyPathCache } from "./keyPath";
 import type * as tdk from "./tdkSchema";
 import type * as cbl from "@couchbase/lite-js";
@@ -22,7 +22,7 @@ export class Snapshot {
 
     /** Adds a (possibly nonexistent) document to the snapshot. */
     async record(collection: string, id: cbl.DocID) {
-        const doc = await this.db.getCollection(collection).getDocument(id);
+        const doc = await this.#getCollection(collection).getDocument(id);
         this.#documents.set(collection, id, doc ?? null);
     }
 
@@ -42,14 +42,14 @@ 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;
+                    expected = update ? this.#applyUpdate(oldDoc, update) : oldDoc;
                 } else {
-                    oldDoc = this.db.getCollection(collection).createDocument(id);
-                    expected = this.applyUpdate(oldDoc, update!!);
+                    oldDoc = this.#getCollection(collection).createDocument(id);
+                    expected = this.#applyUpdate(oldDoc, update!!);
                 }
                 // Compare the updated oldDoc against the database's current document:
-                const newDoc = await this.db.getCollection(collection).getDocument(id);
-                const result = this.compareDocs(expected, newDoc, update?.type);
+                const newDoc = await this.#getCollection(collection).getDocument(id);
+                const result = this.#compareDocs(expected, newDoc, update?.type);
                 if (result !== undefined) {
                     // On failure, return the result:
                     result.result = false;
@@ -63,9 +63,8 @@ export class Snapshot {
     }
 
 
-    /** Applies the changes described in a `DatabaseUpdateItem` to a `CBLDocument`.
-     *  @internal (exposed for testing) */
-    applyUpdate(doc: cbl.CBLDocument, update: tdk.DatabaseUpdateItem)
+    /** Applies the changes described in a `DatabaseUpdateItem` to a `CBLDocument`. */
+    #applyUpdate(doc: cbl.CBLDocument, update: tdk.DatabaseUpdateItem)
         : cbl.CBLDocument | undefined
     {
         if (update.type !== 'UPDATE')
@@ -96,11 +95,10 @@ export class Snapshot {
 
 
     /** Compares the expected and actual bodies of a document.
-     *  @returns `undefined` if they're equal, or a response describing the mismatch.
-     *  @internal (exposed for testing) */
-    compareDocs(expected: cbl.CBLDocument | undefined,
-                actual: cbl.CBLDocument | undefined,
-                updateType: string | undefined) : tdk.VerifyDocumentsResponse | undefined {
+     *  @returns `undefined` if they're equal, or a response describing the mismatch. */
+    #compareDocs(expected: cbl.CBLDocument | undefined,
+                 actual: cbl.CBLDocument | undefined,
+                 updateType: string | undefined) : tdk.VerifyDocumentsResponse | undefined {
         let response: tdk.VerifyDocumentsResponse | undefined = undefined;
         let path = new Array<string|number>();
 
@@ -185,6 +183,11 @@ export class Snapshot {
     }
 
 
+    #getCollection(name: string): cbl.Collection {
+        return this.db.getCollection(normalizeCollectionID(name));
+    }
+
+
     readonly #documents = new DocumentMap<cbl.CBLDocument | null>();
 }
 

servers/javascript/src/tdk.ts

@@ -14,7 +14,7 @@
 
 import { KeyPathCache } from "./keyPath";
 import { LogSlurpSender } from "./logSlurpSender";
-import { check, HTTPError } from "./httpError";
+import { check, HTTPError, normalizeCollectionID } from "./utils";
 import { Snapshot } from "./snapshot";
 import type { TestRequest } from "./testServer";
 import * as tdk from "./tdkSchema";
@@ -109,7 +109,7 @@ export class TDKImpl implements tdk.TDK, AsyncDisposable {
         const response: tdk.GetAllDocumentsResponse = {};
         for (const collName of rq.collections) {
             if (collName in db.collections) {
-                const coll = db.getCollection(collName);
+                const coll = db.getCollection(normalizeCollectionID(collName));
                 const docs = new Array<{id:cbl.DocID, rev:cbl.RevID}>();
                 response[collName] = docs;
                 await coll.eachDocument( doc => {
@@ -374,7 +374,7 @@ export class TDKImpl implements tdk.TDK, AsyncDisposable {
         let totalDocs = 0, totalBlobs = 0;
         for (const collID of config.collections) {
             this.#logger.debug `- Loading docs in collection ${collID}...`;
-            const collection = db.getCollection(collID);
+            const collection = db.getCollection(normalizeCollectionID(collID));
             const docs: cbl.CBLDocument[] = [];
             const jsonl = await fetchRelative(`${collID}.jsonl`);
             for (const line of jsonl.trim().split('\n')) {
@@ -466,12 +466,6 @@ export class TDKImpl implements tdk.TDK, AsyncDisposable {
     #logSender?             : LogSlurpSender;
 }
 
-
-/** Strips the default scope name from an incoming collection ID. */
-function normalizeCollectionID(id: string): string {
-    return id.startsWith("_default.") ? id.substring(9) : id;
-}
-
 /** Adds the default scope name, if necessary, to an outgoing collection ID. */
 function collectionIDWithScope(id: string): string {
     return id.includes('.') ? id : `_default.${id}`;

servers/javascript/src/testServer.ts

@@ -13,7 +13,7 @@
 /* eslint-disable camelcase */
 
 import { WebSocketClient } from "./webSocketClient";
-import { check, HTTPError } from "./httpError";
+import { check, HTTPError } from "./utils";
 import * as logtape from "@logtape/logtape";
 import * as cbl from "@couchbase/lite-js";
 

servers/javascript/src/httpError.ts servers/javascript/src/utils.tsservers/javascript/src/httpError.ts renamed to servers/javascript/src/utils.ts

@@ -19,7 +19,15 @@ export class HTTPError extends Error {
     }
 }
 
+
+/** Simple assertion that throws an HTTPError with status 400 on failure. */
 export function check(cond: boolean, message: string): asserts cond {
     if (!cond)
         throw new HTTPError(400, message);
 }
+
+
+/** Strips the default scope name from an incoming collection ID. */
+export function normalizeCollectionID(id: string): string {
+    return id.startsWith("_default.") ? id.substring(9) : id;
+}

servers/javascript/src/webSocketClient.ts

@@ -10,7 +10,7 @@
 // the file licenses/APL2.txt.
 //
 
-import { check } from "./httpError";
+import { check } from "./utils";
 
 
 /** States of WebSocketClient. (Same as the all-caps constants in `WebSocket`.) */