couchbase 4.2.6 → 4.2.7

package/dist/binding.d.ts

@@ -677,6 +677,29 @@ export interface CppGetRequest {
     opaque: number;
     timeout?: CppMilliseconds;
 }
+export interface CppLookupInAllReplicasResponse {
+    entries: CppLookupInAllReplicasResponseEntry[];
+}
+export interface CppLookupInAllReplicasResponseEntry {
+    fields: CppLookupInAllReplicasResponseEntryLookupInEntry[];
+    cas: CppCas;
+    deleted: boolean;
+    is_replica: boolean;
+}
+export interface CppLookupInAllReplicasResponseEntryLookupInEntry {
+    path: string;
+    value: Buffer;
+    original_index: number;
+    exists: boolean;
+    opcode: CppProtocolSubdocOpcode;
+    status: CppKeyValueStatusCode;
+    ec: CppError;
+}
+export interface CppLookupInAllReplicasRequest {
+    id: CppDocumentId;
+    specs: CppImplSubdocCommand[];
+    timeout?: CppMilliseconds;
+}
 export interface CppAnalyticsResponse {
     meta: CppAnalyticsResponseAnalyticsMetaData;
     rows: string[];
@@ -970,6 +993,26 @@ export interface CppInsertWithLegacyDurabilityRequest {
     persist_to: CppPersistTo;
     replicate_to: CppReplicateTo;
 }
+export interface CppLookupInAnyReplicaResponse {
+    cas: CppCas;
+    fields: CppLookupInAnyReplicaResponseEntry[];
+    deleted: boolean;
+    is_replica: boolean;
+}
+export interface CppLookupInAnyReplicaResponseEntry {
+    path: string;
+    value: Buffer;
+    original_index: number;
+    exists: boolean;
+    opcode: CppProtocolSubdocOpcode;
+    status: CppKeyValueStatusCode;
+    ec: CppError;
+}
+export interface CppLookupInAnyReplicaRequest {
+    id: CppDocumentId;
+    specs: CppImplSubdocCommand[];
+    timeout?: CppMilliseconds;
+}
 export interface CppMutateInResponse {
     cas: CppCas;
     token: CppMutationToken;
@@ -1884,6 +1927,7 @@ export interface CppConnectionAutogen {
     remove(options: CppRemoveRequest, callback: (err: CppError | null, result: CppRemoveResponse) => void): void;
     removeWithLegacyDurability(options: CppRemoveWithLegacyDurabilityRequest, callback: (err: CppError | null, result: CppRemoveResponse) => void): void;
     get(options: CppGetRequest, callback: (err: CppError | null, result: CppGetResponse) => void): void;
+    lookupInAllReplicas(options: CppLookupInAllReplicasRequest, callback: (err: CppError | null, result: CppLookupInAllReplicasResponse) => void): void;
     analytics(options: CppAnalyticsRequest, callback: (err: CppError | null, result: CppAnalyticsResponse) => void): void;
     getProjected(options: CppGetProjectedRequest, callback: (err: CppError | null, result: CppGetProjectedResponse) => void): void;
     decrement(options: CppDecrementRequest, callback: (err: CppError | null, result: CppDecrementResponse) => void): void;
@@ -1895,6 +1939,7 @@ export interface CppConnectionAutogen {
     getAndLock(options: CppGetAndLockRequest, callback: (err: CppError | null, result: CppGetAndLockResponse) => void): void;
     insert(options: CppInsertRequest, callback: (err: CppError | null, result: CppInsertResponse) => void): void;
     insertWithLegacyDurability(options: CppInsertWithLegacyDurabilityRequest, callback: (err: CppError | null, result: CppInsertResponse) => void): void;
+    lookupInAnyReplica(options: CppLookupInAnyReplicaRequest, callback: (err: CppError | null, result: CppLookupInAnyReplicaResponse) => void): void;
     mutateIn(options: CppMutateInRequest, callback: (err: CppError | null, result: CppMutateInResponse) => void): void;
     mutateInWithLegacyDurability(options: CppMutateInWithLegacyDurabilityRequest, callback: (err: CppError | null, result: CppMutateInResponse) => void): void;
     increment(options: CppIncrementRequest, callback: (err: CppError | null, result: CppIncrementResponse) => void): void;

package/dist/collection.d.ts

@@ -2,7 +2,7 @@
 import { IncrementOptions, DecrementOptions, AppendOptions, PrependOptions, BinaryCollection } from './binarycollection';
 import { CppDocumentId, CppConnection, CppScanIterator, CppRangeScanOrchestratorOptions } from './binding';
 import { Cluster } from './cluster';
-import { CounterResult, ExistsResult, GetReplicaResult, GetResult, LookupInResult, MutateInResult, MutationResult, ScanResult } from './crudoptypes';
+import { CounterResult, ExistsResult, GetReplicaResult, GetResult, LookupInResult, LookupInReplicaResult, MutateInResult, MutationResult, ScanResult } from './crudoptypes';
 import { CouchbaseList, CouchbaseMap, CouchbaseQueue, CouchbaseSet } from './datastructures';
 import { DurabilityLevel, StoreSemantics } from './generaltypes';
 import { MutationState } from './mutationstate';
@@ -270,6 +270,30 @@ export interface LookupInOptions {
      * The timeout for this operation, represented in milliseconds.
      */
     timeout?: number;
+    /**
+     * For internal use only - allows access to deleted documents that are in 'tombstone' form
+     *
+     * @internal
+     */
+    accessDeleted?: boolean;
+}
+/**
+ * @category Key-Value
+ */
+export interface LookupInAnyReplicaOptions {
+    /**
+     * The timeout for this operation, represented in milliseconds.
+     */
+    timeout?: number;
+}
+/**
+ * @category Key-Value
+ */
+export interface LookupInAllReplicasOptions {
+    /**
+     * The timeout for this operation, represented in milliseconds.
+     */
+    timeout?: number;
 }
 /**
  * @category Key-Value
@@ -567,6 +591,34 @@ export declare class Collection {
      * @param callback A node-style callback to be invoked after execution.
      */
     lookupIn(key: string, specs: LookupInSpec[], options?: LookupInOptions, callback?: NodeCallback<LookupInResult>): Promise<LookupInResult>;
+    /**
+     * @internal
+     */
+    _lookupInReplica(key: string, lookupInAllReplicas: boolean, specs: LookupInSpec[], options?: {
+        timeout?: number;
+    }, callback?: NodeCallback<LookupInReplicaResult[]>): StreamableReplicasPromise<LookupInReplicaResult[], LookupInReplicaResult>;
+    /**
+     * Performs a lookup-in operation against a document, fetching individual fields or
+     * information about specific fields inside the document value from any of the available
+     * replicas in the cluster.
+     *
+     * @param key The document key to look in.
+     * @param specs A list of specs describing the data to fetch from the document.
+     * @param options Optional parameters for this operation.
+     * @param callback A node-style callback to be invoked after execution.
+     */
+    lookupInAnyReplica(key: string, specs: LookupInSpec[], options?: LookupInOptions, callback?: NodeCallback<LookupInReplicaResult>): Promise<LookupInReplicaResult>;
+    /**
+     * Performs a lookup-in operation against a document, fetching individual fields or
+     * information about specific fields inside the document value from all available replicas.
+     * Note that as replication is asynchronous, each node may return a different value.
+     *
+     * @param key The document key to look in.
+     * @param specs A list of specs describing the data to fetch from the document.
+     * @param options Optional parameters for this operation.
+     * @param callback A node-style callback to be invoked after execution.
+     */
+    lookupInAllReplicas(key: string, specs: LookupInSpec[], options?: LookupInOptions, callback?: NodeCallback<LookupInReplicaResult[]>): Promise<LookupInReplicaResult[]>;
     /**
      * Performs a mutate-in operation against a document.  Allowing atomic modification of
      * specific fields within a document.  Also enables access to document extended-attributes.

package/dist/collection.js

@@ -939,6 +939,7 @@ class Collection {
             });
         }
         const timeout = options.timeout || this.cluster.kvTimeout;
+        const accessDeleted = options.accessDeleted || false;
         return utilities_1.PromiseHelper.wrap((wrapCallback) => {
             this._conn.lookupIn({
                 id: this._cppDocId(key),
@@ -946,7 +947,7 @@ class Collection {
                 timeout,
                 partition: 0,
                 opaque: 0,
-                access_deleted: false,
+                access_deleted: accessDeleted,
             }, (cppErr, resp) => {
                 const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
                 if (resp && resp.fields) {
@@ -978,6 +979,143 @@ class Collection {
             });
         }, callback);
     }
+    /**
+     * @internal
+     */
+    _lookupInReplica(key, lookupInAllReplicas, specs, options, callback) {
+        if (options instanceof Function) {
+            callback = arguments[3];
+            options = undefined;
+        }
+        if (!options) {
+            options = {};
+        }
+        const emitter = new streamablepromises_1.StreamableReplicasPromise((replicas) => replicas);
+        const cppSpecs = [];
+        for (let i = 0; i < specs.length; ++i) {
+            cppSpecs.push({
+                opcode_: specs[i]._op,
+                flags_: specs[i]._flags,
+                path_: specs[i]._path,
+                original_index_: i,
+            });
+        }
+        const timeout = options.timeout || this.cluster.kvTimeout;
+        if (lookupInAllReplicas) {
+            this._conn.lookupInAllReplicas({
+                id: this._cppDocId(key),
+                specs: cppSpecs,
+                timeout: timeout,
+            }, (cppErr, resp) => {
+                const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
+                if (err) {
+                    emitter.emit('error', err);
+                    emitter.emit('end');
+                    return;
+                }
+                resp.entries.forEach((replica) => {
+                    const content = [];
+                    for (let i = 0; i < replica.fields.length; ++i) {
+                        const itemRes = replica.fields[i];
+                        let error = (0, bindingutilities_1.errorFromCpp)(itemRes.ec);
+                        let value = undefined;
+                        if (itemRes.value && itemRes.value.length > 0) {
+                            value = this._subdocDecode(itemRes.value);
+                        }
+                        // BUG(JSCBC-1016): Should remove this workaround when the underlying bug is resolved.
+                        if (itemRes.opcode === binding_1.default.protocol_subdoc_opcode.exists) {
+                            error = null;
+                            value = itemRes.exists;
+                        }
+                        content.push(new crudoptypes_1.LookupInResultEntry({
+                            error,
+                            value,
+                        }));
+                    }
+                    emitter.emit('replica', new crudoptypes_1.LookupInReplicaResult(({
+                        content: content,
+                        cas: replica.cas,
+                        isReplica: replica.is_replica
+                    })));
+                });
+                emitter.emit('end');
+                return;
+            });
+        }
+        else {
+            this._conn.lookupInAnyReplica({
+                id: this._cppDocId(key),
+                specs: cppSpecs,
+                timeout: timeout,
+            }, (cppErr, resp) => {
+                const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
+                if (err) {
+                    emitter.emit('error', err);
+                    emitter.emit('end');
+                    return;
+                }
+                const content = [];
+                for (let i = 0; i < resp.fields.length; ++i) {
+                    const itemRes = resp.fields[i];
+                    let error = (0, bindingutilities_1.errorFromCpp)(itemRes.ec);
+                    let value = undefined;
+                    if (itemRes.value && itemRes.value.length > 0) {
+                        value = this._subdocDecode(itemRes.value);
+                    }
+                    // BUG(JSCBC-1016): Should remove this workaround when the underlying bug is resolved.
+                    if (itemRes.opcode === binding_1.default.protocol_subdoc_opcode.exists) {
+                        error = null;
+                        value = itemRes.exists;
+                    }
+                    content.push(new crudoptypes_1.LookupInResultEntry({
+                        error,
+                        value,
+                    }));
+                }
+                emitter.emit('replica', new crudoptypes_1.GetReplicaResult({
+                    content: content,
+                    cas: resp.cas,
+                    isReplica: resp.is_replica,
+                }));
+                emitter.emit('end');
+                return;
+            });
+        }
+        return utilities_1.PromiseHelper.wrapAsync(() => emitter, callback);
+    }
+    /**
+     * Performs a lookup-in operation against a document, fetching individual fields or
+     * information about specific fields inside the document value from any of the available
+     * replicas in the cluster.
+     *
+     * @param key The document key to look in.
+     * @param specs A list of specs describing the data to fetch from the document.
+     * @param options Optional parameters for this operation.
+     * @param callback A node-style callback to be invoked after execution.
+     */
+    lookupInAnyReplica(key, specs, options, callback) {
+        if (options instanceof Function) {
+            callback = arguments[2];
+            options = undefined;
+        }
+        return utilities_1.PromiseHelper.wrapAsync(async () => {
+            const replicas = await this._lookupInReplica(key, false, specs, options);
+            return replicas[0];
+        }, callback);
+    }
+    /**
+     * Performs a lookup-in operation against a document, fetching individual fields or
+     * information about specific fields inside the document value from all available replicas.
+     * Note that as replication is asynchronous, each node may return a different value.
+     *
+     * @param key The document key to look in.
+     * @param specs A list of specs describing the data to fetch from the document.
+     * @param options Optional parameters for this operation.
+     * @param callback A node-style callback to be invoked after execution.
+     */
+    lookupInAllReplicas(key, specs, options, callback) {
+        return this._lookupInReplica(key, true, specs, options, callback);
+    }
     /**
      * Performs a mutate-in operation against a document.  Allowing atomic modification of
      * specific fields within a document.  Also enables access to document extended-attributes.

package/dist/crudoptypes.d.ts

@@ -189,6 +189,30 @@ export declare class LookupInResult {
     get results(): LookupInResultEntry[];
     set results(v: LookupInResultEntry[]);
 }
+/**
+ * Contains the results of a lookup-in replica operation.
+ *
+ * @category Key-Value
+ */
+export declare class LookupInReplicaResult {
+    /**
+     * A list of result entries for each sub-operation performed.
+     */
+    content: LookupInResultEntry[];
+    /**
+     * The cas of the document.
+     */
+    cas: Cas;
+    /**
+     * Indicates whether this result came from a replica or the primary.
+     */
+    isReplica: boolean;
+    constructor(data: {
+        content: LookupInResultEntry[];
+        cas: Cas;
+        isReplica: boolean;
+    });
+}
 /**
  * Contains the results of a specific sub-operation within a mutate-in operation.
  *

package/dist/crudoptypes.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CounterResult = exports.MutateInResult = exports.MutateInResultEntry = exports.LookupInResult = exports.LookupInResultEntry = exports.GetReplicaResult = exports.MutationResult = exports.ExistsResult = exports.ScanResult = exports.GetResult = void 0;
+exports.CounterResult = exports.MutateInResult = exports.MutateInResultEntry = exports.LookupInReplicaResult = exports.LookupInResult = exports.LookupInResultEntry = exports.GetReplicaResult = exports.MutationResult = exports.ExistsResult = exports.ScanResult = exports.GetResult = void 0;
 /**
  * Contains the results of a Get operation.
  *
@@ -140,6 +140,19 @@ class LookupInResult {
     }
 }
 exports.LookupInResult = LookupInResult;
+/**
+ * Contains the results of a lookup-in replica operation.
+ *
+ * @category Key-Value
+ */
+class LookupInReplicaResult {
+    constructor(data) {
+        this.content = data.content;
+        this.cas = data.cas;
+        this.isReplica = data.isReplica;
+    }
+}
+exports.LookupInReplicaResult = LookupInReplicaResult;
 /**
  * Contains the results of a specific sub-operation within a mutate-in operation.
  *

package/package.json

@@ -55,7 +55,7 @@
     "type": "git",
     "url": "http://github.com/couchbase/couchnode.git"
   },
-  "version": "4.2.6",
+  "version": "4.2.7",
   "config": {
     "native": false
   },
@@ -80,17 +80,17 @@
     ]
   },
   "optionalDependencies": {
-    "@couchbase/couchbase-darwin-arm64-openssl1": "4.2.6",
-    "@couchbase/couchbase-darwin-arm64-openssl3": "4.2.6",
-    "@couchbase/couchbase-darwin-x64-openssl1": "4.2.6",
-    "@couchbase/couchbase-darwin-x64-openssl3": "4.2.6",
-    "@couchbase/couchbase-linux-arm64-openssl1": "4.2.6",
-    "@couchbase/couchbase-linux-arm64-openssl3": "4.2.6",
-    "@couchbase/couchbase-linux-x64-openssl1": "4.2.6",
-    "@couchbase/couchbase-linux-x64-openssl3": "4.2.6",
-    "@couchbase/couchbase-linuxmusl-x64-openssl1": "4.2.6",
-    "@couchbase/couchbase-linuxmusl-x64-openssl3": "4.2.6",
-    "@couchbase/couchbase-win32-x64-openssl1": "4.2.6",
-    "@couchbase/couchbase-win32-x64-openssl3": "4.2.6"
+    "@couchbase/couchbase-darwin-arm64-openssl1": "4.2.7",
+    "@couchbase/couchbase-darwin-arm64-openssl3": "4.2.7",
+    "@couchbase/couchbase-darwin-x64-openssl1": "4.2.7",
+    "@couchbase/couchbase-darwin-x64-openssl3": "4.2.7",
+    "@couchbase/couchbase-linux-arm64-openssl1": "4.2.7",
+    "@couchbase/couchbase-linux-arm64-openssl3": "4.2.7",
+    "@couchbase/couchbase-linux-x64-openssl1": "4.2.7",
+    "@couchbase/couchbase-linux-x64-openssl3": "4.2.7",
+    "@couchbase/couchbase-linuxmusl-x64-openssl1": "4.2.7",
+    "@couchbase/couchbase-linuxmusl-x64-openssl3": "4.2.7",
+    "@couchbase/couchbase-win32-x64-openssl1": "4.2.7",
+    "@couchbase/couchbase-win32-x64-openssl3": "4.2.7"
   }
 }

package/src/connection.cpp

@@ -65,6 +65,8 @@ void Connection::Init(Napi::Env env, Napi::Object exports)
             InstanceMethod<&Connection::jsRemoveWithLegacyDurability>(
                 "removeWithLegacyDurability"),
             InstanceMethod<&Connection::jsGet>("get"),
+            InstanceMethod<&Connection::jsLookupInAllReplicas>(
+                "lookupInAllReplicas"),
             InstanceMethod<&Connection::jsAnalytics>("analytics"),
             InstanceMethod<&Connection::jsGetProjected>("getProjected"),
             InstanceMethod<&Connection::jsDecrement>("decrement"),
@@ -78,6 +80,8 @@ void Connection::Init(Napi::Env env, Napi::Object exports)
             InstanceMethod<&Connection::jsInsert>("insert"),
             InstanceMethod<&Connection::jsInsertWithLegacyDurability>(
                 "insertWithLegacyDurability"),
+            InstanceMethod<&Connection::jsLookupInAnyReplica>(
+                "lookupInAnyReplica"),
             InstanceMethod<&Connection::jsMutateIn>("mutateIn"),
             InstanceMethod<&Connection::jsMutateInWithLegacyDurability>(
                 "mutateInWithLegacyDurability"),

package/src/connection.hpp

@@ -91,6 +91,7 @@ public:
     Napi::Value jsRemove(const Napi::CallbackInfo &info);
     Napi::Value jsRemoveWithLegacyDurability(const Napi::CallbackInfo &info);
     Napi::Value jsGet(const Napi::CallbackInfo &info);
+    Napi::Value jsLookupInAllReplicas(const Napi::CallbackInfo &info);
     Napi::Value jsAnalytics(const Napi::CallbackInfo &info);
     Napi::Value jsGetProjected(const Napi::CallbackInfo &info);
     Napi::Value jsDecrement(const Napi::CallbackInfo &info);
@@ -102,6 +103,7 @@ public:
     Napi::Value jsGetAndLock(const Napi::CallbackInfo &info);
     Napi::Value jsInsert(const Napi::CallbackInfo &info);
     Napi::Value jsInsertWithLegacyDurability(const Napi::CallbackInfo &info);
+    Napi::Value jsLookupInAnyReplica(const Napi::CallbackInfo &info);
     Napi::Value jsMutateIn(const Napi::CallbackInfo &info);
     Napi::Value jsMutateInWithLegacyDurability(const Napi::CallbackInfo &info);
     Napi::Value jsIncrement(const Napi::CallbackInfo &info);

package/src/connection_autogen.cpp

@@ -242,6 +242,20 @@ Napi::Value Connection::jsGet(const Napi::CallbackInfo &info)
     return info.Env().Null();
 }
 
+Napi::Value Connection::jsLookupInAllReplicas(const Napi::CallbackInfo &info)
+{
+    auto optsJsObj = info[0].As<Napi::Object>();
+    auto callbackJsFn = info[1].As<Napi::Function>();
+
+    executeOp(
+        "lookupInAllReplicas",
+        jsToCbpp<couchbase::core::operations::lookup_in_all_replicas_request>(
+            optsJsObj),
+        callbackJsFn);
+
+    return info.Env().Null();
+}
+
 Napi::Value Connection::jsAnalytics(const Napi::CallbackInfo &info)
 {
     auto optsJsObj = info[0].As<Napi::Object>();
@@ -386,6 +400,20 @@ Connection::jsInsertWithLegacyDurability(const Napi::CallbackInfo &info)
     return info.Env().Null();
 }
 
+Napi::Value Connection::jsLookupInAnyReplica(const Napi::CallbackInfo &info)
+{
+    auto optsJsObj = info[0].As<Napi::Object>();
+    auto callbackJsFn = info[1].As<Napi::Function>();
+
+    executeOp(
+        "lookupInAnyReplica",
+        jsToCbpp<couchbase::core::operations::lookup_in_any_replica_request>(
+            optsJsObj),
+        callbackJsFn);
+
+    return info.Env().Null();
+}
+
 Napi::Value Connection::jsMutateIn(const Napi::CallbackInfo &info)
 {
     auto optsJsObj = info[0].As<Napi::Object>();