mongodb 6.7.0-dev.20240607.sha.aa429f8c → 6.7.0-dev.20240608.sha.0655c730

package/src/cursor/aggregation_cursor.ts

@@ -8,16 +8,11 @@ import type { Sort } from '../sort';
 import type { MongoDBNamespace } from '../utils';
 import { mergeOptions } from '../utils';
 import type { AbstractCursorOptions } from './abstract_cursor';
-import { AbstractCursor, assertUninitialized } from './abstract_cursor';
+import { AbstractCursor } from './abstract_cursor';
 
 /** @public */
 export interface AggregationCursorOptions extends AbstractCursorOptions, AggregateOptions {}
 
-/** @internal */
-const kPipeline = Symbol('pipeline');
-/** @internal */
-const kOptions = Symbol('options');
-
 /**
  * The **AggregationCursor** class is an internal class that embodies an aggregation cursor on MongoDB
  * allowing for iteration over the results returned from the underlying query. It supports
@@ -26,10 +21,9 @@ const kOptions = Symbol('options');
  * @public
  */
 export class AggregationCursor<TSchema = any> extends AbstractCursor<TSchema> {
+  public readonly pipeline: Document[];
   /** @internal */
-  [kPipeline]: Document[];
-  /** @internal */
-  [kOptions]: AggregateOptions;
+  private aggregateOptions: AggregateOptions;
 
   /** @internal */
   constructor(
@@ -40,18 +34,14 @@ export class AggregationCursor<TSchema = any> extends AbstractCursor<TSchema> {
   ) {
     super(client, namespace, options);
 
-    this[kPipeline] = pipeline;
-    this[kOptions] = options;
-  }
-
-  get pipeline(): Document[] {
-    return this[kPipeline];
+    this.pipeline = pipeline;
+    this.aggregateOptions = options;
   }
 
   clone(): AggregationCursor<TSchema> {
-    const clonedOptions = mergeOptions({}, this[kOptions]);
+    const clonedOptions = mergeOptions({}, this.aggregateOptions);
     delete clonedOptions.session;
-    return new AggregationCursor(this.client, this.namespace, this[kPipeline], {
+    return new AggregationCursor(this.client, this.namespace, this.pipeline, {
       ...clonedOptions
     });
   }
@@ -62,8 +52,8 @@ export class AggregationCursor<TSchema = any> extends AbstractCursor<TSchema> {
 
   /** @internal */
   async _initialize(session: ClientSession): Promise<ExecutionResult> {
-    const aggregateOperation = new AggregateOperation(this.namespace, this[kPipeline], {
-      ...this[kOptions],
+    const aggregateOperation = new AggregateOperation(this.namespace, this.pipeline, {
+      ...this.aggregateOptions,
       ...this.cursorOptions,
       session
     });
@@ -78,8 +68,8 @@ export class AggregationCursor<TSchema = any> extends AbstractCursor<TSchema> {
   async explain(verbosity?: ExplainVerbosityLike): Promise<Document> {
     return await executeOperation(
       this.client,
-      new AggregateOperation(this.namespace, this[kPipeline], {
-        ...this[kOptions], // NOTE: order matters here, we may need to refine this
+      new AggregateOperation(this.namespace, this.pipeline, {
+        ...this.aggregateOptions, // NOTE: order matters here, we may need to refine this
         ...this.cursorOptions,
         explain: verbosity ?? true
       })
@@ -101,8 +91,8 @@ export class AggregationCursor<TSchema = any> extends AbstractCursor<TSchema> {
   addStage(stage: Document): this;
   addStage<T = Document>(stage: Document): AggregationCursor<T>;
   addStage<T = Document>(stage: Document): AggregationCursor<T> {
-    assertUninitialized(this);
-    this[kPipeline].push(stage);
+    this.throwIfInitialized();
+    this.pipeline.push(stage);
     return this as unknown as AggregationCursor<T>;
   }
 

package/src/cursor/change_stream_cursor.ts

@@ -43,15 +43,12 @@ export class ChangeStreamCursor<
   TSchema extends Document = Document,
   TChange extends Document = ChangeStreamDocument<TSchema>
 > extends AbstractCursor<TChange, ChangeStreamEvents> {
-  _resumeToken: ResumeToken;
-  startAtOperationTime?: OperationTime;
-  hasReceived?: boolean;
-  resumeAfter: ResumeToken;
-  startAfter: ResumeToken;
-  options: ChangeStreamCursorOptions;
-
-  postBatchResumeToken?: ResumeToken;
-  pipeline: Document[];
+  private _resumeToken: ResumeToken;
+  private startAtOperationTime?: OperationTime;
+  private hasReceived?: boolean;
+  private readonly changeStreamCursorOptions: ChangeStreamCursorOptions;
+  private postBatchResumeToken?: ResumeToken;
+  private readonly pipeline: Document[];
 
   /**
    * @internal
@@ -69,7 +66,7 @@ export class ChangeStreamCursor<
     super(client, namespace, options);
 
     this.pipeline = pipeline;
-    this.options = options;
+    this.changeStreamCursorOptions = options;
     this._resumeToken = null;
     this.startAtOperationTime = options.startAtOperationTime;
 
@@ -91,7 +88,7 @@ export class ChangeStreamCursor<
 
   get resumeOptions(): ChangeStreamCursorOptions {
     const options: ChangeStreamCursorOptions = {
-      ...this.options
+      ...this.changeStreamCursorOptions
     };
 
     for (const key of ['resumeAfter', 'startAfter', 'startAtOperationTime'] as const) {
@@ -99,7 +96,7 @@ export class ChangeStreamCursor<
     }
 
     if (this.resumeToken != null) {
-      if (this.options.startAfter && !this.hasReceived) {
+      if (this.changeStreamCursorOptions.startAfter && !this.hasReceived) {
         options.startAfter = this.resumeToken;
       } else {
         options.resumeAfter = this.resumeToken;
@@ -142,7 +139,7 @@ export class ChangeStreamCursor<
   async _initialize(session: ClientSession): Promise<ExecutionResult> {
     const aggregateOperation = new AggregateOperation(this.namespace, this.pipeline, {
       ...this.cursorOptions,
-      ...this.options,
+      ...this.changeStreamCursorOptions,
       session
     });
 
@@ -156,8 +153,8 @@ export class ChangeStreamCursor<
 
     if (
       this.startAtOperationTime == null &&
-      this.resumeAfter == null &&
-      this.startAfter == null &&
+      this.changeStreamCursorOptions.resumeAfter == null &&
+      this.changeStreamCursorOptions.startAfter == null &&
       this.maxWireVersion >= 7
     ) {
       this.startAtOperationTime = response.operationTime;

package/src/cursor/find_cursor.ts

@@ -11,14 +11,7 @@ import type { Hint } from '../operations/operation';
 import type { ClientSession } from '../sessions';
 import { formatSort, type Sort, type SortDirection } from '../sort';
 import { emitWarningOnce, mergeOptions, type MongoDBNamespace, squashError } from '../utils';
-import { AbstractCursor, assertUninitialized } from './abstract_cursor';
-
-/** @internal */
-const kFilter = Symbol('filter');
-/** @internal */
-const kNumReturned = Symbol('numReturned');
-/** @internal */
-const kBuiltOptions = Symbol('builtOptions');
+import { AbstractCursor } from './abstract_cursor';
 
 /** @public Flags allowed for cursor */
 export const FLAGS = [
@@ -33,11 +26,11 @@ export const FLAGS = [
 /** @public */
 export class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
   /** @internal */
-  [kFilter]: Document;
+  private cursorFilter: Document;
   /** @internal */
-  [kNumReturned] = 0;
+  private numReturned = 0;
   /** @internal */
-  [kBuiltOptions]: FindOptions;
+  private readonly findOptions: FindOptions;
 
   /** @internal */
   constructor(
@@ -48,18 +41,18 @@ export class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
   ) {
     super(client, namespace, options);
 
-    this[kFilter] = filter;
-    this[kBuiltOptions] = options;
+    this.cursorFilter = filter;
+    this.findOptions = options;
 
     if (options.sort != null) {
-      this[kBuiltOptions].sort = formatSort(options.sort);
+      this.findOptions.sort = formatSort(options.sort);
     }
   }
 
   clone(): FindCursor<TSchema> {
-    const clonedOptions = mergeOptions({}, this[kBuiltOptions]);
+    const clonedOptions = mergeOptions({}, this.findOptions);
     delete clonedOptions.session;
-    return new FindCursor(this.client, this.namespace, this[kFilter], {
+    return new FindCursor(this.client, this.namespace, this.cursorFilter, {
       ...clonedOptions
     });
   }
@@ -70,8 +63,8 @@ export class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
 
   /** @internal */
   async _initialize(session: ClientSession): Promise<ExecutionResult> {
-    const findOperation = new FindOperation(this.namespace, this[kFilter], {
-      ...this[kBuiltOptions], // NOTE: order matters here, we may need to refine this
+    const findOperation = new FindOperation(this.namespace, this.cursorFilter, {
+      ...this.findOptions, // NOTE: order matters here, we may need to refine this
       ...this.cursorOptions,
       session
     });
@@ -80,10 +73,10 @@ export class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
 
     // the response is not a cursor when `explain` is enabled
     if (CursorResponse.is(response)) {
-      this[kNumReturned] = response.batchSize;
+      this.numReturned = response.batchSize;
     } else {
       // Can be an explain response, hence the ?. on everything
-      this[kNumReturned] = this[kNumReturned] + (response?.cursor?.firstBatch?.length ?? 0);
+      this.numReturned = this.numReturned + (response?.cursor?.firstBatch?.length ?? 0);
     }
 
     // TODO: NODE-2882
@@ -92,10 +85,10 @@ export class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
 
   /** @internal */
   override async getMore(batchSize: number): Promise<Document | null> {
-    const numReturned = this[kNumReturned];
+    const numReturned = this.numReturned;
     if (numReturned) {
       // TODO(DRIVERS-1448): Remove logic to enforce `limit` in the driver
-      const limit = this[kBuiltOptions].limit;
+      const limit = this.findOptions.limit;
       batchSize =
         limit && limit > 0 && numReturned + batchSize > limit ? limit - numReturned : batchSize;
 
@@ -120,9 +113,9 @@ export class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
     const response = await super.getMore(batchSize, false);
     // TODO: wrap this in some logic to prevent it from happening if we don't need this support
     if (CursorResponse.is(response)) {
-      this[kNumReturned] = this[kNumReturned] + response.batchSize;
+      this.numReturned = this.numReturned + response.batchSize;
     } else {
-      this[kNumReturned] = this[kNumReturned] + (response?.cursor?.nextBatch?.length ?? 0);
+      this.numReturned = this.numReturned + (response?.cursor?.nextBatch?.length ?? 0);
     }
 
     return response;
@@ -141,8 +134,8 @@ export class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
     }
     return await executeOperation(
       this.client,
-      new CountOperation(this.namespace, this[kFilter], {
-        ...this[kBuiltOptions], // NOTE: order matters here, we may need to refine this
+      new CountOperation(this.namespace, this.cursorFilter, {
+        ...this.findOptions, // NOTE: order matters here, we may need to refine this
         ...this.cursorOptions,
         ...options
       })
@@ -153,8 +146,8 @@ export class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
   async explain(verbosity?: ExplainVerbosityLike): Promise<Document> {
     return await executeOperation(
       this.client,
-      new FindOperation(this.namespace, this[kFilter], {
-        ...this[kBuiltOptions], // NOTE: order matters here, we may need to refine this
+      new FindOperation(this.namespace, this.cursorFilter, {
+        ...this.findOptions, // NOTE: order matters here, we may need to refine this
         ...this.cursorOptions,
         explain: verbosity ?? true
       })
@@ -163,8 +156,8 @@ export class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
 
   /** Set the cursor query */
   filter(filter: Document): this {
-    assertUninitialized(this);
-    this[kFilter] = filter;
+    this.throwIfInitialized();
+    this.cursorFilter = filter;
     return this;
   }
 
@@ -174,8 +167,8 @@ export class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
    * @param hint - If specified, then the query system will only consider plans using the hinted index.
    */
   hint(hint: Hint): this {
-    assertUninitialized(this);
-    this[kBuiltOptions].hint = hint;
+    this.throwIfInitialized();
+    this.findOptions.hint = hint;
     return this;
   }
 
@@ -185,8 +178,8 @@ export class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
    * @param min - Specify a $min value to specify the inclusive lower bound for a specific index in order to constrain the results of find(). The $min specifies the lower bound for all keys of a specific index in order.
    */
   min(min: Document): this {
-    assertUninitialized(this);
-    this[kBuiltOptions].min = min;
+    this.throwIfInitialized();
+    this.findOptions.min = min;
     return this;
   }
 
@@ -196,8 +189,8 @@ export class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
    * @param max - Specify a $max value to specify the exclusive upper bound for a specific index in order to constrain the results of find(). The $max specifies the upper bound for all keys of a specific index in order.
    */
   max(max: Document): this {
-    assertUninitialized(this);
-    this[kBuiltOptions].max = max;
+    this.throwIfInitialized();
+    this.findOptions.max = max;
     return this;
   }
 
@@ -209,8 +202,8 @@ export class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
    * @param value - the returnKey value.
    */
   returnKey(value: boolean): this {
-    assertUninitialized(this);
-    this[kBuiltOptions].returnKey = value;
+    this.throwIfInitialized();
+    this.findOptions.returnKey = value;
     return this;
   }
 
@@ -220,8 +213,8 @@ export class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
    * @param value - The $showDiskLoc option has now been deprecated and replaced with the showRecordId field. $showDiskLoc will still be accepted for OP_QUERY stye find.
    */
   showRecordId(value: boolean): this {
-    assertUninitialized(this);
-    this[kBuiltOptions].showRecordId = value;
+    this.throwIfInitialized();
+    this.findOptions.showRecordId = value;
     return this;
   }
 
@@ -232,7 +225,7 @@ export class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
    * @param value - The modifier value.
    */
   addQueryModifier(name: string, value: string | boolean | number | Document): this {
-    assertUninitialized(this);
+    this.throwIfInitialized();
     if (name[0] !== '$') {
       throw new MongoInvalidArgumentError(`${name} is not a valid query modifier`);
     }
@@ -243,43 +236,43 @@ export class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
     // NOTE: consider some TS magic for this
     switch (field) {
       case 'comment':
-        this[kBuiltOptions].comment = value as string | Document;
+        this.findOptions.comment = value as string | Document;
         break;
 
       case 'explain':
-        this[kBuiltOptions].explain = value as boolean;
+        this.findOptions.explain = value as boolean;
         break;
 
       case 'hint':
-        this[kBuiltOptions].hint = value as string | Document;
+        this.findOptions.hint = value as string | Document;
         break;
 
       case 'max':
-        this[kBuiltOptions].max = value as Document;
+        this.findOptions.max = value as Document;
         break;
 
       case 'maxTimeMS':
-        this[kBuiltOptions].maxTimeMS = value as number;
+        this.findOptions.maxTimeMS = value as number;
         break;
 
       case 'min':
-        this[kBuiltOptions].min = value as Document;
+        this.findOptions.min = value as Document;
         break;
 
       case 'orderby':
-        this[kBuiltOptions].sort = formatSort(value as string | Document);
+        this.findOptions.sort = formatSort(value as string | Document);
         break;
 
       case 'query':
-        this[kFilter] = value as Document;
+        this.cursorFilter = value as Document;
         break;
 
       case 'returnKey':
-        this[kBuiltOptions].returnKey = value as boolean;
+        this.findOptions.returnKey = value as boolean;
         break;
 
       case 'showDiskLoc':
-        this[kBuiltOptions].showRecordId = value as boolean;
+        this.findOptions.showRecordId = value as boolean;
         break;
 
       default:
@@ -295,8 +288,8 @@ export class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
    * @param value - The comment attached to this query.
    */
   comment(value: string): this {
-    assertUninitialized(this);
-    this[kBuiltOptions].comment = value;
+    this.throwIfInitialized();
+    this.findOptions.comment = value;
     return this;
   }
 
@@ -306,12 +299,12 @@ export class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
    * @param value - Number of milliseconds to wait before aborting the tailed query.
    */
   maxAwaitTimeMS(value: number): this {
-    assertUninitialized(this);
+    this.throwIfInitialized();
     if (typeof value !== 'number') {
       throw new MongoInvalidArgumentError('Argument for maxAwaitTimeMS must be a number');
     }
 
-    this[kBuiltOptions].maxAwaitTimeMS = value;
+    this.findOptions.maxAwaitTimeMS = value;
     return this;
   }
 
@@ -321,12 +314,12 @@ export class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
    * @param value - Number of milliseconds to wait before aborting the query.
    */
   override maxTimeMS(value: number): this {
-    assertUninitialized(this);
+    this.throwIfInitialized();
     if (typeof value !== 'number') {
       throw new MongoInvalidArgumentError('Argument for maxTimeMS must be a number');
     }
 
-    this[kBuiltOptions].maxTimeMS = value;
+    this.findOptions.maxTimeMS = value;
     return this;
   }
 
@@ -371,8 +364,8 @@ export class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
    * ```
    */
   project<T extends Document = Document>(value: Document): FindCursor<T> {
-    assertUninitialized(this);
-    this[kBuiltOptions].projection = value;
+    this.throwIfInitialized();
+    this.findOptions.projection = value;
     return this as unknown as FindCursor<T>;
   }
 
@@ -383,12 +376,12 @@ export class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
    * @param direction - The direction of the sorting (1 or -1).
    */
   sort(sort: Sort | string, direction?: SortDirection): this {
-    assertUninitialized(this);
-    if (this[kBuiltOptions].tailable) {
+    this.throwIfInitialized();
+    if (this.findOptions.tailable) {
       throw new MongoTailableCursorError('Tailable cursor does not support sorting');
     }
 
-    this[kBuiltOptions].sort = formatSort(sort, direction);
+    this.findOptions.sort = formatSort(sort, direction);
     return this;
   }
 
@@ -399,19 +392,19 @@ export class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
    * {@link https://www.mongodb.com/docs/manual/reference/command/find/#find-cmd-allowdiskuse | find command allowDiskUse documentation}
    */
   allowDiskUse(allow = true): this {
-    assertUninitialized(this);
+    this.throwIfInitialized();
 
-    if (!this[kBuiltOptions].sort) {
+    if (!this.findOptions.sort) {
       throw new MongoInvalidArgumentError('Option "allowDiskUse" requires a sort specification');
     }
 
     // As of 6.0 the default is true. This allows users to get back to the old behavior.
     if (!allow) {
-      this[kBuiltOptions].allowDiskUse = false;
+      this.findOptions.allowDiskUse = false;
       return this;
     }
 
-    this[kBuiltOptions].allowDiskUse = true;
+    this.findOptions.allowDiskUse = true;
     return this;
   }
 
@@ -421,8 +414,8 @@ export class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
    * @param value - The cursor collation options (MongoDB 3.4 or higher) settings for update operation (see 3.4 documentation for available fields).
    */
   collation(value: CollationOptions): this {
-    assertUninitialized(this);
-    this[kBuiltOptions].collation = value;
+    this.throwIfInitialized();
+    this.findOptions.collation = value;
     return this;
   }
 
@@ -432,8 +425,8 @@ export class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
    * @param value - The limit for the cursor query.
    */
   limit(value: number): this {
-    assertUninitialized(this);
-    if (this[kBuiltOptions].tailable) {
+    this.throwIfInitialized();
+    if (this.findOptions.tailable) {
       throw new MongoTailableCursorError('Tailable cursor does not support limit');
     }
 
@@ -441,7 +434,7 @@ export class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
       throw new MongoInvalidArgumentError('Operation "limit" requires an integer');
     }
 
-    this[kBuiltOptions].limit = value;
+    this.findOptions.limit = value;
     return this;
   }
 
@@ -451,8 +444,8 @@ export class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
    * @param value - The skip for the cursor query.
    */
   skip(value: number): this {
-    assertUninitialized(this);
-    if (this[kBuiltOptions].tailable) {
+    this.throwIfInitialized();
+    if (this.findOptions.tailable) {
       throw new MongoTailableCursorError('Tailable cursor does not support skip');
     }
 
@@ -460,7 +453,7 @@ export class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
       throw new MongoInvalidArgumentError('Operation "skip" requires an integer');
     }
 
-    this[kBuiltOptions].skip = value;
+    this.findOptions.skip = value;
     return this;
   }
 }