mongodb 4.4.1 → 4.6.0

package/src/collection.ts

@@ -2,7 +2,7 @@ import { BSONSerializeOptions, Document, resolveBSONOptions } from './bson';
 import type { AnyBulkWriteOperation, BulkWriteOptions, BulkWriteResult } from './bulk/common';
 import { OrderedBulkOperation } from './bulk/ordered';
 import { UnorderedBulkOperation } from './bulk/unordered';
-import { ChangeStream, ChangeStreamOptions } from './change_stream';
+import { ChangeStream, ChangeStreamDocument, ChangeStreamOptions } from './change_stream';
 import { AggregationCursor } from './cursor/aggregation_cursor';
 import { FindCursor } from './cursor/find_cursor';
 import type { Db } from './db';
@@ -296,7 +296,7 @@ export class Collection<TSchema extends Document = Document> {
     }
 
     return executeOperation(
-      getTopology(this),
+      this,
       new InsertOneOperation(
         this as TODO_NODE_3286,
         doc,
@@ -338,7 +338,7 @@ export class Collection<TSchema extends Document = Document> {
     options = options ? Object.assign({}, options) : { ordered: true };
 
     return executeOperation(
-      getTopology(this),
+      this,
       new InsertManyOperation(
         this as TODO_NODE_3286,
         docs,
@@ -406,7 +406,7 @@ export class Collection<TSchema extends Document = Document> {
     }
 
     return executeOperation(
-      getTopology(this),
+      this,
       new BulkWriteOperation(
         this as TODO_NODE_3286,
         operations as TODO_NODE_3286,
@@ -453,7 +453,7 @@ export class Collection<TSchema extends Document = Document> {
     if (typeof options === 'function') (callback = options), (options = {});
 
     return executeOperation(
-      getTopology(this),
+      this,
       new UpdateOneOperation(
         this as TODO_NODE_3286,
         filter,
@@ -501,7 +501,7 @@ export class Collection<TSchema extends Document = Document> {
     if (typeof options === 'function') (callback = options), (options = {});
 
     return executeOperation(
-      getTopology(this),
+      this,
       new ReplaceOneOperation(
         this as TODO_NODE_3286,
         filter,
@@ -549,7 +549,7 @@ export class Collection<TSchema extends Document = Document> {
     if (typeof options === 'function') (callback = options), (options = {});
 
     return executeOperation(
-      getTopology(this),
+      this,
       new UpdateManyOperation(
         this as TODO_NODE_3286,
         filter,
@@ -583,7 +583,7 @@ export class Collection<TSchema extends Document = Document> {
     if (typeof options === 'function') (callback = options), (options = {});
 
     return executeOperation(
-      getTopology(this),
+      this,
       new DeleteOneOperation(this as TODO_NODE_3286, filter, resolveOptions(this, options)),
       callback
     );
@@ -623,7 +623,7 @@ export class Collection<TSchema extends Document = Document> {
     }
 
     return executeOperation(
-      getTopology(this),
+      this,
       new DeleteManyOperation(this as TODO_NODE_3286, filter, resolveOptions(this, options)),
       callback
     );
@@ -652,7 +652,7 @@ export class Collection<TSchema extends Document = Document> {
 
     // Intentionally, we do not inherit options from parent for this operation.
     return executeOperation(
-      getTopology(this),
+      this,
       new RenameOperation(this as TODO_NODE_3286, newName, {
         ...options,
         readPreference: ReadPreference.PRIMARY
@@ -679,7 +679,7 @@ export class Collection<TSchema extends Document = Document> {
     options = options ?? {};
 
     return executeOperation(
-      getTopology(this),
+      this,
       new DropCollectionOperation(this.s.db, this.collectionName, options),
       callback
     );
@@ -747,7 +747,7 @@ export class Collection<TSchema extends Document = Document> {
    */
   find(): FindCursor<WithId<TSchema>>;
   find(filter: Filter<TSchema>, options?: FindOptions): FindCursor<WithId<TSchema>>;
-  find<T>(filter: Filter<TSchema>, options?: FindOptions): FindCursor<T>;
+  find<T extends Document>(filter: Filter<TSchema>, options?: FindOptions): FindCursor<T>;
   find(filter?: Filter<TSchema>, options?: FindOptions): FindCursor<WithId<TSchema>> {
     if (arguments.length > 2) {
       throw new MongoInvalidArgumentError(
@@ -783,7 +783,7 @@ export class Collection<TSchema extends Document = Document> {
     if (typeof options === 'function') (callback = options), (options = {});
 
     return executeOperation(
-      getTopology(this),
+      this,
       new OptionsOperation(this as TODO_NODE_3286, resolveOptions(this, options)),
       callback
     );
@@ -806,7 +806,7 @@ export class Collection<TSchema extends Document = Document> {
     if (typeof options === 'function') (callback = options), (options = {});
 
     return executeOperation(
-      getTopology(this),
+      this,
       new IsCappedOperation(this as TODO_NODE_3286, resolveOptions(this, options)),
       callback
     );
@@ -857,7 +857,7 @@ export class Collection<TSchema extends Document = Document> {
     if (typeof options === 'function') (callback = options), (options = {});
 
     return executeOperation(
-      getTopology(this),
+      this,
       new CreateIndexOperation(
         this as TODO_NODE_3286,
         this.collectionName,
@@ -918,7 +918,7 @@ export class Collection<TSchema extends Document = Document> {
     if (typeof options.maxTimeMS !== 'number') delete options.maxTimeMS;
 
     return executeOperation(
-      getTopology(this),
+      this,
       new CreateIndexesOperation(
         this as TODO_NODE_3286,
         this.collectionName,
@@ -952,7 +952,7 @@ export class Collection<TSchema extends Document = Document> {
     options.readPreference = ReadPreference.primary;
 
     return executeOperation(
-      getTopology(this),
+      this,
       new DropIndexOperation(this as TODO_NODE_3286, indexName, options),
       callback
     );
@@ -975,7 +975,7 @@ export class Collection<TSchema extends Document = Document> {
     if (typeof options === 'function') (callback = options), (options = {});
 
     return executeOperation(
-      getTopology(this),
+      this,
       new DropIndexesOperation(this as TODO_NODE_3286, resolveOptions(this, options)),
       callback
     );
@@ -1013,7 +1013,7 @@ export class Collection<TSchema extends Document = Document> {
     if (typeof options === 'function') (callback = options), (options = {});
 
     return executeOperation(
-      getTopology(this),
+      this,
       new IndexExistsOperation(this as TODO_NODE_3286, indexes, resolveOptions(this, options)),
       callback
     );
@@ -1036,7 +1036,7 @@ export class Collection<TSchema extends Document = Document> {
     if (typeof options === 'function') (callback = options), (options = {});
 
     return executeOperation(
-      getTopology(this),
+      this,
       new IndexInformationOperation(this.s.db, this.collectionName, resolveOptions(this, options)),
       callback
     );
@@ -1058,7 +1058,7 @@ export class Collection<TSchema extends Document = Document> {
   ): Promise<number> | void {
     if (typeof options === 'function') (callback = options), (options = {});
     return executeOperation(
-      getTopology(this),
+      this,
       new EstimatedDocumentCountOperation(this as TODO_NODE_3286, resolveOptions(this, options)),
       callback
     );
@@ -1118,7 +1118,7 @@ export class Collection<TSchema extends Document = Document> {
 
     filter ??= {};
     return executeOperation(
-      getTopology(this),
+      this,
       new CountDocumentsOperation(
         this as TODO_NODE_3286,
         filter as Document,
@@ -1193,7 +1193,7 @@ export class Collection<TSchema extends Document = Document> {
 
     filter ??= {};
     return executeOperation(
-      getTopology(this),
+      this,
       new DistinctOperation(
         this as TODO_NODE_3286,
         key as TODO_NODE_3286,
@@ -1221,7 +1221,7 @@ export class Collection<TSchema extends Document = Document> {
     if (typeof options === 'function') (callback = options), (options = {});
 
     return executeOperation(
-      getTopology(this),
+      this,
       new IndexesOperation(this as TODO_NODE_3286, resolveOptions(this, options)),
       callback
     );
@@ -1245,7 +1245,7 @@ export class Collection<TSchema extends Document = Document> {
     options = options ?? {};
 
     return executeOperation(
-      getTopology(this),
+      this,
       new CollStatsOperation(this as TODO_NODE_3286, options),
       callback
     );
@@ -1277,7 +1277,7 @@ export class Collection<TSchema extends Document = Document> {
     if (typeof options === 'function') (callback = options), (options = {});
 
     return executeOperation(
-      getTopology(this),
+      this,
       new FindOneAndDeleteOperation(
         this as TODO_NODE_3286,
         filter,
@@ -1324,7 +1324,7 @@ export class Collection<TSchema extends Document = Document> {
     if (typeof options === 'function') (callback = options), (options = {});
 
     return executeOperation(
-      getTopology(this),
+      this,
       new FindOneAndReplaceOperation(
         this as TODO_NODE_3286,
         filter,
@@ -1372,7 +1372,7 @@ export class Collection<TSchema extends Document = Document> {
     if (typeof options === 'function') (callback = options), (options = {});
 
     return executeOperation(
-      getTopology(this),
+      this,
       new FindOneAndUpdateOperation(
         this as TODO_NODE_3286,
         filter,
@@ -1389,7 +1389,7 @@ export class Collection<TSchema extends Document = Document> {
    * @param pipeline - An array of aggregation pipelines to execute
    * @param options - Optional settings for the command
    */
-  aggregate<T = Document>(
+  aggregate<T extends Document = Document>(
     pipeline: Document[] = [],
     options?: AggregateOptions
   ): AggregationCursor<T> {
@@ -1418,21 +1418,52 @@ export class Collection<TSchema extends Document = Document> {
   /**
    * Create a new Change Stream, watching for new changes (insertions, updates, replacements, deletions, and invalidations) in this collection.
    *
-   * @since 3.0.0
+   * @remarks
+   * watch() accepts two generic arguments for distinct usecases:
+   * - The first is to override the schema that may be defined for this specific collection
+   * - 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
+   * @example
+   * By just providing the first argument I can type the change to be `ChangeStreamDocument<{ _id: number }>`
+   * ```ts
+   * collection.watch<{ _id: number }>()
+   *   .on('change', change => console.log(change._id.toFixed(4)));
+   * ```
+   *
+   * @example
+   * Passing a second argument provides a way to reflect the type changes caused by an advanced pipeline.
+   * Here, we are using a pipeline to have MongoDB filter for insert changes only and add a comment.
+   * No need start from scratch on the ChangeStreamInsertDocument type!
+   * By using an intersection we can save time and ensure defaults remain the same type!
+   * ```ts
+   * collection
+   *   .watch<Schema, ChangeStreamInsertDocument<Schema> & { comment: string }>([
+   *     { $addFields: { comment: 'big changes' } },
+   *     { $match: { operationType: 'insert' } }
+   *   ])
+   *   .on('change', change => {
+   *     change.comment.startsWith('big');
+   *     change.operationType === 'insert';
+   *     // No need to narrow in code because the generics did that for us!
+   *     expectType<Schema>(change.fullDocument);
+   *   });
+   * ```
+   *
    * @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 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
    */
-  watch<TLocal = TSchema>(
+  watch<TLocal extends Document = TSchema, TChange extends Document = ChangeStreamDocument<TLocal>>(
     pipeline: Document[] = [],
     options: ChangeStreamOptions = {}
-  ): ChangeStream<TLocal> {
+  ): ChangeStream<TLocal, TChange> {
     // Allow optionally not specifying a pipeline
     if (!Array.isArray(pipeline)) {
       options = pipeline;
       pipeline = [];
     }
 
-    return new ChangeStream<TLocal>(this, pipeline, resolveOptions(this, options));
+    return new ChangeStream<TLocal, TChange>(this, pipeline, resolveOptions(this, options));
   }
 
   /**
@@ -1495,7 +1526,7 @@ export class Collection<TSchema extends Document = Document> {
     }
 
     return executeOperation(
-      getTopology(this),
+      this,
       new MapReduceOperation(
         this as TODO_NODE_3286,
         map,
@@ -1636,7 +1667,7 @@ export class Collection<TSchema extends Document = Document> {
 
     filter ??= {};
     return executeOperation(
-      getTopology(this),
+      this,
       new CountOperation(
         MongoDBNamespace.fromString(this.namespace),
         filter,

package/src/connection_string.ts

@@ -19,7 +19,6 @@ import {
   ServerApi,
   ServerApiVersion
 } from './mongo_client';
-import type { OneOrMore } from './mongo_types';
 import { PromiseProvider } from './promise_provider';
 import { ReadConcern, ReadConcernLevel } from './read_concern';
 import { ReadPreference, ReadPreferenceMode } from './read_preference';
@@ -220,12 +219,7 @@ function getUint(name: string, value: unknown): number {
   return parsedValue;
 }
 
-/** Wrap a single value in an array if the value is not an array */
-function toArray<T>(value: OneOrMore<T>): T[] {
-  return Array.isArray(value) ? value : [value];
-}
-
-function* entriesFromString(value: string) {
+function* entriesFromString(value: string): Generator<[string, string]> {
   const keyValuePairs = value.split(',');
   for (const keyValue of keyValuePairs) {
     const [key, value] = keyValue.split(':');
@@ -241,16 +235,16 @@ class CaseInsensitiveMap<Value = any> extends Map<string, Value> {
   constructor(entries: Array<[string, any]> = []) {
     super(entries.map(([k, v]) => [k.toLowerCase(), v]));
   }
-  has(k: string) {
+  override has(k: string) {
     return super.has(k.toLowerCase());
   }
-  get(k: string) {
+  override get(k: string) {
     return super.get(k.toLowerCase());
   }
-  set(k: string, v: any) {
+  override set(k: string, v: any) {
     return super.set(k.toLowerCase(), v);
   }
-  delete(k: string): boolean {
+  override delete(k: string): boolean {
     return super.delete(k.toLowerCase());
   }
 }
@@ -269,6 +263,14 @@ export function parseOptions(
   const { hosts, isSRV } = url;
 
   const mongoOptions = Object.create(null);
+
+  // Feature flags
+  for (const flag of Object.getOwnPropertySymbols(options)) {
+    if (FEATURE_FLAGS.has(flag)) {
+      mongoOptions[flag] = options[flag];
+    }
+  }
+
   mongoOptions.hosts = isSRV ? [] : hosts.map(HostAddress.fromString);
 
   const urlOptions = new CaseInsensitiveMap<any[]>();
@@ -333,11 +335,19 @@ export function parseOptions(
   ]);
 
   for (const key of allKeys) {
-    const values = [objectOptions, urlOptions, DEFAULT_OPTIONS].flatMap(optionsObject => {
-      const options = optionsObject.get(key) ?? [];
-      return toArray(options);
-    });
-
+    const values = [];
+    const objectOptionValue = objectOptions.get(key);
+    if (objectOptionValue != null) {
+      values.push(objectOptionValue);
+    }
+    const urlValue = urlOptions.get(key);
+    if (urlValue != null) {
+      values.push(...urlValue);
+    }
+    const defaultOptionsValue = DEFAULT_OPTIONS.get(key);
+    if (defaultOptionsValue != null) {
+      values.push(defaultOptionsValue);
+    }
     allOptions.set(key, values);
   }
 
@@ -519,6 +529,7 @@ function validateLoadBalancedOptions(
       return new MongoParseError('Cannot limit srv hosts with loadBalanced enabled');
     }
   }
+  return;
 }
 
 function setOption(
@@ -836,6 +847,7 @@ export const OPTIONS = {
       emitWarning('Alternative loggers might not be supported');
       // TODO: make Logger an interface that others can implement, make usage consistent in driver
       // DRIVERS-1204
+      return;
     }
   },
   loggerLevel: {
@@ -975,13 +987,23 @@ export const OPTIONS = {
           rpOpts
         );
       }
+      throw new MongoParseError(`Unknown ReadPreference value: ${value}`);
     }
   },
   readPreferenceTags: {
     target: 'readPreference',
-    transform({ values, options }) {
+    transform({
+      values,
+      options
+    }: {
+      values: Array<string | Record<string, string>[]>;
+      options: MongoClientOptions;
+    }) {
+      const tags: Array<string | Record<string, string>> = Array.isArray(values[0])
+        ? values[0]
+        : (values as Array<string>);
       const readPreferenceTags = [];
-      for (const tag of values) {
+      for (const tag of tags) {
         const readPreferenceTag: TagSet = Object.create(null);
         if (typeof tag === 'string') {
           for (const [k, v] of entriesFromString(tag)) {
@@ -1227,3 +1249,9 @@ export const DEFAULT_OPTIONS = new CaseInsensitiveMap(
     .filter(([, descriptor]) => descriptor.default != null)
     .map(([k, d]) => [k, d.default])
 );
+
+/**
+ * Set of permitted feature flags
+ * @internal
+ */
+export const FEATURE_FLAGS = new Set([Symbol.for('@@mdb.skipPingOnConnect')]);

package/src/constants.ts

@@ -40,6 +40,12 @@ export const COMMAND_FAILED = 'commandFailed' as const;
 export const SERVER_HEARTBEAT_STARTED = 'serverHeartbeatStarted' as const;
 export const SERVER_HEARTBEAT_SUCCEEDED = 'serverHeartbeatSucceeded' as const;
 export const SERVER_HEARTBEAT_FAILED = 'serverHeartbeatFailed' as const;
+export const RESPONSE = 'response' as const;
+export const MORE = 'more' as const;
+export const INIT = 'init' as const;
+export const CHANGE = 'change' as const;
+export const END = 'end' as const;
+export const RESUME_TOKEN_CHANGED = 'resumeTokenChanged' as const;
 
 /** @public */
 export const HEARTBEAT_EVENTS = Object.freeze([