mongodb 6.7.0-dev.20240608.sha.0655c730 → 6.7.0-dev.20240614.sha.3ed6a2ad

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);
+    }
+  }
+}