fix: typings for readConcern

NODE-2806

Author: Thomas Reggi

src/change_stream.ts

@@ -34,6 +34,7 @@ const CHANGE_DOMAIN_TYPES = {
   CLUSTER: Symbol('Cluster')
 };
 
+/** @public */
 export interface ResumeOptions {
   startAtOperationTime?: Timestamp;
   batchSize?: number;

src/collection.ts

@@ -14,7 +14,7 @@ import { UnorderedBulkOperation } from './bulk/unordered';
 import { OrderedBulkOperation } from './bulk/ordered';
 import { ChangeStream, ChangeStreamOptions } from './change_stream';
 import { WriteConcern, WriteConcernOptions } from './write_concern';
-import { ReadConcern } from './read_concern';
+import { ReadConcern, ReadConcernLike } from './read_concern';
 import { AggregationCursor, CommandCursor, Cursor } from './cursor';
 import { AggregateOperation, AggregateOptions } from './operations/aggregate';
 import { BulkWriteOperation } from './operations/bulk_write';
@@ -113,7 +113,7 @@ export interface CollectionOptions
   /** Returns an error if the collection does not exist */
   strict?: boolean;
   /** Specify a read concern for the collection. (only MongoDB 3.2 or higher supported) */
-  readConcern?: ReadConcern;
+  readConcern?: ReadConcernLike;
   /** The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST). */
   readPreference?: ReadPreferenceLike;
 }

src/db.ts

