remove EnsureIndexOperation and CreateIndexOperation

Author: baileympearson

src/collection.ts

@@ -52,7 +52,6 @@ import {
 import {
   CreateIndexesOperation,
   type CreateIndexesOptions,
-  CreateIndexOperation,
   type DropIndexesOptions,
   DropIndexOperation,
   type IndexDescription,
@@ -575,15 +574,17 @@ export class Collection<TSchema extends Document = Document> {
     indexSpec: IndexSpecification,
     options?: CreateIndexesOptions
   ): Promise<string> {
-    return executeOperation(
+    const indexes = await executeOperation(
       this.client,
-      new CreateIndexOperation(
+      CreateIndexesOperation.fromIndexSpecification(
         this as TODO_NODE_3286,
         this.collectionName,
         indexSpec,
         resolveOptions(this, options)
       )
     );
+
+    return indexes[0];
   }
 
   /**
@@ -623,7 +624,7 @@ export class Collection<TSchema extends Document = Document> {
   ): Promise<string[]> {
     return executeOperation(
       this.client,
-      new CreateIndexesOperation(
+      CreateIndexesOperation.fromIndexDescriptionArray(
         this as TODO_NODE_3286,
         this.collectionName,
         indexSpecs,

src/db.ts

@@ -25,7 +25,6 @@ import {
 import { executeOperation } from './operations/execute_operation';
 import {
   type CreateIndexesOptions,
-  CreateIndexOperation,
   IndexInformationOperation,
   type IndexSpecification
 } from './operations/indexes';
@@ -426,10 +425,7 @@ export class Db {
     indexSpec: IndexSpecification,
     options?: CreateIndexesOptions
   ): Promise<string> {
-    return executeOperation(
-      this.client,
-      new CreateIndexOperation(this, name, indexSpec, resolveOptions(this, options))
-    );
+    return this.collection(name).createIndex(indexSpec, options);
   }
 
   /**

src/operations/create_collection.ts

@@ -10,7 +10,7 @@ import type { PkFactory } from '../mongo_client';
 import type { Server } from '../sdam/server';
 import type { ClientSession } from '../sessions';
 import { CommandOperation, type CommandOperationOptions } from './command';
-import { CreateIndexOperation } from './indexes';
+import { CreateIndexesOperation } from './indexes';
 import { Aspect, defineAspects } from './operation';
 
 const ILLEGAL_COMMAND_FIELDS = new Set([
@@ -167,7 +167,14 @@ export class CreateCollectionOperation extends CommandOperation<Collection> {
 
     if (encryptedFields) {
       // Create the required index for queryable encryption support.
-      const createIndexOp = new CreateIndexOperation(db, name, { __safeContent__: 1 }, {});
+      // We could use `this.db.collection(name).createIndex()` to create the index,
+      // but we can use the same session & server to avoid an extra server selection.
+      const createIndexOp = CreateIndexesOperation.fromIndexSpecification(
+        db,
+        name,
+        { __safeContent__: 1 },
+        {}
+      );
       await createIndexOp.execute(server, session);
     }
 

src/operations/indexes.ts

@@ -204,14 +204,12 @@ export class IndexesOperation extends AbstractOperation<Document[]> {
 }
 
 /** @internal */
-export class CreateIndexesOperation<
-  T extends string | string[] = string[]
-> extends CommandOperation<T> {
+export class CreateIndexesOperation extends CommandOperation<string[]> {
   override options: CreateIndexesOptions;
   collectionName: string;
   indexes: ReadonlyArray<Omit<IndexDescription, 'key'> & { key: Map<string, IndexDirection> }>;
 
-  constructor(
+  private constructor(
     parent: OperationParent,
     collectionName: string,
     indexes: IndexDescription[],
@@ -239,11 +237,34 @@ export class CreateIndexesOperation<
     });
   }
 
+  static fromIndexDescriptionArray(
+    parent: OperationParent,
+    collectionName: string,
+    indexes: IndexDescription[],
+    options?: CreateIndexesOptions
+  ): CreateIndexesOperation {
+    return new CreateIndexesOperation(parent, collectionName, indexes, options);
+  }
+
+  static fromIndexSpecification(
+    parent: OperationParent,
+    collectionName: string,
+    indexSpec: IndexSpecification,
+    options?: CreateIndexesOptions
+  ): CreateIndexesOperation {
+    return new CreateIndexesOperation(
+      parent,
+      collectionName,
+      [makeIndexSpec(indexSpec, options)],
+      options
+    );
+  }
+
   override get commandName() {
     return 'createIndexes';
   }
 
-  override async execute(server: Server, session: ClientSession | undefined): Promise<T> {
+  override async execute(server: Server, session: ClientSession | undefined): Promise<string[]> {
     const options = this.options;
     const indexes = this.indexes;
 
@@ -266,61 +287,7 @@ export class CreateIndexesOperation<
     await super.executeCommand(server, session, cmd);
 
     const indexNames = indexes.map(index => index.name || '');
-    return indexNames as T;
-  }
-}
-
-/** @internal */
-export class CreateIndexOperation extends CreateIndexesOperation<string> {
-  constructor(
-    parent: OperationParent,
-    collectionName: string,
-    indexSpec: IndexSpecification,
-    options?: CreateIndexesOptions
-  ) {
-    super(parent, collectionName, [makeIndexSpec(indexSpec, options)], options);
-  }
-
-  override async execute(server: Server, session: ClientSession | undefined): Promise<string> {
-    const indexNames = await super.execute(server, session);
-    return indexNames[0];
-  }
-}
-
-/** @internal */
-export class EnsureIndexOperation extends CreateIndexOperation {
-  db: Db;
-
-  constructor(
-    db: Db,
-    collectionName: string,
-    indexSpec: IndexSpecification,
-    options?: CreateIndexesOptions
-  ) {
-    super(db, collectionName, indexSpec, options);
-
-    this.readPreference = ReadPreference.primary;
-    this.db = db;
-    this.collectionName = collectionName;
-  }
-
-  override get commandName() {
-    return 'listIndexes';
-  }
-
-  override async execute(server: Server, session: ClientSession | undefined): Promise<string> {
-    const indexName = this.indexes[0].name;
-    const indexes = await this.db
-      .collection(this.collectionName)
-      .listIndexes({ session })
-      .toArray()
-      .catch(error => {
-        if (error instanceof MongoError && error.code === MONGODB_ERROR_CODES.NamespaceNotFound)
-          return [];
-        throw error;
-      });
-    if (indexName && indexes.some(index => index.name === indexName)) return indexName;
-    return super.execute(server, session);
+    return indexNames;
   }
 }
 
@@ -470,6 +437,4 @@ defineAspects(ListIndexesOperation, [
   Aspect.CURSOR_CREATING
 ]);
 defineAspects(CreateIndexesOperation, [Aspect.WRITE_OPERATION]);
-defineAspects(CreateIndexOperation, [Aspect.WRITE_OPERATION]);
-defineAspects(EnsureIndexOperation, [Aspect.WRITE_OPERATION]);
 defineAspects(DropIndexOperation, [Aspect.WRITE_OPERATION]);

test/integration/crud/abstract_operation.test.ts

@@ -146,23 +146,12 @@ describe('abstract operation', async function () {
         subclassType: mongodb.IndexesOperation,
         correctCommandName: 'listIndexes'
       },
-      {
-        subclassCreator: () => new mongodb.CreateIndexesOperation(db, 'bar', [{ key: { a: 1 } }]),
-        subclassType: mongodb.CreateIndexesOperation,
-        correctCommandName: 'createIndexes'
-      },
       {
         subclassCreator: () =>
-          new mongodb.CreateIndexOperation(db, 'collectionName', 'indexDescription'),
-        subclassType: mongodb.CreateIndexOperation,
+          mongodb.CreateIndexesOperation.fromIndexDescriptionArray(db, 'bar', [{ key: { a: 1 } }]),
+        subclassType: mongodb.CreateIndexesOperation,
         correctCommandName: 'createIndexes'
       },
-      {
-        subclassCreator: () =>
-          new mongodb.EnsureIndexOperation(db, 'collectionName', 'indexDescription'),
-        subclassType: mongodb.EnsureIndexOperation,
-        correctCommandName: 'listIndexes'
-      },
       {
         subclassCreator: () => new mongodb.DropIndexOperation(collection, 'a', {}),
         subclassType: mongodb.DropIndexOperation,

test/unit/operations/indexes.test.ts

@@ -1,13 +1,13 @@
 import { expect } from 'chai';
 
 import {
+  CreateIndexesOperation,
   type CreateIndexesOptions,
-  CreateIndexOperation,
   type IndexDirection,
   ns
 } from '../../mongodb';
 
-describe('class CreateIndexOperation', () => {
+describe('class CreateIndexesOperation', () => {
   const testCases = [
     {
       description: 'single string',
@@ -101,7 +101,12 @@ describe('class CreateIndexOperation', () => {
   ];
 
   const makeIndexOperation = (input, options: CreateIndexesOptions = {}) =>
-    new CreateIndexOperation({ s: { namespace: ns('a.b') } }, 'b', input, options);
+    CreateIndexesOperation.fromIndexSpecification(
+      { s: { namespace: ns('a.b') } },
+      'b',
+      input,
+      options
+    );
 
   describe('#constructor()', () => {
     for (const { description, input, mapData, name } of testCases) {