Fix JS Server : snapshot missing, docID filters, getDocuments, and doc's flags (#299)

* Fix JS Server : snapshot missing, docID filters, getDocuments, and doc flags

* Fixed snaphot missing as it is deleted after being verification (We have a test that calls to verify on the sampe snapshot more than once).

* Fixed documentIDs filter due to an invalid type check.

* Fixed getDocuments result not including body.

* Fixed document replication’s flags value.

* Add enableAutoPurge and resetCheckpoint support

* Disable non-applicable tests for JS

Author: pasin

servers/javascript/src/filters.ts

@@ -1,6 +1,6 @@
 import type * as cbl from "@couchbase/lite-js";
 import type * as tdk from "./tdkSchema";
-import { check } from "./utils";
+import {check, isObject} from "./utils";
 
 
 // https://github.com/couchbaselabs/couchbase-lite-tests/blob/main/spec/api/replication-filters.md
@@ -12,8 +12,15 @@ type PullFilterMaker = (spec: tdk.Filter) => PullReplicatorFilter;
 
 function _documentIDs(spec: tdk.Filter, rev: cbl.RemoteRevisionInfo | cbl.RevisionInfo) : boolean {
     const documentIDs = spec.params?.documentIDs;
-    check(Array.isArray(documentIDs), "invalid documentIDs in filter");
-    const docSet = new Set(documentIDs);
+    check(isObject(documentIDs), "documentIDs must be an object");
+    // Currently JS API doesn't provide information regarding the collection
+    // so validating that only one collection is allowed at least for now.
+    check(Object.keys(documentIDs).length === 1, "documentIDs have more than one collection");
+
+    const ids = Object.values(documentIDs)[0];
+    check(Array.isArray(ids), "documentIDs's value must be an array");
+
+    const docSet = new Set(ids);
     return docSet.has(rev.id as string);
 }
 

servers/javascript/src/snapshot.ts

@@ -10,7 +10,7 @@
 // the file licenses/APL2.txt.
 //
 
-import { HTTPError, normalizeCollectionID } from "./utils";
+import { docToJSON, HTTPError, normalizeCollectionID } from "./utils";
 import { KeyPath, KeyPathCache } from "./keyPath";
 import type * as tdk from "./tdkSchema";
 import type * as cbl from "@couchbase/lite-js";
@@ -238,9 +238,3 @@ class DocumentMap<T> {
 
     #map = new Map<string, Map<cbl.DocID, T>>();
 }
-
-
-/** Converts a CBLDocument to a regular JSON object (i.e. Blobs are replaced by their metadata.) */
-function docToJSON(doc: cbl.CBLDocument): cbl.JSONObject {
-    return JSON.parse(JSON.stringify(doc)) as cbl.JSONObject;
-}

servers/javascript/src/tdk.ts

@@ -14,7 +14,7 @@
 
 import { KeyPathCache } from "./keyPath";
 import { LogSlurpSender } from "./logSlurpSender";
-import { check, HTTPError, normalizeCollectionID } from "./utils";
+import { check, docToJSON, HTTPError, normalizeCollectionID } from "./utils";
 import { Snapshot } from "./snapshot";
 import type { TestRequest } from "./testServer";
 import * as tdk from "./tdkSchema";
@@ -143,7 +143,8 @@ export class TDKImpl implements tdk.TDK, AsyncDisposable {
         const doc = await coll.getDocument(rq.document.id);
         if (!doc) throw new HTTPError(404, `No document "${rq.document.id}"`);
         const m = cbl.meta(doc);
-        return {_id: rq.document.id, _revs: m.revisionID!};
+        const jsonBody = docToJSON(doc);
+        return {_id: rq.document.id, _revs: m.revisionID!, ...jsonBody};
     }
 
 
