@depup/mongodb 7.1.0-depup.0

package/src/cursor/aggregation_cursor.ts

@@ -0,0 +1,245 @@
+import type { Document } from '../bson';
+import { MongoAPIError } from '../error';
+import {
+  Explain,
+  type ExplainCommandOptions,
+  type ExplainVerbosityLike,
+  validateExplainTimeoutOptions
+} from '../explain';
+import type { MongoClient } from '../mongo_client';
+import { type Abortable } from '../mongo_types';
+import { AggregateOperation, type AggregateOptions } from '../operations/aggregate';
+import { executeOperation } from '../operations/execute_operation';
+import type { ClientSession } from '../sessions';
+import type { Sort } from '../sort';
+import { mergeOptions, type MongoDBNamespace } from '../utils';
+import {
+  type AbstractCursorOptions,
+  CursorTimeoutMode,
+  type InitialCursorResponse
+} from './abstract_cursor';
+import { ExplainableCursor } from './explainable_cursor';
+
+/** @public */
+export interface AggregationCursorOptions extends AbstractCursorOptions, AggregateOptions {}
+
+/**
+ * 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
+ * one by one document iteration, conversion to an array or can be iterated as a Node 4.X
+ * or higher stream
+ * @public
+ */
+export class AggregationCursor<TSchema = any> extends ExplainableCursor<TSchema> {
+  public readonly pipeline: Document[];
+  /** @internal */
+  private aggregateOptions: AggregateOptions & Abortable;
+
+  /** @internal */
+  constructor(
+    client: MongoClient,
+    namespace: MongoDBNamespace,
+    pipeline: Document[] = [],
+    options: AggregateOptions & Abortable = {}
+  ) {
+    super(client, namespace, options);
+
+    this.pipeline = pipeline;
+    this.aggregateOptions = options;
+
+    const lastStage: Document | undefined = this.pipeline[this.pipeline.length - 1];
+
+    if (
+      this.cursorOptions.timeoutMS != null &&
+      this.cursorOptions.timeoutMode === CursorTimeoutMode.ITERATION &&
+      (lastStage?.$merge != null || lastStage?.$out != null)
+    )
+      throw new MongoAPIError('Cannot use $out or $merge stage with ITERATION timeoutMode');
+  }
+
+  clone(): AggregationCursor<TSchema> {
+    const clonedOptions = mergeOptions({}, this.aggregateOptions);
+    delete clonedOptions.session;
+    return new AggregationCursor(this.client, this.namespace, this.pipeline, {
+      ...clonedOptions
+    });
+  }
+
+  override map<T>(transform: (doc: TSchema) => T): AggregationCursor<T> {
+    return super.map(transform) as AggregationCursor<T>;
+  }
+
+  /** @internal */
+  async _initialize(session: ClientSession): Promise<InitialCursorResponse> {
+    const options = {
+      ...this.aggregateOptions,
+      ...this.cursorOptions,
+      session,
+      signal: this.signal
+    };
+    if (options.explain) {
+      try {
+        validateExplainTimeoutOptions(options, Explain.fromOptions(options));
+      } catch {
+        throw new MongoAPIError(
+          'timeoutMS cannot be used with explain when explain is specified in aggregateOptions'
+        );
+      }
+    }
+
+    const aggregateOperation = new AggregateOperation(this.namespace, this.pipeline, options);
+
+    const response = await executeOperation(this.client, aggregateOperation, this.timeoutContext);
+
+    return { server: aggregateOperation.server, session, response };
+  }
+
+  /** Execute the explain for the cursor */
+  async explain(): Promise<Document>;
+  async explain(verbosity: ExplainVerbosityLike | ExplainCommandOptions): Promise<Document>;
+  async explain(options: { timeoutMS?: number }): Promise<Document>;
+  async explain(
+    verbosity: ExplainVerbosityLike | ExplainCommandOptions,
+    options: { timeoutMS?: number }
+  ): Promise<Document>;
+  async explain(
+    verbosity?: ExplainVerbosityLike | ExplainCommandOptions | { timeoutMS?: number },
+    options?: { timeoutMS?: number }
+  ): Promise<Document> {
+    const { explain, timeout } = this.resolveExplainTimeoutOptions(verbosity, options);
+    return (
+      await executeOperation(
+        this.client,
+        new AggregateOperation(this.namespace, this.pipeline, {
+          ...this.aggregateOptions, // NOTE: order matters here, we may need to refine this
+          ...this.cursorOptions,
+          ...timeout,
+          explain: explain ?? true
+        })
+      )
+    ).shift(this.deserializationOptions);
+  }
+
+  /** Add a stage to the aggregation pipeline
+   * @example
+   * ```
+   * const documents = await users.aggregate().addStage({ $match: { name: /Mike/ } }).toArray();
+   * ```
+   * @example
+   * ```
+   * const documents = await users.aggregate()
+   *   .addStage<{ name: string }>({ $project: { name: true } })
+   *   .toArray(); // type of documents is { name: string }[]
+   * ```
+   */
+  addStage(stage: Document): this;
+  addStage<T = Document>(stage: Document): AggregationCursor<T>;
+  addStage<T = Document>(stage: Document): AggregationCursor<T> {
+    this.throwIfInitialized();
+    if (
+      this.cursorOptions.timeoutMS != null &&
+      this.cursorOptions.timeoutMode === CursorTimeoutMode.ITERATION &&
+      (stage.$out != null || stage.$merge != null)
+    ) {
+      throw new MongoAPIError('Cannot use $out or $merge stage with ITERATION timeoutMode');
+    }
+    this.pipeline.push(stage);
+    return this as unknown as AggregationCursor<T>;
+  }
+
+  /** Add a group stage to the aggregation pipeline */
+  group<T = TSchema>($group: Document): AggregationCursor<T>;
+  group($group: Document): this {
+    return this.addStage({ $group });
+  }
+
+  /** Add a limit stage to the aggregation pipeline */
+  limit($limit: number): this {
+    return this.addStage({ $limit });
+  }
+
+  /** Add a match stage to the aggregation pipeline */
+  match($match: Document): this {
+    return this.addStage({ $match });
+  }
+
+  /** Add an out stage to the aggregation pipeline */
+  out($out: { db: string; coll: string } | string): this {
+    return this.addStage({ $out });
+  }
+
+  /**
+   * Add a project stage to the aggregation pipeline
+   *
+   * @remarks
+   * In order to strictly type this function you must provide an interface
+   * that represents the effect of your projection on the result documents.
+   *
+   * By default chaining a projection to your cursor changes the returned type to the generic {@link Document} type.
+   * You should specify a parameterized type to have assertions on your final results.
+   *
+   * @example
+   * ```typescript
+   * // Best way
+   * const docs: AggregationCursor<{ a: number }> = cursor.project<{ a: number }>({ _id: 0, a: true });
+   * // Flexible way
+   * const docs: AggregationCursor<Document> = cursor.project({ _id: 0, a: true });
+   * ```
+   *
+   * @remarks
+   * In order to strictly type this function you must provide an interface
+   * that represents the effect of your projection on the result documents.
+   *
+   * **Note for Typescript Users:** adding a transform changes the return type of the iteration of this cursor,
+   * it **does not** return a new instance of a cursor. This means when calling project,
+   * you should always assign the result to a new variable in order to get a correctly typed cursor variable.
+   * Take note of the following example:
+   *
+   * @example
+   * ```typescript
+   * const cursor: AggregationCursor<{ a: number; b: string }> = coll.aggregate([]);
+   * const projectCursor = cursor.project<{ a: number }>({ _id: 0, a: true });
+   * const aPropOnlyArray: {a: number}[] = await projectCursor.toArray();
+   *
+   * // or always use chaining and save the final cursor
+   *
+   * const cursor = coll.aggregate().project<{ a: string }>({
+   *   _id: 0,
+   *   a: { $convert: { input: '$a', to: 'string' }
+   * }});
+   * ```
+   */
+  project<T extends Document = Document>($project: Document): AggregationCursor<T> {
+    return this.addStage<T>({ $project });
+  }
+
+  /** Add a lookup stage to the aggregation pipeline */
+  lookup($lookup: Document): this {
+    return this.addStage({ $lookup });
+  }
+
+  /** Add a redact stage to the aggregation pipeline */
+  redact($redact: Document): this {
+    return this.addStage({ $redact });
+  }
+
+  /** Add a skip stage to the aggregation pipeline */
+  skip($skip: number): this {
+    return this.addStage({ $skip });
+  }
+
+  /** Add a sort stage to the aggregation pipeline */
+  sort($sort: Sort): this {
+    return this.addStage({ $sort });
+  }
+
+  /** Add a unwind stage to the aggregation pipeline */
+  unwind($unwind: Document | string): this {
+    return this.addStage({ $unwind });
+  }
+
+  /** Add a geoNear stage to the aggregation pipeline */
+  geoNear($geoNear: Document): this {
+    return this.addStage({ $geoNear });
+  }
+}

