mongodb 6.20.0-dev.20251106.sha.696664cb → 6.21.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mongodb",
-  "version": "6.20.0-dev.20251106.sha.696664cb",
+  "version": "6.21.0",
   "description": "The official MongoDB driver for Node.js",
   "main": "lib/index.js",
   "files": [
@@ -26,17 +26,17 @@
   },
   "dependencies": {
     "@mongodb-js/saslprep": "^1.3.0",
-    "bson": "^7.0.0",
-    "mongodb-connection-string-url": "^7.0.0"
+    "bson": "^6.10.4",
+    "mongodb-connection-string-url": "^3.0.2"
   },
   "peerDependencies": {
-    "@aws-sdk/credential-providers": "^3.806.0",
-    "@mongodb-js/zstd": "^7.0.0",
-    "gcp-metadata": "^7.0.1",
-    "kerberos": "^7.0.0",
-    "mongodb-client-encryption": ">=7.0.0 <7.1.0",
+    "@aws-sdk/credential-providers": "^3.188.0",
+    "@mongodb-js/zstd": "^1.1.0 || ^2.0.0",
+    "gcp-metadata": "^5.2.0",
+    "kerberos": "^2.0.1",
+    "mongodb-client-encryption": ">=6.0.0 <7",
     "snappy": "^7.3.2",
-    "socks": "^2.8.6"
+    "socks": "^2.7.1"
   },
   "peerDependenciesMeta": {
     "@aws-sdk/credential-providers": {
@@ -67,7 +67,7 @@
     "@istanbuljs/nyc-config-typescript": "^1.0.2",
     "@microsoft/api-extractor": "^7.52.11",
     "@microsoft/tsdoc-config": "^0.17.1",
-    "@mongodb-js/zstd": "^7.0.0",
+    "@mongodb-js/zstd": "^2.0.1",
     "@types/chai": "^4.3.17",
     "@types/chai-subset": "^1.3.5",
     "@types/express": "^5.0.3",
@@ -92,11 +92,12 @@
     "eslint-plugin-tsdoc": "^0.4.0",
     "eslint-plugin-unused-imports": "^4.2.0",
     "express": "^5.1.0",
-    "gcp-metadata": "^7.0.1",
+    "gcp-metadata": "^5.3.0",
     "js-yaml": "^4.1.0",
     "mocha": "^11.7.1",
     "mocha-sinon": "^2.1.2",
-    "mongodb-client-encryption": "^7.0.0",
+    "mongodb-client-encryption": "^6.5.0",
+    "mongodb-legacy": "^6.1.3",
     "nyc": "^15.1.0",
     "prettier": "^3.6.2",
     "semver": "^7.7.2",
@@ -114,7 +115,7 @@
   },
   "license": "Apache-2.0",
   "engines": {
-    "node": ">=20.19.0"
+    "node": ">=16.20.1"
   },
   "bugs": {
     "url": "https://jira.mongodb.org/projects/NODE/issues/"
@@ -123,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",
+    "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:docs": "./etc/docs/build.ts",
     "build:typedoc": "typedoc",
     "build:nightly": "node ./.github/scripts/nightly.mjs",
@@ -136,14 +137,16 @@
     "check:eslint": "npm run build:dts && ESLINT_USE_FLAT_CONFIG=false eslint -v && ESLINT_USE_FLAT_CONFIG=false eslint --max-warnings=0 --ext '.js,.ts' src test",
     "check:tsd": "tsd --version && tsd",
     "check:dependencies": "mocha test/action/dependency.test.ts",
-    "check:dts": "node ./node_modules/typescript/bin/tsc --target es2023 --module commonjs --noEmit mongodb.d.ts && tsd",
+    "check:dts": "node ./node_modules/typescript/bin/tsc --noEmit mongodb.d.ts && tsd",
     "check:search-indexes": "nyc mocha --config test/mocha_mongodb.js test/manual/search-index-management.prose.test.ts",
     "check:test": "mocha --config test/mocha_mongodb.js test/integration",
     "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 test/integration/auth/mongodb_aws.prose.test.ts",
+    "check:adl": "nyc mocha --config test/mocha_mongodb.js test/manual/atlas-data-lake-testing",
+    "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",
     "check:oidc-test": "nyc mocha --config test/mocha_mongodb.js test/integration/auth/mongodb_oidc.prose.test.ts",
     "check:oidc-azure": "nyc mocha --config test/mocha_mongodb.js test/integration/auth/mongodb_oidc_azure.prose.05.test.ts",
@@ -172,4 +175,4 @@
       "moduleResolution": "node"
     }
   }
