mongodb 6.20.0-dev.20251008.sha.cfbada66 → 6.20.0-dev.20251010.sha.c5f74abe

package/src/mongo_client.ts

@@ -16,7 +16,6 @@ import { AuthMechanism } from './cmap/auth/providers';
 import type { LEGAL_TCP_SOCKET_OPTIONS, LEGAL_TLS_SOCKET_OPTIONS } from './cmap/connect';
 import type { Connection } from './cmap/connection';
 import {
-  addContainerMetadata,
   type ClientMetadata,
   isDriverInfoEqual,
   makeClientMetadata
@@ -48,7 +47,6 @@ import { executeOperation } from './operations/execute_operation';
 import { AbstractOperation } from './operations/operation';
 import type { ReadConcern, ReadConcernLevel, ReadConcernLike } from './read_concern';
 import { ReadPreference, type ReadPreferenceMode } from './read_preference';
-import { type AsyncDisposable, configureResourceManagement } from './resource_management';
 import type { ServerMonitoringMode } from './sdam/monitor';
 import type { TagSet } from './sdam/server_description';
 import { readPreferenceServerSelector } from './sdam/server_selection';
@@ -408,31 +406,12 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements
    * The consolidate, parsed, transformed and merged options.
    */
   public readonly options: Readonly<
-    Omit<
-      MongoOptions,
-      | 'monitorCommands'
-      | 'ca'
-      | 'crl'
-      | 'key'
-      | 'cert'
-      | 'driverInfo'
-      | 'additionalDriverInfo'
-      | 'metadata'
-      | 'extendedMetadata'
-    >
+    Omit<MongoOptions, 'monitorCommands' | 'ca' | 'crl' | 'key' | 'cert' | 'driverInfo'>
   > &
-    Pick<
-      MongoOptions,
-      | 'monitorCommands'
-      | 'ca'
-      | 'crl'
-      | 'key'
-      | 'cert'
-      | 'driverInfo'
-      | 'additionalDriverInfo'
-      | 'metadata'
-      | 'extendedMetadata'
-    >;
+    Pick<MongoOptions, 'monitorCommands' | 'ca' | 'crl' | 'key' | 'cert' | 'driverInfo'> & {
+      /** @internal */
+      metadata: Promise<ClientMetadata>;
+    };
 
   private driverInfoList: DriverInfo[] = [];
 
@@ -485,13 +464,10 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements
   }
 
   /**
-   * @beta
    * @experimental
    * An alias for {@link MongoClient.close|MongoClient.close()}.
    */
-  declare [Symbol.asyncDispose]: () => Promise<void>;
-  /** @internal */
-  async asyncDispose() {
+  async [Symbol.asyncDispose]() {
     await this.close();
   }
 
@@ -506,10 +482,9 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements
     if (isDuplicateDriverInfo) return;
 
     this.driverInfoList.push(driverInfo);
-    this.options.metadata = makeClientMetadata(this.driverInfoList, this.options);
-    this.options.extendedMetadata = addContainerMetadata(this.options.metadata)
+    this.options.metadata = makeClientMetadata(this.driverInfoList, this.options)
       .then(undefined, squashError)
-      .then(result => result ?? {}); // ensure Promise<Document>
+      .then(result => result ?? ({} as ClientMetadata)); // ensure Promise<Document>
   }
 
   /** @internal */
@@ -594,20 +569,13 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements
   }
 
   /**
-   * Connect to MongoDB using a url
+   * An optional method to verify a handful of assumptions that are generally useful at application boot-time before using a MongoClient.
+   * For detailed information about the connect process see the MongoClient.connect static method documentation.
    *
-   * @remarks
-   * Calling `connect` is optional since the first operation you perform will call `connect` if it's needed.
-   * `timeoutMS` will bound the time any operation can take before throwing a timeout error.
-   * However, when the operation being run is automatically connecting your `MongoClient` the `timeoutMS` will not apply to the time taken to connect the MongoClient.
-   * This means the time to setup the `MongoClient` does not count against `timeoutMS`.
-   * If you are using `timeoutMS` we recommend connecting your client explicitly in advance of any operation to avoid this inconsistent execution time.
-   *
-   * @remarks
-   * The driver will look up corresponding SRV and TXT records if the connection string starts with `mongodb+srv://`.
-   * If those look ups throw a DNS Timeout error, the driver will retry the look up once.
+   * @param url - The MongoDB connection string (supports `mongodb://` and `mongodb+srv://` schemes)
+   * @param options - Optional configuration options for the client
    *
-   * @see docs.mongodb.org/manual/reference/connection-string/
+   * @see https://www.mongodb.com/docs/manual/reference/connection-string/
    */
   async connect(): Promise<this> {
     if (this.connectionLock) {
@@ -868,21 +836,35 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements
   }
 
   /**
-   * Connect to MongoDB using a url
+   * Creates a new MongoClient instance and immediately connects it to MongoDB.
+   * This convenience method combines `new MongoClient(url, options)` and `client.connect()` in a single step.
+   *
+   * Connect can be helpful to detect configuration issues early by validating:
+   * - **DNS Resolution**: Verifies that SRV records and hostnames in the connection string resolve DNS entries
+   * - **Network Connectivity**: Confirms that host addresses are reachable and ports are open
+   * - **TLS Configuration**: Validates SSL/TLS certificates, CA files, and encryption settings are correct
+   * - **Authentication**: Verifies that provided credentials are valid
+   * - **Server Compatibility**: Ensures the MongoDB server version is supported by this driver version
+   * - **Load Balancer Setup**: For load-balanced deployments, confirms the service is properly configured
+   *
+   * @returns A promise that resolves to the same MongoClient instance once connected
    *
    * @remarks
-   * Calling `connect` is optional since the first operation you perform will call `connect` if it's needed.
-   * `timeoutMS` will bound the time any operation can take before throwing a timeout error.
-   * However, when the operation being run is automatically connecting your `MongoClient` the `timeoutMS` will not apply to the time taken to connect the MongoClient.
-   * This means the time to setup the `MongoClient` does not count against `timeoutMS`.
-   * If you are using `timeoutMS` we recommend connecting your client explicitly in advance of any operation to avoid this inconsistent execution time.
+   * **Connection is Optional:** Calling `connect` is optional since any operation method (`find`, `insertOne`, etc.)
+   * will automatically perform these same validation steps if the client is not already connected.
+   * However, explicitly calling `connect` can make sense for:
+   * - **Fail-fast Error Detection**: Non-transient connection issues (hostname unresolved, port refused connection) are discovered immediately rather than during your first operation
+   * - **Predictable Performance**: Eliminates first connection overhead from your first database operation
    *
    * @remarks
-   * The programmatically provided options take precedence over the URI options.
+   * **Connection Pooling Impact:** Calling `connect` will populate the connection pool with one connection
+   * to a server selected by the client's configured `readPreference` (defaults to primary).
    *
    * @remarks
-   * The driver will look up corresponding SRV and TXT records if the connection string starts with `mongodb+srv://`.
-   * If those look ups throw a DNS Timeout error, the driver will retry the look up once.
+   * **Timeout Behavior:** When using `timeoutMS`, the connection establishment time does not count against
+   * the timeout for subsequent operations. This means `connect` runs without a `timeoutMS` limit, while
+   * your database operations will still respect the configured timeout. If you need predictable operation
+   * timing with `timeoutMS`, call `connect` explicitly before performing operations.
    *
    * @see https://www.mongodb.com/docs/manual/reference/connection-string/
    */
@@ -1037,8 +1019,6 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements
   }
 }
 