package/src/cursor/change_stream_cursor.ts

@@ -0,0 +1,171 @@
+import type { Document } from '../bson';
+import {
+  ChangeStream,
+  type ChangeStreamDocument,
+  type ChangeStreamEvents,
+  type OperationTime,
+  type ResumeToken
+} from '../change_stream';
+import { type CursorResponse } from '../cmap/wire_protocol/responses';
+import { INIT, RESPONSE } from '../constants';
+import type { MongoClient } from '../mongo_client';
+import { AggregateOperation } from '../operations/aggregate';
+import type { CollationOptions } from '../operations/command';
+import { executeOperation } from '../operations/execute_operation';
+import type { ClientSession } from '../sessions';
+import { maxWireVersion, type MongoDBNamespace } from '../utils';
+import {
+  AbstractCursor,
+  type AbstractCursorOptions,
+  type InitialCursorResponse
+} from './abstract_cursor';
+
+/** @internal */
+export interface ChangeStreamCursorOptions extends AbstractCursorOptions {
+  startAtOperationTime?: OperationTime;
+  resumeAfter?: ResumeToken;
+  startAfter?: ResumeToken;
+  maxAwaitTimeMS?: number;
+  collation?: CollationOptions;
+  fullDocument?: string;
+}
+
+/** @internal */
+export class ChangeStreamCursor<
+  TSchema extends Document = Document,
+  TChange extends Document = ChangeStreamDocument<TSchema>
+> extends AbstractCursor<TChange, ChangeStreamEvents> {
+  private _resumeToken: ResumeToken;
+  private startAtOperationTime: OperationTime | null;
+  private hasReceived?: boolean;
+  private readonly changeStreamCursorOptions: ChangeStreamCursorOptions;
+  private postBatchResumeToken?: ResumeToken;
+  private readonly pipeline: Document[];
+
+  /**
+   * @internal
+   *
+   * used to determine change stream resumability
+   */
+  maxWireVersion: number | undefined;
+
+  constructor(
+    client: MongoClient,
+    namespace: MongoDBNamespace,
+    pipeline: Document[] = [],
+    options: ChangeStreamCursorOptions = {}
+  ) {
+    super(client, namespace, { ...options, tailable: true, awaitData: true });
+
+    this.pipeline = pipeline;
+    this.changeStreamCursorOptions = options;
+    this._resumeToken = null;
+    this.startAtOperationTime = options.startAtOperationTime ?? null;
+
+    if (options.startAfter) {
+      this.resumeToken = options.startAfter;
+    } else if (options.resumeAfter) {
+      this.resumeToken = options.resumeAfter;
+    }
+  }
+
+  set resumeToken(token: ResumeToken) {
+    this._resumeToken = token;
+    this.emit(ChangeStream.RESUME_TOKEN_CHANGED, token);
+  }
+
+  get resumeToken(): ResumeToken {
+    return this._resumeToken;
+  }
+
+  get resumeOptions(): ChangeStreamCursorOptions {
+    const options: ChangeStreamCursorOptions = {
+      ...this.changeStreamCursorOptions
+    };
+
+    for (const key of ['resumeAfter', 'startAfter', 'startAtOperationTime'] as const) {
+      delete options[key];
+    }
+
+    if (this.resumeToken != null) {
+      if (this.changeStreamCursorOptions.startAfter && !this.hasReceived) {
+        options.startAfter = this.resumeToken;
+      } else {
+        options.resumeAfter = this.resumeToken;
+      }
+    } else if (this.startAtOperationTime != null) {
+      options.startAtOperationTime = this.startAtOperationTime;
+    }
+
+    return options;
+  }
+
+  cacheResumeToken(resumeToken: ResumeToken): void {
+    if (this.bufferedCount() === 0 && this.postBatchResumeToken) {
+      this.resumeToken = this.postBatchResumeToken;
+    } else {
+      this.resumeToken = resumeToken;
+    }
+    this.hasReceived = true;
+  }
+
+  _processBatch(response: CursorResponse): void {
+    const { postBatchResumeToken } = response;
+    if (postBatchResumeToken) {
+      this.postBatchResumeToken = postBatchResumeToken;
+
+      if (response.batchSize === 0) {
+        this.resumeToken = postBatchResumeToken;
+      }
+    }
+  }
+
+  clone(): AbstractCursor<TChange> {
+    return new ChangeStreamCursor(this.client, this.namespace, this.pipeline, {
+      ...this.cursorOptions
+    });
+  }
+
+  async _initialize(session: ClientSession): Promise<InitialCursorResponse> {
+    const aggregateOperation = new AggregateOperation(this.namespace, this.pipeline, {
+      ...this.cursorOptions,
+      ...this.changeStreamCursorOptions,
+      session
+    });
+
+    const response = await executeOperation(
+      session.client,
+      aggregateOperation,
+      this.timeoutContext
+    );
+
+    const server = aggregateOperation.server;
+    this.maxWireVersion = maxWireVersion(server);
+
+    if (
+      this.startAtOperationTime == null &&
+      this.changeStreamCursorOptions.resumeAfter == null &&
+      this.changeStreamCursorOptions.startAfter == null
+    ) {
+      this.startAtOperationTime = response.operationTime;
+    }
+
+    this._processBatch(response);
+
+    this.emit(INIT, response);
+    this.emit(RESPONSE);
+
+    return { server, session, response };
+  }
+
+  override async getMore(): Promise<CursorResponse> {
+    const response = await super.getMore();
+
+    this.maxWireVersion = maxWireVersion(this.server);
+    this._processBatch(response);
+
+    this.emit(ChangeStream.MORE, response);
+    this.emit(ChangeStream.RESPONSE);
+    return response;
+  }
+}

