@depup/mongodb 7.1.0-depup.0

package/src/cursor/find_cursor.ts

@@ -0,0 +1,497 @@
+import { type Document } from '../bson';
+import { CursorResponse } from '../cmap/wire_protocol/responses';
+import { MongoAPIError, MongoInvalidArgumentError, MongoTailableCursorError } from '../error';
+import {
+  Explain,
+  type ExplainCommandOptions,
+  type ExplainVerbosityLike,
+  validateExplainTimeoutOptions
+} from '../explain';
+import type { MongoClient } from '../mongo_client';
+import { type Abortable } from '../mongo_types';
+import type { CollationOptions } from '../operations/command';
+import { CountOperation, type CountOptions } from '../operations/count';
+import { executeOperation } from '../operations/execute_operation';
+import { FindOperation, type FindOptions } from '../operations/find';
+import type { Hint } from '../operations/operation';
+import type { ClientSession } from '../sessions';
+import { formatSort, type Sort, type SortDirection } from '../sort';
+import { emitWarningOnce, mergeOptions, type MongoDBNamespace, noop, squashError } from '../utils';
+import { type InitialCursorResponse } from './abstract_cursor';
+import { ExplainableCursor } from './explainable_cursor';
+
+/** @public Flags allowed for cursor */
+export const FLAGS = [
+  'tailable',
+  'oplogReplay',
+  'noCursorTimeout',
+  'awaitData',
+  'exhaust',
+  'partial'
+] as const;
+
+/** @public */
+export class FindCursor<TSchema = any> extends ExplainableCursor<TSchema> {
+  /** @internal */
+  private cursorFilter: Document;
+  /** @internal */
+  private numReturned = 0;
+  /** @internal */
+  private readonly findOptions: FindOptions & Abortable;
+
+  /** @internal */
+  constructor(
+    client: MongoClient,
+    namespace: MongoDBNamespace,
+    filter: Document = {},
+    options: FindOptions & Abortable = {}
+  ) {
+    super(client, namespace, options);
+
+    this.cursorFilter = filter;
+    this.findOptions = options;
+
+    if (options.sort != null) {
+      this.findOptions.sort = formatSort(options.sort);
+    }
+  }
+
+  clone(): FindCursor<TSchema> {
+    const clonedOptions = mergeOptions({}, this.findOptions);
+    delete clonedOptions.session;
+    return new FindCursor(this.client, this.namespace, this.cursorFilter, {
+      ...clonedOptions
+    });
+  }
+
+  override map<T>(transform: (doc: TSchema) => T): FindCursor<T> {
+    return super.map(transform) as FindCursor<T>;
+  }
+
+  /** @internal */
+  async _initialize(session: ClientSession): Promise<InitialCursorResponse> {
+    const options = {
+      ...this.findOptions, // NOTE: order matters here, we may need to refine this
+      ...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 findOptions'
+        );
+      }
+    }
+
+    const findOperation = new FindOperation(this.namespace, this.cursorFilter, options);
+
+    const response = await executeOperation(this.client, findOperation, this.timeoutContext);
+
+    // the response is not a cursor when `explain` is enabled
+    this.numReturned = response.batchSize;
+
+    return { server: findOperation.server, session, response };
+  }
+
+  /** @internal */
+  override async getMore(): Promise<CursorResponse> {
+    const numReturned = this.numReturned;
+    const limit = this.findOptions.limit ?? Infinity;
+    const remaining = limit - numReturned;
+
+    if (numReturned === limit && !this.id?.isZero()) {
+      // this is an optimization for the special case of a limit for a find command to avoid an
+      // extra getMore when the limit has been reached and the limit is a multiple of the batchSize.
+      // This is a consequence of the new query engine in 5.0 having no knowledge of the limit as it
+      // produces results for the find command.  Once a batch is filled up, it is returned and only
+      // on the subsequent getMore will the query framework consider the limit, determine the cursor
+      // is exhausted and return a cursorId of zero.
+      // instead, if we determine there are no more documents to request from the server, we preemptively
+      // close the cursor
+      try {
+        await this.close();
+      } catch (error) {
+        squashError(error);
+      }
+      return CursorResponse.emptyGetMore;
+    }
+
+    // TODO(DRIVERS-1448): Remove logic to enforce `limit` in the driver
+    let cleanup: () => void = noop;
+    const { batchSize } = this.cursorOptions;
+    if (batchSize != null && batchSize > remaining) {
+      this.cursorOptions.batchSize = remaining;
+
+      // After executing the final getMore, re-assign the batchSize back to its original value so that
+      // if the cursor is rewound and executed, the batchSize is still correct.
+      cleanup = () => {
+        this.cursorOptions.batchSize = batchSize;
+      };
+    }
+
+    try {
+      const response = await super.getMore();
+
+      this.numReturned = this.numReturned + response.batchSize;
+
+      return response;
+    } finally {
+      cleanup?.();
+    }
+  }
+
+  /**
+   * Get the count of documents for this cursor
+   * @deprecated Use `collection.estimatedDocumentCount` or `collection.countDocuments` instead
+   */
+  async count(options?: CountOptions): Promise<number> {
+    emitWarningOnce(
+      'cursor.count is deprecated and will be removed in the next major version, please use `collection.estimatedDocumentCount` or `collection.countDocuments` instead '
+    );
+    if (typeof options === 'boolean') {
+      throw new MongoInvalidArgumentError('Invalid first parameter to count');
+    }
+    return await executeOperation(
+      this.client,
+      new CountOperation(this.namespace, this.cursorFilter, {
+        ...this.findOptions, // NOTE: order matters here, we may need to refine this
+        ...this.cursorOptions,
+        ...options
+      })
+    );
+  }
+
+  /** 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 FindOperation(this.namespace, this.cursorFilter, {
+          ...this.findOptions, // NOTE: order matters here, we may need to refine this
+          ...this.cursorOptions,
+          ...timeout,
+          explain: explain ?? true
+        })
+      )
+    ).shift(this.deserializationOptions);
+  }
+
+  /** Set the cursor query */
+  filter(filter: Document): this {
+    this.throwIfInitialized();
+    this.cursorFilter = filter;
+    return this;
+  }
+
+  /**
+   * Set the cursor hint
+   *
+   * @param hint - If specified, then the query system will only consider plans using the hinted index.
+   */
+  hint(hint: Hint): this {
+    this.throwIfInitialized();
+    this.findOptions.hint = hint;
+    return this;
+  }
+
+  /**
+   * Set the cursor min
+   *
+   * @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 {
+    this.throwIfInitialized();
+    this.findOptions.min = min;
+    return this;
+  }
+
+  /**
+   * Set the cursor max
+   *
+   * @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 {
+    this.throwIfInitialized();
+    this.findOptions.max = max;
+    return this;
+  }
+
+  /**
+   * Set the cursor returnKey.
+   * If set to true, modifies the cursor to only return the index field or fields for the results of the query, rather than documents.
+   * If set to true and the query does not use an index to perform the read operation, the returned documents will not contain any fields.
+   *
+   * @param value - the returnKey value.
+   */
+  returnKey(value: boolean): this {
+    this.throwIfInitialized();
+    this.findOptions.returnKey = value;
+    return this;
+  }
+
+  /**
+   * Modifies the output of a query by adding a field $recordId to matching documents. $recordId is the internal key which uniquely identifies a document in a collection.
+   *
+   * @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 {
+    this.throwIfInitialized();
+    this.findOptions.showRecordId = value;
+    return this;
+  }
+
+  /**
+   * Add a query modifier to the cursor query
+   *
+   * @param name - The query modifier (must start with $, such as $orderby etc)
+   * @param value - The modifier value.
+   */
+  addQueryModifier(name: string, value: string | boolean | number | Document): this {
+    this.throwIfInitialized();
+    if (name[0] !== '$') {
+      throw new MongoInvalidArgumentError(`${name} is not a valid query modifier`);
+    }
+
+    // Strip of the $
+    const field = name.substr(1);
+
+    // NOTE: consider some TS magic for this
+    switch (field) {
+      case 'comment':
+        this.findOptions.comment = value as string | Document;
+        break;
+
+      case 'explain':
+        this.findOptions.explain = value as boolean;
+        break;
+
+      case 'hint':
+        this.findOptions.hint = value as string | Document;
+        break;
+
+      case 'max':
+        this.findOptions.max = value as Document;
+        break;
+
+      case 'maxTimeMS':
+        this.findOptions.maxTimeMS = value as number;
+        break;
+
+      case 'min':
+        this.findOptions.min = value as Document;
+        break;
+
+      case 'orderby':
+        this.findOptions.sort = formatSort(value as string | Document);
+        break;
+
+      case 'query':
+        this.cursorFilter = value as Document;
+        break;
+
+      case 'returnKey':
+        this.findOptions.returnKey = value as boolean;
+        break;
+
+      case 'showDiskLoc':
+        this.findOptions.showRecordId = value as boolean;
+        break;
+
+      default:
+        throw new MongoInvalidArgumentError(`Invalid query modifier: ${name}`);
+    }
+
+    return this;
+  }
+
+  /**
+   * Add a comment to the cursor query allowing for tracking the comment in the log.
+   *
+   * @param value - The comment attached to this query.
+   */
+  comment(value: string): this {
+    this.throwIfInitialized();
+    this.findOptions.comment = value;
+    return this;
+  }
+
+  /**
+   * Set a maxAwaitTimeMS on a tailing cursor query to allow to customize the timeout value for the option awaitData (Only supported on MongoDB 3.2 or higher, ignored otherwise)
+   *
+   * @param value - Number of milliseconds to wait before aborting the tailed query.
+   */
+  maxAwaitTimeMS(value: number): this {
+    this.throwIfInitialized();
+    if (typeof value !== 'number') {
+      throw new MongoInvalidArgumentError('Argument for maxAwaitTimeMS must be a number');
+    }
+
+    this.findOptions.maxAwaitTimeMS = value;
+    return this;
+  }
+
+  /**
+   * Set a maxTimeMS on the cursor query, allowing for hard timeout limits on queries (Only supported on MongoDB 2.6 or higher)
+   *
+   * @param value - Number of milliseconds to wait before aborting the query.
+   */
+  override maxTimeMS(value: number): this {
+    this.throwIfInitialized();
+    if (typeof value !== 'number') {
+      throw new MongoInvalidArgumentError('Argument for maxTimeMS must be a number');
+    }
+
+    this.findOptions.maxTimeMS = value;
+    return this;
+  }
+
+  /**
+   * 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: FindCursor<{ a: number }> = cursor.project<{ a: number }>({ _id: 0, a: true });
+   * // Flexible way
+   * const docs: FindCursor<Document> = cursor.project({ _id: 0, a: true });
+   * ```
+   *
+   * @remarks
+   *
+   * **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: FindCursor<{ a: number; b: string }> = coll.find();
+   * 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.find().project<{ a: string }>({
+   *   _id: 0,
+   *   a: { $convert: { input: '$a', to: 'string' }
+   * }});
+   * ```
+   */
+  project<T extends Document = Document>(value: Document): FindCursor<T> {
+    this.throwIfInitialized();
+    this.findOptions.projection = value;
+    return this as unknown as FindCursor<T>;
+  }
+
+  /**
+   * Sets the sort order of the cursor query.
+   *
+   * @param sort - The key or keys set for the sort.
+   * @param direction - The direction of the sorting (1 or -1).
+   */
+  sort(sort: Sort | string, direction?: SortDirection): this {
+    this.throwIfInitialized();
+    if (this.findOptions.tailable) {
+      throw new MongoTailableCursorError('Tailable cursor does not support sorting');
+    }
+
+    this.findOptions.sort = formatSort(sort, direction);
+    return this;
+  }
+
+  /**
+   * Allows disk use for blocking sort operations exceeding 100MB memory. (MongoDB 3.2 or higher)
+   *
+   * @remarks
+   * {@link https://www.mongodb.com/docs/manual/reference/command/find/#find-cmd-allowdiskuse | find command allowDiskUse documentation}
+   */
+  allowDiskUse(allow = true): this {
+    this.throwIfInitialized();
+
+    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.findOptions.allowDiskUse = false;
+      return this;
+    }
+
+    this.findOptions.allowDiskUse = true;
+    return this;
+  }
+
+  /**
+   * Set the collation options for the cursor.
+   *
+   * @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 {
+    this.throwIfInitialized();
+    this.findOptions.collation = value;
+    return this;
+  }
+
+  /**
+   * Set the limit for the cursor.
+   *
+   * @param value - The limit for the cursor query.
+   */
+  limit(value: number): this {
+    this.throwIfInitialized();
+    if (this.findOptions.tailable) {
+      throw new MongoTailableCursorError('Tailable cursor does not support limit');
+    }
+
+    if (typeof value !== 'number') {
+      throw new MongoInvalidArgumentError('Operation "limit" requires an integer');
+    }
+
+    this.findOptions.limit = value;
+    return this;
+  }
+
+  /**
+   * Set the skip for the cursor.
+   *
+   * @param value - The skip for the cursor query.
+   */
+  skip(value: number): this {
+    this.throwIfInitialized();
+    if (this.findOptions.tailable) {
+      throw new MongoTailableCursorError('Tailable cursor does not support skip');
+    }
+
+    if (typeof value !== 'number') {
+      throw new MongoInvalidArgumentError('Operation "skip" requires an integer');
+    }
+
+    this.findOptions.skip = value;
+    return this;
+  }
+}

