mongodb 5.0.1 → 5.2.0

package/src/cmap/connection_pool.ts

@@ -16,8 +16,11 @@ import {
   CONNECTION_READY
 } from '../constants';
 import {
+  AnyError,
+  MONGODB_ERROR_CODES,
   MongoError,
   MongoInvalidArgumentError,
+  MongoMissingCredentialsError,
   MongoNetworkError,
   MongoRuntimeError,
   MongoServerError
@@ -25,7 +28,7 @@ import {
 import { CancellationToken, TypedEventEmitter } from '../mongo_types';
 import type { Server } from '../sdam/server';
 import { Callback, eachAsync, List, makeCounter } from '../utils';
-import { connect } from './connect';
+import { AUTH_PROVIDERS, connect } from './connect';
 import { Connection, ConnectionEvents, ConnectionOptions } from './connection';
 import {
   ConnectionCheckedInEvent,
@@ -135,7 +138,7 @@ export type ConnectionPoolEvents = {
  */
 export class ConnectionPool extends TypedEventEmitter<ConnectionPoolEvents> {
   options: Readonly<ConnectionPoolOptions>;
-  [kPoolState]: typeof PoolState[keyof typeof PoolState];
+  [kPoolState]: (typeof PoolState)[keyof typeof PoolState];
   [kServer]: Server;
   [kConnections]: List<Connection>;
   [kPending]: number;
@@ -510,7 +513,7 @@ export class ConnectionPool extends TypedEventEmitter<ConnectionPoolEvents> {
           ConnectionPool.CONNECTION_CLOSED,
           new ConnectionClosedEvent(this, conn, 'poolClosed')
         );
-        conn.destroy(options, cb);
+        conn.destroy({ force: !!options.force }, cb);
       },
       err => {
         this[kConnections].clear();
@@ -537,32 +540,30 @@ export class ConnectionPool extends TypedEventEmitter<ConnectionPoolEvents> {
   withConnection(
     conn: Connection | undefined,
     fn: WithConnectionCallback,
-    callback?: Callback<Connection>
+    callback: Callback<Connection>
   ): void {
     if (conn) {
       // use the provided connection, and do _not_ check it in after execution
       fn(undefined, conn, (fnErr, result) => {
-        if (typeof callback === 'function') {
-          if (fnErr) {
-            callback(fnErr);
-          } else {
-            callback(undefined, result);
-          }
+        if (fnErr) {
+          return this.withReauthentication(fnErr, conn, fn, callback);
         }
+        callback(undefined, result);
       });
-
       return;
     }
 
     this.checkOut((err, conn) => {
       // don't callback with `err` here, we might want to act upon it inside `fn`
       fn(err as MongoError, conn, (fnErr, result) => {
-        if (typeof callback === 'function') {
-          if (fnErr) {
-            callback(fnErr);
+        if (fnErr) {
+          if (conn) {
+            this.withReauthentication(fnErr, conn, fn, callback);
           } else {
-            callback(undefined, result);
+            callback(fnErr);
           }
+        } else {
+          callback(undefined, result);
         }
 
         if (conn) {
@@ -572,6 +573,66 @@ export class ConnectionPool extends TypedEventEmitter<ConnectionPoolEvents> {
     });
   }
 
+  private withReauthentication(
+    fnErr: AnyError,
+    conn: Connection,
+    fn: WithConnectionCallback,
+    callback: Callback<Connection>
+  ) {
+    if (fnErr instanceof MongoError && fnErr.code === MONGODB_ERROR_CODES.Reauthenticate) {
+      this.reauthenticate(conn, fn, (error, res) => {
+        if (error) {
+          return callback(error);
+        }
+        callback(undefined, res);
+      });
+    } else {
+      callback(fnErr);
+    }
+  }
+
+  /**
+   * Reauthenticate on the same connection and then retry the operation.
+   */
+  private reauthenticate(
+    connection: Connection,
+    fn: WithConnectionCallback,
+    callback: Callback
+  ): void {
+    const authContext = connection.authContext;
+    if (!authContext) {
+      return callback(new MongoRuntimeError('No auth context found on connection.'));
+    }
+    const credentials = authContext.credentials;
+    if (!credentials) {
+      return callback(
+        new MongoMissingCredentialsError(
+          'Connection is missing credentials when asked to reauthenticate'
+        )
+      );
+    }
+    const resolvedCredentials = credentials.resolveAuthMechanism(connection.hello || undefined);
+    const provider = AUTH_PROVIDERS.get(resolvedCredentials.mechanism);
+    if (!provider) {
+      return callback(
+        new MongoMissingCredentialsError(
+          `Reauthenticate failed due to no auth provider for ${credentials.mechanism}`
+        )
+      );
+    }
+    provider.reauth(authContext).then(
+      () => {
+        fn(undefined, connection, (fnErr, fnResult) => {
+          if (fnErr) {
+            return callback(fnErr);
+          }
+          callback(undefined, fnResult);
+        });
+      },
+      error => callback(error)
+    );
+  }
+
   /** Clear the min pool size timer */
   private clearMinPoolSizeTimer(): void {
     const minPoolSizeTimer = this[kMinPoolSizeTimer];
@@ -586,7 +647,7 @@ export class ConnectionPool extends TypedEventEmitter<ConnectionPoolEvents> {
       new ConnectionClosedEvent(this, connection, reason)
     );
     // destroy the connection
-    process.nextTick(() => connection.destroy());
+    process.nextTick(() => connection.destroy({ force: false }));
   }
 
   private connectionIsStale(connection: Connection) {

package/src/cmap/message_stream.ts

@@ -30,13 +30,11 @@ export interface MessageStreamOptions extends DuplexOptions {
 export interface OperationDescription extends BSONSerializeOptions {
   started: number;
   cb: Callback<Document>;
-  command: boolean;
   documentsReturnedIn?: string;
   noResponse: boolean;
   raw: boolean;
   requestId: number;
   session?: ClientSession;
-  socketTimeoutOverride?: boolean;
   agreedCompressor?: CompressorName;
   zlibCompressionLevel?: number;
   $clusterTime?: Document;

package/src/cmap/wire_protocol/compression.ts

@@ -14,7 +14,7 @@ export const Compressor = Object.freeze({
 } as const);
 
 /** @public */
-export type Compressor = typeof Compressor[CompressorName];
+export type Compressor = (typeof Compressor)[CompressorName];
 
 /** @public */
 export type CompressorName = keyof typeof Compressor;

package/src/cmap/wire_protocol/shared.ts

@@ -7,8 +7,7 @@ import type { Server } from '../../sdam/server';
 import type { ServerDescription } from '../../sdam/server_description';
 import type { Topology } from '../../sdam/topology';
 import { TopologyDescription } from '../../sdam/topology_description';
-import type { OpQueryOptions } from '../commands';
-import type { CommandOptions, Connection } from '../connection';
+import type { Connection } from '../connection';
 
 export interface ReadPreferenceOption {
   readPreference?: ReadPreferenceLike;
@@ -35,27 +34,6 @@ export function getReadPreference(cmd: Document, options?: ReadPreferenceOption)
   return readPreference;
 }
 
-export function applyCommonQueryOptions(
-  queryOptions: OpQueryOptions,
-  options: CommandOptions
-): CommandOptions {
-  Object.assign(queryOptions, {
-    raw: typeof options.raw === 'boolean' ? options.raw : false,
-    promoteLongs: typeof options.promoteLongs === 'boolean' ? options.promoteLongs : true,
-    promoteValues: typeof options.promoteValues === 'boolean' ? options.promoteValues : true,
-    promoteBuffers: typeof options.promoteBuffers === 'boolean' ? options.promoteBuffers : false,
-    bsonRegExp: typeof options.bsonRegExp === 'boolean' ? options.bsonRegExp : false,
-    enableUtf8Validation:
-      typeof options.enableUtf8Validation === 'boolean' ? options.enableUtf8Validation : true
-  });
-
-  if (options.session) {
-    queryOptions.session = options.session;
-  }
-
-  return queryOptions;
-}
-
 export function isSharded(topologyOrServer?: Topology | Server | Connection): boolean {
   if (topologyOrServer == null) {
     return false;

package/src/collection.ts

@@ -92,7 +92,7 @@ import { WriteConcern, WriteConcernOptions } from './write_concern';
 
 /**
  * @public
- * @deprecated This type will be completely removed in 5.0 and findOneAndUpdate,
+ * @deprecated This type will be completely removed and findOneAndUpdate,
  *             findOneAndDelete, and findOneAndReplace will then return the
  *             actual result document.
  */
@@ -568,7 +568,7 @@ export class Collection<TSchema extends Document = Document> {
    * error.
    *
    * **Note**: Unlike {@link Collection#createIndex| createIndex}, this function takes in raw index specifications.
-   * Index specifications are defined {@link http://docs.mongodb.org/manual/reference/command/createIndexes/| here}.
+   * Index specifications are defined {@link https://www.mongodb.com/docs/manual/reference/command/createIndexes/| here}.
    *
    * @param indexSpecs - An array of index specifications to be created
    * @param options - Optional settings for the command
@@ -705,18 +705,18 @@ export class Collection<TSchema extends Document = Document> {
    * | `$near`    | [`$geoWithin`][2] with [`$center`][3] |
    * | `$nearSphere` | [`$geoWithin`][2] with [`$centerSphere`][4] |
    *
-   * [1]: https://docs.mongodb.com/manual/reference/operator/query/expr/
-   * [2]: https://docs.mongodb.com/manual/reference/operator/query/geoWithin/
-   * [3]: https://docs.mongodb.com/manual/reference/operator/query/center/#op._S_center
-   * [4]: https://docs.mongodb.com/manual/reference/operator/query/centerSphere/#op._S_centerSphere
+   * [1]: https://www.mongodb.com/docs/manual/reference/operator/query/expr/
+   * [2]: https://www.mongodb.com/docs/manual/reference/operator/query/geoWithin/
+   * [3]: https://www.mongodb.com/docs/manual/reference/operator/query/center/#op._S_center
+   * [4]: https://www.mongodb.com/docs/manual/reference/operator/query/centerSphere/#op._S_centerSphere
    *
    * @param filter - The filter for the count
    * @param options - Optional settings for the command
    *
-   * @see https://docs.mongodb.com/manual/reference/operator/query/expr/
-   * @see https://docs.mongodb.com/manual/reference/operator/query/geoWithin/
-   * @see https://docs.mongodb.com/manual/reference/operator/query/center/#op._S_center
-   * @see https://docs.mongodb.com/manual/reference/operator/query/centerSphere/#op._S_centerSphere
+   * @see https://www.mongodb.com/docs/manual/reference/operator/query/expr/
+   * @see https://www.mongodb.com/docs/manual/reference/operator/query/geoWithin/
+   * @see https://www.mongodb.com/docs/manual/reference/operator/query/center/#op._S_center
+   * @see https://www.mongodb.com/docs/manual/reference/operator/query/centerSphere/#op._S_centerSphere
    */
   async countDocuments(
     filter: Document = {},
@@ -916,7 +916,7 @@ export class Collection<TSchema extends Document = Document> {
    *   });
    * ```
    *
-   * @param pipeline - An array of {@link https://docs.mongodb.com/manual/reference/operator/aggregation-pipeline/|aggregation pipeline stages} through which to pass change stream documents. This allows for filtering (using $match) and manipulating the change stream documents.
+   * @param pipeline - An array of {@link https://www.mongodb.com/docs/manual/reference/operator/aggregation-pipeline/|aggregation pipeline stages} through which to pass change stream documents. This allows for filtering (using $match) and manipulating the change stream documents.
    * @param options - Optional settings for the command
    * @typeParam TLocal - Type of the data being detected by the change stream
    * @typeParam TChange - Type of the whole change stream document emitted

package/src/connection_string.ts

@@ -15,7 +15,6 @@ import {
   MongoParseError
 } from './error';
 import {
-  DriverInfo,
   MongoClient,
   MongoClientOptions,
   MongoOptions,
@@ -255,6 +254,15 @@ export function parseOptions(
     mongoClient = undefined;
   }
 
+  // validate BSONOptions
+  if (options.useBigInt64 && typeof options.promoteLongs === 'boolean' && !options.promoteLongs) {
+    throw new MongoAPIError('Must request either bigint or Long for int64 deserialization');
+  }
+
+  if (options.useBigInt64 && typeof options.promoteValues === 'boolean' && !options.promoteValues) {
+    throw new MongoAPIError('Must request either bigint or Long for int64 deserialization');
+  }
+
   const url = new ConnectionString(uri);
   const { hosts, isSRV } = url;
 
@@ -386,6 +394,7 @@ export function parseOptions(
     const isGssapi = mongoOptions.credentials.mechanism === AuthMechanism.MONGODB_GSSAPI;
     const isX509 = mongoOptions.credentials.mechanism === AuthMechanism.MONGODB_X509;
     const isAws = mongoOptions.credentials.mechanism === AuthMechanism.MONGODB_AWS;
+    const isOidc = mongoOptions.credentials.mechanism === AuthMechanism.MONGODB_OIDC;
     if (
       (isGssapi || isX509) &&
       allOptions.has('authSource') &&
@@ -393,11 +402,15 @@ export function parseOptions(
     ) {
       // If authSource was explicitly given and its incorrect, we error
       throw new MongoParseError(
-        `${mongoOptions.credentials} can only have authSource set to '$external'`
+        `authMechanism ${mongoOptions.credentials.mechanism} requires an authSource of '$external'`
       );
     }
 
-    if (!(isGssapi || isX509 || isAws) && mongoOptions.dbName && !allOptions.has('authSource')) {
+    if (
+      !(isGssapi || isX509 || isAws || isOidc) &&
+      mongoOptions.dbName &&
+      !allOptions.has('authSource')
+    ) {
       // inherit the dbName unless GSSAPI or X509, then silently ignore dbName
       // and there was no specific authSource given
       mongoOptions.credentials = MongoCredentials.merge(mongoOptions.credentials, {
@@ -517,7 +530,8 @@ export function parseOptions(
       MONGODB_LOG_CONNECTION: process.env.MONGODB_LOG_CONNECTION,
       MONGODB_LOG_ALL: process.env.MONGODB_LOG_ALL,
       MONGODB_LOG_MAX_DOCUMENT_LENGTH: process.env.MONGODB_LOG_MAX_DOCUMENT_LENGTH,
-      MONGODB_LOG_PATH: process.env.MONGODB_LOG_PATH
+      MONGODB_LOG_PATH: process.env.MONGODB_LOG_PATH,
+      ...mongoOptions[Symbol.for('@@mdb.internalLoggerConfig')]
     };
     loggerClientOptions = {
       mongodbLogPath: mongoOptions.mongodbLogPath
@@ -528,6 +542,8 @@ export function parseOptions(
     loggerClientOptions
   );
 
+  mongoOptions.metadata = makeClientMetadata(mongoOptions);
+
   return mongoOptions;
 }
 
@@ -629,10 +645,7 @@ interface OptionDescriptor {
 
 export const OPTIONS = {
   appName: {
-    target: 'metadata',
-    transform({ options, values: [value] }): DriverInfo {
-      return makeClientMetadata({ ...options.driverInfo, appName: String(value) });
-    }
+    type: 'string'
   },
   auth: {
     target: 'credentials',
@@ -678,26 +691,31 @@ export const OPTIONS = {
   },
   authMechanismProperties: {
     target: 'credentials',
-    transform({ options, values: [optionValue] }): MongoCredentials {
-      if (typeof optionValue === 'string') {
-        const mechanismProperties = Object.create(null);
-
-        for (const [key, value] of entriesFromString(optionValue)) {
-          try {
-            mechanismProperties[key] = getBoolean(key, value);
-          } catch {
-            mechanismProperties[key] = value;
+    transform({ options, values }): MongoCredentials {
+      // We can have a combination of options passed in the URI and options passed
+      // as an object to the MongoClient. So we must transform the string options
+      // as well as merge them together with a potentially provided object.
+      let mechanismProperties = Object.create(null);
+
+      for (const optionValue of values) {
+        if (typeof optionValue === 'string') {
+          for (const [key, value] of entriesFromString(optionValue)) {
+            try {
+              mechanismProperties[key] = getBoolean(key, value);
+            } catch {
+              mechanismProperties[key] = value;
+            }
+          }
+        } else {
+          if (!isRecord(optionValue)) {
+            throw new MongoParseError('AuthMechanismProperties must be an object');
           }
+          mechanismProperties = { ...optionValue };
         }
-
-        return MongoCredentials.merge(options.credentials, {
-          mechanismProperties
-        });
-      }
-      if (!isRecord(optionValue)) {
-        throw new MongoParseError('AuthMechanismProperties must be an object');
       }
-      return MongoCredentials.merge(options.credentials, { mechanismProperties: optionValue });
+      return MongoCredentials.merge(options.credentials, {
+        mechanismProperties
+      });
     }
   },
   authSource: {
@@ -778,15 +796,8 @@ export const OPTIONS = {
     type: 'boolean'
   },
   driverInfo: {
-    target: 'metadata',
-    default: makeClientMetadata(),
-    transform({ options, values: [value] }) {
-      if (!isRecord(value)) throw new MongoParseError('DriverInfo must be an object');
-      return makeClientMetadata({
-        driverInfo: value,
-        appName: options.metadata?.application?.name
-      });
-    }
+    default: {},
+    type: 'record'
   },
   enableUtf8Validation: { type: 'boolean', default: true },
   family: {
@@ -945,6 +956,9 @@ export const OPTIONS = {
   promoteValues: {
     type: 'boolean'
   },
+  useBigInt64: {
+    type: 'boolean'
+  },
   proxyHost: {
     type: 'string'
   },
@@ -1260,7 +1274,10 @@ export const OPTIONS = {
   index: { type: 'any' },
   // Legacy Options, these are unused but left here to avoid errors with CSFLE lib
   useNewUrlParser: { type: 'boolean' } as OptionDescriptor,
-  useUnifiedTopology: { type: 'boolean' } as OptionDescriptor
+  useUnifiedTopology: { type: 'boolean' } as OptionDescriptor,
+  // MongoLogger
+  // TODO(NODE-4849): Tighten the type of mongodbLogPath
+  mongodbLogPath: { type: 'any' }
 } as Record<keyof MongoClientOptions, OptionDescriptor>;
 
 export const DEFAULT_OPTIONS = new CaseInsensitiveMap(

package/src/cursor/abstract_cursor.ts

@@ -65,7 +65,7 @@ export interface CursorStreamOptions {
 }
 
 /** @public */
-export type CursorFlag = typeof CURSOR_FLAGS[number];
+export type CursorFlag = (typeof CURSOR_FLAGS)[number];
 
 /** @public */
 export interface AbstractCursorOptions extends BSONSerializeOptions {
@@ -557,7 +557,7 @@ export abstract class AbstractCursor<
   /**
    * Set the batch size for the cursor.
    *
-   * @param value - The number of documents to return per batch. See {@link https://docs.mongodb.com/manual/reference/command/find/|find command documentation}.
+   * @param value - The number of documents to return per batch. See {@link https://www.mongodb.com/docs/manual/reference/command/find/|find command documentation}.
    */
   batchSize(value: number): this {
     assertUninitialized(this);
@@ -642,6 +642,8 @@ export abstract class AbstractCursor<
           this[kId] =
             typeof response.cursor.id === 'number'
               ? Long.fromNumber(response.cursor.id)
+              : typeof response.cursor.id === 'bigint'
+              ? Long.fromBigInt(response.cursor.id)
               : response.cursor.id;
 
           if (response.cursor.ns) {
@@ -741,6 +743,8 @@ export function next<T>(
       const cursorId =
         typeof response.cursor.id === 'number'
           ? Long.fromNumber(response.cursor.id)
+          : typeof response.cursor.id === 'bigint'
+          ? Long.fromBigInt(response.cursor.id)
           : response.cursor.id;
 
       cursor[kDocuments].pushMany(response.cursor.nextBatch);
@@ -828,13 +832,16 @@ function cleanupCursor(
 
   cursor[kKilled] = true;
 
+  if (session.hasEnded) {
+    return completeCleanup();
+  }
+
   executeOperation(
     cursor[kClient],
     new KillCursorsOperation(cursorId, cursorNs, server, { session })
-  ).finally(() => {
-    completeCleanup();
-  });
-  return;
+  )
+    .catch(() => null)
+    .finally(completeCleanup);
 }
 
 /** @internal */

package/src/cursor/change_stream_cursor.ts

@@ -1,20 +1,20 @@
 import type { Document, Long, Timestamp } from '../bson';
 import {
+  ChangeStream,
   type ChangeStreamDocument,
   type ChangeStreamEvents,
   type OperationTime,
-  type ResumeToken,
-  ChangeStream
+  type ResumeToken
 } from '../change_stream';
 import { INIT, RESPONSE } from '../constants';
 import type { MongoClient } from '../mongo_client';
 import type { TODO_NODE_3286 } from '../mongo_types';
 import { AggregateOperation } from '../operations/aggregate';
 import type { CollationOptions } from '../operations/command';
-import { type ExecutionResult, executeOperation } from '../operations/execute_operation';
+import { executeOperation, type ExecutionResult } from '../operations/execute_operation';
 import type { ClientSession } from '../sessions';
-import { type Callback, type MongoDBNamespace, maxWireVersion } from '../utils';
-import { type AbstractCursorOptions, AbstractCursor } from './abstract_cursor';
+import { type Callback, maxWireVersion, type MongoDBNamespace } from '../utils';
+import { AbstractCursor, type AbstractCursorOptions } from './abstract_cursor';
 
 /** @internal */
 export interface ChangeStreamCursorOptions extends AbstractCursorOptions {

package/src/cursor/find_cursor.ts

@@ -386,7 +386,7 @@ export class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
    * Allows disk use for blocking sort operations exceeding 100MB memory. (MongoDB 3.2 or higher)
    *
    * @remarks
-   * {@link https://docs.mongodb.com/manual/reference/command/find/#find-cmd-allowdiskuse | find command allowDiskUse documentation}
+   * {@link https://www.mongodb.com/docs/manual/reference/command/find/#find-cmd-allowdiskuse | find command allowDiskUse documentation}
    */
   allowDiskUse(allow = true): this {
     assertUninitialized(this);

package/src/db.ts

@@ -57,6 +57,7 @@ const DB_OPTIONS_ALLOW_LIST = [
   'readConcern',
   'retryMiliSeconds',
   'numberOfRetries',
+  'useBigInt64',
   'promoteBuffers',
   'promoteLongs',
   'bsonRegExp',
@@ -210,7 +211,7 @@ export class Db {
 
   /**
    * Create a new collection on a server with the specified options. Use this to create capped collections.
-   * More information about command options available at https://docs.mongodb.com/manual/reference/command/create/
+   * More information about command options available at https://www.mongodb.com/docs/manual/reference/command/create/
    *
    * @param name - The name of the collection to create
    * @param options - Optional settings for the command
@@ -487,7 +488,7 @@ export class Db {
    * - The first is to provide the schema that may be defined for all the collections within this database
    * - The second is to override the shape of the change stream document entirely, if it is not provided the type will default to ChangeStreamDocument of the first argument
    *
-   * @param pipeline - An array of {@link https://docs.mongodb.com/manual/reference/operator/aggregation-pipeline/|aggregation pipeline stages} through which to pass change stream documents. This allows for filtering (using $match) and manipulating the change stream documents.
+   * @param pipeline - An array of {@link https://www.mongodb.com/docs/manual/reference/operator/aggregation-pipeline/|aggregation pipeline stages} through which to pass change stream documents. This allows for filtering (using $match) and manipulating the change stream documents.
    * @param options - Optional settings for the command
    * @typeParam TSchema - Type of the data being detected by the change stream
    * @typeParam TChange - Type of the whole change stream document emitted