mongodb 6.12.0 → 6.13.0

package/src/db.ts

@@ -8,7 +8,7 @@ import { ListCollectionsCursor } from './cursor/list_collections_cursor';
 import { RunCommandCursor, type RunCursorCommandOptions } from './cursor/run_command_cursor';
 import { MongoInvalidArgumentError } from './error';
 import type { MongoClient, PkFactory } from './mongo_client';
-import type { TODO_NODE_3286 } from './mongo_types';
+import type { Abortable, TODO_NODE_3286 } from './mongo_types';
 import type { AggregateOptions } from './operations/aggregate';
 import { CollectionsOperation } from './operations/collections';
 import {
@@ -273,7 +273,7 @@ export class Db {
    * @param command - The command to run
    * @param options - Optional settings for the command
    */
-  async command(command: Document, options?: RunCommandOptions): Promise<Document> {
+  async command(command: Document, options?: RunCommandOptions & Abortable): Promise<Document> {
     // Intentionally, we do not inherit options from parent for this operation.
     return await executeOperation(
       this.client,
@@ -284,7 +284,8 @@ export class Db {
           ...resolveBSONOptions(options),
           timeoutMS: options?.timeoutMS ?? this.timeoutMS,
           session: options?.session,
-          readPreference: options?.readPreference
+          readPreference: options?.readPreference,
+          signal: options?.signal
         })
       )
     );
@@ -351,22 +352,25 @@ export class Db {
    */
   listCollections(
     filter: Document,
-    options: Exclude<ListCollectionsOptions, 'nameOnly'> & { nameOnly: true }
+    options: Exclude<ListCollectionsOptions, 'nameOnly'> & { nameOnly: true } & Abortable
   ): ListCollectionsCursor<Pick<CollectionInfo, 'name' | 'type'>>;
   listCollections(
     filter: Document,
-    options: Exclude<ListCollectionsOptions, 'nameOnly'> & { nameOnly: false }
+    options: Exclude<ListCollectionsOptions, 'nameOnly'> & { nameOnly: false } & Abortable
   ): ListCollectionsCursor<CollectionInfo>;
   listCollections<
     T extends Pick<CollectionInfo, 'name' | 'type'> | CollectionInfo =
       | Pick<CollectionInfo, 'name' | 'type'>
       | CollectionInfo
-  >(filter?: Document, options?: ListCollectionsOptions): ListCollectionsCursor<T>;
+  >(filter?: Document, options?: ListCollectionsOptions & Abortable): ListCollectionsCursor<T>;
   listCollections<
     T extends Pick<CollectionInfo, 'name' | 'type'> | CollectionInfo =
       | Pick<CollectionInfo, 'name' | 'type'>
       | CollectionInfo
-  >(filter: Document = {}, options: ListCollectionsOptions = {}): ListCollectionsCursor<T> {
+  >(
+    filter: Document = {},
+    options: ListCollectionsOptions & Abortable = {}
+  ): ListCollectionsCursor<T> {
     return new ListCollectionsCursor<T>(this, filter, resolveOptions(this, options));
   }
 

package/src/encrypter.ts

@@ -7,9 +7,6 @@ import { MongoInvalidArgumentError, MongoMissingDependencyError } from './error'
 import { MongoClient, type MongoClientOptions } from './mongo_client';
 import { type Callback } from './utils';
 
-/** @internal */
-const kInternalClient = Symbol('internalClient');
-
 /** @internal */
 export interface EncrypterOptions {
   autoEncryption: AutoEncryptionOptions;
@@ -18,7 +15,7 @@ export interface EncrypterOptions {
 
 /** @internal */
 export class Encrypter {
-  [kInternalClient]: MongoClient | null;
+  private internalClient: MongoClient | null;
   bypassAutoEncryption: boolean;
   needsConnecting: boolean;
   autoEncrypter: AutoEncrypter;
@@ -28,7 +25,7 @@ export class Encrypter {
       throw new MongoInvalidArgumentError('Option "autoEncryption" must be specified');
     }
     // initialize to null, if we call getInternalClient, we may set this it is important to not overwrite those function calls.
-    this[kInternalClient] = null;
+    this.internalClient = null;
 
     this.bypassAutoEncryption = !!options.autoEncryption.bypassAutoEncryption;
     this.needsConnecting = false;
@@ -60,8 +57,7 @@ export class Encrypter {
   }
 
   getInternalClient(client: MongoClient, uri: string, options: MongoClientOptions): MongoClient {
-    // TODO(NODE-4144): Remove new variable for type narrowing
-    let internalClient = this[kInternalClient];
+    let internalClient = this.internalClient;
     if (internalClient == null) {
       const clonedOptions: MongoClientOptions = {};
 
@@ -77,7 +73,7 @@ export class Encrypter {
       clonedOptions.minPoolSize = 0;
 
       internalClient = new MongoClient(uri, clonedOptions);
-      this[kInternalClient] = internalClient;
+      this.internalClient = internalClient;
 
       for (const eventName of MONGO_CLIENT_EVENTS) {
         for (const listener of client.listeners(eventName)) {
@@ -95,8 +91,7 @@ export class Encrypter {
   }
 
   async connectInternalClient(): Promise<void> {
-    // TODO(NODE-4144): Remove new variable for type narrowing
-    const internalClient = this[kInternalClient];
+    const internalClient = this.internalClient;
     if (this.needsConnecting && internalClient != null) {
       this.needsConnecting = false;
       await internalClient.connect();
@@ -114,7 +109,7 @@ export class Encrypter {
     } catch (autoEncrypterError) {
       error = autoEncrypterError;
     }
-    const internalClient = this[kInternalClient];
+    const internalClient = this.internalClient;
     if (internalClient != null && client !== internalClient) {
       return await internalClient.close(force);
     }

package/src/error.ts

@@ -10,9 +10,6 @@ import type { TopologyDescription } from './sdam/topology_description';
 /** @public */
 export type AnyError = MongoError | Error;
 
-/** @internal */
-const kErrorLabels = Symbol('errorLabels');
-
 /**
  * @internal
  * The legacy error message from the server that indicates the node is not a writable primary
@@ -129,7 +126,11 @@ function isAggregateError(e: unknown): e is Error & { errors: Error[] } {
  */
 export class MongoError extends Error {
   /** @internal */
-  [kErrorLabels]: Set<string>;
+  private readonly errorLabelSet: Set<string> = new Set();
+  public get errorLabels(): string[] {
+    return Array.from(this.errorLabelSet);
+  }
+
   /**
    * This is a number in MongoServerError and a string in MongoDriverError
    * @privateRemarks
@@ -153,7 +154,6 @@ export class MongoError extends Error {
    **/
   constructor(message: string, options?: { cause?: Error }) {
     super(message, options);
-    this[kErrorLabels] = new Set();
   }
 
   /** @internal */
@@ -188,15 +188,11 @@ export class MongoError extends Error {
    * @returns returns true if the error has the provided error label
    */
   hasErrorLabel(label: string): boolean {
-    return this[kErrorLabels].has(label);
+    return this.errorLabelSet.has(label);
   }
 
   addErrorLabel(label: string): void {
-    this[kErrorLabels].add(label);
-  }
-
-  get errorLabels(): string[] {
-    return Array.from(this[kErrorLabels]);
+    this.errorLabelSet.add(label);
   }
 }
 
@@ -228,8 +224,9 @@ export class MongoServerError extends MongoError {
    **/
   constructor(message: ErrorDescription) {
     super(message.message || message.errmsg || message.$err || 'n/a');
+
     if (message.errorLabels) {
-      this[kErrorLabels] = new Set(message.errorLabels);
+      for (const label of message.errorLabels) this.addErrorLabel(label);
     }
 
     this.errorResponse = message;
@@ -1028,12 +1025,6 @@ export class MongoTopologyClosedError extends MongoAPIError {
   }
 }
 
-/** @internal */
-const kBeforeHandshake = Symbol('beforeHandshake');
-export function isNetworkErrorBeforeHandshake(err: MongoNetworkError): boolean {
-  return err[kBeforeHandshake] === true;
-}
-
 /** @public */
 export interface MongoNetworkErrorOptions {
   /** Indicates the timeout happened before a connection handshake completed */
@@ -1048,7 +1039,7 @@ export interface MongoNetworkErrorOptions {
  */
 export class MongoNetworkError extends MongoError {
   /** @internal */
-  [kBeforeHandshake]?: boolean;
+  public readonly beforeHandshake: boolean;
 
   /**
    * **Do not use this constructor!**
@@ -1063,10 +1054,7 @@ export class MongoNetworkError extends MongoError {
    **/
   constructor(message: string, options?: MongoNetworkErrorOptions) {
     super(message, { cause: options?.cause });
-
-    if (options && typeof options.beforeHandshake === 'boolean') {
-      this[kBeforeHandshake] = options.beforeHandshake;
-    }
+    this.beforeHandshake = !!options?.beforeHandshake;
   }
 
   override get name(): string {

package/src/index.ts

@@ -120,6 +120,7 @@ export { CURSOR_FLAGS, CursorTimeoutMode } from './cursor/abstract_cursor';
 export { MongoErrorLabel } from './error';
 export { ExplainVerbosity } from './explain';
 export { ServerApiVersion } from './mongo_client';
+export { MongoLoggableComponent, SeverityLevel } from './mongo_logger';
 export { ReturnDocument } from './operations/find_and_modify';
 export { ProfilingLevel } from './operations/set_profiling_level';
 export { ReadConcernLevel } from './read_concern';
@@ -422,14 +423,13 @@ export type {
   LoggableServerHeartbeatStartedEvent,
   LoggableServerHeartbeatSucceededEvent,
   MongoDBLogWritable,
-  MongoLoggableComponent,
   MongoLogger,
   MongoLoggerEnvOptions,
   MongoLoggerMongoClientOptions,
-  MongoLoggerOptions,
-  SeverityLevel
+  MongoLoggerOptions
 } from './mongo_logger';
 export type {
+  Abortable,
   CommonEvents,
   EventsDescription,
   GenericListener,

package/src/mongo_client.ts

@@ -18,6 +18,7 @@ import type { ClientMetadata } from './cmap/handshake/client_metadata';
 import type { CompressorName } from './cmap/wire_protocol/compression';
 import { parseOptions, resolveSRVRecord } from './connection_string';
 import { MONGO_CLIENT_EVENTS } from './constants';
+import { type AbstractCursor } from './cursor/abstract_cursor';
 import { Db, type DbOptions } from './db';
 import type { Encrypter } from './encrypter';
 import { MongoInvalidArgumentError } from './error';
@@ -277,29 +278,29 @@ export interface MongoClientOptions extends BSONSerializeOptions, SupportedNodeC
   proxyPassword?: string;
   /** Instructs the driver monitors to use a specific monitoring mode */
   serverMonitoringMode?: ServerMonitoringMode;
-
-  /** @internal */
-  srvPoller?: SrvPoller;
-  /** @internal */
-  connectionType?: typeof Connection;
   /**
-   * @internal
-   * TODO: NODE-5671 - remove internal flag
+   * @public
+   * Specifies the destination of the driver's logging. The default is stderr.
    */
   mongodbLogPath?: 'stderr' | 'stdout' | MongoDBLogWritable;
   /**
-   * @internal
-   * TODO: NODE-5671 - remove internal flag
+   * @public
+   * Enable logging level per component or use `default` to control any unset components.
    */
   mongodbLogComponentSeverities?: LogComponentSeveritiesClientOptions;
   /**
-   * @internal
-   * TODO: NODE-5671 - remove internal flag
+   * @public
+   * All BSON documents are stringified to EJSON. This controls the maximum length of those strings.
+   * It is defaulted to 1000.
    */
   mongodbLogMaxDocumentLength?: number;
 
   /** @internal */
-  [featureFlag: symbol]: any;
+  srvPoller?: SrvPoller;
+  /** @internal */
+  connectionType?: typeof Connection;
+  /** @internal */
+  __skipPingOnConnect?: boolean;
 }
 
 /** @public */
@@ -318,6 +319,12 @@ export interface MongoClientPrivate {
    * - used to notify the leak checker in our tests if test author forgot to clean up explicit sessions
    */
   readonly activeSessions: Set<ClientSession>;
+  /**
+   * We keep a reference to the cursors that are created from this client.
+   * - used to track and close all cursors in client.close().
+   *   Cursors in this set are ones that still need to have their close method invoked (no other conditions are considered)
+   */
+  readonly activeCursors: Set<AbstractCursor>;
   readonly sessionPool: ServerSessionPool;
   readonly options: MongoOptions;
   readonly readConcern?: ReadConcern;
@@ -333,9 +340,6 @@ export type MongoClientEvents = Pick<TopologyEvents, (typeof MONGO_CLIENT_EVENTS
   open(mongoClient: MongoClient): void;
 };
 
-/** @internal */
-const kOptions = Symbol('options');
-
 /**
  * The **MongoClient** class is a class that allows for making Connections to MongoDB.
  * @public
@@ -364,23 +368,27 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements
   override readonly mongoLogger: MongoLogger | undefined;
   /** @internal */
   private connectionLock?: Promise<this>;
+  /** @internal */
+  private closeLock?: Promise<void>;
 
   /**
    * The consolidate, parsed, transformed and merged options.
-   * @internal
    */
-  [kOptions]: MongoOptions;
+  public readonly options: Readonly<
+    Omit<MongoOptions, 'monitorCommands' | 'ca' | 'crl' | 'key' | 'cert'>
+  > &
+    Pick<MongoOptions, 'monitorCommands' | 'ca' | 'crl' | 'key' | 'cert'>;
 
   constructor(url: string, options?: MongoClientOptions) {
     super();
 
-    this[kOptions] = parseOptions(url, this, options);
+    this.options = parseOptions(url, this, options);
 
-    const shouldSetLogger = Object.values(
-      this[kOptions].mongoLoggerOptions.componentSeverities
-    ).some(value => value !== SeverityLevel.OFF);
+    const shouldSetLogger = Object.values(this.options.mongoLoggerOptions.componentSeverities).some(
+      value => value !== SeverityLevel.OFF
+    );
     this.mongoLogger = shouldSetLogger
-      ? new MongoLogger(this[kOptions].mongoLoggerOptions)
+      ? new MongoLogger(this.options.mongoLoggerOptions)
       : undefined;
 
     // eslint-disable-next-line @typescript-eslint/no-this-alias
@@ -389,24 +397,25 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements
     // The internal state
     this.s = {
       url,
-      bsonOptions: resolveBSONOptions(this[kOptions]),
+      bsonOptions: resolveBSONOptions(this.options),
       namespace: ns('admin'),
       hasBeenClosed: false,
       sessionPool: new ServerSessionPool(this),
       activeSessions: new Set(),
+      activeCursors: new Set(),
       authProviders: new MongoClientAuthProviders(),
 
       get options() {
-        return client[kOptions];
+        return client.options;
       },
       get readConcern() {
-        return client[kOptions].readConcern;
+        return client.options.readConcern;
       },
       get writeConcern() {
-        return client[kOptions].writeConcern;
+        return client.options.writeConcern;
       },
       get readPreference() {
-        return client[kOptions].readPreference;
+        return client.options.readPreference;
       },
       get isMongoClient(): true {
         return true;
@@ -428,15 +437,15 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements
 
   /** @internal */
   private checkForNonGenuineHosts() {
-    const documentDBHostnames = this[kOptions].hosts.filter((hostAddress: HostAddress) =>
+    const documentDBHostnames = this.options.hosts.filter((hostAddress: HostAddress) =>
       isHostMatch(DOCUMENT_DB_CHECK, hostAddress.host)
     );
-    const srvHostIsDocumentDB = isHostMatch(DOCUMENT_DB_CHECK, this[kOptions].srvHost);
+    const srvHostIsDocumentDB = isHostMatch(DOCUMENT_DB_CHECK, this.options.srvHost);
 
-    const cosmosDBHostnames = this[kOptions].hosts.filter((hostAddress: HostAddress) =>
+    const cosmosDBHostnames = this.options.hosts.filter((hostAddress: HostAddress) =>
       isHostMatch(COSMOS_DB_CHECK, hostAddress.host)
     );
-    const srvHostIsCosmosDB = isHostMatch(COSMOS_DB_CHECK, this[kOptions].srvHost);
+    const srvHostIsCosmosDB = isHostMatch(COSMOS_DB_CHECK, this.options.srvHost);
 
     if (documentDBHostnames.length !== 0 || srvHostIsDocumentDB) {
       this.mongoLogger?.info('client', DOCUMENT_DB_MSG);
@@ -445,28 +454,23 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements
     }
   }
 
-  /** @see MongoOptions */
-  get options(): Readonly<MongoOptions> {
-    return Object.freeze({ ...this[kOptions] });
-  }
-
   get serverApi(): Readonly<ServerApi | undefined> {
-    return this[kOptions].serverApi && Object.freeze({ ...this[kOptions].serverApi });
+    return this.options.serverApi && Object.freeze({ ...this.options.serverApi });
   }
   /**
    * Intended for APM use only
    * @internal
    */
   get monitorCommands(): boolean {
-    return this[kOptions].monitorCommands;
+    return this.options.monitorCommands;
   }
   set monitorCommands(value: boolean) {
-    this[kOptions].monitorCommands = value;
+    this.options.monitorCommands = value;
   }
 
   /** @internal */
   get autoEncrypter(): AutoEncrypter | undefined {
-    return this[kOptions].autoEncrypter;
+    return this.options.autoEncrypter;
   }
 
   get readConcern(): ReadConcern | undefined {
@@ -522,6 +526,10 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements
    * 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.
+   *
    * @see docs.mongodb.org/manual/reference/connection-string/
    */
   async connect(): Promise<this> {
@@ -551,7 +559,7 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements
       return this;
     }
 
-    const options = this[kOptions];
+    const options = this.options;
 
     if (options.tls) {
       if (typeof options.tlsCAFile === 'string') {
@@ -639,6 +647,21 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements
    * @param force - Force close, emitting no events
    */
   async close(force = false): Promise<void> {
+    if (this.closeLock) {
+      return await this.closeLock;
+    }
+
+    try {
+      this.closeLock = this._close(force);
+      await this.closeLock;
+    } finally {
+      // release
+      this.closeLock = undefined;
+    }
+  }
+
+  /* @internal */
+  private async _close(force = false): Promise<void> {
     // There's no way to set hasBeenClosed back to false
     Object.defineProperty(this.s, 'hasBeenClosed', {
       value: true,
@@ -647,6 +670,11 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements
       writable: false
     });
 
+    const activeCursorCloses = Array.from(this.s.activeCursors, cursor => cursor.close());
+    this.s.activeCursors.clear();
+
+    await Promise.all(activeCursorCloses);
+
     const activeSessionEnds = Array.from(this.s.activeSessions, session => session.endSession());
     this.s.activeSessions.clear();
 
@@ -685,7 +713,7 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements
 
     topology.close();
 
-    const { encrypter } = this[kOptions];
+    const { encrypter } = this.options;
     if (encrypter) {
       await encrypter.close(this, force);
     }
@@ -706,7 +734,7 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements
     }
 
     // Copy the options and add out internal override of the not shared flag
-    const finalOptions = Object.assign({}, this[kOptions], options);
+    const finalOptions = Object.assign({}, this.options, options);
 
     // Return the db object
     const db = new Db(this, dbName, finalOptions);
@@ -728,6 +756,10 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements
    * @remarks
    * The programmatically provided options take precedence over the URI options.
    *
+   * @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.
+   *
    * @see https://www.mongodb.com/docs/manual/reference/connection-string/
    */
   static async connect(url: string, options?: MongoClientOptions): Promise<MongoClient> {
@@ -748,7 +780,7 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements
       this,
       this.s.sessionPool,
       { explicit: true, ...options },
-      this[kOptions]
+      this.options
     );
     this.s.activeSessions.add(session);
     session.once('ended', () => {
@@ -1012,9 +1044,6 @@ export interface MongoOptions
   tlsCRLFile?: string;
   tlsCertificateKeyFile?: string;
 
-  /** @internal */
-  [featureFlag: symbol]: any;
-
   /**
    * @internal
    * TODO: NODE-5671 - remove internal flag
@@ -1026,4 +1055,6 @@ export interface MongoOptions
    */
   mongodbLogPath?: 'stderr' | 'stdout' | MongoDBLogWritable;
   timeoutMS?: number;
+  /** @internal */
+  __skipPingOnConnect?: boolean;
 }