-}
+}

package/src/beta.ts

@@ -0,0 +1,22 @@
+import { type Document } from './bson';
+
+export * from './index';
+
+/**
+ * @internal
+ *
+ * Since we don't bundle tslib helpers, we need to polyfill this method.
+ *
+ * This is used in the generated JS.  Adapted from https://github.com/microsoft/TypeScript/blob/aafdfe5b3f76f5c41abeec412ce73c86da94c75f/src/compiler/factory/emitHelpers.ts#L1202.
+ */
+
+function __exportStar(mod: Document) {
+  for (const key of Object.keys(mod)) {
+    Object.defineProperty(exports, key, {
+      enumerable: true,
+      get: function () {
+        return mod[key];
+      }
+    });
+  }
+}

package/src/bulk/common.ts

@@ -20,6 +20,7 @@ import type { Topology } from '../sdam/topology';
 import { type Sort } from '../sort';
 import { TimeoutContext } from '../timeout';
 import {
+  applyRetryableWrites,
   getTopology,
   hasAtomicOperators,
   maybeAddIdToDocuments,
@@ -526,15 +527,15 @@ async function executeCommands(
       finalOptions.checkKeys = false;
     }
 
-    if (bulkOperation.retryWrites) {
+    if (finalOptions.retryWrites) {
       if (isUpdateBatch(batch)) {
-        bulkOperation.retryWrites =
-          bulkOperation.retryWrites && !batch.operations.some(op => op.multi);
+        finalOptions.retryWrites =
+          finalOptions.retryWrites && !batch.operations.some(op => op.multi);
       }
 
       if (isDeleteBatch(batch)) {
-        bulkOperation.retryWrites =
-          bulkOperation.retryWrites && !batch.operations.some(op => op.limit === 0);
+        finalOptions.retryWrites =
+          finalOptions.retryWrites && !batch.operations.some(op => op.limit === 0);
       }
     }
 
@@ -858,8 +859,6 @@ export abstract class BulkOperationBase {
   s: BulkOperationPrivate;
   operationId?: number;
   private collection: Collection;
-  /** @internal */
-  retryWrites?: boolean;
 
   /**
    * Create a new OrderedBulkOperation or UnorderedBulkOperation instance
@@ -867,7 +866,6 @@ export abstract class BulkOperationBase {
    */
   constructor(collection: Collection, options: BulkWriteOptions, isOrdered: boolean) {
     this.collection = collection;
-    this.retryWrites = collection.db.options?.retryWrites;
     // determine whether bulkOperation is ordered or unordered
     this.isOrdered = isOrdered;
 
@@ -900,6 +898,10 @@ export abstract class BulkOperationBase {
     //   + 1 bytes for null terminator
     const maxKeySize = (maxWriteBatchSize - 1).toString(10).length + 2;
 
+    // Final options for retryable writes
+    let finalOptions = Object.assign({}, options);
+    finalOptions = applyRetryableWrites(finalOptions, collection.db);
+
     // Final results
     const bulkResult: BulkResult = {
       ok: 1,
@@ -941,7 +943,7 @@ export abstract class BulkOperationBase {
       // Topology
       topology,
       // Options
-      options: options,
+      options: finalOptions,
       // BSON options
       bsonOptions: resolveBSONOptions(options),
       // Current operation

package/src/change_stream.ts

@@ -3,7 +3,7 @@ import type { Readable } from 'stream';
 import type { Binary, Document, Timestamp } from './bson';
 import { Collection } from './collection';
 import { CHANGE, CLOSE, END, ERROR, INIT, MORE, RESPONSE, RESUME_TOKEN_CHANGED } from './constants';
-import { CursorTimeoutContext } from './cursor/abstract_cursor';
+import { type CursorStreamOptions, CursorTimeoutContext } from './cursor/abstract_cursor';
 import { ChangeStreamCursor, type ChangeStreamCursorOptions } from './cursor/change_stream_cursor';
 import { Db } from './db';
 import {
@@ -17,10 +17,21 @@ import {
 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 { CollationOptions, OperationParent } from './operations/command';
+import type { ReadPreference } from './read_preference';
+import { type AsyncDisposable, configureResourceManagement } from './resource_management';
 import type { ServerSessionId } from './sessions';
 import { CSOTTimeoutContext, type TimeoutContext } from './timeout';
-import { type AnyOptions, getTopology, type MongoDBNamespace, squashError } from './utils';
+import { filterOptions, getTopology, type MongoDBNamespace, squashError } from './utils';
+
+const CHANGE_STREAM_OPTIONS = [
+  'resumeAfter',
+  'startAfter',
+  'startAtOperationTime',
+  'fullDocument',
+  'fullDocumentBeforeChange',
+  'showExpandedEvents'
+] as const;
 
 const CHANGE_DOMAIN_TYPES = {
   COLLECTION: Symbol('Collection'),
@@ -34,12 +45,19 @@ const NO_RESUME_TOKEN_ERROR =
   'A change stream document has been received that lacks a resume token (_id).';
 const CHANGESTREAM_CLOSED_ERROR = 'ChangeStream is closed';
 
-const INVALID_STAGE_OPTIONS = buildDisallowedChangeStreamOptions();
-
-export function filterOutOptions(options: AnyOptions): AnyOptions {
-  return Object.fromEntries(
-    Object.entries(options).filter(([k, _]) => !INVALID_STAGE_OPTIONS.has(k))
-  );
+/**
+ * @public
+ * @deprecated Please use the ChangeStreamCursorOptions type instead.
+ */
+export interface ResumeOptions {
+  startAtOperationTime?: Timestamp;
+  batchSize?: number;
+  maxAwaitTimeMS?: number;
+  collation?: CollationOptions;
+  readPreference?: ReadPreference;
+  resumeAfter?: ResumeToken;
+  startAfter?: ResumeToken;
+  fullDocument?: string;
 }
 
 /**
@@ -572,10 +590,13 @@ export class ChangeStream<
   implements AsyncDisposable
 {
   /**
+   * @beta
    * @experimental
    * An alias for {@link ChangeStream.close|ChangeStream.close()}.
    */
-  async [Symbol.asyncDispose]() {
+  declare [Symbol.asyncDispose]: () => Promise<void>;
+  /** @internal */
+  async asyncDispose() {
     await this.close();
   }
 
@@ -593,6 +614,7 @@ export class ChangeStream<
   type: symbol;
   /** @internal */
   private cursor: ChangeStreamCursor<TSchema, TChange>;
+  streamOptions?: CursorStreamOptions;
   /** @internal */
   private cursorStream?: Readable & AsyncIterable<TChange>;
   /** @internal */
@@ -860,12 +882,13 @@ export class ChangeStream<
    *
    * @throws MongoChangeStreamError if the underlying cursor or the change stream is closed
    */
-  stream(): Readable & AsyncIterable<TChange> {
+  stream(options?: CursorStreamOptions): Readable & AsyncIterable<TChange> {
     if (this.closed) {
       throw new MongoChangeStreamError(CHANGESTREAM_CLOSED_ERROR);
     }
 
-    return this.cursor.stream();
+    this.streamOptions = options;
+    return this.cursor.stream(options);
   }
 
   /** @internal */
@@ -897,7 +920,7 @@ export class ChangeStream<
   private _createChangeStreamCursor(
     options: ChangeStreamOptions | ChangeStreamCursorOptions
   ): ChangeStreamCursor<TSchema, TChange> {
-    const changeStreamStageOptions: Document = filterOutOptions(options);
+    const changeStreamStageOptions = filterOptions(options, CHANGE_STREAM_OPTIONS);
     if (this.type === CHANGE_DOMAIN_TYPES.CLUSTER) {
       changeStreamStageOptions.allChangesForCluster = true;
     }
@@ -1084,75 +1107,4 @@ export class ChangeStream<
   }
 }
 
-/**
- * This function returns a list of options that are *not* supported by the $changeStream
- * aggregation stage.  This is best-effort - it uses the options "officially supported" by the driver
- * to derive a list of known, unsupported options for the $changeStream stage.
- *
- * Notably, at runtime, users can still provide options unknown to the driver and the driver will
- * *not* filter them out of the options object (see NODE-5510).
- */
-function buildDisallowedChangeStreamOptions(): Set<string> {
-  /** hard-coded list of allowed ChangeStream options */
-  type CSOptions =
-    | 'resumeAfter'
-    | 'startAfter'
-    | 'startAtOperationTime'
-    | 'fullDocument'
-    | 'fullDocumentBeforeChange'
-    | 'showExpandedEvents';
-
-  /**
-   * a type representing all known options that the driver supports that are *not* change stream stage options.
-   *
-   * each known key is mapped to a non-optional string, so that if new driver-specific options are added, the
-   * instantiation of `denyList` below results in a TS error.
-   */
-  type DisallowedOptions = {
-    [k in Exclude<
-      keyof ChangeStreamOptions & { timeoutContext: TimeoutContext },
-      CSOptions
-    >]: string;
-  };
-
-  const denyList: DisallowedOptions = {
-    allowDiskUse: '',
-    authdb: '',
-    batchSize: '',
-    bsonRegExp: '',
-    bypassDocumentValidation: '',
-    bypassPinningCheck: '',
-    checkKeys: '',
-    collation: '',
-    comment: '',
-    cursor: '',
-    dbName: '',
-    enableUtf8Validation: '',
-    explain: '',
-    fieldsAsRaw: '',
-    hint: '',
-    ignoreUndefined: '',
-    let: '',
-    maxAwaitTimeMS: '',
-    maxTimeMS: '',
-    omitMaxTimeMS: '',
-    out: '',
-    promoteBuffers: '',
-    promoteLongs: '',
-    promoteValues: '',
-    raw: '',
-    rawData: '',
-    readConcern: '',
-    readPreference: '',
-    serializeFunctions: '',
-    session: '',
-    timeoutContext: '',
-    timeoutMS: '',
-    timeoutMode: '',
-    useBigInt64: '',
-    willRetryWrite: '',
-    writeConcern: ''
-  };
-
-  return new Set(Object.keys(denyList));
-}
+configureResourceManagement(ChangeStream.prototype);

package/src/client-side-encryption/auto_encrypter.ts

@@ -1,4 +1,8 @@
-import { type MongoCrypt, type MongoCryptOptions } from 'mongodb-client-encryption';
+import {
+  type MongoCrypt,
+  type MongoCryptConstructor,
+  type MongoCryptOptions
+} from 'mongodb-client-encryption';
 import * as net from 'net';
 
 import { deserialize, type Document, serialize } from '../bson';
@@ -10,7 +14,8 @@ import { MongoClient, type MongoClientOptions } from '../mongo_client';
 import { type Abortable } from '../mongo_types';
 import { MongoDBCollectionNamespace } from '../utils';
 import { autoSelectSocketOptions } from './client_encryption';
-import { defaultErrorWrapper, MongoCryptInvalidArgumentError } from './errors';
+import * as cryptoCallbacks from './crypto_callbacks';
+import { MongoCryptInvalidArgumentError } from './errors';
 import { MongocryptdManager } from './mongocryptd_manager';
 import {
   type CredentialProviders,
@@ -64,7 +69,7 @@ export interface AutoEncryptionOptions {
     /** If true, autoEncryption will not attempt to spawn a mongocryptd before connecting  */
     mongocryptdBypassSpawn?: boolean;
     /** The path to the mongocryptd executable on the system */
-    mongocryptdSpawnPath?: `${string}mongocryptd${'.exe' | ''}`;
+    mongocryptdSpawnPath?: string;
     /** Command line arguments to use when auto-spawning a mongocryptd */
     mongocryptdSpawnArgs?: string[];
     /**
@@ -90,7 +95,7 @@ export interface AutoEncryptionOptions {
      *
      * Requires the MongoDB Crypt shared library, available in MongoDB 6.0 or higher.
      */
-    cryptSharedLibPath?: `${string}mongo_crypt_v${number}.${'so' | 'dll' | 'dylib'}`;
+    cryptSharedLibPath?: string;
     /**
      * If specified, never use mongocryptd and instead fail when the MongoDB Crypt
      * shared library could not be loaded.
@@ -178,7 +183,7 @@ export class AutoEncrypter {
   [kDecorateResult] = false;
 
   /** @internal */
-  static getMongoCrypt(): typeof MongoCrypt {
+  static getMongoCrypt(): MongoCryptConstructor {
     const encryption = getMongoDBClientEncryption();
     if ('kModuleError' in encryption) {
       throw encryption.kModuleError;
@@ -253,7 +258,8 @@ export class AutoEncrypter {
     }
 
     const mongoCryptOptions: MongoCryptOptions = {
-      errorWrapper: defaultErrorWrapper
+      enableMultipleCollinfo: true,
+      cryptoCallbacks
     };
     if (options.schemaMap) {
       mongoCryptOptions.schemaMap = Buffer.isBuffer(options.schemaMap)

package/src/client-side-encryption/client_encryption.ts

@@ -1,6 +1,7 @@
 import type {
   ExplicitEncryptionContextOptions,
   MongoCrypt,
+  MongoCryptConstructor,
   MongoCryptOptions
 } from 'mongodb-client-encryption';
 
@@ -25,8 +26,8 @@ import { type CreateCollectionOptions } from '../operations/create_collection';
 import { type DeleteResult } from '../operations/delete';
 import { type CSOTTimeoutContext, TimeoutContext } from '../timeout';
 import { MongoDBCollectionNamespace, resolveTimeoutOptions } from '../utils';
+import * as cryptoCallbacks from './crypto_callbacks';
 import {
-  defaultErrorWrapper,
   MongoCryptCreateDataKeyError,
   MongoCryptCreateEncryptedCollectionError,
   MongoCryptInvalidArgumentError
@@ -86,7 +87,7 @@ export class ClientEncryption {
   _credentialProviders?: CredentialProviders;
 
   /** @internal */
-  static getMongoCrypt(): typeof MongoCrypt {
+  static getMongoCrypt(): MongoCryptConstructor {
     const encryption = getMongoDBClientEncryption();
     if ('kModuleError' in encryption) {
       throw encryption.kModuleError;
@@ -143,10 +144,10 @@ export class ClientEncryption {
 
     const mongoCryptOptions: MongoCryptOptions = {
       ...options,
+      cryptoCallbacks,
       kmsProviders: !Buffer.isBuffer(this._kmsProviders)
         ? (serialize(this._kmsProviders) as Buffer)
-        : this._kmsProviders,
-      errorWrapper: defaultErrorWrapper
+        : this._kmsProviders
     };
 
     this._keyVaultNamespace = options.keyVaultNamespace;
@@ -285,7 +286,7 @@ export class ClientEncryption {
    */
   async rewrapManyDataKey(
     filter: Filter<DataKey>,
-    options?: ClientEncryptionRewrapManyDataKeyProviderOptions
+    options: ClientEncryptionRewrapManyDataKeyProviderOptions
   ): Promise<{ bulkWriteResult?: BulkWriteResult }> {
     let keyEncryptionKeyBson = undefined;
     if (options) {

package/src/client-side-encryption/crypto_callbacks.ts

@@ -0,0 +1,87 @@
+import * as crypto from 'crypto';
+
+type AES256Callback = (key: Buffer, iv: Buffer, input: Buffer, output: Buffer) => number | Error;
+
+export function makeAES256Hook(
+  method: 'createCipheriv' | 'createDecipheriv',
+  mode: 'aes-256-cbc' | 'aes-256-ctr'
+): AES256Callback {
+  return function (key: Buffer, iv: Buffer, input: Buffer, output: Buffer): number | Error {
+    let result;
+
+    try {
+      const cipher = crypto[method](mode, key, iv);
+      cipher.setAutoPadding(false);
+      result = cipher.update(input);
+      const final = cipher.final();
+      if (final.length > 0) {
+        result = Buffer.concat([result, final]);
+      }
+    } catch (e) {
+      return e;
+    }
+
+    result.copy(output);
+    return result.length;
+  };
+}
+
+export function randomHook(buffer: Buffer, count: number): number | Error {
+  try {
+    crypto.randomFillSync(buffer, 0, count);
+  } catch (e) {
+    return e;
+  }
+  return count;
+}
+
+export function sha256Hook(input: Buffer, output: Buffer): number | Error {
+  let result;
+  try {
+    result = crypto.createHash('sha256').update(input).digest();
+  } catch (e) {
+    return e;
+  }
+
+  result.copy(output);
+  return result.length;
+}
+
+type HMACHook = (key: Buffer, input: Buffer, output: Buffer) => number | Error;
+export function makeHmacHook(algorithm: 'sha512' | 'sha256'): HMACHook {
+  return (key: Buffer, input: Buffer, output: Buffer): number | Error => {
+    let result;
+    try {
+      result = crypto.createHmac(algorithm, key).update(input).digest();
+    } catch (e) {
+      return e;
+    }
+
+    result.copy(output);
+    return result.length;
+  };
+}
+
+export function signRsaSha256Hook(key: Buffer, input: Buffer, output: Buffer): number | Error {
+  let result;
+  try {
+    const signer = crypto.createSign('sha256WithRSAEncryption');
+    const privateKey = Buffer.from(
+      `-----BEGIN PRIVATE KEY-----\n${key.toString('base64')}\n-----END PRIVATE KEY-----\n`
+    );
+
+    result = signer.update(input).end().sign(privateKey);
+  } catch (e) {
+    return e;
+  }
+
+  result.copy(output);
+  return result.length;
+}
+
+export const aes256CbcEncryptHook = makeAES256Hook('createCipheriv', 'aes-256-cbc');
+export const aes256CbcDecryptHook = makeAES256Hook('createDecipheriv', 'aes-256-cbc');
+export const aes256CtrEncryptHook = makeAES256Hook('createCipheriv', 'aes-256-ctr');
+export const aes256CtrDecryptHook = makeAES256Hook('createDecipheriv', 'aes-256-ctr');
+export const hmacSha512Hook = makeHmacHook('sha512');
+export const hmacSha256Hook = makeHmacHook('sha256');

package/src/client-side-encryption/errors.ts

@@ -26,9 +26,6 @@ export class MongoCryptError extends MongoError {
   }
 }
 
-export const defaultErrorWrapper = (error: Error) =>
-  new MongoCryptError(error.message, { cause: error });
-
 /**
  * @public
  *