couchbase 4.6.0 → 4.7.0-dev.1

package/dist/searchindexmanager.js

@@ -2,7 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SearchIndexManager = exports.SearchIndex = void 0;
 const utilities_1 = require("./utilities");
-const bindingutilities_1 = require("./bindingutilities");
+const observability_1 = require("./observability");
+const observabilityhandler_1 = require("./observabilityhandler");
+const observabilitytypes_1 = require("./observabilitytypes");
 /**
  * This class is currently incomplete and must be casted to `any` in
  * TypeScript to be used.
@@ -81,6 +83,12 @@ class SearchIndexManager {
     constructor(cluster) {
         this._cluster = cluster;
     }
+    /**
+     * @internal
+     */
+    get observabilityInstruments() {
+        return this._cluster.observabilityInstruments;
+    }
     /**
      * Returns an index by it's name.
      *
@@ -96,20 +104,27 @@ class SearchIndexManager {
         if (!options) {
             options = {};
         }
-        const timeout = options.timeout || this._cluster.managementTimeout;
-        return utilities_1.PromiseHelper.wrap((wrapCallback) => {
-            this._cluster.conn.managementSearchIndexGet({
-                index_name: indexName,
-                timeout: timeout,
-            }, (cppErr, resp) => {
-                const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
+        const obsReqHandler = new observabilityhandler_1.ObservableRequestHandler(observabilitytypes_1.SearchIndexMgmtOp.SearchIndexGet, this.observabilityInstruments, options === null || options === void 0 ? void 0 : options.parentSpan);
+        obsReqHandler.setRequestHttpAttributes();
+        try {
+            const timeout = options.timeout || this._cluster.managementTimeout;
+            return utilities_1.PromiseHelper.wrapAsync(async () => {
+                const [err, resp] = await (0, observability_1.wrapObservableBindingCall)(this._cluster.conn.managementSearchIndexGet.bind(this._cluster.conn), {
+                    index_name: indexName,
+                    timeout: timeout,
+                }, obsReqHandler);
                 if (err) {
-                    return wrapCallback(err, null);
+                    obsReqHandler.endWithError(err);
+                    throw err;
                 }
-                const index = SearchIndex._fromCppData(resp.index);
-                wrapCallback(null, index);
-            });
-        }, callback);
+                obsReqHandler.end();
+                return SearchIndex._fromCppData(resp.index);
+            }, callback);
+        }
+        catch (err) {
+            obsReqHandler.endWithError(err);
+            throw err;
+        }
     }
     /**
      * Returns a list of all existing indexes.
@@ -125,19 +140,26 @@ class SearchIndexManager {
         if (!options) {
             options = {};
         }
-        const timeout = options.timeout || this._cluster.managementTimeout;
-        return utilities_1.PromiseHelper.wrap((wrapCallback) => {
-            this._cluster.conn.managementSearchIndexGetAll({
-                timeout: timeout,
-            }, (cppErr, resp) => {
-                const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
+        const obsReqHandler = new observabilityhandler_1.ObservableRequestHandler(observabilitytypes_1.SearchIndexMgmtOp.SearchIndexGetAll, this.observabilityInstruments, options === null || options === void 0 ? void 0 : options.parentSpan);
+        obsReqHandler.setRequestHttpAttributes();
+        try {
+            const timeout = options.timeout || this._cluster.managementTimeout;
+            return utilities_1.PromiseHelper.wrapAsync(async () => {
+                const [err, resp] = await (0, observability_1.wrapObservableBindingCall)(this._cluster.conn.managementSearchIndexGetAll.bind(this._cluster.conn), {
+                    timeout: timeout,
+                }, obsReqHandler);
                 if (err) {
-                    return wrapCallback(err, null);
+                    obsReqHandler.endWithError(err);
+                    throw err;
                 }
-                const indexes = resp.indexes.map((indexData) => SearchIndex._fromCppData(indexData));
-                wrapCallback(null, indexes);
-            });
-        }, callback);
+                obsReqHandler.end();
+                return resp.indexes.map((indexData) => SearchIndex._fromCppData(indexData));
+            }, callback);
+        }
+        catch (err) {
+            obsReqHandler.endWithError(err);
+            throw err;
+        }
     }
     /**
      * Creates or updates an existing index.
@@ -154,19 +176,26 @@ class SearchIndexManager {
         if (!options) {
             options = {};
         }
-        const timeout = options.timeout || this._cluster.managementTimeout;
-        return utilities_1.PromiseHelper.wrap((wrapCallback) => {
-            this._cluster.conn.managementSearchIndexUpsert({
-                index: SearchIndex._toCppData(indexDefinition),
-                timeout: timeout,
-            }, (cppErr) => {
-                const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
+        const obsReqHandler = new observabilityhandler_1.ObservableRequestHandler(observabilitytypes_1.SearchIndexMgmtOp.SearchIndexUpsert, this.observabilityInstruments, options === null || options === void 0 ? void 0 : options.parentSpan);
+        obsReqHandler.setRequestHttpAttributes();
+        try {
+            const timeout = options.timeout || this._cluster.managementTimeout;
+            return utilities_1.PromiseHelper.wrapAsync(async () => {
+                const [err, _] = await (0, observability_1.wrapObservableBindingCall)(this._cluster.conn.managementSearchIndexUpsert.bind(this._cluster.conn), {
+                    index: SearchIndex._toCppData(indexDefinition),
+                    timeout: timeout,
+                }, obsReqHandler);
                 if (err) {
-                    return wrapCallback(err, null);
+                    obsReqHandler.endWithError(err);
+                    throw err;
                 }
-                wrapCallback(err);
-            });
-        }, callback);
+                obsReqHandler.end();
+            }, callback);
+        }
+        catch (err) {
+            obsReqHandler.endWithError(err);
+            throw err;
+        }
     }
     /**
      * Drops an index.
@@ -183,19 +212,26 @@ class SearchIndexManager {
         if (!options) {
             options = {};
         }
-        const timeout = options.timeout || this._cluster.managementTimeout;
-        return utilities_1.PromiseHelper.wrap((wrapCallback) => {
-            this._cluster.conn.managementSearchIndexDrop({
-                index_name: indexName,
-                timeout: timeout,
-            }, (cppErr) => {
-                const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
+        const obsReqHandler = new observabilityhandler_1.ObservableRequestHandler(observabilitytypes_1.SearchIndexMgmtOp.SearchIndexDrop, this.observabilityInstruments, options === null || options === void 0 ? void 0 : options.parentSpan);
+        obsReqHandler.setRequestHttpAttributes();
+        try {
+            const timeout = options.timeout || this._cluster.managementTimeout;
+            return utilities_1.PromiseHelper.wrapAsync(async () => {
+                const [err, _] = await (0, observability_1.wrapObservableBindingCall)(this._cluster.conn.managementSearchIndexDrop.bind(this._cluster.conn), {
+                    index_name: indexName,
+                    timeout: timeout,
+                }, obsReqHandler);
                 if (err) {
-                    return wrapCallback(err, null);
+                    obsReqHandler.endWithError(err);
+                    throw err;
                 }
-                wrapCallback(err);
-            });
-        }, callback);
+                obsReqHandler.end();
+            }, callback);
+        }
+        catch (err) {
+            obsReqHandler.endWithError(err);
+            throw err;
+        }
     }
     /**
      * Returns the number of documents that have been indexed.
@@ -212,19 +248,27 @@ class SearchIndexManager {
         if (!options) {
             options = {};
         }
-        const timeout = options.timeout || this._cluster.managementTimeout;
-        return utilities_1.PromiseHelper.wrap((wrapCallback) => {
-            this._cluster.conn.managementSearchIndexGetDocumentsCount({
-                index_name: indexName,
-                timeout: timeout,
-            }, (cppErr, resp) => {
-                const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
+        const obsReqHandler = new observabilityhandler_1.ObservableRequestHandler(observabilitytypes_1.SearchIndexMgmtOp.SearchIndexGetDocumentsCount, this.observabilityInstruments, options === null || options === void 0 ? void 0 : options.parentSpan);
+        obsReqHandler.setRequestHttpAttributes();
+        try {
+            const timeout = options.timeout || this._cluster.managementTimeout;
+            return utilities_1.PromiseHelper.wrapAsync(async () => {
+                const [err, resp] = await (0, observability_1.wrapObservableBindingCall)(this._cluster.conn.managementSearchIndexGetDocumentsCount.bind(this._cluster.conn), {
+                    index_name: indexName,
+                    timeout: timeout,
+                }, obsReqHandler);
                 if (err) {
-                    return wrapCallback(err, null);
+                    obsReqHandler.endWithError(err);
+                    throw err;
                 }
-                wrapCallback(null, resp.count);
-            });
-        }, callback);
+                obsReqHandler.end();
+                return resp.count;
+            }, callback);
+        }
+        catch (err) {
+            obsReqHandler.endWithError(err);
+            throw err;
+        }
     }
     /**
      * Pauses the ingestion of documents into an index.
@@ -241,20 +285,27 @@ class SearchIndexManager {
         if (!options) {
             options = {};
         }
-        const timeout = options.timeout || this._cluster.managementTimeout;
-        return utilities_1.PromiseHelper.wrap((wrapCallback) => {
-            this._cluster.conn.managementSearchIndexControlIngest({
-                index_name: indexName,
-                pause: true,
-                timeout: timeout,
-            }, (cppErr) => {
-                const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
+        const obsReqHandler = new observabilityhandler_1.ObservableRequestHandler(observabilitytypes_1.SearchIndexMgmtOp.SearchIndexPauseIngest, this.observabilityInstruments, options === null || options === void 0 ? void 0 : options.parentSpan);
+        obsReqHandler.setRequestHttpAttributes();
+        try {
+            const timeout = options.timeout || this._cluster.managementTimeout;
+            return utilities_1.PromiseHelper.wrapAsync(async () => {
+                const [err, _] = await (0, observability_1.wrapObservableBindingCall)(this._cluster.conn.managementSearchIndexControlIngest.bind(this._cluster.conn), {
+                    index_name: indexName,
+                    pause: true,
+                    timeout: timeout,
+                }, obsReqHandler);
                 if (err) {
-                    return wrapCallback(err, null);
+                    obsReqHandler.endWithError(err);
+                    throw err;
                 }
-                wrapCallback(err);
-            });
-        }, callback);
+                obsReqHandler.end();
+            }, callback);
+        }
+        catch (err) {
+            obsReqHandler.endWithError(err);
+            throw err;
+        }
     }
     /**
      * Resumes the ingestion of documents into an index.
@@ -271,20 +322,27 @@ class SearchIndexManager {
         if (!options) {
             options = {};
         }
-        const timeout = options.timeout || this._cluster.managementTimeout;
-        return utilities_1.PromiseHelper.wrap((wrapCallback) => {
-            this._cluster.conn.managementSearchIndexControlIngest({
-                index_name: indexName,
-                pause: false,
-                timeout: timeout,
-            }, (cppErr) => {
-                const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
+        const obsReqHandler = new observabilityhandler_1.ObservableRequestHandler(observabilitytypes_1.SearchIndexMgmtOp.SearchIndexResumeIngest, this.observabilityInstruments, options === null || options === void 0 ? void 0 : options.parentSpan);
+        obsReqHandler.setRequestHttpAttributes();
+        try {
+            const timeout = options.timeout || this._cluster.managementTimeout;
+            return utilities_1.PromiseHelper.wrapAsync(async () => {
+                const [err, _] = await (0, observability_1.wrapObservableBindingCall)(this._cluster.conn.managementSearchIndexControlIngest.bind(this._cluster.conn), {
+                    index_name: indexName,
+                    pause: false,
+                    timeout: timeout,
+                }, obsReqHandler);
                 if (err) {
-                    return wrapCallback(err, null);
+                    obsReqHandler.endWithError(err);
+                    throw err;
                 }
-                wrapCallback(err);
-            });
-        }, callback);
+                obsReqHandler.end();
+            }, callback);
+        }
+        catch (err) {
+            obsReqHandler.endWithError(err);
+            throw err;
+        }
     }
     /**
      * Enables querying of an index.
@@ -301,20 +359,27 @@ class SearchIndexManager {
         if (!options) {
             options = {};
         }
-        const timeout = options.timeout || this._cluster.managementTimeout;
-        return utilities_1.PromiseHelper.wrap((wrapCallback) => {
-            this._cluster.conn.managementSearchIndexControlQuery({
-                index_name: indexName,
-                allow: true,
-                timeout: timeout,
-            }, (cppErr) => {
-                const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
+        const obsReqHandler = new observabilityhandler_1.ObservableRequestHandler(observabilitytypes_1.SearchIndexMgmtOp.SearchIndexAllowQuerying, this.observabilityInstruments, options === null || options === void 0 ? void 0 : options.parentSpan);
+        obsReqHandler.setRequestHttpAttributes();
+        try {
+            const timeout = options.timeout || this._cluster.managementTimeout;
+            return utilities_1.PromiseHelper.wrapAsync(async () => {
+                const [err, _] = await (0, observability_1.wrapObservableBindingCall)(this._cluster.conn.managementSearchIndexControlQuery.bind(this._cluster.conn), {
+                    index_name: indexName,
+                    allow: true,
+                    timeout: timeout,
+                }, obsReqHandler);
                 if (err) {
-                    return wrapCallback(err, null);
+                    obsReqHandler.endWithError(err);
+                    throw err;
                 }
-                wrapCallback(err);
-            });
-        }, callback);
+                obsReqHandler.end();
+            }, callback);
+        }
+        catch (err) {
+            obsReqHandler.endWithError(err);
+            throw err;
+        }
     }
     /**
      * Disables querying of an index.
@@ -331,20 +396,27 @@ class SearchIndexManager {
         if (!options) {
             options = {};
         }
-        const timeout = options.timeout || this._cluster.managementTimeout;
-        return utilities_1.PromiseHelper.wrap((wrapCallback) => {
-            this._cluster.conn.managementSearchIndexControlQuery({
-                index_name: indexName,
-                allow: false,
-                timeout: timeout,
-            }, (cppErr) => {
-                const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
+        const obsReqHandler = new observabilityhandler_1.ObservableRequestHandler(observabilitytypes_1.SearchIndexMgmtOp.SearchIndexDisallowQuerying, this.observabilityInstruments, options === null || options === void 0 ? void 0 : options.parentSpan);
+        obsReqHandler.setRequestHttpAttributes();
+        try {
+            const timeout = options.timeout || this._cluster.managementTimeout;
+            return utilities_1.PromiseHelper.wrapAsync(async () => {
+                const [err, _] = await (0, observability_1.wrapObservableBindingCall)(this._cluster.conn.managementSearchIndexControlQuery.bind(this._cluster.conn), {
+                    index_name: indexName,
+                    allow: false,
+                    timeout: timeout,
+                }, obsReqHandler);
                 if (err) {
-                    return wrapCallback(err, null);
+                    obsReqHandler.endWithError(err);
+                    throw err;
                 }
-                wrapCallback(err);
-            });
-        }, callback);
+                obsReqHandler.end();
+            }, callback);
+        }
+        catch (err) {
+            obsReqHandler.endWithError(err);
+            throw err;
+        }
     }
     /**
      * Freezes the indexing plan for execution of queries.
@@ -361,20 +433,27 @@ class SearchIndexManager {
         if (!options) {
             options = {};
         }
-        const timeout = options.timeout || this._cluster.managementTimeout;
-        return utilities_1.PromiseHelper.wrap((wrapCallback) => {
-            this._cluster.conn.managementSearchIndexControlPlanFreeze({
-                index_name: indexName,
-                freeze: true,
-                timeout: timeout,
-            }, (cppErr) => {
-                const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
+        const obsReqHandler = new observabilityhandler_1.ObservableRequestHandler(observabilitytypes_1.SearchIndexMgmtOp.SearchIndexFreezePlan, this.observabilityInstruments, options === null || options === void 0 ? void 0 : options.parentSpan);
+        obsReqHandler.setRequestHttpAttributes();
+        try {
+            const timeout = options.timeout || this._cluster.managementTimeout;
+            return utilities_1.PromiseHelper.wrapAsync(async () => {
+                const [err, _] = await (0, observability_1.wrapObservableBindingCall)(this._cluster.conn.managementSearchIndexControlPlanFreeze.bind(this._cluster.conn), {
+                    index_name: indexName,
+                    freeze: true,
+                    timeout: timeout,
+                }, obsReqHandler);
                 if (err) {
-                    return wrapCallback(err, null);
+                    obsReqHandler.endWithError(err);
+                    throw err;
                 }
-                wrapCallback(err);
-            });
-        }, callback);
+                obsReqHandler.end();
+            }, callback);
+        }
+        catch (err) {
+            obsReqHandler.endWithError(err);
+            throw err;
+        }
     }
     /**
      * Unfreezes the indexing plan for execution of queries.
@@ -391,20 +470,27 @@ class SearchIndexManager {
         if (!options) {
             options = {};
         }
-        const timeout = options.timeout || this._cluster.managementTimeout;
-        return utilities_1.PromiseHelper.wrap((wrapCallback) => {
-            this._cluster.conn.managementSearchIndexControlPlanFreeze({
-                index_name: indexName,
-                freeze: false,
-                timeout: timeout,
-            }, (cppErr) => {
-                const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
+        const obsReqHandler = new observabilityhandler_1.ObservableRequestHandler(observabilitytypes_1.SearchIndexMgmtOp.SearchIndexUnfreezePlan, this.observabilityInstruments, options === null || options === void 0 ? void 0 : options.parentSpan);
+        obsReqHandler.setRequestHttpAttributes();
+        try {
+            const timeout = options.timeout || this._cluster.managementTimeout;
+            return utilities_1.PromiseHelper.wrapAsync(async () => {
+                const [err, _] = await (0, observability_1.wrapObservableBindingCall)(this._cluster.conn.managementSearchIndexControlPlanFreeze.bind(this._cluster.conn), {
+                    index_name: indexName,
+                    freeze: false,
+                    timeout: timeout,
+                }, obsReqHandler);
                 if (err) {
-                    return wrapCallback(err, null);
+                    obsReqHandler.endWithError(err);
+                    throw err;
                 }
-                wrapCallback(err);
-            });
-        }, callback);
+                obsReqHandler.end();
+            }, callback);
+        }
+        catch (err) {
+            obsReqHandler.endWithError(err);
+            throw err;
+        }
     }
     /**
      * Performs analysis of a specific document by an index.
@@ -422,21 +508,28 @@ class SearchIndexManager {
         if (!options) {
             options = {};
         }
-        const timeout = options.timeout || this._cluster.managementTimeout;
-        return utilities_1.PromiseHelper.wrap((wrapCallback) => {
-            this._cluster.conn.managementSearchIndexAnalyzeDocument({
-                index_name: indexName,
-                encoded_document: JSON.stringify(document),
-                timeout: timeout,
-            }, (cppErr, resp) => {
-                const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
+        const obsReqHandler = new observabilityhandler_1.ObservableRequestHandler(observabilitytypes_1.SearchIndexMgmtOp.SearchIndexAnalyzeDocument, this.observabilityInstruments, options === null || options === void 0 ? void 0 : options.parentSpan);
+        obsReqHandler.setRequestHttpAttributes();
+        try {
+            const timeout = options.timeout || this._cluster.managementTimeout;
+            return utilities_1.PromiseHelper.wrapAsync(async () => {
+                const [err, resp] = await (0, observability_1.wrapObservableBindingCall)(this._cluster.conn.managementSearchIndexAnalyzeDocument.bind(this._cluster.conn), {
+                    index_name: indexName,
+                    encoded_document: JSON.stringify(document),
+                    timeout: timeout,
+                }, obsReqHandler);
                 if (err) {
-                    return wrapCallback(err, null);
+                    obsReqHandler.endWithError(err);
+                    throw err;
                 }
-                const result = JSON.parse(resp.analysis);
-                wrapCallback(result, null);
-            });
-        }, callback);
+                obsReqHandler.end();
+                return JSON.parse(resp.analysis);
+            }, callback);
+        }
+        catch (err) {
+            obsReqHandler.endWithError(err);
+            throw err;
+        }
     }
 }
 exports.SearchIndexManager = SearchIndexManager;

package/dist/searchtypes.d.ts

@@ -3,6 +3,7 @@ import { SearchFacet } from './searchfacet';
 import { SearchQuery } from './searchquery';
 import { SearchSort } from './searchsort';
 import { VectorSearch } from './vectorsearch';
+import { RequestSpan } from './tracing';
 /**
  * SearchMetaData represents the meta-data available from a search query.
  * This class is currently incomplete and must be casted to `any` in
@@ -160,6 +161,10 @@ export interface SearchQueryOptions {
      * Specifies that the search response should appear in the log.
      */
     logResponse?: boolean;
+    /**
+     * Specifies the parent span for this specific operation.
+     */
+    parentSpan?: RequestSpan;
 }
 /**
  *  Represents a search query and/or vector search to execute via the Couchbase Full Text Search (FTS) service.