mongodb 6.5.0 → 6.6.0-dev.20240504.sha.2609953

package/src/db.ts

@@ -11,7 +11,6 @@ import type { MongoClient, PkFactory } from './mongo_client';
 import type { TODO_NODE_3286 } from './mongo_types';
 import type { AggregateOptions } from './operations/aggregate';
 import { CollectionsOperation } from './operations/collections';
-import type { IndexInformationOptions } from './operations/common_functions';
 import {
   CreateCollectionOperation,
   type CreateCollectionOptions
@@ -24,9 +23,11 @@ import {
 } from './operations/drop';
 import { executeOperation } from './operations/execute_operation';
 import {
+  CreateIndexesOperation,
   type CreateIndexesOptions,
-  CreateIndexOperation,
-  IndexInformationOperation,
+  type IndexDescriptionCompact,
+  type IndexDescriptionInfo,
+  type IndexInformationOptions,
   type IndexSpecification
 } from './operations/indexes';
 import type { CollectionInfo, ListCollectionsOptions } from './operations/list_collections';
@@ -67,7 +68,8 @@ const DB_OPTIONS_ALLOW_LIST = [
   'enableUtf8Validation',
   'promoteValues',
   'compression',
-  'retryWrites'
+  'retryWrites',
+  'timeoutMS'
 ];
 
 /** @internal */
@@ -95,6 +97,8 @@ export interface DbOptions extends BSONSerializeOptions, WriteConcernOptions {
   readConcern?: ReadConcern;
   /** Should retry failed writes */
   retryWrites?: boolean;
+  /** @internal TODO(NODE-5688): make this public */
+  timeoutMS?: number;
 }
 
 /**
@@ -231,7 +235,7 @@ export class Db {
     name: string,
     options?: CreateCollectionOptions
   ): Promise<Collection<TSchema>> {
-    return executeOperation(
+    return await executeOperation(
       this.client,
       new CreateCollectionOperation(this, name, resolveOptions(this, options)) as TODO_NODE_3286
     );
@@ -264,7 +268,7 @@ export class Db {
    */
   async command(command: Document, options?: RunCommandOptions): Promise<Document> {
     // Intentionally, we do not inherit options from parent for this operation.
-    return executeOperation(
+    return await executeOperation(
       this.client,
       new RunCommandOperation(this, command, {
         ...resolveBSONOptions(options),
@@ -321,7 +325,10 @@ export class Db {
    * @param options - Optional settings for the command
    */
   async stats(options?: DbStatsOptions): Promise<Document> {
-    return executeOperation(this.client, new DbStatsOperation(this, resolveOptions(this, options)));
+    return await executeOperation(
+      this.client,
+      new DbStatsOperation(this, resolveOptions(this, options))
+    );
   }
 
   /**
@@ -367,7 +374,7 @@ export class Db {
     options?: RenameOptions
   ): Promise<Collection<TSchema>> {
     // Intentionally, we do not inherit options from parent for this operation.
-    return executeOperation(
+    return await executeOperation(
       this.client,
       new RenameOperation(
         this.collection<TSchema>(fromCollection) as TODO_NODE_3286,
@@ -384,7 +391,7 @@ export class Db {
    * @param options - Optional settings for the command
    */
   async dropCollection(name: string, options?: DropCollectionOptions): Promise<boolean> {
-    return executeOperation(
+    return await executeOperation(
       this.client,
       new DropCollectionOperation(this, name, resolveOptions(this, options))
     );
@@ -396,7 +403,7 @@ export class Db {
    * @param options - Optional settings for the command
    */
   async dropDatabase(options?: DropDatabaseOptions): Promise<boolean> {
-    return executeOperation(
+    return await executeOperation(
       this.client,
       new DropDatabaseOperation(this, resolveOptions(this, options))
     );
@@ -408,7 +415,7 @@ export class Db {
    * @param options - Optional settings for the command
    */
   async collections(options?: ListCollectionsOptions): Promise<Collection[]> {
-    return executeOperation(
+    return await executeOperation(
       this.client,
       new CollectionsOperation(this, resolveOptions(this, options))
     );
@@ -426,10 +433,11 @@ export class Db {
     indexSpec: IndexSpecification,
     options?: CreateIndexesOptions
   ): Promise<string> {
-    return executeOperation(
+    const indexes = await executeOperation(
       this.client,
-      new CreateIndexOperation(this, name, indexSpec, resolveOptions(this, options))
+      CreateIndexesOperation.fromIndexSpecification(this, name, indexSpec, options)
     );
+    return indexes[0];
   }
 
   /**
@@ -439,7 +447,7 @@ export class Db {
    * @param options - Optional settings for the command
    */
   async removeUser(username: string, options?: RemoveUserOptions): Promise<boolean> {
-    return executeOperation(
+    return await executeOperation(
       this.client,
       new RemoveUserOperation(this, username, resolveOptions(this, options))
     );
@@ -455,7 +463,7 @@ export class Db {
     level: ProfilingLevel,
     options?: SetProfilingLevelOptions
   ): Promise<ProfilingLevel> {
-    return executeOperation(
+    return await executeOperation(
       this.client,
       new SetProfilingLevelOperation(this, level, resolveOptions(this, options))
     );
@@ -467,7 +475,7 @@ export class Db {
    * @param options - Optional settings for the command
    */
   async profilingLevel(options?: ProfilingLevelOptions): Promise<string> {
-    return executeOperation(
+    return await executeOperation(
       this.client,
       new ProfilingLevelOperation(this, resolveOptions(this, options))
     );
@@ -479,11 +487,24 @@ export class Db {
    * @param name - The name of the collection.
    * @param options - Optional settings for the command
    */
-  async indexInformation(name: string, options?: IndexInformationOptions): Promise<Document> {
-    return executeOperation(
-      this.client,
-      new IndexInformationOperation(this, name, resolveOptions(this, options))
-    );
+  indexInformation(
+    name: string,
+    options: IndexInformationOptions & { full: true }
+  ): Promise<IndexDescriptionInfo[]>;
+  indexInformation(
+    name: string,
+    options: IndexInformationOptions & { full?: false }
+  ): Promise<IndexDescriptionCompact>;
+  indexInformation(
+    name: string,
+    options: IndexInformationOptions
+  ): Promise<IndexDescriptionCompact | IndexDescriptionInfo[]>;
+  indexInformation(name: string): Promise<IndexDescriptionCompact>;
+  async indexInformation(
+    name: string,
+    options?: IndexInformationOptions
+  ): Promise<IndexDescriptionCompact | IndexDescriptionInfo[]> {
+    return await this.collection(name).indexInformation(resolveOptions(this, options));
   }
 
   /**

package/src/deps.ts

@@ -18,21 +18,22 @@ function makeErrorModule(error: any) {
   });
 }
 
-export let Kerberos: typeof import('kerberos') | { kModuleError: MongoMissingDependencyError } =
-  makeErrorModule(
-    new MongoMissingDependencyError(
-      'Optional module `kerberos` not found. Please install it to enable kerberos authentication'
-    )
-  );
+export type Kerberos = typeof import('kerberos') | { kModuleError: MongoMissingDependencyError };
 
-export function getKerberos(): typeof Kerberos | { kModuleError: MongoMissingDependencyError } {
+export function getKerberos(): Kerberos {
+  let kerberos: Kerberos;
   try {
     // Ensure you always wrap an optional require in the try block NODE-3199
-    Kerberos = require('kerberos');
-    return Kerberos;
-  } catch {
-    return Kerberos;
+    kerberos = require('kerberos');
+  } catch (error) {
+    kerberos = makeErrorModule(
+      new MongoMissingDependencyError(
+        'Optional module `kerberos` not found. Please install it to enable kerberos authentication',
+        { cause: error, dependencyName: 'kerberos' }
+      )
+    );
   }
+  return kerberos;
 }
 
 export interface KerberosClient {
@@ -57,20 +58,22 @@ type ZStandardLib = {
   decompress(buf: Buffer): Promise<Buffer>;
 };
 
-export let ZStandard: ZStandardLib | { kModuleError: MongoMissingDependencyError } =
-  makeErrorModule(
-    new MongoMissingDependencyError(
-      'Optional module `@mongodb-js/zstd` not found. Please install it to enable zstd compression'
-    )
-  );
+export type ZStandard = ZStandardLib | { kModuleError: MongoMissingDependencyError };
 
-export function getZstdLibrary(): typeof ZStandard | { kModuleError: MongoMissingDependencyError } {
+export function getZstdLibrary(): ZStandardLib | { kModuleError: MongoMissingDependencyError } {
+  let ZStandard: ZStandardLib | { kModuleError: MongoMissingDependencyError };
   try {
     ZStandard = require('@mongodb-js/zstd');
-    return ZStandard;
-  } catch {
-    return ZStandard;
+  } catch (error) {
+    ZStandard = makeErrorModule(
+      new MongoMissingDependencyError(
+        'Optional module `@mongodb-js/zstd` not found. Please install it to enable zstd compression',
+        { cause: error, dependencyName: 'zstd' }
+      )
+    );
   }
+
+  return ZStandard;
 }
 
 /**
@@ -100,11 +103,12 @@ export function getAwsCredentialProvider():
     // Ensure you always wrap an optional require in the try block NODE-3199
     const credentialProvider = require('@aws-sdk/credential-providers');
     return credentialProvider;
-  } catch {
+  } catch (error) {
     return makeErrorModule(
       new MongoMissingDependencyError(
         'Optional module `@aws-sdk/credential-providers` not found.' +
-          ' Please install it to enable getting aws credentials via the official sdk.'
+          ' Please install it to enable getting aws credentials via the official sdk.',
+        { cause: error, dependencyName: '@aws-sdk/credential-providers' }
       )
     );
   }
@@ -120,11 +124,12 @@ export function getGcpMetadata(): GcpMetadata {
     // Ensure you always wrap an optional require in the try block NODE-3199
     const credentialProvider = require('gcp-metadata');
     return credentialProvider;
-  } catch {
+  } catch (error) {
     return makeErrorModule(
       new MongoMissingDependencyError(
         'Optional module `gcp-metadata` not found.' +
-          ' Please install it to enable getting gcp credentials via the official sdk.'
+          ' Please install it to enable getting gcp credentials via the official sdk.',
+        { cause: error, dependencyName: 'gcp-metadata' }
       )
     );
   }
@@ -150,10 +155,10 @@ export function getSnappy(): SnappyLib | { kModuleError: MongoMissingDependencyE
     // Ensure you always wrap an optional require in the try block NODE-3199
     const value = require('snappy');
     return value;
-  } catch (cause) {
+  } catch (error) {
     const kModuleError = new MongoMissingDependencyError(
       'Optional module `snappy` not found. Please install it to enable snappy compression',
-      { cause }
+      { cause: error, dependencyName: 'snappy' }
     );
     return { kModuleError };
   }
@@ -184,10 +189,10 @@ export function getSocks(): SocksLib | { kModuleError: MongoMissingDependencyErr
     // Ensure you always wrap an optional require in the try block NODE-3199
     const value = require('socks');
     return value;
-  } catch (cause) {
+  } catch (error) {
     const kModuleError = new MongoMissingDependencyError(
       'Optional module `socks` not found. Please install it to connections over a SOCKS5 proxy',
-      { cause }
+      { cause: error, dependencyName: 'socks' }
     );
     return { kModuleError };
   }
@@ -234,16 +239,23 @@ interface AWS4 {
   };
 }
 
-export let aws4: AWS4 | { kModuleError: MongoMissingDependencyError } = makeErrorModule(
-  new MongoMissingDependencyError(
-    'Optional module `aws4` not found. Please install it to enable AWS authentication'
-  )
-);
+export const aws4: AWS4 | { kModuleError: MongoMissingDependencyError } = loadAws4();
 
-try {
-  // Ensure you always wrap an optional require in the try block NODE-3199
-  aws4 = require('aws4');
-} catch {} // eslint-disable-line
+function loadAws4() {
+  let aws4: AWS4 | { kModuleError: MongoMissingDependencyError };
+  try {
+    aws4 = require('aws4');
+  } catch (error) {
+    aws4 = makeErrorModule(
+      new MongoMissingDependencyError(
+        'Optional module `aws4` not found. Please install it to enable AWS authentication',
+        { cause: error, dependencyName: 'aws4' }
+      )
+    );
+  }
+
+  return aws4;
+}
 
 /** A utility function to get the instance of mongodb-client-encryption, if it exists. */
 export function getMongoDBClientEncryption():
@@ -256,10 +268,10 @@ export function getMongoDBClientEncryption():
     // Cannot be moved to helper utility function, bundlers search and replace the actual require call
     // in a way that makes this line throw at bundle time, not runtime, catching here will make bundling succeed
     mongodbClientEncryption = require('mongodb-client-encryption');
-  } catch (cause) {
+  } catch (error) {
     const kModuleError = new MongoMissingDependencyError(
       'Optional module `mongodb-client-encryption` not found. Please install it to use auto encryption or ClientEncryption.',
-      { cause }
+      { cause: error, dependencyName: 'mongodb-client-encryption' }
     );
     return { kModuleError };
   }

package/src/encrypter.ts

@@ -108,13 +108,18 @@ export class Encrypter {
   }
 
   async close(client: MongoClient, force: boolean): Promise<void> {
-    const maybeError: Error | void = await this.autoEncrypter.teardown(!!force).catch(e => e);
+    let error;
+    try {
+      await this.autoEncrypter.teardown(force);
+    } catch (autoEncrypterError) {
+      error = autoEncrypterError;
+    }
     const internalClient = this[kInternalClient];
     if (internalClient != null && client !== internalClient) {
-      return internalClient.close(force);
+      return await internalClient.close(force);
     }
-    if (maybeError) {
-      throw maybeError;
+    if (error != null) {
+      throw error;
     }
   }
 
@@ -123,7 +128,11 @@ export class Encrypter {
     if ('kModuleError' in mongodbClientEncryption) {
       throw new MongoMissingDependencyError(
         'Auto-encryption requested, but the module is not installed. ' +
-          'Please add `mongodb-client-encryption` as a dependency of your project'
+          'Please add `mongodb-client-encryption` as a dependency of your project',
+        {
+          cause: mongodbClientEncryption['kModuleError'],
+          dependencyName: 'mongodb-client-encryption'
+        }
       );
     }
   }

package/src/error.ts

@@ -520,8 +520,8 @@ export class MongoAWSError extends MongoRuntimeError {
    *
    * @public
    **/
-  constructor(message: string) {
-    super(message);
+  constructor(message: string, options?: { cause?: Error }) {
+    super(message, options);
   }
 
   override get name(): string {
@@ -1008,6 +1008,11 @@ export class MongoMissingCredentialsError extends MongoAPIError {
  * @category Error
  */
 export class MongoMissingDependencyError extends MongoAPIError {
+  dependencyName: string;
+
+  /** @remarks This property is assigned in the `Error` constructor. */
+  declare cause: Error;
+
   /**
    * **Do not use this constructor!**
    *
@@ -1019,8 +1024,9 @@ export class MongoMissingDependencyError extends MongoAPIError {
    *
    * @public
    **/
-  constructor(message: string, options: { cause?: Error } = {}) {
+  constructor(message: string, options: { cause: Error; dependencyName: string }) {
     super(message, options);
+    this.dependencyName = options.dependencyName;
   }
 
   override get name(): string {

package/src/gridfs/download.ts

@@ -28,6 +28,8 @@ export interface GridFSBucketReadStreamOptions {
    * to be returned by the stream. `end` is non-inclusive
    */
   end?: number;
+  /** @internal TODO(NODE-5688): make this public */
+  timeoutMS?: number;
 }
 
 /** @public */
@@ -183,24 +185,13 @@ function doRead(stream: GridFSBucketReadStream): void {
   if (!stream.s.cursor) return;
   if (!stream.s.file) return;
 
-  const handleReadResult = ({
-    error,
-    doc
-  }: { error: Error; doc: null } | { error: null; doc: any }) => {
-    if (stream.destroyed) {
-      return;
-    }
-    if (error) {
-      stream.destroy(error);
-      return;
-    }
+  const handleReadResult = (doc: Document | null) => {
+    if (stream.destroyed) return;
+
     if (!doc) {
       stream.push(null);
-
-      stream.s.cursor?.close().then(
-        () => null,
-        error => stream.destroy(error)
-      );
+      // eslint-disable-next-line github/no-then
+      stream.s.cursor?.close().then(undefined, error => stream.destroy(error));
       return;
     }
 
@@ -271,10 +262,11 @@ function doRead(stream: GridFSBucketReadStream): void {
     return;
   };
 
-  stream.s.cursor.next().then(
-    doc => handleReadResult({ error: null, doc }),
-    error => handleReadResult({ error, doc: null })
-  );
+  // eslint-disable-next-line github/no-then
+  stream.s.cursor.next().then(handleReadResult, error => {
+    if (stream.destroyed) return;
+    stream.destroy(error);
+  });
 }
 
 function init(stream: GridFSBucketReadStream): void {
@@ -289,13 +281,8 @@ function init(stream: GridFSBucketReadStream): void {
     findOneOptions.skip = stream.s.options.skip;
   }
 
-  const handleReadResult = ({
-    error,
-    doc
-  }: { error: Error; doc: null } | { error: null; doc: any }) => {
-    if (error) {
-      return stream.destroy(error);
-    }
+  const handleReadResult = (doc: Document | null) => {
+    if (stream.destroyed) return;
 
     if (!doc) {
       const identifier = stream.s.filter._id
@@ -359,10 +346,11 @@ function init(stream: GridFSBucketReadStream): void {
     return;
   };
 
-  stream.s.files.findOne(stream.s.filter, findOneOptions).then(
-    doc => handleReadResult({ error: null, doc }),
-    error => handleReadResult({ error, doc: null })
-  );
+  // 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);
+  });
 }
 
 function waitForFile(stream: GridFSBucketReadStream, callback: Callback): void {

package/src/gridfs/index.ts

@@ -36,6 +36,8 @@ export interface GridFSBucketOptions extends WriteConcernOptions {
   chunkSizeBytes?: number;
   /** Read preference to be passed to read operations */
   readPreference?: ReadPreference;
+  /** @internal TODO(NODE-5688): make this public */
+  timeoutMS?: number;
 }
 
 /** @internal */

package/src/gridfs/upload.ts

@@ -4,7 +4,7 @@ import type { Document } from '../bson';
 import { ObjectId } from '../bson';
 import type { Collection } from '../collection';
 import { MongoAPIError, MONGODB_ERROR_CODES, MongoError } from '../error';
-import type { Callback } from '../utils';
+import { type Callback, squashError } from '../utils';
 import type { WriteConcernOptions } from '../write_concern';
 import { WriteConcern } from './../write_concern';
 import type { GridFSFile } from './download';
@@ -36,6 +36,8 @@ export interface GridFSBucketWriteStreamOptions extends WriteConcernOptions {
    * @deprecated Will be removed in the next major version. Add an aliases field to the metadata document instead.
    */
   aliases?: string[];
+  /** @internal TODO(NODE-5688): make this public */
+  timeoutMS?: number;
 }
 
 /**
@@ -133,13 +135,11 @@ export class GridFSBucketWriteStream extends Writable {
     if (!this.bucket.s.calledOpenUploadStream) {
       this.bucket.s.calledOpenUploadStream = true;
 
-      checkIndexes(this).then(
-        () => {
-          this.bucket.s.checkedIndexes = true;
-          this.bucket.emit('index');
-        },
-        () => null
-      );
+      // eslint-disable-next-line github/no-then
+      checkIndexes(this).then(() => {
+        this.bucket.s.checkedIndexes = true;
+        this.bucket.emit('index');
+      }, squashError);
     }
   }
 
@@ -272,6 +272,7 @@ 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;
@@ -395,6 +396,7 @@ function doWrite(
         return;
       }
 
+      // eslint-disable-next-line github/no-then
       stream.chunks.insertOne(doc, { writeConcern: stream.writeConcern }).then(
         () => {
           --stream.state.outstandingRequests;
@@ -435,6 +437,7 @@ 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

@@ -264,8 +264,7 @@ export type {
   OpMsgResponse,
   OpQueryOptions,
   OpQueryRequest,
-  OpQueryResponse,
-  OpResponseOptions,
+  OpReply,
   WriteProtocolMessageType
 } from './cmap/commands';
 export type { HandshakeDocument } from './cmap/connect';
@@ -290,6 +289,12 @@ export type { ClientMetadata, ClientMetadataOptions } from './cmap/handshake/cli
 export type { ConnectionPoolMetrics } from './cmap/metrics';
 export type { StreamDescription, StreamDescriptionOptions } from './cmap/stream_description';
 export type { CompressorName } from './cmap/wire_protocol/compression';
+export type { JSTypeOf, OnDemandDocument } from './cmap/wire_protocol/on_demand/document';
+export type {
+  CursorResponse,
+  MongoDBResponse,
+  MongoDBResponseConstructor
+} from './cmap/wire_protocol/responses';
 export type { CollectionOptions, CollectionPrivate, ModifyResult } from './collection';
 export type {
   COMMAND_FAILED,
@@ -447,7 +452,6 @@ export type {
   CommandOperationOptions,
   OperationParent
 } from './operations/command';
-export type { IndexInformationOptions } from './operations/common_functions';
 export type { CountOptions } from './operations/count';
 export type { CountDocumentsOptions } from './operations/count_documents';
 export type {
@@ -466,10 +470,13 @@ export type {
   FindOneAndReplaceOptions,
   FindOneAndUpdateOptions
 } from './operations/find_and_modify';
+export type { IndexInformationOptions } from './operations/indexes';
 export type {
   CreateIndexesOptions,
   DropIndexesOptions,
   IndexDescription,
+  IndexDescriptionCompact,
+  IndexDescriptionInfo,
   IndexDirection,
   IndexSpecification,
   ListIndexesOptions
@@ -510,6 +517,7 @@ export type {
   MonitorPrivate,
   RTTPinger,
   RTTPingerOptions,
+  RTTSampler,
   ServerMonitoringMode
 } from './sdam/monitor';
 export type { Server, ServerEvents, ServerOptions, ServerPrivate } from './sdam/server';
@@ -543,6 +551,7 @@ export type {
   WithTransactionCallback
 } from './sessions';
 export type { Sort, SortDirection, SortDirectionForCmd, SortForCmd } from './sort';
+export type { Timeout } from './timeout';
 export type { Transaction, TransactionOptions, TxnState } from './transactions';
 export type {
   BufferPool,
@@ -551,7 +560,6 @@ export type {
   HostAddress,
   List,
   MongoDBCollectionNamespace,
-  MongoDBNamespace,
-  TimeoutController
+  MongoDBNamespace
 } from './utils';
 export type { W, WriteConcernOptions, WriteConcernSettings } from './write_concern';