package/src/cursor/list_collections_cursor.ts

@@ -0,0 +1,50 @@
+import type { Document } from '../bson';
+import type { Db } from '../db';
+import { type Abortable } from '../mongo_types';
+import { executeOperation } from '../operations/execute_operation';
+import {
+  type CollectionInfo,
+  ListCollectionsOperation,
+  type ListCollectionsOptions
+} from '../operations/list_collections';
+import type { ClientSession } from '../sessions';
+import { AbstractCursor, type InitialCursorResponse } from './abstract_cursor';
+
+/** @public */
+export class ListCollectionsCursor<
+  T extends Pick<CollectionInfo, 'name' | 'type'> | CollectionInfo =
+    | Pick<CollectionInfo, 'name' | 'type'>
+    | CollectionInfo
+> extends AbstractCursor<T> {
+  parent: Db;
+  filter: Document;
+  options?: ListCollectionsOptions & Abortable;
+
+  constructor(db: Db, filter: Document, options?: ListCollectionsOptions & Abortable) {
+    super(db.client, db.s.namespace, options);
+    this.parent = db;
+    this.filter = filter;
+    this.options = options;
+  }
+
+  clone(): ListCollectionsCursor<T> {
+    return new ListCollectionsCursor(this.parent, this.filter, {
+      ...this.options,
+      ...this.cursorOptions
+    });
+  }
+
+  /** @internal */
+  async _initialize(session: ClientSession | undefined): Promise<InitialCursorResponse> {
+    const operation = new ListCollectionsOperation(this.parent, this.filter, {
+      ...this.cursorOptions,
+      ...this.options,
+      session,
+      signal: this.signal
+    });
+
+    const response = await executeOperation(this.parent.client, operation, this.timeoutContext);
+
+    return { server: operation.server, session, response };
+  }
+}

