feat(NODE-6390): Add timeoutMS support to auto encryption

etc/notes/errors.md

@@ -67,7 +67,7 @@ Children of `MongoError` include:
 ### `MongoDriverError`
 
 This class represents errors which originate in the driver itself or when the user incorrectly uses the driver. This class should **never** be directly instantiated.
-Its children are the main classes of errors that most users will interact with: [**`MongoAPIError`**](#MongoAPIError) and [**`MongoRuntimeError`**](#MongoRuntimeError).
+Its children are the main classes of errors that most users will interact with: [**`MongoAPIError`**](#MongoAPIError), [**`MongoRuntimeError`**](#MongoRuntimeError) and [**`MongoOperationTimeoutError`**](#MongoOperationTimeoutError).
 
 ### `MongoAPIError`
 
@@ -109,6 +109,10 @@ This class should **never** be directly instantiated.
 | **MongoGridFSChunkError**   | Thrown when a malformed or invalid chunk is encountered when reading from a GridFS Stream. |
 | **MongoUnexpectedServerResponseError**   | Thrown when the driver receives a **parsable** response it did not expect from the server. |
 
+### `MongoOperationTimeoutError`
+
+- TODO(NODE-5688): Add MongoOperationTimeoutError documentation
+
 ### MongoUnexpectedServerResponseError
 
 Intended for the scenario where the MongoDB returns an unexpected response in relation to some state the driver is in.

package.json

@@ -97,7 +97,7 @@
     "mocha": "^10.4.0",
     "mocha-sinon": "^2.1.2",
     "mongodb-client-encryption": "^6.1.0",
-    "mongodb-legacy": "^6.1.0",
+    "mongodb-legacy": "^6.1.2",
     "nyc": "^15.1.0",
     "prettier": "^3.3.3",
     "semver": "^7.6.3",

src/admin.ts

@@ -78,7 +78,8 @@ export class Admin {
       new RunAdminCommandOperation(command, {
         ...resolveBSONOptions(options),
         session: options?.session,
-        readPreference: options?.readPreference
+        readPreference: options?.readPreference,
+        timeoutMS: options?.timeoutMS ?? this.s.db.timeoutMS
       })
     );
   }
@@ -154,7 +155,10 @@ export class Admin {
    * @param options - Optional settings for the command
    */
   async listDatabases(options?: ListDatabasesOptions): Promise<ListDatabasesResult> {
-    return await executeOperation(this.s.db.client, new ListDatabasesOperation(this.s.db, options));
+    return await executeOperation(
+      this.s.db.client,
+      new ListDatabasesOperation(this.s.db, { timeoutMS: this.s.db.timeoutMS, ...options })
+    );
   }
 
   /**

src/bulk/common.ts

@@ -19,6 +19,7 @@ import { makeUpdateStatement, UpdateOperation, type UpdateStatement } from '../o
 import type { Server } from '../sdam/server';
 import type { Topology } from '../sdam/topology';
 import type { ClientSession } from '../sessions';
+import { type TimeoutContext } from '../timeout';
 import {
   applyRetryableWrites,
   getTopology,
@@ -500,7 +501,7 @@ export function mergeBatchResults(
 
 async function executeCommands(
   bulkOperation: BulkOperationBase,
-  options: BulkWriteOptions
+  options: BulkWriteOptions & { timeoutContext?: TimeoutContext | null }
 ): Promise<BulkWriteResult> {
   if (bulkOperation.s.batches.length === 0) {
     return new BulkWriteResult(bulkOperation.s.bulkResult, bulkOperation.isOrdered);
@@ -551,7 +552,11 @@ async function executeCommands(
     let thrownError = null;
     let result;
     try {
-      result = await executeOperation(bulkOperation.s.collection.client, operation);
+      result = await executeOperation(
+        bulkOperation.s.collection.client,
+        operation,
+        finalOptions.timeoutContext
+      );
     } catch (error) {
       thrownError = error;
     }
@@ -842,6 +847,9 @@ export interface BulkWriteOptions extends CommandOperationOptions {
   forceServerObjectId?: boolean;
   /** Map of parameter names and values that can be accessed using $$var (requires MongoDB 5.0). */
   let?: Document;
+
+  /** @internal */
+  timeoutContext?: TimeoutContext;
 }
 
 /**
@@ -862,15 +870,19 @@ export class BulkWriteShimOperation extends AbstractOperation {
     return 'bulkWrite' as const;
   }
 
-  async execute(_server: Server, session: ClientSession | undefined): Promise<any> {
+  async execute(
+    _server: Server,
+    session: ClientSession | undefined,
+    timeoutContext: TimeoutContext
+  ): Promise<any> {
     if (this.options.session == null) {
       // An implicit session could have been created by 'executeOperation'
       // So if we stick it on finalOptions here, each bulk operation
       // will use this same session, it'll be passed in the same way
       // an explicit session would be
       this.options.session = session;
     }
-    return await executeCommands(this.bulkOperation, this.options);
+    return await executeCommands(this.bulkOperation, { ...this.options, timeoutContext });
   }
 }
 
@@ -1199,7 +1211,7 @@ export abstract class BulkOperationBase {
     const finalOptions = { ...this.s.options, ...options };
     const operation = new BulkWriteShimOperation(this, finalOptions);
 
-    return await executeOperation(this.s.collection.client, operation);
+    return await executeOperation(this.s.collection.client, operation, finalOptions.timeoutContext);
   }
 
   /**

src/client-side-encryption/auto_encrypter.ts

@@ -395,10 +395,17 @@ export class AutoEncrypter {
       socketOptions: autoSelectSocketOptions(this._client.options)
     });
 
-    return deserialize(await stateMachine.execute(this, context), {
-      promoteValues: false,
-      promoteLongs: false
-    });
+    return deserialize(
+      await stateMachine.execute(
+        this,
+        context,
+        options.timeoutContext?.csotEnabled() ? options.timeoutContext : undefined
+      ),
+      {
+        promoteValues: false,
+        promoteLongs: false
+      }
+    );
   }
 
   /**
@@ -416,7 +423,11 @@ export class AutoEncrypter {
       socketOptions: autoSelectSocketOptions(this._client.options)
     });
 
-    return await stateMachine.execute(this, context);
+    return await stateMachine.execute(
+      this,
+      context,
+      options.timeoutContext?.csotEnabled() ? options.timeoutContext : undefined
+    );
   }
 
   /**