mongodb 4.6.0 → 4.7.0

package/src/change_stream.ts

@@ -1,7 +1,8 @@
 import Denque = require('denque');
 import type { Readable } from 'stream';
+import { setTimeout } from 'timers';
 
-import type { Document, Long, Timestamp } from './bson';
+import type { Binary, Document, Long, Timestamp } from './bson';
 import { Collection } from './collection';
 import { CHANGE, CLOSE, END, ERROR, INIT, MORE, RESPONSE, RESUME_TOKEN_CHANGED } from './constants';
 import {
@@ -50,16 +51,9 @@ const CHANGE_STREAM_OPTIONS = [
   'resumeAfter',
   'startAfter',
   'startAtOperationTime',
-  'fullDocument'
-] as const;
-
-const CURSOR_OPTIONS = [
-  'batchSize',
-  'maxAwaitTimeMS',
-  'collation',
-  'readPreference',
-  'comment',
-  ...CHANGE_STREAM_OPTIONS
+  'fullDocument',
+  'fullDocumentBeforeChange',
+  'showExpandedEvents'
 ] as const;
 
 const CHANGE_DOMAIN_TYPES = {
@@ -83,7 +77,10 @@ const NO_RESUME_TOKEN_ERROR =
 const NO_CURSOR_ERROR = 'ChangeStream has no cursor';
 const CHANGESTREAM_CLOSED_ERROR = 'ChangeStream is closed';
 
-/** @public */
+/**
+ * @public
+ * @deprecated Please use the ChangeStreamCursorOptions type instead.
+ */
 export interface ResumeOptions {
   startAtOperationTime?: Timestamp;
   batchSize?: number;
@@ -92,6 +89,7 @@ export interface ResumeOptions {
   readPreference?: ReadPreference;
   resumeAfter?: ResumeToken;
   startAfter?: ResumeToken;
+  fullDocument?: string;
 }
 
 /**
@@ -131,11 +129,35 @@ export type ChangeStreamAggregateRawResult<TChange> = {
  */
 export interface ChangeStreamOptions extends AggregateOptions {
   /**
-   * Allowed values: 'updateLookup'. When set to 'updateLookup',
-   * the change stream will include both a delta describing the changes to the document,
-   * as well as a copy of the entire document that was changed from some time after the change occurred.
+   * Allowed values: 'updateLookup', 'whenAvailable', 'required'.
+   *
+   * When set to 'updateLookup', the change notification for partial updates
+   * will include both a delta describing the changes to the document as well
+   * as a copy of the entire document that was changed from some time after
+   * the change occurred.
+   *
+   * When set to 'whenAvailable', configures the change stream to return the
+   * post-image of the modified document for replace and update change events
+   * if the post-image for this event is available.
+   *
+   * When set to 'required', the same behavior as 'whenAvailable' except that
+   * an error is raised if the post-image is not available.
    */
   fullDocument?: string;
+
+  /**
+   * Allowed values: 'whenAvailable', 'required', 'off'.
+   *
+   * The default is to not send a value, which is equivalent to 'off'.
+   *
+   * When set to 'whenAvailable', configures the change stream to return the
+   * pre-image of the modified document for replace, update, and delete change
+   * events if it is available.
+   *
+   * When set to 'required', the same behavior as 'whenAvailable' except that
+   * an error is raised if the pre-image is not available.
+   */
+  fullDocumentBeforeChange?: string;
   /** The maximum amount of time for the server to wait on new documents to satisfy a change stream query. */
   maxAwaitTimeMS?: number;
   /**
@@ -155,6 +177,19 @@ export interface ChangeStreamOptions extends AggregateOptions {
    * @see https://docs.mongodb.com/manual/reference/command/aggregate
    */
   batchSize?: number;
+
+  /**
+   * When enabled, configures the change stream to include extra change events.
+   *
+   * - createIndexes
+   * - dropIndexes
+   * - modify
+   * - create
+   * - shardCollection
+   * - reshardCollection
+   * - refineCollectionShardKey
+   */
+  showExpandedEvents?: boolean;
 }
 
 /** @public */
@@ -204,13 +239,41 @@ export interface ChangeStreamDocumentCommon {
   lsid?: ServerSessionId;
 }
 
+/** @public */
+export interface ChangeStreamDocumentCollectionUUID {
+  /**
+   * The UUID (Binary subtype 4) of the collection that the operation was performed on.
+   *
+   * Only present when the `showExpandedEvents` flag is enabled.
+   *
+   * **NOTE:** collectionUUID will be converted to a NodeJS Buffer if the promoteBuffers
+   *    flag is enabled.
+   *
+   * @since 6.1.0
+   */
+  collectionUUID: Binary;
+}
+
+/** @public */
+export interface ChangeStreamDocumentOperationDescription {
+  /**
+   * An description of the operation.
+   *
+   * Only present when the `showExpandedEvents` flag is enabled.
+   *
+   * @since 6.1.0
+   */
+  operationDescription?: Document;
+}
+
 /**
  * @public
  * @see https://www.mongodb.com/docs/manual/reference/change-events/#insert-event
  */
 export interface ChangeStreamInsertDocument<TSchema extends Document = Document>
   extends ChangeStreamDocumentCommon,
-    ChangeStreamDocumentKey<TSchema> {
+    ChangeStreamDocumentKey<TSchema>,
+    ChangeStreamDocumentCollectionUUID {
   /** Describes the type of operation represented in this change notification */
   operationType: 'insert';
   /** This key will contain the document being inserted */
@@ -225,20 +288,29 @@ export interface ChangeStreamInsertDocument<TSchema extends Document = Document>
  */
 export interface ChangeStreamUpdateDocument<TSchema extends Document = Document>
   extends ChangeStreamDocumentCommon,
-    ChangeStreamDocumentKey<TSchema> {
+    ChangeStreamDocumentKey<TSchema>,
+    ChangeStreamDocumentCollectionUUID {
   /** Describes the type of operation represented in this change notification */
   operationType: 'update';
   /**
    * This is only set if `fullDocument` is set to `'updateLookup'`
-   * The fullDocument document represents the most current majority-committed version of the updated document.
-   * The fullDocument document may vary from the document at the time of the update operation depending on the
-   * number of interleaving majority-committed operations that occur between the update operation and the document lookup.
+   * Contains the point-in-time post-image of the modified document if the
+   * post-image is available and either 'required' or 'whenAvailable' was
+   * specified for the 'fullDocument' option when creating the change stream.
    */
   fullDocument?: TSchema;
   /** Contains a description of updated and removed fields in this operation */
   updateDescription: UpdateDescription<TSchema>;
   /** Namespace the update event occured on */
   ns: ChangeStreamNameSpace;
+  /**
+   * Contains the pre-image of the modified or deleted document if the
+   * pre-image is available for the change event and either 'required' or
+   * 'whenAvailable' was specified for the 'fullDocumentBeforeChange' option
+   * when creating the change stream. If 'whenAvailable' was specified but the
+   * pre-image is unavailable, this will be explicitly set to null.
+   */
+  fullDocumentBeforeChange?: TSchema;
 }
 
 /**
@@ -254,6 +326,14 @@ export interface ChangeStreamReplaceDocument<TSchema extends Document = Document
   fullDocument: TSchema;
   /** Namespace the replace event occured on */
   ns: ChangeStreamNameSpace;
+  /**
+   * Contains the pre-image of the modified or deleted document if the
+   * pre-image is available for the change event and either 'required' or
+   * 'whenAvailable' was specified for the 'fullDocumentBeforeChange' option
+   * when creating the change stream. If 'whenAvailable' was specified but the
+   * pre-image is unavailable, this will be explicitly set to null.
+   */
+  fullDocumentBeforeChange?: TSchema;
 }
 
 /**
@@ -262,18 +342,29 @@ export interface ChangeStreamReplaceDocument<TSchema extends Document = Document
  */
 export interface ChangeStreamDeleteDocument<TSchema extends Document = Document>
   extends ChangeStreamDocumentCommon,
-    ChangeStreamDocumentKey<TSchema> {
+    ChangeStreamDocumentKey<TSchema>,
+    ChangeStreamDocumentCollectionUUID {
   /** Describes the type of operation represented in this change notification */
   operationType: 'delete';
   /** Namespace the delete event occured on */
   ns: ChangeStreamNameSpace;
+  /**
+   * Contains the pre-image of the modified or deleted document if the
+   * pre-image is available for the change event and either 'required' or
+   * 'whenAvailable' was specified for the 'fullDocumentBeforeChange' option
+   * when creating the change stream. If 'whenAvailable' was specified but the
+   * pre-image is unavailable, this will be explicitly set to null.
+   */
+  fullDocumentBeforeChange?: TSchema;
 }
 
 /**
  * @public
  * @see https://www.mongodb.com/docs/manual/reference/change-events/#drop-event
  */
-export interface ChangeStreamDropDocument extends ChangeStreamDocumentCommon {
+export interface ChangeStreamDropDocument
+  extends ChangeStreamDocumentCommon,
+    ChangeStreamDocumentCollectionUUID {
   /** Describes the type of operation represented in this change notification */
   operationType: 'drop';
   /** Namespace the drop event occured on */
@@ -284,7 +375,9 @@ export interface ChangeStreamDropDocument extends ChangeStreamDocumentCommon {
  * @public
  * @see https://www.mongodb.com/docs/manual/reference/change-events/#rename-event
  */
-export interface ChangeStreamRenameDocument extends ChangeStreamDocumentCommon {
+export interface ChangeStreamRenameDocument
+  extends ChangeStreamDocumentCommon,
+    ChangeStreamDocumentCollectionUUID {
   /** Describes the type of operation represented in this change notification */
   operationType: 'rename';
   /** The new name for the `ns.coll` collection */
@@ -313,6 +406,91 @@ export interface ChangeStreamInvalidateDocument extends ChangeStreamDocumentComm
   operationType: 'invalidate';
 }
 
+/**
+ * Only present when the `showExpandedEvents` flag is enabled.
+ * @public
+ * @see https://www.mongodb.com/docs/manual/reference/change-events/
+ */
+export interface ChangeStreamCreateIndexDocument
+  extends ChangeStreamDocumentCommon,
+    ChangeStreamDocumentCollectionUUID,
+    ChangeStreamDocumentOperationDescription {
+  /** Describes the type of operation represented in this change notification */
+  operationType: 'createIndexes';
+}
+
+/**
+ * Only present when the `showExpandedEvents` flag is enabled.
+ * @public
+ * @see https://www.mongodb.com/docs/manual/reference/change-events/
+ */
+export interface ChangeStreamDropIndexDocument
+  extends ChangeStreamDocumentCommon,
+    ChangeStreamDocumentCollectionUUID,
+    ChangeStreamDocumentOperationDescription {
+  /** Describes the type of operation represented in this change notification */
+  operationType: 'dropIndexes';
+}
+
+/**
+ * Only present when the `showExpandedEvents` flag is enabled.
+ * @public
+ * @see https://www.mongodb.com/docs/manual/reference/change-events/
+ */
+export interface ChangeStreamCollModDocument
+  extends ChangeStreamDocumentCommon,
+    ChangeStreamDocumentCollectionUUID {
+  /** Describes the type of operation represented in this change notification */
+  operationType: 'modify';
+}
+
+/**
+ * @public
+ * @see https://www.mongodb.com/docs/manual/reference/change-events/
+ */
+export interface ChangeStreamCreateDocument
+  extends ChangeStreamDocumentCommon,
+    ChangeStreamDocumentCollectionUUID {
+  /** Describes the type of operation represented in this change notification */
+  operationType: 'create';
+}
+
+/**
+ * @public
+ * @see https://www.mongodb.com/docs/manual/reference/change-events/
+ */
+export interface ChangeStreamShardCollectionDocument
+  extends ChangeStreamDocumentCommon,
+    ChangeStreamDocumentCollectionUUID,
+    ChangeStreamDocumentOperationDescription {
+  /** Describes the type of operation represented in this change notification */
+  operationType: 'shardCollection';
+}
+
+/**
+ * @public
+ * @see https://www.mongodb.com/docs/manual/reference/change-events/
+ */
+export interface ChangeStreamReshardCollectionDocument
+  extends ChangeStreamDocumentCommon,
+    ChangeStreamDocumentCollectionUUID,
+    ChangeStreamDocumentOperationDescription {
+  /** Describes the type of operation represented in this change notification */
+  operationType: 'reshardCollection';
+}
+
+/**
+ * @public
+ * @see https://www.mongodb.com/docs/manual/reference/change-events/
+ */
+export interface ChangeStreamRefineCollectionShardKeyDocument
+  extends ChangeStreamDocumentCommon,
+    ChangeStreamDocumentCollectionUUID,
+    ChangeStreamDocumentOperationDescription {
+  /** Describes the type of operation represented in this change notification */
+  operationType: 'refineCollectionShardKey';
+}
+
 /** @public */
 export type ChangeStreamDocument<TSchema extends Document = Document> =
   | ChangeStreamInsertDocument<TSchema>
@@ -322,7 +500,14 @@ export type ChangeStreamDocument<TSchema extends Document = Document> =
   | ChangeStreamDropDocument
   | ChangeStreamRenameDocument
   | ChangeStreamDropDatabaseDocument
-  | ChangeStreamInvalidateDocument;
+  | ChangeStreamInvalidateDocument
+  | ChangeStreamCreateIndexDocument
+  | ChangeStreamCreateDocument
+  | ChangeStreamCollModDocument
+  | ChangeStreamDropIndexDocument
+  | ChangeStreamShardCollectionDocument
+  | ChangeStreamReshardCollectionDocument
+  | ChangeStreamRefineCollectionShardKeyDocument;
 
 /** @public */
 export interface UpdateDescription<TSchema extends Document = Document> {
@@ -590,7 +775,7 @@ export class ChangeStream<
    * @internal
    */
   private _createChangeStreamCursor(
-    options: ChangeStreamOptions | ResumeOptions
+    options: ChangeStreamOptions | ChangeStreamCursorOptions
   ): ChangeStreamCursor<TSchema, TChange> {
     const changeStreamStageOptions = filterOptions(options, CHANGE_STREAM_OPTIONS);
     if (this.type === CHANGE_DOMAIN_TYPES.CLUSTER) {
@@ -598,13 +783,27 @@ export class ChangeStream<
     }
     const pipeline = [{ $changeStream: changeStreamStageOptions }, ...this.pipeline];
 
-    const cursorOptions: ChangeStreamCursorOptions = filterOptions(options, CURSOR_OPTIONS);
+    const client: MongoClient | null =
+      this.type === CHANGE_DOMAIN_TYPES.CLUSTER
+        ? (this.parent as MongoClient)
+        : this.type === CHANGE_DOMAIN_TYPES.DATABASE
+        ? (this.parent as Db).s.client
+        : this.type === CHANGE_DOMAIN_TYPES.COLLECTION
+        ? (this.parent as Collection).s.db.s.client
+        : null;
+
+    if (client == null) {
+      // This should never happen because of the assertion in the constructor
+      throw new MongoRuntimeError(
+        `Changestream type should only be one of cluster, database, collection. Found ${this.type.toString()}`
+      );
+    }
 
     const changeStreamCursor = new ChangeStreamCursor<TSchema, TChange>(
-      getTopology(this.parent),
+      client,
       this.namespace,
       pipeline,
-      cursorOptions
+      options
     );
 
     for (const event of CHANGE_STREAM_EVENTS) {
@@ -789,7 +988,7 @@ export class ChangeStream<
    * Drain the resume queue when a new has become available
    * @internal
    *
-   * @param err - error getting a new cursor
+   * @param error - error getting a new cursor
    */
   private _processResumeQueue(error?: Error) {
     while (this[kResumeQueue].length) {
@@ -817,6 +1016,9 @@ export interface ChangeStreamCursorOptions extends AbstractCursorOptions {
   startAtOperationTime?: OperationTime;
   resumeAfter?: ResumeToken;
   startAfter?: ResumeToken;
+  maxAwaitTimeMS?: number;
+  collation?: CollationOptions;
+  fullDocument?: string;
 }
 
 /** @internal */
@@ -835,12 +1037,12 @@ export class ChangeStreamCursor<
   pipeline: Document[];
 
   constructor(
-    topology: Topology,
+    client: MongoClient,
     namespace: MongoDBNamespace,
     pipeline: Document[] = [],
     options: ChangeStreamCursorOptions = {}
   ) {
-    super(topology, namespace, options);
+    super(client, namespace, options);
 
     this.pipeline = pipeline;
     this.options = options;
@@ -863,25 +1065,26 @@ export class ChangeStreamCursor<
     return this._resumeToken;
   }
 
-  get resumeOptions(): ResumeOptions {
-    const result: ResumeOptions = filterOptions(this.options, CURSOR_OPTIONS);
-
-    if (this.resumeToken || this.startAtOperationTime) {
-      for (const key of ['resumeAfter', 'startAfter', 'startAtOperationTime']) {
-        Reflect.deleteProperty(result, key);
-      }
+  get resumeOptions(): ChangeStreamCursorOptions {
+    const options: ChangeStreamCursorOptions = {
+      ...this.options
+    };
 
-      if (this.resumeToken) {
-        const resumeKey =
-          this.options.startAfter && !this.hasReceived ? 'startAfter' : 'resumeAfter';
+    for (const key of ['resumeAfter', 'startAfter', 'startAtOperationTime'] as const) {
+      delete options[key];
+    }
 
-        result[resumeKey] = this.resumeToken;
-      } else if (this.startAtOperationTime && maxWireVersion(this.server) >= 7) {
-        result.startAtOperationTime = this.startAtOperationTime;
+    if (this.resumeToken != null) {
+      if (this.options.startAfter && !this.hasReceived) {
+        options.startAfter = this.resumeToken;
+      } else {
+        options.resumeAfter = this.resumeToken;
       }
+    } else if (this.startAtOperationTime != null && maxWireVersion(this.server) >= 7) {
+      options.startAtOperationTime = this.startAtOperationTime;
     }
 
-    return result;
+    return options;
   }
 
   cacheResumeToken(resumeToken: ResumeToken): void {
@@ -907,7 +1110,7 @@ export class ChangeStreamCursor<
   }
 
   clone(): AbstractCursor<TChange> {
-    return new ChangeStreamCursor(this.topology, this.namespace, this.pipeline, {
+    return new ChangeStreamCursor(this.client, this.namespace, this.pipeline, {
       ...this.cursorOptions
     });
   }
@@ -920,7 +1123,7 @@ export class ChangeStreamCursor<
     });
 
     executeOperation<TODO_NODE_3286, ChangeStreamAggregateRawResult<TChange>>(
-      session,
+      session.client,
       aggregateOperation,
       (err, response) => {
         if (err || response == null) {

package/src/cmap/auth/scram.ts

@@ -261,7 +261,17 @@ function passwordDigest(username: string, password: string) {
     throw new MongoInvalidArgumentError('Password cannot be empty');
   }
 
-  const md5 = crypto.createHash('md5');
+  let md5: crypto.Hash;
+  try {
+    md5 = crypto.createHash('md5');
+  } catch (err) {
+    if (crypto.getFips()) {
+      // This error is (slightly) more helpful than what comes from OpenSSL directly, e.g.
+      // 'Error: error:060800C8:digital envelope routines:EVP_DigestInit_ex:disabled for FIPS'
+      throw new Error('Auth mechanism SCRAM-SHA-1 is not supported in FIPS mode');
+    }
+    throw err;
+  }
   md5.update(`${username}:mongo:${password}`, 'utf8');
   return md5.digest('hex');
 }

package/src/cmap/connection.ts

@@ -1,3 +1,5 @@
+import { setTimeout } from 'timers';
+
 import { BSONSerializeOptions, Document, Long, ObjectId, pluckBSONSerializeOptions } from '../bson';
 import {
   CLOSE,
@@ -293,6 +295,15 @@ export class Connection extends TypedEventEmitter<ConnectionEvents> {
     this[kHello] = response;
   }
 
+  // Set the whether the message stream is for a monitoring connection.
+  set isMonitoringConnection(value: boolean) {
+    this[kMessageStream].isMonitoringConnection = value;
+  }
+
+  get isMonitoringConnection(): boolean {
+    return this[kMessageStream].isMonitoringConnection;
+  }
+
   get serviceId(): ObjectId | undefined {
     return this.hello?.serviceId;
   }