-configureResourceManagement(MongoClient.prototype);
-
 /**
  * Parsed Mongo Client Options.
  *
@@ -1105,12 +1085,8 @@ export interface MongoOptions
   compressors: CompressorName[];
   writeConcern: WriteConcern;
   dbName: string;
-  /** @deprecated - Will be made internal in a future major release. */
-  metadata: ClientMetadata;
-  /** @deprecated - Will be made internal in a future major release. */
-  extendedMetadata: Promise<Document>;
-  /** @deprecated - Will be made internal in a future major release. */
-  additionalDriverInfo: DriverInfo[];
+  /** @internal */
+  metadata: Promise<ClientMetadata>;
   /** @internal */
   autoEncrypter?: AutoEncrypter;
   /** @internal */

package/src/operations/aggregate.ts

@@ -80,12 +80,6 @@ export class AggregateOperation extends CommandOperation<CursorResponse> {
       delete this.options.writeConcern;
     }
 
-    if (this.explain && this.writeConcern) {
-      throw new MongoInvalidArgumentError(
-        'Option "explain" cannot be used on an aggregate call with writeConcern'
-      );
-    }
-
     if (options?.cursor != null && typeof options.cursor !== 'object') {
       throw new MongoInvalidArgumentError('Cursor options must be an object');
     }

package/src/sdam/topology.ts

@@ -150,8 +150,7 @@ export interface TopologyOptions extends BSONSerializeOptions, ServerOptions {
   /** Indicates that a client should directly connect to a node without attempting to discover its topology type */
   directConnection: boolean;
   loadBalanced: boolean;
-  metadata: ClientMetadata;
-  extendedMetadata: Promise<Document>;
+  metadata: Promise<ClientMetadata>;
   serverMonitoringMode: ServerMonitoringMode;
   /** MongoDB server API version */
   serverApi?: ServerApi;
@@ -466,7 +465,7 @@ export class Topology extends TypedEventEmitter<TopologyEvents> {
       );
 
       const skipPingOnConnect = this.s.options.__skipPingOnConnect === true;
-      if (!skipPingOnConnect && this.s.credentials) {
+      if (!skipPingOnConnect) {
         const connection = await server.pool.checkOut({ timeoutContext: timeoutContext });
         server.pool.checkIn(connection);
         stateTransition(this, STATE_CONNECTED);
@@ -750,10 +749,6 @@ export class Topology extends TypedEventEmitter<TopologyEvents> {
     if (typeof callback === 'function') callback(undefined, true);
   }
 
-  get clientMetadata(): ClientMetadata {
-    return this.s.options.metadata;
-  }
-
   isConnected(): boolean {
     return this.s.state === STATE_CONNECTED;
   }

package/src/sessions.ts

@@ -26,7 +26,6 @@ import { executeOperation } from './operations/execute_operation';
 import { RunCommandOperation } from './operations/run_command';
 import { ReadConcernLevel } from './read_concern';
 import { ReadPreference } from './read_preference';
-import { type AsyncDisposable, configureResourceManagement } from './resource_management';
 import { _advanceClusterTime, type ClusterTime, TopologyType } from './sdam/common';
 import { TimeoutContext } from './timeout';
 import {
@@ -289,13 +288,10 @@ export class ClientSession
     }
   }
   /**
-   * @beta
    * @experimental
    * An alias for {@link ClientSession.endSession|ClientSession.endSession()}.
    */
-  declare [Symbol.asyncDispose]: () => Promise<void>;
-  /** @internal */
-  async asyncDispose() {
+  async [Symbol.asyncDispose]() {
     await this.endSession({ force: true });
   }
 
@@ -823,8 +819,6 @@ export class ClientSession
   }
 }
 
-configureResourceManagement(ClientSession.prototype);
-
 const NON_DETERMINISTIC_WRITE_CONCERN_ERRORS = new Set([
   'CannotSatisfyWriteConcern',
   'UnknownReplWriteConcern',