@@ -169,7 +170,7 @@ export class TDKImpl implements tdk.TDK, AsyncDisposable {
             function updatePath(pathStr: string, value: cbl.CBLValue | undefined): void {
                 if (!KeyPathCache.path(pathStr).write(doc, value))
                     throw new HTTPError(400, `Invalid path ${pathStr} in doc ${update.documentID}`);
-            };
+            }
 
             switch (update.type) {
                 case 'UPDATE': {
@@ -233,9 +234,11 @@ export class TDKImpl implements tdk.TDK, AsyncDisposable {
                     filter:     CreatePushFilter(colls.pushFilter),
                 };
             }
+
             if (rq.config.replicatorType !== 'push') {
                 collCfg.pull = {
                     continuous: rq.config.continuous,
+                    enableAutoPurge: rq.config.enableAutoPurge,
                     channels:   colls.channels,
                     filter:     CreatePullFilter(colls.pullFilter),
                 };
@@ -246,8 +249,12 @@ export class TDKImpl implements tdk.TDK, AsyncDisposable {
                     collCfg.pull.conflictResolver = resolverFn;
                 }
             }
+
             if (colls.documentIDs)
                 collCfg.documentIDs = colls.documentIDs;
+
+            if (rq.reset)
+                collCfg.resetCheckpoint = rq.reset;
 
             for (const collName of colls.names)
                 config.collections[normalizeCollectionID(collName)] = collCfg;
@@ -261,11 +268,15 @@ export class TDKImpl implements tdk.TDK, AsyncDisposable {
                 if (info.documents === undefined)
                     info.documents = [];
                 for (const doc of documents) {
+                    const flags: ('deleted' | 'accessRemoved')[] = [];
+                    doc.deleted && flags.push('deleted');
+                    doc.lostAccess && flags.push('accessRemoved');
+
                     info.documents.push({
                         collection: collectionIDWithScope(collection.name),
                         documentID: doc.docID,
                         isPush:     (direction === 'push'),
-                        flags:      (doc.deleted ? ["deleted"] : []),
+                        flags:      flags,
                         error:      this.#mkErrorInfo(doc.error),
                     });
                 }
@@ -352,8 +363,6 @@ export class TDKImpl implements tdk.TDK, AsyncDisposable {
             throw new HTTPError(404, `No such snapshot ${rq.snapshot}`);
         if (snap.db !== db)
             throw new HTTPError(400, `Snapshot is of a different database, ${db.name}`);
-        this.#snapshots.delete(rq.snapshot);
-
         return await snap.verify(rq.changes, this.#downloadBlob.bind(this));
     }
 
@@ -362,9 +371,9 @@ export class TDKImpl implements tdk.TDK, AsyncDisposable {
 
 
     #mkErrorInfo(error: Error | undefined): tdk.ErrorInfo | undefined {
-        let code = -1
+        let code = -1;
         if (error instanceof cbl.ReplicatorError) {
-            code = (error as cbl.ReplicatorError).code ?? -1;
+            code = error.code ?? -1;
         }
 
         return error ? {domain: "CBL-JS", code: code, message: error.message} : undefined;

servers/javascript/src/utils.ts

@@ -10,7 +10,7 @@
 // the file licenses/APL2.txt.
 //
 
-import type { CBLDictionary, CBLValue, JSONObject, JSONValue } from "@couchbase/lite-js";
+import type { CBLDictionary, CBLDocument, CBLValue, JSONObject, JSONValue } from "@couchbase/lite-js";
 import { Blob } from "@couchbase/lite-js";
 
 
@@ -44,3 +44,9 @@ export function isObject(val: JSONValue | undefined) : val is JSONObject {
 export function isDict(val: CBLValue | undefined) : val is CBLDictionary {
     return typeof val === "object" && val !== null && !Array.isArray(val) && !(val instanceof Blob);
 }
+
+
+/** Converts a CBLDocument to a regular JSON object (i.e. Blobs are replaced by their metadata.) */
+export function docToJSON(doc: CBLDocument): JSONObject {
+    return JSON.parse(JSON.stringify(doc)) as JSONObject;
+}

tests/dev_e2e/test_basic_replication.py

@@ -19,6 +19,7 @@
 )
 from cbltest.api.syncgateway import DocumentUpdateEntry
 from cbltest.api.test_functions import compare_local_and_remote
+from cbltest.responses import ServerVariant
 from cbltest.utils import assert_not_null
 
 
@@ -64,11 +65,14 @@ async def test_replicate_non_existing_sg_collections(
         status = await replicator.wait_for(ReplicatorActivityLevel.STOPPED)
 
         self.mark_test_step("Check that the replicator's error is CBL/10404")
-        assert (
-            status.error is not None
-            and status.error.code == 10404
-            and ErrorDomain.equal(status.error.domain, ErrorDomain.CBL)
-        )
+        if (await cblpytest.test_servers[0].get_info()).variant == ServerVariant.JS:
+            assert status.error is not None and status.error.code == 404
+        else:
+            assert (
+                status.error is not None
+                and status.error.code == 10404
+                and ErrorDomain.equal(status.error.domain, ErrorDomain.CBL)
+            )
 
         await cblpytest.test_servers[0].cleanup()
 

tests/dev_e2e/test_replication_blob.py

@@ -16,6 +16,7 @@
 from cbltest.api.replicator_types import ReplicatorBasicAuthenticator
 from cbltest.api.syncgateway import DocumentUpdateEntry
 from cbltest.api.test_functions import compare_local_and_remote
+from cbltest.responses import ServerVariant
 from cbltest.utils import assert_not_null
 
 
@@ -28,6 +29,10 @@ class TestReplicationBlob(CBLTestClass):
     async def test_pull_non_blob_changes_with_delta_sync_and_compact(
         self, cblpytest: CBLPyTest, dataset_path: Path
     ):
+        await self.skip_if_not_platform(
+            cblpytest.test_servers[0], ServerVariant.ALL & ~ServerVariant.JS
+        )
+
         self.mark_test_step(
             "Reset SG and load `travel` dataset with delta sync enabled."
         )