package/src/cursor/list_indexes_cursor.ts

@@ -0,0 +1,37 @@
+import type { Collection } from '../collection';
+import { executeOperation } from '../operations/execute_operation';
+import { ListIndexesOperation, type ListIndexesOptions } from '../operations/indexes';
+import type { ClientSession } from '../sessions';
+import { AbstractCursor, type InitialCursorResponse } from './abstract_cursor';
+
+/** @public */
+export class ListIndexesCursor extends AbstractCursor {
+  parent: Collection;
+  options?: ListIndexesOptions;
+
+  constructor(collection: Collection, options?: ListIndexesOptions) {
+    super(collection.client, collection.s.namespace, options);
+    this.parent = collection;
+    this.options = options;
+  }
+
+  clone(): ListIndexesCursor {
+    return new ListIndexesCursor(this.parent, {
+      ...this.options,
+      ...this.cursorOptions
+    });
+  }
+
+  /** @internal */
+  async _initialize(session: ClientSession | undefined): Promise<InitialCursorResponse> {
+    const operation = new ListIndexesOperation(this.parent, {
+      ...this.cursorOptions,
+      ...this.options,
+      session
+    });
+
+    const response = await executeOperation(this.parent.client, operation, this.timeoutContext);
+
+    return { server: operation.server, session, response };
+  }
+}

package/src/cursor/list_search_indexes_cursor.ts

@@ -0,0 +1,20 @@
+import type { Collection } from '../collection';
+import type { AggregateOptions } from '../operations/aggregate';
+import { AggregationCursor } from './aggregation_cursor';
+
+/** @public */
+export type ListSearchIndexesOptions = Omit<AggregateOptions, 'readConcern' | 'writeConcern'>;
+
+/** @public */
+export class ListSearchIndexesCursor extends AggregationCursor<{ name: string }> {
+  /** @internal */
+  constructor(
+    { fullNamespace: ns, client }: Collection,
+    name: string | null,
+    options: ListSearchIndexesOptions = {}
+  ) {
+    const pipeline =
+      name == null ? [{ $listSearchIndexes: {} }] : [{ $listSearchIndexes: { name } }];
+    super(client, ns, pipeline, options);
+  }
+}