couchbase 4.6.0 → 4.7.0-dev.1

package/dist/queryexecutor.js

@@ -2,8 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.QueryExecutor = void 0;
 const bindingutilities_1 = require("./bindingutilities");
+const observability_1 = require("./observability");
+const observabilityhandler_1 = require("./observabilityhandler");
+const observabilitytypes_1 = require("./observabilitytypes");
 const querytypes_1 = require("./querytypes");
 const streamablepromises_1 = require("./streamablepromises");
+const utilities_1 = require("./utilities");
 /**
  * @internal
  */
@@ -17,6 +21,72 @@ class QueryExecutor {
     /**
      * @internal
      */
+    get observabilityInstruments() {
+        return this._cluster.observabilityInstruments;
+    }
+    /**
+     * @internal
+     */
+    static _processQueryResponse(emitter, err, resp, obsReqHandler) {
+        if (err) {
+            obsReqHandler === null || obsReqHandler === void 0 ? void 0 : obsReqHandler.endWithError(err);
+            emitter.emit('error', err);
+            emitter.emit('end');
+            return;
+        }
+        resp.rows.forEach((row) => {
+            emitter.emit('row', JSON.parse(row));
+        });
+        {
+            const metaData = resp.meta;
+            let warnings;
+            if (metaData.warnings) {
+                warnings = metaData.warnings.map((warningData) => new querytypes_1.QueryWarning({
+                    code: warningData.code,
+                    message: warningData.message,
+                }));
+            }
+            else {
+                warnings = [];
+            }
+            let metrics;
+            if (metaData.metrics) {
+                const metricsData = metaData.metrics;
+                metrics = new querytypes_1.QueryMetrics({
+                    elapsedTime: metricsData.elapsed_time,
+                    executionTime: metricsData.execution_time,
+                    sortCount: metricsData.sort_count || 0,
+                    resultCount: metricsData.result_count || 0,
+                    resultSize: metricsData.result_size || 0,
+                    mutationCount: metricsData.mutation_count || 0,
+                    errorCount: metricsData.error_count || 0,
+                    warningCount: metricsData.warning_count || 0,
+                });
+            }
+            else {
+                metrics = undefined;
+            }
+            const meta = new querytypes_1.QueryMetaData({
+                requestId: metaData.request_id,
+                clientContextId: metaData.client_context_id,
+                status: metaData.status,
+                signature: metaData.signature
+                    ? JSON.parse(metaData.signature)
+                    : undefined,
+                warnings: warnings,
+                metrics: metrics,
+                profile: metaData.profile ? JSON.parse(metaData.profile) : undefined,
+            });
+            emitter.emit('meta', meta);
+        }
+        obsReqHandler === null || obsReqHandler === void 0 ? void 0 : obsReqHandler.end();
+        emitter.emit('end');
+    }
+    /**
+     * @internal
+     *
+     * Used by transactions (observability currently not available for transactions)
+     */
     static execute(exec) {
         const emitter = new streamablepromises_1.StreamableRowPromise((rows, meta) => {
             return new querytypes_1.QueryResult({
@@ -25,59 +95,27 @@ class QueryExecutor {
             });
         });
         exec((cppErr, resp) => {
-            const err = (0, bindingutilities_1.errorFromCpp)(cppErr);
-            if (err) {
-                emitter.emit('error', err);
-                emitter.emit('end');
-                return;
+            let err = null;
+            if (cppErr) {
+                err = (0, bindingutilities_1.errorFromCpp)(cppErr);
             }
-            resp.rows.forEach((row) => {
-                emitter.emit('row', JSON.parse(row));
+            QueryExecutor._processQueryResponse(emitter, err, resp);
+        });
+        return emitter;
+    }
+    /**
+     * @internal
+     */
+    static executePromise(queryPromise, obsReqHandler) {
+        const emitter = new streamablepromises_1.StreamableRowPromise((rows, meta) => {
+            return new querytypes_1.QueryResult({
+                rows: rows,
+                meta: meta,
             });
-            {
-                const metaData = resp.meta;
-                let warnings;
-                if (metaData.warnings) {
-                    warnings = metaData.warnings.map((warningData) => new querytypes_1.QueryWarning({
-                        code: warningData.code,
-                        message: warningData.message,
-                    }));
-                }
-                else {
-                    warnings = [];
-                }
-                let metrics;
-                if (metaData.metrics) {
-                    const metricsData = metaData.metrics;
-                    metrics = new querytypes_1.QueryMetrics({
-                        elapsedTime: metricsData.elapsed_time,
-                        executionTime: metricsData.execution_time,
-                        sortCount: metricsData.sort_count || 0,
-                        resultCount: metricsData.result_count || 0,
-                        resultSize: metricsData.result_size || 0,
-                        mutationCount: metricsData.mutation_count || 0,
-                        errorCount: metricsData.error_count || 0,
-                        warningCount: metricsData.warning_count || 0,
-                    });
-                }
-                else {
-                    metrics = undefined;
-                }
-                const meta = new querytypes_1.QueryMetaData({
-                    requestId: metaData.request_id,
-                    clientContextId: metaData.client_context_id,
-                    status: metaData.status,
-                    signature: metaData.signature
-                        ? JSON.parse(metaData.signature)
-                        : undefined,
-                    warnings: warnings,
-                    metrics: metrics,
-                    profile: metaData.profile ? JSON.parse(metaData.profile) : undefined,
-                });
-                emitter.emit('meta', meta);
-            }
-            emitter.emit('end');
-            return;
+        });
+        utilities_1.PromiseHelper.wrapAsync(async () => {
+            const [err, resp] = await queryPromise;
+            QueryExecutor._processQueryResponse(emitter, err, resp, obsReqHandler);
         });
         return emitter;
     }
@@ -86,42 +124,46 @@ class QueryExecutor {
      */
     query(query, options) {
         const timeout = options.timeout || this._cluster.queryTimeout;
-        return QueryExecutor.execute((callback) => {
-            this._cluster.conn.query({
-                statement: query,
-                client_context_id: options.clientContextId,
-                adhoc: options.adhoc === false ? false : true,
-                metrics: options.metrics || false,
-                readonly: options.readOnly || false,
-                flex_index: options.flexIndex || false,
-                preserve_expiry: options.preserveExpiry || false,
-                use_replica: options.useReplica,
-                max_parallelism: options.maxParallelism,
-                scan_cap: options.scanCap,
-                scan_wait: options.scanWait,
-                pipeline_batch: options.pipelineBatch,
-                pipeline_cap: options.pipelineCap,
-                scan_consistency: (0, bindingutilities_1.queryScanConsistencyToCpp)(options.scanConsistency),
-                mutation_state: (0, bindingutilities_1.mutationStateToCpp)(options.consistentWith).tokens,
-                timeout: timeout,
-                query_context: options.queryContext,
-                profile: (0, bindingutilities_1.queryProfileToCpp)(options.profile),
-                raw: options.raw
-                    ? Object.fromEntries(Object.entries(options.raw)
-                        .filter(([, v]) => v !== undefined)
-                        .map(([k, v]) => [k, JSON.stringify(v)]))
-                    : {},
-                positional_parameters: options.parameters && Array.isArray(options.parameters)
-                    ? options.parameters.map((v) => JSON.stringify(v !== null && v !== void 0 ? v : null))
-                    : [],
-                named_parameters: options.parameters && !Array.isArray(options.parameters)
-                    ? Object.fromEntries(Object.entries(options.parameters)
-                        .filter(([, v]) => v !== undefined)
-                        .map(([k, v]) => [k, JSON.stringify(v)]))
-                    : {},
-                body_str: '',
-            }, callback);
+        const obsReqHandler = new observabilityhandler_1.ObservableRequestHandler(observabilitytypes_1.StreamingOp.Query, this.observabilityInstruments, options === null || options === void 0 ? void 0 : options.parentSpan);
+        obsReqHandler.setRequestHttpAttributes({
+            statement: query,
+            queryContext: options.queryContext,
+            queryOptions: options,
         });
+        return QueryExecutor.executePromise((0, observability_1.wrapObservableBindingCall)(this._cluster.conn.query.bind(this._cluster.conn), {
+            statement: query,
+            client_context_id: options.clientContextId,
+            adhoc: options.adhoc === false ? false : true,
+            metrics: options.metrics || false,
+            readonly: options.readOnly || false,
+            flex_index: options.flexIndex || false,
+            preserve_expiry: options.preserveExpiry || false,
+            use_replica: options.useReplica,
+            max_parallelism: options.maxParallelism,
+            scan_cap: options.scanCap,
+            scan_wait: options.scanWait,
+            pipeline_batch: options.pipelineBatch,
+            pipeline_cap: options.pipelineCap,
+            scan_consistency: (0, bindingutilities_1.queryScanConsistencyToCpp)(options.scanConsistency),
+            mutation_state: (0, bindingutilities_1.mutationStateToCpp)(options.consistentWith).tokens,
+            timeout: timeout,
+            query_context: options.queryContext,
+            profile: (0, bindingutilities_1.queryProfileToCpp)(options.profile),
+            raw: options.raw
+                ? Object.fromEntries(Object.entries(options.raw)
+                    .filter(([, v]) => v !== undefined)
+                    .map(([k, v]) => [k, JSON.stringify(v)]))
+                : {},
+            positional_parameters: options.parameters && Array.isArray(options.parameters)
+                ? options.parameters.map((v) => JSON.stringify(v !== null && v !== void 0 ? v : null))
+                : [],
+            named_parameters: options.parameters && !Array.isArray(options.parameters)
+                ? Object.fromEntries(Object.entries(options.parameters)
+                    .filter(([, v]) => v !== undefined)
+                    .map(([k, v]) => [k, JSON.stringify(v)]))
+                : {},
+            body_str: '',
+        }, obsReqHandler), obsReqHandler);
     }
 }
 exports.QueryExecutor = QueryExecutor;

package/dist/queryindexmanager.d.ts

@@ -1,5 +1,6 @@
 import { Cluster } from './cluster';
 import { Collection } from './collection';
+import { RequestSpan } from './tracing';
 import { NodeCallback } from './utilities';
 /**
  * Contains a specific index configuration for the query service.
@@ -86,6 +87,10 @@ export interface CreateQueryIndexOptions {
      * The timeout for this operation, represented in milliseconds.
      */
     timeout?: number;
+    /**
+     * Specifies the parent span for this specific operation.
+     */
+    parentSpan?: RequestSpan;
 }
 /**
  * @category Management
@@ -125,6 +130,10 @@ export interface CreatePrimaryQueryIndexOptions {
      * The timeout for this operation, represented in milliseconds.
      */
     timeout?: number;
+    /**
+     * Specifies the parent span for this specific operation.
+     */
+    parentSpan?: RequestSpan;
 }
 /**
  * @category Management
@@ -151,6 +160,10 @@ export interface DropQueryIndexOptions {
      * The timeout for this operation, represented in milliseconds.
      */
     timeout?: number;
+    /**
+     * Specifies the parent span for this specific operation.
+     */
+    parentSpan?: RequestSpan;
 }
 /**
  * @category Management
@@ -181,6 +194,10 @@ export interface DropPrimaryQueryIndexOptions {
      * The timeout for this operation, represented in milliseconds.
      */
     timeout?: number;
+    /**
+     * Specifies the parent span for this specific operation.
+     */
+    parentSpan?: RequestSpan;
 }
 /**
  * @category Management
@@ -202,6 +219,10 @@ export interface GetAllQueryIndexesOptions {
      * The timeout for this operation, represented in milliseconds.
      */
     timeout?: number;
+    /**
+     * Specifies the parent span for this specific operation.
+     */
+    parentSpan?: RequestSpan;
 }
 /**
  * @category Management
@@ -223,6 +244,10 @@ export interface BuildQueryIndexOptions {
      * The timeout for this operation, represented in milliseconds.
      */
     timeout?: number;
+    /**
+     * Specifies the parent span for this specific operation.
+     */
+    parentSpan?: RequestSpan;
 }
 /**
  * @category Management
@@ -244,6 +269,10 @@ export interface WatchQueryIndexOptions {
      * Specifies whether the primary indexes should be watched as well.
      */
     watchPrimary?: boolean;
+    /**
+     * Specifies the parent span for this specific operation.
+     */
+    parentSpan?: RequestSpan;
 }
 /**
  * CollectionQueryIndexManager provides an interface for managing the