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

package/mongodb.d.ts

@@ -69,7 +69,7 @@ export declare type Abortable = {
 };
 
 /** @public */
-export declare abstract class AbstractCursor<TSchema = any, CursorEvents extends AbstractCursorEvents = AbstractCursorEvents> extends TypedEventEmitter<CursorEvents> implements AsyncDisposable_2 {
+export declare abstract class AbstractCursor<TSchema = any, CursorEvents extends AbstractCursorEvents = AbstractCursorEvents> extends TypedEventEmitter<CursorEvents> implements AsyncDisposable {
     /* Excluded from this release type: cursorId */
     /* Excluded from this release type: cursorSession */
     /* Excluded from this release type: selectedServer */
@@ -114,8 +114,11 @@ export declare abstract class AbstractCursor<TSchema = any, CursorEvents extends
      */
     get killed(): boolean;
     get loadBalanced(): boolean;
-    /* Excluded from this release type: [Symbol.asyncDispose] */
-    /* Excluded from this release type: asyncDispose */
+    /**
+     * @experimental
+     * An alias for {@link AbstractCursor.close|AbstractCursor.close()}.
+     */
+    [Symbol.asyncDispose](): Promise<void>;
     /** Adds cursor to client's tracking so it will be closed by MongoClient.close() */
     private trackCursor;
     /** Returns current buffered documents length */
@@ -628,15 +631,6 @@ export declare type ArrayOperator<Type> = {
     $sort?: Sort;
 };
 
-/**
- * @public
- */
-declare interface AsyncDisposable_2 {
-    /* Excluded from this release type: [Symbol.asyncDispose] */
-    /* Excluded from this release type: asyncDispose */
-}
-export { AsyncDisposable_2 as AsyncDisposable }
-
 /** @public */
 export declare interface Auth {
     /** The username for auth */
@@ -1171,9 +1165,12 @@ export declare type Callback<T = any> = (error?: AnyError, result?: T) => void;
  * Creates a new Change Stream instance. Normally created using {@link Collection#watch|Collection.watch()}.
  * @public
  */
-export declare class ChangeStream<TSchema extends Document = Document, TChange extends Document = ChangeStreamDocument<TSchema>> extends TypedEventEmitter<ChangeStreamEvents<TSchema, TChange>> implements AsyncDisposable_2 {
-    /* Excluded from this release type: [Symbol.asyncDispose] */
-    /* Excluded from this release type: asyncDispose */
+export declare class ChangeStream<TSchema extends Document = Document, TChange extends Document = ChangeStreamDocument<TSchema>> extends TypedEventEmitter<ChangeStreamEvents<TSchema, TChange>> implements AsyncDisposable {
+    /**
+     * @experimental
+     * An alias for {@link ChangeStream.close|ChangeStream.close()}.
+     */
+    [Symbol.asyncDispose](): Promise<void>;
     pipeline: Document[];
     /**
      * @remarks WriteConcern can still be present on the options because
@@ -2272,35 +2269,7 @@ export declare interface ClientInsertOneResult {
     insertedId: any;
 }
 
-/**
- * @public
- * @deprecated This interface will be made internal in the next major release.
- * @see https://github.com/mongodb/specifications/blob/master/source/mongodb-handshake/handshake.md#hello-command
- */
-export declare interface ClientMetadata {
-    driver: {
-        name: string;
-        version: string;
-    };
-    os: {
-        type: string;
-        name?: NodeJS.Platform;
-        architecture?: string;
-        version?: string;
-    };
-    platform: string;
-    application?: {
-        name: string;
-    };
-    /** FaaS environment information */
-    env?: {
-        name: 'aws.lambda' | 'gcp.func' | 'azure.func' | 'vercel';
-        timeout_sec?: Int32;
-        memory_mb?: Int32;
-        region?: string;
-        url?: string;
-    };
-}
+/* Excluded from this release type: ClientMetadata */
 
 /** @public */
 export declare interface ClientReplaceOneModel<TSchema> extends ClientWriteModel {
@@ -2328,7 +2297,7 @@ export declare interface ClientReplaceOneModel<TSchema> extends ClientWriteModel
  * NOTE: not meant to be instantiated directly.
  * @public
  */
-export declare class ClientSession extends TypedEventEmitter<ClientSessionEvents> implements AsyncDisposable_2 {
+export declare class ClientSession extends TypedEventEmitter<ClientSessionEvents> implements AsyncDisposable {
     /* Excluded from this release type: client */
     /* Excluded from this release type: sessionPool */
     hasEnded: boolean;
@@ -2371,8 +2340,11 @@ export declare class ClientSession extends TypedEventEmitter<ClientSessionEvents
      * @param options - Optional settings. Currently reserved for future use
      */
     endSession(options?: EndSessionOptions): Promise<void>;
-    /* Excluded from this release type: [Symbol.asyncDispose] */
-    /* Excluded from this release type: asyncDispose */
+    /**
+     * @experimental
+     * An alias for {@link ClientSession.endSession|ClientSession.endSession()}.
+     */
+    [Symbol.asyncDispose](): Promise<void>;
     /**
      * Advances the operationTime for a ClientSession.
      *
@@ -3405,8 +3377,6 @@ export declare type CompressorName = keyof typeof Compressor;
 /** @public */
 export declare type Condition<T> = AlternativeType<T> | FilterOperators<AlternativeType<T>>;
 
-/* Excluded from this release type: configureExplicitResourceManagement */
-
 /* Excluded from this release type: Connection */
 
 /* Excluded from this release type: CONNECTION_CHECK_OUT_FAILED */
@@ -3548,8 +3518,7 @@ export declare interface ConnectionOptions extends SupportedNodeConnectionOption
     noDelay?: boolean;
     socketTimeoutMS?: number;
     /* Excluded from this release type: cancellationToken */
-    metadata: ClientMetadata;
-    /* Excluded from this release type: extendedMetadata */
+    /* Excluded from this release type: metadata */
     /* Excluded from this release type: mongoLogger */
 }
 
@@ -5716,7 +5685,7 @@ export declare class MongoChangeStreamError extends MongoRuntimeError {
  * const client = new MongoClient('mongodb://localhost:27017?appName=mflix', { monitorCommands: true });
  * ```
  */
-export declare class MongoClient extends TypedEventEmitter<MongoClientEvents> implements AsyncDisposable_2 {
+export declare class MongoClient extends TypedEventEmitter<MongoClientEvents> implements AsyncDisposable {
     /* Excluded from this release type: s */
     /* Excluded from this release type: topology */
     /* Excluded from this release type: mongoLogger */
@@ -5725,11 +5694,16 @@ export declare class MongoClient extends TypedEventEmitter<MongoClientEvents> im
     /**
      * The consolidate, parsed, transformed and merged options.
      */
-    readonly options: Readonly<Omit<MongoOptions, 'monitorCommands' | 'ca' | 'crl' | 'key' | 'cert' | 'driverInfo' | 'additionalDriverInfo' | 'metadata' | 'extendedMetadata'>> & Pick<MongoOptions, 'monitorCommands' | 'ca' | 'crl' | 'key' | 'cert' | 'driverInfo' | 'additionalDriverInfo' | 'metadata' | 'extendedMetadata'>;
+    readonly options: Readonly<Omit<MongoOptions, 'monitorCommands' | 'ca' | 'crl' | 'key' | 'cert' | 'driverInfo'>> & Pick<MongoOptions, 'monitorCommands' | 'ca' | 'crl' | 'key' | 'cert' | 'driverInfo'> & {
+        /* Excluded from this release type: metadata */
+    };
     private driverInfoList;
     constructor(url: string, options?: MongoClientOptions);
-    /* Excluded from this release type: [Symbol.asyncDispose] */
-    /* Excluded from this release type: asyncDispose */
+    /**
+     * @experimental
+     * An alias for {@link MongoClient.close|MongoClient.close()}.
+     */
+    [Symbol.asyncDispose](): Promise<void>;
     /**
      * Append metadata to the client metadata after instantiation.
      * @param driverInfo - Information about the application or library.
@@ -5753,20 +5727,13 @@ export declare class MongoClient extends TypedEventEmitter<MongoClientEvents> im
      */
     bulkWrite<SchemaMap extends Record<string, Document> = Record<string, Document>>(models: ReadonlyArray<ClientBulkWriteModel<SchemaMap>>, options?: ClientBulkWriteOptions): Promise<ClientBulkWriteResult>;
     /**
-     * Connect to MongoDB using a url
-     *
-     * @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.
+     * 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
-     * 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/
      */
     connect(): Promise<this>;
     /* Excluded from this release type: _connect */
@@ -5825,21 +5792,35 @@ export declare class MongoClient extends TypedEventEmitter<MongoClientEvents> im
      */
     db(dbName?: string, options?: DbOptions): Db;
     /**
-     * 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/
      */
@@ -6980,12 +6961,7 @@ export declare interface MongoOptions extends Required<Pick<MongoClientOptions,
     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[];
+    /* Excluded from this release type: metadata */
     /* Excluded from this release type: autoEncrypter */
     /* Excluded from this release type: tokenCache */
     proxyHost?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mongodb",
-  "version": "6.20.0-dev.20251008.sha.cfbada66",
+  "version": "6.20.0-dev.20251010.sha.c5f74abe",
   "description": "The official MongoDB driver for Node.js",
   "main": "lib/index.js",
   "files": [
@@ -124,7 +124,7 @@
   "scripts": {
     "build:evergreen": "node .evergreen/generate_evergreen_tasks.js",
     "build:ts": "node ./node_modules/typescript/bin/tsc",
-    "build:dts": "npm run build:ts && api-extractor run && node etc/clean_definition_files.cjs && ESLINT_USE_FLAT_CONFIG=false eslint --no-ignore --fix mongodb.d.ts lib/beta.d.ts",
+    "build:dts": "npm run build:ts && api-extractor run && node etc/clean_definition_files.cjs && ESLINT_USE_FLAT_CONFIG=false eslint --no-ignore --fix mongodb.d.ts",
     "build:docs": "./etc/docs/build.ts",
     "build:typedoc": "typedoc",
     "build:nightly": "node ./.github/scripts/nightly.mjs",
@@ -143,7 +143,6 @@
     "check:unit": "nyc mocha test/unit",
     "check:ts": "node ./node_modules/typescript/bin/tsc -v && node ./node_modules/typescript/bin/tsc --noEmit",
     "check:atlas": "nyc mocha --config test/manual/mocharc.js test/manual/atlas_connectivity.test.ts",
-    "check:resource-management": "nyc mocha --config test/manual/mocharc.js test/manual/resource_management.test.ts",
     "check:drivers-atlas-testing": "nyc mocha --config test/mocha_mongodb.js test/atlas/drivers_atlas_testing.test.ts",
     "check:aws": "nyc mocha --config test/mocha_mongodb.js test/integration/auth/mongodb_aws.test.ts",
     "check:oidc-auth": "nyc mocha --config test/mocha_mongodb.js test/integration/auth/auth.spec.test.ts",

package/src/change_stream.ts

@@ -18,7 +18,6 @@ import { MongoClient } from './mongo_client';
 import { type InferIdType, TypedEventEmitter } from './mongo_types';
 import type { AggregateOptions } from './operations/aggregate';
 import type { OperationParent } from './operations/command';
-import { type AsyncDisposable, configureResourceManagement } from './resource_management';
 import type { ServerSessionId } from './sessions';
 import { CSOTTimeoutContext, type TimeoutContext } from './timeout';
 import { filterOptions, getTopology, type MongoDBNamespace, squashError } from './utils';
@@ -574,13 +573,10 @@ export class ChangeStream<
   implements AsyncDisposable
 {
   /**
-   * @beta
    * @experimental
    * An alias for {@link ChangeStream.close|ChangeStream.close()}.
    */
-  declare [Symbol.asyncDispose]: () => Promise<void>;
-  /** @internal */
-  async asyncDispose() {
+  async [Symbol.asyncDispose]() {
     await this.close();
   }
 
@@ -1090,5 +1086,3 @@ export class ChangeStream<
     }
   }
 }
-
-configureResourceManagement(ChangeStream.prototype);

package/src/cmap/connect.ts

@@ -222,7 +222,7 @@ export async function prepareHandshakeDocument(
   const options = authContext.options;
   const compressors = options.compressors ? options.compressors : [];
   const { serverApi } = authContext.connection;
-  const clientMetadata: Document = await options.extendedMetadata;
+  const clientMetadata: Document = await options.metadata;
 
   const handshakeDoc: HandshakeDocument = {
     [serverApi?.version || options.loadBalanced === true ? 'hello' : LEGACY_HELLO_COMMAND]: 1,

package/src/cmap/connection.ts

@@ -140,9 +140,8 @@ export interface ConnectionOptions
   socketTimeoutMS?: number;
   /** @internal */
   cancellationToken?: CancellationToken;
-  metadata: ClientMetadata;
   /** @internal */
-  extendedMetadata: Promise<Document>;
+  metadata: Promise<ClientMetadata>;
   /** @internal */
   mongoLogger?: MongoLogger | undefined;
 }

package/src/cmap/connection_pool.ts

@@ -601,9 +601,9 @@ export class ConnectionPool extends TypedEventEmitter<ConnectionPoolEvents> {
   }
 
   private createConnection(callback: Callback<Connection>) {
-    // Note that metadata and extendedMetadata may have changed on the client but have
-    // been frozen here, so we pull the extendedMetadata promise always from the client
-    // no mattter what options were set at the construction of the pool.
+    // Note that metadata may have changed on the client but have
+    // been frozen here, so we pull the metadata promise always from the client
+    // no matter what options were set at the construction of the pool.
     const connectOptions: ConnectionOptions = {
       ...this.options,
       id: this.connectionCounter.next().value,
@@ -611,7 +611,7 @@ export class ConnectionPool extends TypedEventEmitter<ConnectionPoolEvents> {
       cancellationToken: this.cancellationToken,
       mongoLogger: this.mongoLogger,
       authProviders: this.server.topology.client.s.authProviders,
-      extendedMetadata: this.server.topology.client.options.extendedMetadata
+      metadata: this.server.topology.client.options.metadata
     };
 
     this.pending++;

package/src/cmap/handshake/client_metadata.ts

@@ -27,8 +27,7 @@ export function isDriverInfoEqual(info1: DriverInfo, info2: DriverInfo): boolean
 }
 
 /**
- * @public
- * @deprecated This interface will be made internal in the next major release.
+ * @internal
  * @see https://github.com/mongodb/specifications/blob/master/source/mongodb-handshake/handshake.md#hello-command
  */
 export interface ClientMetadata {
@@ -48,11 +47,14 @@ export interface ClientMetadata {
   };
   /** FaaS environment information */
   env?: {
-    name: 'aws.lambda' | 'gcp.func' | 'azure.func' | 'vercel';
+    name?: 'aws.lambda' | 'gcp.func' | 'azure.func' | 'vercel';
     timeout_sec?: Int32;
     memory_mb?: Int32;
     region?: string;
-    url?: string;
+    container?: {
+      runtime?: string;
+      orchestrator?: string;
+    };
   };
 }
 
@@ -103,10 +105,10 @@ type MakeClientMetadataOptions = Pick<MongoOptions, 'appName'>;
  * 3. Omit the `env` document entirely.
  * 4. Truncate `platform`. -- special we do not truncate this field
  */
-export function makeClientMetadata(
+export async function makeClientMetadata(
   driverInfoList: DriverInfo[],
   { appName = '' }: MakeClientMetadataOptions
-): ClientMetadata {
+): Promise<ClientMetadata> {
   const metadataDocument = new LimitedSizeDocument(512);
 
   // Add app name first, it must be sent
@@ -178,19 +180,21 @@ export function makeClientMetadata(
       }
     }
   }
-  return metadataDocument.toObject() as ClientMetadata;
+  return await addContainerMetadata(metadataDocument.toObject() as ClientMetadata);
 }
 
 let dockerPromise: Promise<boolean>;
+type ContainerMetadata = NonNullable<NonNullable<ClientMetadata['env']>['container']>;
 /** @internal */
-async function getContainerMetadata() {
-  const containerMetadata: Record<string, any> = {};
+async function getContainerMetadata(): Promise<ContainerMetadata> {
   dockerPromise ??= fileIsAccessible('/.dockerenv');
   const isDocker = await dockerPromise;
 
   const { KUBERNETES_SERVICE_HOST = '' } = process.env;
   const isKubernetes = KUBERNETES_SERVICE_HOST.length > 0 ? true : false;
 
+  const containerMetadata: ContainerMetadata = {};
+
   if (isDocker) containerMetadata.runtime = 'docker';
   if (isKubernetes) containerMetadata.orchestrator = 'kubernetes';
 
@@ -202,15 +206,16 @@ async function getContainerMetadata() {
  * Re-add each metadata value.
  * Attempt to add new env container metadata, but keep old data if it does not fit.
  */
-export async function addContainerMetadata(
-  originalMetadata: ClientMetadata
-): Promise<ClientMetadata> {
+async function addContainerMetadata(originalMetadata: ClientMetadata): Promise<ClientMetadata> {
   const containerMetadata = await getContainerMetadata();
   if (Object.keys(containerMetadata).length === 0) return originalMetadata;
 
   const extendedMetadata = new LimitedSizeDocument(512);
 
-  const extendedEnvMetadata = { ...originalMetadata?.env, container: containerMetadata };
+  const extendedEnvMetadata: NonNullable<ClientMetadata['env']> = {
+    ...originalMetadata?.env,
+    container: containerMetadata
+  };
 
   for (const [key, val] of Object.entries(originalMetadata)) {
     if (key !== 'env') {

package/src/cursor/abstract_cursor.ts

@@ -18,7 +18,6 @@ import { GetMoreOperation } from '../operations/get_more';
 import { KillCursorsOperation } from '../operations/kill_cursors';
 import { ReadConcern, type ReadConcernLike } from '../read_concern';
 import { ReadPreference, type ReadPreferenceLike } from '../read_preference';
-import { type AsyncDisposable, configureResourceManagement } from '../resource_management';
 import type { Server } from '../sdam/server';
 import { type ClientSession, maybeClearPinnedConnection } from '../sessions';
 import { type CSOTTimeoutContext, type Timeout, TimeoutContext } from '../timeout';
@@ -437,13 +436,10 @@ export abstract class AbstractCursor<
   }
 
   /**
-   * @beta
    * @experimental
    * An alias for {@link AbstractCursor.close|AbstractCursor.close()}.
    */
-  declare [Symbol.asyncDispose]: () => Promise<void>;
-  /** @internal */
-  async asyncDispose() {
+  async [Symbol.asyncDispose]() {
     await this.close();
   }
 
@@ -1223,8 +1219,6 @@ class ReadableCursorStream extends Readable {
   }
 }
 
-configureResourceManagement(AbstractCursor.prototype);
-
 /**
  * @internal
  * The cursor timeout context is a wrapper around a timeout context

package/src/index.ts

@@ -87,7 +87,6 @@ export {
   MongoWriteConcernError,
   WriteConcernErrorResult
 } from './error';
-export { configureExplicitResourceManagement } from './resource_management';
 export {
   AbstractCursor,
   // Actual driver classes exported
@@ -564,7 +563,6 @@ export type {
   ReadPreferenceLikeOptions,
   ReadPreferenceOptions
 } from './read_preference';
-export type { AsyncDisposable } from './resource_management';
 export type { ClusterTime } from './sdam/common';
 export type {
   Monitor,