mongodb 6.7.0-dev.20240613.sha.c1af6adc → 6.7.0-dev.20240614.sha.3ed6a2ad

package/src/error.ts

@@ -750,8 +750,8 @@ export class MongoUnexpectedServerResponseError extends MongoRuntimeError {
    *
    * @public
    **/
-  constructor(message: string) {
-    super(message);
+  constructor(message: string, options?: { cause?: Error }) {
+    super(message, options);
   }
 
   override get name(): string {
@@ -1157,27 +1157,14 @@ export class MongoServerSelectionError extends MongoSystemError {
   }
 }
 
-function makeWriteConcernResultObject(input: any) {
-  const output = Object.assign({}, input);
-
-  if (output.ok === 0) {
-    output.ok = 1;
-    delete output.errmsg;
-    delete output.code;
-    delete output.codeName;
-  }
-
-  return output;
-}
-
 /**
  * An error thrown when the server reports a writeConcernError
  * @public
  * @category Error
  */
 export class MongoWriteConcernError extends MongoServerError {
-  /** The result document (provided if ok: 1) */
-  result?: Document;
+  /** The result document */
+  result: Document;
 
   /**
    * **Do not use this constructor!**
@@ -1190,17 +1177,18 @@ export class MongoWriteConcernError extends MongoServerError {
    *
    * @public
    **/
-  constructor(message: ErrorDescription, result?: Document) {
-    if (result && Array.isArray(result.errorLabels)) {
-      message.errorLabels = result.errorLabels;
-    }
-
-    super(message);
-    this.errInfo = message.errInfo;
-
-    if (result != null) {
-      this.result = makeWriteConcernResultObject(result);
-    }
+  constructor(result: {
+    writeConcernError: {
+      code: number;
+      errmsg: string;
+      codeName?: string;
+      errInfo?: Document;
+    };
+    errorLabels?: string[];
+  }) {
+    super({ ...result, ...result.writeConcernError });
+    this.errInfo = result.writeConcernError.errInfo;
+    this.result = result;
   }
 
   override get name(): string {

package/src/index.ts

@@ -160,7 +160,7 @@ export { SrvPollingEvent } from './sdam/srv_polling';
 
 // type only exports below, these are removed from emitted JS
 export type { AdminPrivate } from './admin';
-export type { BSONSerializeOptions, Document } from './bson';
+export type { BSONElement, BSONSerializeOptions, Document } from './bson';
 export type { deserialize, serialize } from './bson';
 export type {
   BulkResult,
@@ -342,12 +342,12 @@ export type {
   CursorFlag,
   CursorStreamOptions
 } from './cursor/abstract_cursor';
-export type { InternalAbstractCursorOptions } from './cursor/abstract_cursor';
-export type { AggregationCursorOptions } from './cursor/aggregation_cursor';
 export type {
-  ChangeStreamAggregateRawResult,
-  ChangeStreamCursorOptions
-} from './cursor/change_stream_cursor';
+  InitialCursorResponse,
+  InternalAbstractCursorOptions
+} from './cursor/abstract_cursor';
+export type { AggregationCursorOptions } from './cursor/aggregation_cursor';
+export type { ChangeStreamCursorOptions } from './cursor/change_stream_cursor';
 export type {
   ListSearchIndexesCursor,
   ListSearchIndexesOptions
@@ -473,7 +473,6 @@ export type { DeleteOptions, DeleteResult, DeleteStatement } from './operations/
 export type { DistinctOptions } from './operations/distinct';
 export type { DropCollectionOptions, DropDatabaseOptions } from './operations/drop';
 export type { EstimatedDocumentCountOptions } from './operations/estimated_document_count';
-export type { ExecutionResult } from './operations/execute_operation';
 export type { FindOptions } from './operations/find';
 export type {
   FindOneAndDeleteOptions,

package/src/operations/aggregate.ts

@@ -1,6 +1,6 @@
 import type { Document } from '../bson';
+import { CursorResponse, ExplainedCursorResponse } from '../cmap/wire_protocol/responses';
 import { MongoInvalidArgumentError } from '../error';
-import { type TODO_NODE_3286 } from '../mongo_types';
 import type { Server } from '../sdam/server';
 import type { ClientSession } from '../sessions';
 import { maxWireVersion, type MongoDBNamespace } from '../utils';
@@ -37,7 +37,7 @@ export interface AggregateOptions extends CommandOperationOptions {
 }
 
 /** @internal */
-export class AggregateOperation<T = Document> extends CommandOperation<T> {
+export class AggregateOperation extends CommandOperation<CursorResponse> {
   override options: AggregateOptions;
   target: string | typeof DB_AGGREGATE_COLLECTION;
   pipeline: Document[];
@@ -94,7 +94,10 @@ export class AggregateOperation<T = Document> extends CommandOperation<T> {
     this.pipeline.push(stage);
   }
 
-  override async execute(server: Server, session: ClientSession | undefined): Promise<T> {
+  override async execute(
+    server: Server,
+    session: ClientSession | undefined
+  ): Promise<CursorResponse> {
     const options: AggregateOptions = this.options;
     const serverWireVersion = maxWireVersion(server);
     const command: Document = { aggregate: this.target, pipeline: this.pipeline };
@@ -134,8 +137,12 @@ export class AggregateOperation<T = Document> extends CommandOperation<T> {
       command.cursor.batchSize = options.batchSize;
     }
 
-    const res: TODO_NODE_3286 = await super.executeCommand(server, session, command);
-    return res;
+    return await super.executeCommand(
+      server,
+      session,
+      command,
+      this.explain ? ExplainedCursorResponse : CursorResponse
+    );
   }
 }
 

package/src/operations/bulk_write.ts

@@ -50,8 +50,7 @@ export class BulkWriteOperation extends AbstractOperation<BulkWriteResult> {
     }
 
     // Execute the bulk
-    const result = await bulk.execute({ ...options, session });
-    return result;
+    return await bulk.execute({ ...options, session });
   }
 }
 

package/src/operations/command.ts

@@ -1,4 +1,5 @@
 import type { BSONSerializeOptions, Document } from '../bson';
+import { type MongoDBResponseConstructor } from '../cmap/wire_protocol/responses';
 import { MongoInvalidArgumentError } from '../error';
 import { Explain, type ExplainOptions } from '../explain';
 import { ReadConcern } from '../read_concern';
@@ -106,12 +107,25 @@ export abstract class CommandOperation<T> extends AbstractOperation<T> {
     return true;
   }
 
-  async executeCommand(
+  public async executeCommand<T extends MongoDBResponseConstructor>(
+    server: Server,
+    session: ClientSession | undefined,
+    cmd: Document,
+    responseType: T | undefined
+  ): Promise<typeof responseType extends undefined ? Document : InstanceType<T>>;
+
+  public async executeCommand(
     server: Server,
     session: ClientSession | undefined,
     cmd: Document
+  ): Promise<Document>;
+
+  async executeCommand(
+    server: Server,
+    session: ClientSession | undefined,
+    cmd: Document,
+    responseType?: MongoDBResponseConstructor
   ): Promise<Document> {
-    // TODO: consider making this a non-enumerable property
     this.server = server;
 
     const options = {
@@ -152,6 +166,6 @@ export abstract class CommandOperation<T> extends AbstractOperation<T> {
       cmd = decorateWithExplain(cmd, this.explain);
     }
 
-    return await server.command(this.ns, cmd, options);
+    return await server.command(this.ns, cmd, options, responseType);
   }
 }

package/src/operations/count_documents.ts

@@ -1,5 +1,6 @@
 import type { Document } from '../bson';
 import type { Collection } from '../collection';
+import { type TODO_NODE_3286 } from '../mongo_types';
 import type { Server } from '../sdam/server';
 import type { ClientSession } from '../sessions';
 import { AggregateOperation, type AggregateOptions } from './aggregate';
@@ -13,7 +14,7 @@ export interface CountDocumentsOptions extends AggregateOptions {
 }
 
 /** @internal */
-export class CountDocumentsOperation extends AggregateOperation<number> {
+export class CountDocumentsOperation extends AggregateOperation {
   constructor(collection: Collection, query: Document, options: CountDocumentsOptions) {
     const pipeline = [];
     pipeline.push({ $match: query });
@@ -31,16 +32,11 @@ export class CountDocumentsOperation extends AggregateOperation<number> {
     super(collection.s.namespace, pipeline, options);
   }
 
-  override async execute(server: Server, session: ClientSession | undefined): Promise<number> {
+  override async execute(
+    server: Server,
+    session: ClientSession | undefined
+  ): Promise<TODO_NODE_3286> {
     const result = await super.execute(server, session);
-
-    // NOTE: We're avoiding creating a cursor here to reduce the callstack.
-    const response = result as unknown as Document;
-    if (response.cursor == null || response.cursor.firstBatch == null) {
-      return 0;
-    }
-
-    const docs = response.cursor.firstBatch;
-    return docs.length ? docs[0].n : 0;
+    return result.shift()?.n ?? 0;
   }
 }

package/src/operations/delete.ts

@@ -4,8 +4,8 @@ import { MongoCompatibilityError, MongoServerError } from '../error';
 import { type TODO_NODE_3286 } from '../mongo_types';
 import type { Server } from '../sdam/server';
 import type { ClientSession } from '../sessions';
-import type { MongoDBNamespace } from '../utils';
-import type { WriteConcernOptions } from '../write_concern';
+import { type MongoDBNamespace } from '../utils';
+import { type WriteConcernOptions } from '../write_concern';
 import { type CollationOptions, CommandOperation, type CommandOperationOptions } from './command';
 import { Aspect, defineAspects, type Hint } from './operation';
 

package/src/operations/execute_operation.ts

@@ -1,5 +1,3 @@
-import type { Document } from '../bson';
-import { type CursorResponse } from '../cmap/wire_protocol/responses';
 import {
   isRetryableReadError,
   isRetryableWriteError,
@@ -18,7 +16,6 @@ import {
 } from '../error';
 import type { MongoClient } from '../mongo_client';
 import { ReadPreference } from '../read_preference';
-import type { Server } from '../sdam/server';
 import type { ServerDescription } from '../sdam/server_description';
 import {
   sameServerSelector,
@@ -38,16 +35,6 @@ type ResultTypeFromOperation<TOperation> = TOperation extends AbstractOperation<
   ? K
   : never;
 
-/** @internal */
-export interface ExecutionResult {
-  /** The server selected for the operation */
-  server: Server;
-  /** The session used for this operation, may be implicitly created */
-  session?: ClientSession;
-  /** The raw server response for the operation */
-  response: Document | CursorResponse;
-}
-
 /**
  * Executes the given operation with provided arguments.
  * @internal

package/src/operations/find.ts

@@ -1,4 +1,5 @@
 import type { Document } from '../bson';
+import { CursorResponse, ExplainedCursorResponse } from '../cmap/wire_protocol/responses';
 import { MongoInvalidArgumentError } from '../error';
 import { ReadConcern } from '../read_concern';
 import type { Server } from '../sdam/server';
@@ -65,7 +66,7 @@ export interface FindOptions<TSchema extends Document = Document>
 }
 
 /** @internal */
-export class FindOperation extends CommandOperation<Document> {
+export class FindOperation extends CommandOperation<CursorResponse> {
   /**
    * @remarks WriteConcern can still be present on the options because
    * we inherit options from the client/db/collection.  The
@@ -95,7 +96,10 @@ export class FindOperation extends CommandOperation<Document> {
     return 'find' as const;
   }
 
-  override async execute(server: Server, session: ClientSession | undefined): Promise<Document> {
+  override async execute(
+    server: Server,
+    session: ClientSession | undefined
+  ): Promise<CursorResponse> {
     this.server = server;
 
     const options = this.options;
@@ -114,7 +118,7 @@ export class FindOperation extends CommandOperation<Document> {
         documentsReturnedIn: 'firstBatch',
         session
       },
-      undefined
+      this.explain ? ExplainedCursorResponse : CursorResponse
     );
   }
 }

package/src/operations/find_and_modify.ts

@@ -6,7 +6,7 @@ import type { Server } from '../sdam/server';
 import type { ClientSession } from '../sessions';
 import { formatSort, type Sort, type SortForCmd } from '../sort';
 import { decorateWithCollation, hasAtomicOperators, maxWireVersion } from '../utils';
-import type { WriteConcern, WriteConcernSettings } from '../write_concern';
+import { type WriteConcern, type WriteConcernSettings } from '../write_concern';
 import { CommandOperation, type CommandOperationOptions } from './command';
 import { Aspect, defineAspects } from './operation';
 

package/src/operations/get_more.ts

@@ -1,4 +1,4 @@
-import type { Document, Long } from '../bson';
+import type { Long } from '../bson';
 import { CursorResponse } from '../cmap/wire_protocol/responses';
 import { MongoRuntimeError } from '../error';
 import type { Server } from '../sdam/server';
@@ -20,8 +20,6 @@ export interface GetMoreOptions extends OperationOptions {
   maxTimeMS?: number;
   /** TODO(NODE-4413): Address bug with maxAwaitTimeMS not being passed in from the cursor correctly */
   maxAwaitTimeMS?: number;
-
-  useCursorResponse: boolean;
 }
 
 /**
@@ -58,7 +56,10 @@ export class GetMoreOperation extends AbstractOperation {
    * Although there is a server already associated with the get more operation, the signature
    * for execute passes a server so we will just use that one.
    */
-  override async execute(server: Server, _session: ClientSession | undefined): Promise<Document> {
+  override async execute(
+    server: Server,
+    _session: ClientSession | undefined
+  ): Promise<CursorResponse> {
     if (server !== this.server) {
       throw new MongoRuntimeError('Getmore must run on the same server operation began on');
     }
@@ -99,12 +100,7 @@ export class GetMoreOperation extends AbstractOperation {
       ...this.options
     };
 
-    return await server.command(
-      this.ns,
-      getMoreCmd,
-      commandOptions,
-      this.options.useCursorResponse ? CursorResponse : undefined
-    );
+    return await server.command(this.ns, getMoreCmd, commandOptions, CursorResponse);
   }
 }
 

package/src/operations/indexes.ts

@@ -1,4 +1,5 @@
 import type { Document } from '../bson';
+import { CursorResponse } from '../cmap/wire_protocol/responses';
 import type { Collection } from '../collection';
 import { type AbstractCursorOptions } from '../cursor/abstract_cursor';
 import { MongoCompatibilityError } from '../error';
@@ -353,7 +354,7 @@ export class DropIndexOperation extends CommandOperation<Document> {
 export type ListIndexesOptions = AbstractCursorOptions;
 
 /** @internal */
-export class ListIndexesOperation extends CommandOperation<Document> {
+export class ListIndexesOperation extends CommandOperation<CursorResponse> {
   /**
    * @remarks WriteConcern can still be present on the options because
    * we inherit options from the client/db/collection.  The
@@ -376,7 +377,10 @@ export class ListIndexesOperation extends CommandOperation<Document> {
     return 'listIndexes' as const;
   }
 
-  override async execute(server: Server, session: ClientSession | undefined): Promise<Document> {
+  override async execute(
+    server: Server,
+    session: ClientSession | undefined
+  ): Promise<CursorResponse> {
     const serverWireVersion = maxWireVersion(server);
 
     const cursor = this.options.batchSize ? { batchSize: this.options.batchSize } : {};
@@ -389,7 +393,7 @@ export class ListIndexesOperation extends CommandOperation<Document> {
       command.comment = this.options.comment;
     }
 
-    return await super.executeCommand(server, session, command);
+    return await super.executeCommand(server, session, command, CursorResponse);
   }
 }
 

package/src/operations/list_collections.ts

@@ -1,4 +1,5 @@
 import type { Binary, Document } from '../bson';
+import { CursorResponse } from '../cmap/wire_protocol/responses';
 import type { Db } from '../db';
 import type { Server } from '../sdam/server';
 import type { ClientSession } from '../sessions';
@@ -17,7 +18,7 @@ export interface ListCollectionsOptions extends Omit<CommandOperationOptions, 'w
 }
 
 /** @internal */
-export class ListCollectionsOperation extends CommandOperation<Document> {
+export class ListCollectionsOperation extends CommandOperation<CursorResponse> {
   /**
    * @remarks WriteConcern can still be present on the options because
    * we inherit options from the client/db/collection.  The
@@ -51,11 +52,15 @@ export class ListCollectionsOperation extends CommandOperation<Document> {
     return 'listCollections' as const;
   }
 
-  override async execute(server: Server, session: ClientSession | undefined): Promise<Document> {
+  override async execute(
+    server: Server,
+    session: ClientSession | undefined
+  ): Promise<CursorResponse> {
     return await super.executeCommand(
       server,
       session,
-      this.generateCommand(maxWireVersion(server))
+      this.generateCommand(maxWireVersion(server)),
+      CursorResponse
     );
   }
 

package/src/operations/run_command.ts

@@ -1,4 +1,5 @@
 import type { BSONSerializeOptions, Document } from '../bson';
+import { type MongoDBResponseConstructor } from '../cmap/wire_protocol/responses';
 import { type Db } from '../db';
 import { type TODO_NODE_3286 } from '../mongo_types';
 import type { ReadPreferenceLike } from '../read_preference';
@@ -17,7 +18,11 @@ export type RunCommandOptions = {
 
 /** @internal */
 export class RunCommandOperation<T = Document> extends AbstractOperation<T> {
-  constructor(parent: Db, public command: Document, public override options: RunCommandOptions) {
+  constructor(
+    parent: Db,
+    public command: Document,
+    public override options: RunCommandOptions & { responseType?: MongoDBResponseConstructor }
+  ) {
     super(options);
     this.ns = parent.s.namespace.withCollection('$cmd');
   }
@@ -28,11 +33,16 @@ export class RunCommandOperation<T = Document> extends AbstractOperation<T> {
 
   override async execute(server: Server, session: ClientSession | undefined): Promise<T> {
     this.server = server;
-    const res: TODO_NODE_3286 = await server.command(this.ns, this.command, {
-      ...this.options,
-      readPreference: this.readPreference,
-      session
-    });
+    const res: TODO_NODE_3286 = await server.command(
+      this.ns,
+      this.command,
+      {
+        ...this.options,
+        readPreference: this.readPreference,
+        session
+      },
+      this.options.responseType
+    );
     return res;
   }
 }

package/src/operations/update.ts

@@ -122,7 +122,8 @@ export class UpdateOperation extends CommandOperation<Document> {
       }
     }
 
-    return await super.executeCommand(server, session, command);
+    const res = await super.executeCommand(server, session, command);
+    return res;
   }
 }
 

package/src/sdam/server.ts

@@ -48,6 +48,7 @@ import {
   type MongoDBNamespace,
   supportsRetryableWrites
 } from '../utils';
+import { throwIfWriteConcernError } from '../write_concern';
 import {
   type ClusterTime,
   STATE_CLOSED,
@@ -323,7 +324,9 @@ export class Server extends TypedEventEmitter<ServerEvents> {
 
     try {
       try {
-        return await conn.command(ns, cmd, finalOptions, responseType);
+        const res = await conn.command(ns, cmd, finalOptions, responseType);
+        throwIfWriteConcernError(res);
+        return res;
       } catch (commandError) {
         throw this.decorateCommandError(conn, cmd, finalOptions, commandError);
       }
@@ -334,7 +337,9 @@ export class Server extends TypedEventEmitter<ServerEvents> {
       ) {
         await this.pool.reauthenticate(conn);
         try {
-          return await conn.command(ns, cmd, finalOptions, responseType);
+          const res = await conn.command(ns, cmd, finalOptions, responseType);
+          throwIfWriteConcernError(res);
+          return res;
         } catch (commandError) {
           throw this.decorateCommandError(conn, cmd, finalOptions, commandError);
         }

package/src/utils.ts

@@ -8,11 +8,11 @@ import * as url from 'url';
 import { URL } from 'url';
 import { promisify } from 'util';
 
-import { type Document, ObjectId, resolveBSONOptions } from './bson';
+import { deserialize, type Document, ObjectId, resolveBSONOptions } from './bson';
 import type { Connection } from './cmap/connection';
 import { MAX_SUPPORTED_WIRE_VERSION } from './cmap/wire_protocol/constants';
 import type { Collection } from './collection';
-import { LEGACY_HELLO_COMMAND } from './constants';
+import { kDecoratedKeys, LEGACY_HELLO_COMMAND } from './constants';
 import type { AbstractCursor } from './cursor/abstract_cursor';
 import type { FindCursor } from './cursor/find_cursor';
 import type { Db } from './db';
@@ -1366,3 +1366,53 @@ export async function fileIsAccessible(fileName: string, mode?: number) {
 export function noop() {
   return;
 }
+
+/**
+ * Recurse through the (identically-shaped) `decrypted` and `original`
+ * objects and attach a `decryptedKeys` property on each sub-object that
+ * contained encrypted fields. Because we only call this on BSON responses,
+ * we do not need to worry about circular references.
+ *
+ * @internal
+ */
+export function decorateDecryptionResult(
+  decrypted: Document & { [kDecoratedKeys]?: Array<string> },
+  original: Document,
+  isTopLevelDecorateCall = true
+): void {
+  if (isTopLevelDecorateCall) {
+    // The original value could have been either a JS object or a BSON buffer
+    if (Buffer.isBuffer(original)) {
+      original = deserialize(original);
+    }
+    if (Buffer.isBuffer(decrypted)) {
+      throw new MongoRuntimeError('Expected result of decryption to be deserialized BSON object');
+    }
+  }
+
+  if (!decrypted || typeof decrypted !== 'object') return;
+  for (const k of Object.keys(decrypted)) {
+    const originalValue = original[k];
+
+    // An object was decrypted by libmongocrypt if and only if it was
+    // a BSON Binary object with subtype 6.
+    if (originalValue && originalValue._bsontype === 'Binary' && originalValue.sub_type === 6) {
+      if (!decrypted[kDecoratedKeys]) {
+        Object.defineProperty(decrypted, kDecoratedKeys, {
+          value: [],
+          configurable: true,
+          enumerable: false,
+          writable: false
+        });
+      }
+      // this is defined in the preceding if-statement
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      decrypted[kDecoratedKeys]!.push(k);
+      // Do not recurse into this decrypted value. It could be a sub-document/array,
+      // in which case there is no original value associated with its subfields.
+      continue;
+    }
+
+    decorateDecryptionResult(decrypted[k], originalValue, false);
+  }
+}

package/src/write_concern.ts

@@ -1,4 +1,6 @@
 import { type Document } from './bson';
+import { MongoDBResponse } from './cmap/wire_protocol/responses';
+import { MongoWriteConcernError } from './error';
 
 /** @public */
 export type W = number | 'majority';
@@ -159,3 +161,19 @@ export class WriteConcern {
     return undefined;
   }
 }
+
+/** Called with either a plain object or MongoDBResponse */
+export function throwIfWriteConcernError(response: unknown): void {
+  if (typeof response === 'object' && response != null) {
+    const writeConcernError: object | null =
+      MongoDBResponse.is(response) && response.has('writeConcernError')
+        ? response.toObject()
+        : !MongoDBResponse.is(response) && 'writeConcernError' in response
+        ? response
+        : null;
+
+    if (writeConcernError != null) {
+      throw new MongoWriteConcernError(writeConcernError as any);
+    }
+  }
+}