comments part 1

Author: baileympearson

src/bulk/common.ts

@@ -12,7 +12,6 @@ import {
 } from '../error';
 import type { Filter, OneOrMore, OptionalId, UpdateFilter, WithoutId } from '../mongo_types';
 import type { CollationOptions, CommandOperationOptions } from '../operations/command';
-import { maybeAddIdToDocuments } from '../operations/common_functions';
 import { DeleteOperation, type DeleteStatement, makeDeleteStatement } from '../operations/delete';
 import { executeOperation } from '../operations/execute_operation';
 import { InsertOperation } from '../operations/insert';
@@ -21,6 +20,7 @@ import { makeUpdateStatement, UpdateOperation, type UpdateStatement } from '../o
 import type { Server } from '../sdam/server';
 import type { Topology } from '../sdam/topology';
 import type { ClientSession } from '../sessions';
+import { maybeAddIdToDocuments } from '../utils';
 import {
   applyRetryableWrites,
   type Callback,

src/collection.ts

@@ -573,7 +573,7 @@ export class Collection<TSchema extends Document = Document> {
     const indexes = await executeOperation(
       this.client,
       CreateIndexesOperation.fromIndexSpecification(
-        this as TODO_NODE_3286,
+        this,
         this.collectionName,
         indexSpec,
         resolveOptions(this, options)
@@ -621,7 +621,7 @@ export class Collection<TSchema extends Document = Document> {
     return executeOperation(
       this.client,
       CreateIndexesOperation.fromIndexDescriptionArray(
-        this as TODO_NODE_3286,
+        this,
         this.collectionName,
         indexSpecs,
         resolveOptions(this, { ...options, maxTimeMS: undefined })
@@ -681,7 +681,7 @@ export class Collection<TSchema extends Document = Document> {
     indexes: string | string[],
     options?: IndexInformationOptions
   ): Promise<boolean> {
-    const indexNames: string[] = [indexes].flat();
+    const indexNames: string[] = Array.isArray(indexes) ? indexes : [indexes];
     const allIndexes: string[] = await this.listIndexes(options)
       .map(({ name }) => name)
       .toArray();
@@ -806,13 +806,12 @@ export class Collection<TSchema extends Document = Document> {
       return indexes;
     }
 
-    const info: Record<string, Array<[string, unknown]>> = {};
-    for (const { name, key } of indexes) {
-      info[name] = Object.entries(key);
-    }
+    const object: Record<string, Array<[string, unknown]>> = Object.fromEntries(
+      indexes.map(({ name, key }) => [name, Object.entries(key)])
+    );
 
     // @ts-expect-error TODO(NODE-6029): fix return type of `indexes()` and `indexInformation()`
-    return info;
+    return object;
   }
 
   /**

src/operations/common_functions.ts

@@ -73,6 +73,24 @@ export type IndexSpecification = OneOrMore<
 
 /** @public */
 export interface IndexInformationOptions {
+  /**
+   * When `true`, an array of index descriptions is returned.
+   * When `false`, the driver returns an object that with keys corresponding to index names with values
+   * corresponding to the entries of the indexes' key.
+   *
+   * For example, the given the following indexes:
+   * ```
+   * [ { name: 'a_1', key: { a: 1 } }, { name: 'b_1_c_1' , key: { b: 1, c: 1 } }]
+   * ```
+   *
+   * When `full` is `true`, the above array is returned.  When `full` is `false`, the following is returned:
+   * ```
+   * {
+   *   'a_1': [['a', 1]],
+   *   'b_1_c_1': [['b', 1], ['c', 1]],
+   * }
+   * ```
+   */
   full?: boolean;
   readPreference?: ReadPreference;
   session?: ClientSession;

src/operations/indexes.ts

@@ -6,10 +6,10 @@ import type { InferIdType } from '../mongo_types';
 import type { Server } from '../sdam/server';
 import type { ClientSession } from '../sessions';
 import type { MongoDBNamespace } from '../utils';
+import { maybeAddIdToDocuments } from '../utils';
 import { WriteConcern } from '../write_concern';
 import { BulkWriteOperation } from './bulk_write';
 import { CommandOperation, type CommandOperationOptions } from './command';
-import { maybeAddIdToDocuments } from './common_functions';
 import { AbstractOperation, Aspect, defineAspects } from './operation';
 
 /** @internal */

src/operations/insert.ts

@@ -1280,3 +1280,38 @@ export async function once<T>(ee: EventEmitter, name: string): Promise<T> {
     throw error;
   }
 }
+
+export function maybeAddIdToDocuments(
+  coll: Collection,
+  docs: Document[],
+  options: { forceServerObjectId?: boolean }
+): Document[];
+export function maybeAddIdToDocuments(
+  coll: Collection,
+  docs: Document,
+  options: { forceServerObjectId?: boolean }
+): Document;
+export function maybeAddIdToDocuments(
+  coll: Collection,
+  docOrDocs: Document[] | Document,
+  options: { forceServerObjectId?: boolean }
+): Document[] | Document {
+  const forceServerObjectId =
+    typeof options.forceServerObjectId === 'boolean'
+      ? options.forceServerObjectId
+      : coll.s.db.options?.forceServerObjectId;
+
+  // no need to modify the docs if server sets the ObjectId
+  if (forceServerObjectId === true) {
+    return docOrDocs;
+  }
+
+  const transform = (doc: Document): Document => {
+    if (doc._id == null) {
+      doc._id = coll.s.pkFactory.createPk();
+    }
+
+    return doc;
+  };
+  return Array.isArray(docOrDocs) ? docOrDocs.map(transform) : transform(docOrDocs);
+}