@@ -250,9 +250,7 @@ export class Db implements OperationParent {
   ): Promise<Collection> | void {
     if (typeof options === 'function') (callback = options), (options = {});
     options = options || {};
-    options.readConcern = options.readConcern
-      ? new ReadConcern(options.readConcern.level)
-      : this.readConcern;
+    options.readConcern = ReadConcern.fromOptions(options) ?? this.readConcern;
 
     return executeOperation(
       this.s.topology,
@@ -340,9 +338,7 @@ export class Db implements OperationParent {
     options = Object.assign({}, options);
 
     // If we have not set a collection level readConcern set the db level one
-    options.readConcern = options.readConcern
-      ? new ReadConcern(options.readConcern.level)
-      : this.readConcern;
+    options.readConcern = ReadConcern.fromOptions(options) ?? this.readConcern;
 
     // Do we have ignoreUndefined set
     if (this.s.options?.ignoreUndefined) {

src/index.ts

@@ -104,7 +104,8 @@ export type {
   ResumeToken,
   PipeOptions,
   ChangeStreamCursorOptions,
-  OperationTime
+  OperationTime,
+  ResumeOptions
 } from './change_stream';
 export type { AuthMechanism } from './cmap/auth/defaultAuthProviders';
 export type { MongoCredentials, MongoCredentialsOptions } from './cmap/auth/mongo_credentials';
@@ -239,12 +240,18 @@ export type { ProfilingLevel, SetProfilingLevelOptions } from './operations/set_
 export type { CollStatsOptions, DbStatsOptions } from './operations/stats';
 export type { UpdateResult, UpdateOptions } from './operations/update';
 export type { ValidateCollectionOptions } from './operations/validate_collection';
-export type { ReadConcern, ReadConcernLevel } from './read_concern';
+export type {
+  ReadConcern,
+  ReadConcernLevel,
+  ReadConcernLike,
+  ReadConcernLevelLike
+} from './read_concern';
 export type {
   ReadPreferenceLike,
   ReadPreferenceMode,
   ReadPreferenceOptions,
   ReadPreferenceLikeOptions,
+  ReadPreferenceFromOptions,
   HedgeOptions
 } from './read_preference';
 export type { ClusterTime, ServerType, TimerQueue, TopologyType } from './sdam/common';

src/mongo_client.ts

@@ -9,7 +9,7 @@ import { deprecate } from 'util';
 import { connect, validOptions } from './operations/connect';
 import { PromiseProvider } from './promise_provider';
 import { Logger } from './logger';
-import { ReadConcernLevel, ReadConcern } from './read_concern';
+import { ReadConcern, ReadConcernLevelLike, ReadConcernLike } from './read_concern';
 import type { BSONSerializeOptions, Document } from './bson';
 import type { AutoEncryptionOptions } from './deps';
 import type { CompressorName } from './cmap/wire_protocol/compression';
@@ -91,7 +91,7 @@ export interface MongoURIOptions extends Pick<WriteConcernOptions, 'journal' | '
   /** The maximum time in milliseconds that a thread can wait for a connection to become available. */
   waitQueueTimeoutMS?: number;
   /** The level of isolation */
-  readConcernLevel?: ReadConcernLevel;
+  readConcernLevel?: ReadConcernLevelLike;
   /** Specifies the read preferences for this connection */
   readPreference?: ReadPreferenceMode | ReadPreference;
   /** Specifies, in seconds, how stale a secondary can be before the client stops using it for read operations. */
@@ -174,7 +174,7 @@ export interface MongoClientOptions
   /** A Promise library class the application wishes to use such as Bluebird, must be ES6 compatible */
   promiseLibrary?: any;
   /** Specify a read concern for the collection (only MongoDB 3.2 or higher supported) */
-  readConcern?: ReadConcern;
+  readConcern?: ReadConcernLike;
   /** The logging level */
   loggerLevel?: LogLevel;
   /** Custom logger object */

src/operations/command.ts

@@ -9,6 +9,7 @@ import type { Logger } from '../logger';
 import type { Server } from '../sdam/server';
 import type { Document } from '../bson';
 import type { CollationOptions } from '../cmap/wire_protocol/write_command';
+import type { ReadConcernLike } from './../read_concern';
 
 const SUPPORTS_WRITE_CONCERN_AND_COLLATION = 5;
 
@@ -17,7 +18,7 @@ export interface CommandOperationOptions extends OperationOptions, WriteConcernO
   /** Return the full server response for the command */
   fullResponse?: boolean;
   /** Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported) */
-  readConcern?: ReadConcern;
+  readConcern?: ReadConcernLike;
   /** The preferred read preference (ReadPreference.primary, ReadPreference.primary_preferred, ReadPreference.secondary, ReadPreference.secondary_preferred, ReadPreference.nearest). */
   readPreference?: ReadPreferenceLike;
   /** Collation */

src/operations/find.ts

@@ -13,7 +13,7 @@ import type { Server } from '../sdam/server';
 import type { Collection } from '../collection';
 import type { CollationOptions } from '../cmap/wire_protocol/write_command';
 import type { QueryOptions } from '../cmap/wire_protocol/query';
-import { CommandOperation } from './command';
+import { CommandOperation, CommandOperationOptions } from './command';
 
 /** @public */
 export type SortDirection = 1 | -1 | 'asc' | 'desc' | { $meta: string };
@@ -24,7 +24,7 @@ export type Sort =
   | [string, SortDirection];
 
 /** @public */
-export interface FindOptions extends QueryOptions {
+export interface FindOptions extends QueryOptions, CommandOperationOptions {
   /** Sets the limit of documents returned in the query. */
   limit?: number;
   /** Set to sort the documents coming back from the query. Array of indexes, `[['a', 1]]` etc. */

src/read_concern.ts

@@ -7,6 +7,12 @@ export enum ReadConcernLevel {
   snapshot = 'snapshot'
 }
 
+/** @public */
+export type ReadConcernLevelLike = ReadConcernLevel | keyof typeof ReadConcernLevel;
+
+/** @public */
+export type ReadConcernLike = ReadConcern | { level: ReadConcernLevelLike } | ReadConcernLevelLike;
+
 /**
  * The MongoDB ReadConcern, which allows for control of the consistency and isolation properties
  * of the data read from replica sets and replica set shards.
@@ -15,11 +21,17 @@ export enum ReadConcernLevel {
  * @see https://docs.mongodb.com/manual/reference/read-concern/index.html
  */
 export class ReadConcern {
-  level: ReadConcernLevel;
+  level: ReadConcernLevel | string;
 
   /** Constructs a ReadConcern from the read concern level.*/
-  constructor(level: ReadConcernLevel) {
-    this.level = level;
+  constructor(level: ReadConcernLevelLike) {
+    /**
+     * A spec test exists that allows level to be any string.
+     * "invalid readConcern with out stage"
+     * @see ./test/spec/crud/v2/aggregate-out-readConcern.json
+     * @see https://github.com/mongodb/specifications/blob/master/source/read-write-concern/read-write-concern.rst#unknown-levels-and-additional-options-for-string-based-readconcerns
+     */
+    this.level = ReadConcernLevel[level] || level;
   }
 
   /**
@@ -28,19 +40,22 @@ export class ReadConcern {
    * @param options - The options object from which to extract the write concern.
    */
   static fromOptions(options?: {
-    readConcern?: ReadConcern | { level: ReadConcernLevel };
-    level?: ReadConcernLevel;
+    readConcern?: ReadConcernLike;
+    level?: ReadConcernLevelLike;
   }): ReadConcern | undefined {
     if (options == null) {
       return;
     }
 
     if (options.readConcern) {
-      if (options.readConcern instanceof ReadConcern) {
-        return options.readConcern;
+      const { readConcern } = options;
+      if (readConcern instanceof ReadConcern) {
+        return readConcern;
+      } else if (typeof readConcern === 'string') {
+        return new ReadConcern(readConcern);
+      } else if ('level' in readConcern && readConcern.level) {
+        return new ReadConcern(readConcern.level);
       }
-
-      return new ReadConcern(options.readConcern.level);
     }
 
     if (options.level) {