package/src/cursor/client_bulk_write_cursor.ts

@@ -0,0 +1,83 @@
+import { type Document } from '../bson';
+import { type ClientBulkWriteCursorResponse } from '../cmap/wire_protocol/responses';
+import type { MongoClient } from '../mongo_client';
+import { ClientBulkWriteOperation } from '../operations/client_bulk_write/client_bulk_write';
+import { type ClientBulkWriteCommandBuilder } from '../operations/client_bulk_write/command_builder';
+import { type ClientBulkWriteOptions } from '../operations/client_bulk_write/common';
+import { executeOperation } from '../operations/execute_operation';
+import type { ClientSession } from '../sessions';
+import { mergeOptions, MongoDBNamespace } from '../utils';
+import {
+  AbstractCursor,
+  type AbstractCursorOptions,
+  type InitialCursorResponse
+} from './abstract_cursor';
+
+/** @public */
+export interface ClientBulkWriteCursorOptions
+  extends Omit<AbstractCursorOptions, 'maxAwaitTimeMS' | 'tailable' | 'awaitData'>,
+    ClientBulkWriteOptions {}
+
+/**
+ * This is the cursor that handles client bulk write operations. Note this is never
+ * exposed directly to the user and is always immediately exhausted.
+ * @internal
+ */
+export class ClientBulkWriteCursor extends AbstractCursor {
+  commandBuilder: ClientBulkWriteCommandBuilder;
+  /** @internal */
+  private cursorResponse?: ClientBulkWriteCursorResponse;
+  /** @internal */
+  private clientBulkWriteOptions: ClientBulkWriteOptions;
+
+  /** @internal */
+  constructor(
+    client: MongoClient,
+    commandBuilder: ClientBulkWriteCommandBuilder,
+    options: ClientBulkWriteCursorOptions = {}
+  ) {
+    super(client, new MongoDBNamespace('admin', '$cmd'), options);
+
+    this.commandBuilder = commandBuilder;
+    this.clientBulkWriteOptions = options;
+  }
+
+  /**
+   * We need a way to get the top level cursor response fields for
+   * generating the bulk write result, so we expose this here.
+   */
+  get response(): ClientBulkWriteCursorResponse | null {
+    if (this.cursorResponse) return this.cursorResponse;
+    return null;
+  }
+
+  get operations(): Document[] {
+    return this.commandBuilder.lastOperations;
+  }
+
+  clone(): ClientBulkWriteCursor {
+    const clonedOptions = mergeOptions({}, this.clientBulkWriteOptions);
+    delete clonedOptions.session;
+    return new ClientBulkWriteCursor(this.client, this.commandBuilder, {
+      ...clonedOptions
+    });
+  }
+
+  /** @internal */
+  async _initialize(session: ClientSession): Promise<InitialCursorResponse> {
+    const clientBulkWriteOperation = new ClientBulkWriteOperation(this.commandBuilder, {
+      ...this.clientBulkWriteOptions,
+      ...this.cursorOptions,
+      session
+    });
+
+    const response = await executeOperation(
+      this.client,
+      clientBulkWriteOperation,
+      this.timeoutContext
+    );
+    this.cursorResponse = response;
+
+    return { server: clientBulkWriteOperation.server, session, response };
+  }
+}

