mongodb 6.8.2 → 6.9.0-dev.20240917.sha.20396e1b

package/src/gridfs/download.ts

@@ -56,15 +56,41 @@ export interface GridFSFile {
 
 /** @internal */
 export interface GridFSBucketReadStreamPrivate {
+  /**
+   * The running total number of bytes read from the chunks collection.
+   */
   bytesRead: number;
+  /**
+   * The number of bytes to remove from the last chunk read in the file.  This is non-zero
+   * if `end` is not equal to the length of the document and `end` is not a multiple
+   * of the chunkSize.
+   */
   bytesToTrim: number;
+
+  /**
+   * The number of bytes to remove from the first chunk read in the file.  This is non-zero
+   * if `start` is not equal to the 0  and `start` is not a multiple
+   * of the chunkSize.
+   */
   bytesToSkip: number;
+
+  files: Collection<GridFSFile>;
   chunks: Collection<GridFSChunk>;
   cursor?: FindCursor<GridFSChunk>;
+
+  /** The running total number of chunks read from the chunks collection. */
   expected: number;
-  files: Collection<GridFSFile>;
+
+  /**
+   * The filter used to search in the _files_ collection (i.e., `{ _id: <> }`)
+   * This is not the same filter used when reading chunks from the chunks collection.
+   */
   filter: Document;
+
+  /** Indicates whether or not download has started. */
   init: boolean;
+
+  /** The expected number of chunks to read, calculated from start, end, chunkSize and file length. */
   expectedEnd: number;
   file?: GridFSFile;
   options: {
@@ -190,7 +216,7 @@ function doRead(stream: GridFSBucketReadStream): void {
 
     if (!doc) {
       stream.push(null);
-      // eslint-disable-next-line github/no-then
+
       stream.s.cursor?.close().then(undefined, error => stream.destroy(error));
       return;
     }
@@ -262,7 +288,6 @@ function doRead(stream: GridFSBucketReadStream): void {
     return;
   };
 
-  // eslint-disable-next-line github/no-then
   stream.s.cursor.next().then(handleReadResult, error => {
     if (stream.destroyed) return;
     stream.destroy(error);
@@ -346,7 +371,6 @@ function init(stream: GridFSBucketReadStream): void {
     return;
   };
 
-  // eslint-disable-next-line github/no-then
   stream.s.files.findOne(stream.s.filter, findOneOptions).then(handleReadResult, error => {
     if (stream.destroyed) return;
     stream.destroy(error);

package/src/gridfs/upload.ts

@@ -1,7 +1,6 @@
 import { Writable } from 'stream';
 
-import type { Document } from '../bson';
-import { ObjectId } from '../bson';
+import { type Document, ObjectId } from '../bson';
 import type { Collection } from '../collection';
 import { MongoAPIError, MONGODB_ERROR_CODES, MongoError } from '../error';
 import { type Callback, squashError } from '../utils';
@@ -135,7 +134,6 @@ export class GridFSBucketWriteStream extends Writable {
     if (!this.bucket.s.calledOpenUploadStream) {
       this.bucket.s.calledOpenUploadStream = true;
 
-      // eslint-disable-next-line github/no-then
       checkIndexes(this).then(() => {
         this.bucket.s.checkedIndexes = true;
         this.bucket.emit('index');
@@ -272,7 +270,6 @@ function checkDone(stream: GridFSBucketWriteStream, callback: Callback): void {
       return;
     }
 
-    // eslint-disable-next-line github/no-then
     stream.files.insertOne(gridFSFile, { writeConcern: stream.writeConcern }).then(
       () => {
         stream.gridFSFile = gridFSFile;
@@ -396,7 +393,6 @@ function doWrite(
         return;
       }
 
-      // eslint-disable-next-line github/no-then
       stream.chunks.insertOne(doc, { writeConcern: stream.writeConcern }).then(
         () => {
           --stream.state.outstandingRequests;
@@ -437,7 +433,6 @@ function writeRemnant(stream: GridFSBucketWriteStream, callback: Callback): void
     return;
   }
 
-  // eslint-disable-next-line github/no-then
   stream.chunks.insertOne(doc, { writeConcern: stream.writeConcern }).then(
     () => {
       --stream.state.outstandingRequests;

package/src/index.ts

@@ -73,8 +73,10 @@ export {
   MongoTopologyClosedError,
   MongoTransactionError,
   MongoUnexpectedServerResponseError,
-  MongoWriteConcernError
+  MongoWriteConcernError,
+  WriteConcernErrorResult
 } from './error';
+export { configureExplicitResourceManagement } from './resource_management';
 export {
   AbstractCursor,
   // Actual driver classes exported
@@ -247,6 +249,7 @@ export type {
   LocalKMSProviderConfiguration
 } from './client-side-encryption/providers/index';
 export type {
+  ClientEncryptionSocketOptions,
   ClientEncryptionTlsOptions,
   CSFLEKMSTlsOptions,
   StateMachineExecutable
@@ -365,7 +368,12 @@ export type { RunCursorCommandOptions } from './cursor/run_command_cursor';
 export type { DbOptions, DbPrivate } from './db';
 export type { Encrypter, EncrypterOptions } from './encrypter';
 export type { AnyError, ErrorDescription, MongoNetworkErrorOptions } from './error';
-export type { Explain, ExplainOptions, ExplainVerbosityLike } from './explain';
+export type {
+  Explain,
+  ExplainCommandOptions,
+  ExplainOptions,
+  ExplainVerbosityLike
+} from './explain';
 export type {
   GridFSBucketReadStreamOptions,
   GridFSBucketReadStreamOptionsWithRevision,
@@ -524,6 +532,7 @@ export type {
   ReadPreferenceLikeOptions,
   ReadPreferenceOptions
 } from './read_preference';
+export type { AsyncDisposable } from './resource_management';
 export type { ClusterTime, TimerQueue } from './sdam/common';
 export type {
   Monitor,

package/src/mongo_client.ts

@@ -34,6 +34,7 @@ import { executeOperation } from './operations/execute_operation';
 import { RunAdminCommandOperation } from './operations/run_command';
 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';
@@ -92,8 +93,10 @@ export interface PkFactory {
 
 /** @public */
 export type SupportedTLSConnectionOptions = Pick<
-  TLSConnectionOptions,
-  Extract<keyof TLSConnectionOptions, (typeof LEGAL_TLS_SOCKET_OPTIONS)[number]>
+  TLSConnectionOptions & {
+    allowPartialTrustChain?: boolean;
+  },
+  (typeof LEGAL_TLS_SOCKET_OPTIONS)[number]
 >;
 
 /** @public */
@@ -104,7 +107,7 @@ export type SupportedTLSSocketOptions = Pick<
 
 /** @public */
 export type SupportedSocketOptions = Pick<
-  TcpNetConnectOpts,
+  TcpNetConnectOpts & { autoSelectFamily?: boolean; autoSelectFamilyAttemptTimeout?: number },
   (typeof LEGAL_TCP_SOCKET_OPTIONS)[number]
 >;
 
@@ -344,7 +347,7 @@ const kOptions = Symbol('options');
  * await client.insertOne({ name: 'spot', kind: 'dog' });
  * ```
  */
-export class MongoClient extends TypedEventEmitter<MongoClientEvents> {
+export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements AsyncDisposable {
   /** @internal */
   s: MongoClientPrivate;
   /** @internal */
@@ -404,6 +407,17 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> {
     this.checkForNonGenuineHosts();
   }
 
+  /**
+   * @beta
+   * @experimental
+   * An alias for {@link MongoClient.close|MongoClient.close()}.
+   */
+  declare [Symbol.asyncDispose]: () => Promise<void>;
+  /** @internal */
+  async asyncDispose() {
+    await this.close();
+  }
+
   /** @internal */
   private checkForNonGenuineHosts() {
     const documentDBHostnames = this[kOptions].hosts.filter((hostAddress: HostAddress) =>
@@ -570,7 +584,15 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> {
   }
 
   /**
-   * Close the client and its underlying connections
+   * Cleans up client-side resources used by the MongoCLient and .  This includes:
+   *
+   * - Closes all open, unused connections (see note).
+   * - Ends all in-use sessions with {@link ClientSession#endSession|ClientSession.endSession()}.
+   * - Ends all unused sessions server-side.
+   * - Cleans up any resources being used for auto encryption if auto encryption is enabled.
+   *
+   * @remarks Any in-progress operations are not killed and any connections used by in progress operations
+   * will be cleaned up lazily as operations finish.
    *
    * @param force - Force close, emitting no events
    */
@@ -758,6 +780,8 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> {
   }
 }
 
+configureResourceManagement(MongoClient.prototype);
+
 /**
  * Parsed Mongo Client Options.
  *

package/src/mongo_client_auth_providers.ts

@@ -1,7 +1,6 @@
 import { type AuthProvider } from './cmap/auth/auth_provider';
 import { GSSAPI } from './cmap/auth/gssapi';
 import { type AuthMechanismProperties } from './cmap/auth/mongo_credentials';
-import { MongoCR } from './cmap/auth/mongocr';
 import { MongoDBAWS } from './cmap/auth/mongodb_aws';
 import { MongoDBOIDC, OIDC_WORKFLOWS, type Workflow } from './cmap/auth/mongodb_oidc';
 import { AutomatedCallbackWorkflow } from './cmap/auth/mongodb_oidc/automated_callback_workflow';
@@ -16,7 +15,14 @@ import { MongoInvalidArgumentError } from './error';
 /** @internal */
 const AUTH_PROVIDERS = new Map<AuthMechanism | string, (workflow?: Workflow) => AuthProvider>([
   [AuthMechanism.MONGODB_AWS, () => new MongoDBAWS()],
-  [AuthMechanism.MONGODB_CR, () => new MongoCR()],
+  [
+    AuthMechanism.MONGODB_CR,
+    () => {
+      throw new MongoInvalidArgumentError(
+        'MONGODB-CR is no longer a supported auth mechanism in MongoDB 4.0+'
+      );
+    }
+  ],
   [AuthMechanism.MONGODB_GSSAPI, () => new GSSAPI()],
   [AuthMechanism.MONGODB_OIDC, (workflow?: Workflow) => new MongoDBOIDC(workflow)],
   [AuthMechanism.MONGODB_PLAIN, () => new Plain()],

package/src/mongo_logger.ts

@@ -604,6 +604,7 @@ export function defaultLogTransform(
       log = attachConnectionFields(log, logObject);
       log.message = 'Connection ready';
       log.driverConnectionId = logObject.connectionId;
+      log.durationMS = logObject.durationMS;
       return log;
     case CONNECTION_CLOSED:
       log = attachConnectionFields(log, logObject);
@@ -653,11 +654,13 @@ export function defaultLogTransform(
         default:
           log.reason = `Unknown close reason: ${logObject.reason}`;
       }
+      log.durationMS = logObject.durationMS;
       return log;
     case CONNECTION_CHECKED_OUT:
       log = attachConnectionFields(log, logObject);
       log.message = 'Connection checked out';
       log.driverConnectionId = logObject.connectionId;
+      log.durationMS = logObject.durationMS;
       return log;
     case CONNECTION_CHECKED_IN:
       log = attachConnectionFields(log, logObject);
@@ -836,9 +839,9 @@ export class MongoLogger {
 
     if (isPromiseLike(this.pendingLog)) {
       this.pendingLog = this.pendingLog
-        // eslint-disable-next-line github/no-then
+
         .then(() => this.logDestination.write(logMessage))
-        // eslint-disable-next-line github/no-then
+
         .then(this.clearPendingLog.bind(this), this.logWriteFailureHandler.bind(this));
       return;
     }
@@ -846,7 +849,6 @@ export class MongoLogger {
     try {
       const logResult = this.logDestination.write(logMessage);
       if (isPromiseLike(logResult)) {
-        // eslint-disable-next-line github/no-then
         this.pendingLog = logResult.then(
           this.clearPendingLog.bind(this),
           this.logWriteFailureHandler.bind(this)

package/src/mongo_types.ts

@@ -34,11 +34,11 @@ export type InferIdType<TSchema> = TSchema extends { _id: infer IdType }
     ? never // explicitly forbid empty objects as the type of _id
     : IdType
   : TSchema extends { _id?: infer IdType }
-  ? // optional _id defined - return ObjectId | IdType
-    unknown extends IdType
-    ? ObjectId // infer the _id type as ObjectId if the type of _id is unknown
-    : IdType
-  : ObjectId; // user has not defined _id on schema
+    ? // optional _id defined - return ObjectId | IdType
+      unknown extends IdType
+      ? ObjectId // infer the _id type as ObjectId if the type of _id is unknown
+      : IdType
+    : ObjectId; // user has not defined _id on schema
 
 /** Add an _id field to an object shaped type @public */
 export type WithId<TSchema> = EnhancedOmit<TSchema, '_id'> & { _id: InferIdType<TSchema> };
@@ -68,8 +68,8 @@ export type OptionalUnlessRequiredId<TSchema> = TSchema extends { _id: any }
 export type EnhancedOmit<TRecordOrUnion, KeyUnion> = string extends keyof TRecordOrUnion
   ? TRecordOrUnion // TRecordOrUnion has indexed type e.g. { _id: string; [k: string]: any; } or it is "any"
   : TRecordOrUnion extends any
-  ? Pick<TRecordOrUnion, Exclude<keyof TRecordOrUnion, KeyUnion>> // discriminated unions
-  : never;
+    ? Pick<TRecordOrUnion, Exclude<keyof TRecordOrUnion, KeyUnion>> // discriminated unions
+    : never;
 
 /** Remove the _id field from an object shaped type @public */
 export type WithoutId<TSchema> = Omit<TSchema, '_id'>;
@@ -88,9 +88,8 @@ export type Condition<T> = AlternativeType<T> | FilterOperators<AlternativeType<
  * array types can be searched using their element type
  * @public
  */
-export type AlternativeType<T> = T extends ReadonlyArray<infer U>
-  ? T | RegExpOrString<U>
-  : RegExpOrString<T>;
+export type AlternativeType<T> =
+  T extends ReadonlyArray<infer U> ? T | RegExpOrString<U> : RegExpOrString<T>;
 
 /** @public */
 export type RegExpOrString<T> = T extends string ? BSONRegExp | RegExp | T : T;
@@ -192,9 +191,10 @@ export type IntegerType = number | Int32 | Long | bigint;
 export type NumericType = IntegerType | Decimal128 | Double;
 
 /** @public */
-export type FilterOperations<T> = T extends Record<string, any>
-  ? { [key in keyof T]?: FilterOperators<T[key]> }
-  : FilterOperators<T>;
+export type FilterOperations<T> =
+  T extends Record<string, any>
+    ? { [key in keyof T]?: FilterOperators<T[key]> }
+    : FilterOperators<T>;
 
 /** @public */
 export type KeysOfAType<TSchema, Type> = {
@@ -412,6 +412,7 @@ export declare interface TypedEventEmitter<Events extends EventsDescription> ext
  * @public
  */
 
+// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging
 export class TypedEventEmitter<Events extends EventsDescription> extends EventEmitter {
   /** @internal */
   protected mongoLogger?: MongoLogger;
@@ -480,31 +481,31 @@ export class CancellationToken extends TypedEventEmitter<{ cancel(): void }> {}
 export type Join<T extends unknown[], D extends string> = T extends []
   ? ''
   : T extends [string | number]
-  ? `${T[0]}`
-  : T extends [string | number, ...infer R]
-  ? `${T[0]}${D}${Join<R, D>}`
-  : string;
+    ? `${T[0]}`
+    : T extends [string | number, ...infer R]
+      ? `${T[0]}${D}${Join<R, D>}`
+      : string;
 
 /** @public */
 export type PropertyType<Type, Property extends string> = string extends Property
   ? unknown
   : Property extends keyof Type
-  ? Type[Property]
-  : Property extends `${number}`
-  ? Type extends ReadonlyArray<infer ArrayType>
-    ? ArrayType
-    : unknown
-  : Property extends `${infer Key}.${infer Rest}`
-  ? Key extends `${number}`
-    ? Type extends ReadonlyArray<infer ArrayType>
-      ? PropertyType<ArrayType, Rest>
-      : unknown
-    : Key extends keyof Type
-    ? Type[Key] extends Map<string, infer MapType>
-      ? MapType
-      : PropertyType<Type[Key], Rest>
-    : unknown
-  : unknown;
+    ? Type[Property]
+    : Property extends `${number}`
+      ? Type extends ReadonlyArray<infer ArrayType>
+        ? ArrayType
+        : unknown
+      : Property extends `${infer Key}.${infer Rest}`
+        ? Key extends `${number}`
+          ? Type extends ReadonlyArray<infer ArrayType>
+            ? PropertyType<ArrayType, Rest>
+            : unknown
+          : Key extends keyof Type
+            ? Type[Key] extends Map<string, infer MapType>
+              ? MapType
+              : PropertyType<Type[Key], Rest>
+            : unknown
+        : unknown;
 
 /**
  * @public
@@ -521,41 +522,41 @@ export type PropertyType<Type, Property extends string> = string extends Propert
 export type NestedPaths<Type, Depth extends number[]> = Depth['length'] extends 8
   ? []
   : Type extends
-      | string
-      | number
-      | bigint
-      | boolean
-      | Date
-      | RegExp
-      | Buffer
-      | Uint8Array
-      | ((...args: any[]) => any)
-      | { _bsontype: string }
-  ? []
-  : Type extends ReadonlyArray<infer ArrayType>
-  ? [] | [number, ...NestedPaths<ArrayType, [...Depth, 1]>]
-  : Type extends Map<string, any>
-  ? [string]
-  : Type extends object
-  ? {
-      [Key in Extract<keyof Type, string>]: Type[Key] extends Type // type of value extends the parent
-        ? [Key]
-        : // for a recursive union type, the child will never extend the parent type.
-        // but the parent will still extend the child
-        Type extends Type[Key]
-        ? [Key]
-        : Type[Key] extends ReadonlyArray<infer ArrayType> // handling recursive types with arrays
-        ? Type extends ArrayType // is the type of the parent the same as the type of the array?
-          ? [Key] // yes, it's a recursive array type
-          : // for unions, the child type extends the parent
-          ArrayType extends Type
-          ? [Key] // we have a recursive array union
-          : // child is an array, but it's not a recursive array
-            [Key, ...NestedPaths<Type[Key], [...Depth, 1]>]
-        : // child is not structured the same as the parent
-          [Key, ...NestedPaths<Type[Key], [...Depth, 1]>] | [Key];
-    }[Extract<keyof Type, string>]
-  : [];
+        | string
+        | number
+        | bigint
+        | boolean
+        | Date
+        | RegExp
+        | Buffer
+        | Uint8Array
+        | ((...args: any[]) => any)
+        | { _bsontype: string }
+    ? []
+    : Type extends ReadonlyArray<infer ArrayType>
+      ? [] | [number, ...NestedPaths<ArrayType, [...Depth, 1]>]
+      : Type extends Map<string, any>
+        ? [string]
+        : Type extends object
+          ? {
+              [Key in Extract<keyof Type, string>]: Type[Key] extends Type // type of value extends the parent
+                ? [Key]
+                : // for a recursive union type, the child will never extend the parent type.
+                  // but the parent will still extend the child
+                  Type extends Type[Key]
+                  ? [Key]
+                  : Type[Key] extends ReadonlyArray<infer ArrayType> // handling recursive types with arrays
+                    ? Type extends ArrayType // is the type of the parent the same as the type of the array?
+                      ? [Key] // yes, it's a recursive array type
+                      : // for unions, the child type extends the parent
+                        ArrayType extends Type
+                        ? [Key] // we have a recursive array union
+                        : // child is an array, but it's not a recursive array
+                          [Key, ...NestedPaths<Type[Key], [...Depth, 1]>]
+                    : // child is not structured the same as the parent
+                      [Key, ...NestedPaths<Type[Key], [...Depth, 1]>] | [Key];
+            }[Extract<keyof Type, string>]
+          : [];
 
 /**
  * @public

package/src/operations/aggregate.ts

@@ -9,8 +9,9 @@ import { type CollationOptions, CommandOperation, type CommandOperationOptions }
 import { Aspect, defineAspects, type Hint } from './operation';
 
 /** @internal */
+// eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
 export const DB_AGGREGATE_COLLECTION = 1 as const;
-const MIN_WIRE_VERSION_$OUT_READ_CONCERN_SUPPORT = 8 as const;
+const MIN_WIRE_VERSION_$OUT_READ_CONCERN_SUPPORT = 8;
 
 /** @public */
 export interface AggregateOptions extends CommandOperationOptions {

package/src/operations/bulk_write.ts

@@ -13,11 +13,11 @@ import { AbstractOperation, Aspect, defineAspects } from './operation';
 export class BulkWriteOperation extends AbstractOperation<BulkWriteResult> {
   override options: BulkWriteOptions;
   collection: Collection;
-  operations: AnyBulkWriteOperation[];
+  operations: ReadonlyArray<AnyBulkWriteOperation>;
 
   constructor(
     collection: Collection,
-    operations: AnyBulkWriteOperation[],
+    operations: ReadonlyArray<AnyBulkWriteOperation>,
     options: BulkWriteOptions
   ) {
     super(options);