package/src/cursor/explainable_cursor.ts

@@ -0,0 +1,51 @@
+import { type Document } from '../bson';
+import { type ExplainCommandOptions, type ExplainVerbosityLike } from '../explain';
+import { AbstractCursor } from './abstract_cursor';
+
+/**
+ * @public
+ *
+ * A base class for any cursors that have `explain()` methods.
+ */
+export abstract class ExplainableCursor<TSchema> extends AbstractCursor<TSchema> {
+  /** Execute the explain for the cursor */
+  abstract explain(): Promise<Document>;
+  abstract explain(verbosity: ExplainVerbosityLike | ExplainCommandOptions): Promise<Document>;
+  abstract explain(options: { timeoutMS?: number }): Promise<Document>;
+  abstract explain(
+    verbosity: ExplainVerbosityLike | ExplainCommandOptions,
+    options: { timeoutMS?: number }
+  ): Promise<Document>;
+  abstract explain(
+    verbosity?: ExplainVerbosityLike | ExplainCommandOptions | { timeoutMS?: number },
+    options?: { timeoutMS?: number }
+  ): Promise<Document>;
+
+  protected resolveExplainTimeoutOptions(
+    verbosity?: ExplainVerbosityLike | ExplainCommandOptions | { timeoutMS?: number },
+    options?: { timeoutMS?: number }
+  ): { timeout?: { timeoutMS?: number }; explain?: ExplainVerbosityLike | ExplainCommandOptions } {
+    let explain: ExplainVerbosityLike | ExplainCommandOptions | undefined;
+    let timeout: { timeoutMS?: number } | undefined;
+
+    if (verbosity == null && options == null) {
+      explain = undefined;
+      timeout = undefined;
+    } else if (verbosity != null && options == null) {
+      explain =
+        typeof verbosity !== 'object'
+          ? verbosity
+          : 'verbosity' in verbosity
+            ? verbosity
+            : undefined;
+
+      timeout = typeof verbosity === 'object' && 'timeoutMS' in verbosity ? verbosity : undefined;
+    } else {
+      // @ts-expect-error TS isn't smart enough to determine that if both options are provided, the first is explain options
+      explain = verbosity;
+      timeout = options;
+    }
+
+    return { timeout, explain };
+  }
+}