refactor(NODE-5764): add commandName to AbstractOperation subclasses (#…

…3934)
mongodb · Dec 5, 2023 · 130691d · 130691d
1 parent ad2d15c
commit 130691d
Show file tree

Hide file tree

Showing 34 changed files with 539 additions and 2 deletions.
diff --git a/src/bulk/common.ts b/src/bulk/common.ts
@@ -880,13 +880,17 @@ const executeCommandsAsync = promisify(executeCommands);
  * We would like this logic to simply live inside the BulkWriteOperation class
  * @internal
  */
-class BulkWriteShimOperation extends AbstractOperation {
+export class BulkWriteShimOperation extends AbstractOperation {
   bulkOperation: BulkOperationBase;
   constructor(bulkOperation: BulkOperationBase, options: BulkWriteOptions) {
     super(options);
     this.bulkOperation = bulkOperation;
   }
 
+  get commandName(): string {
+    return 'bulkWrite' as const;
+  }
+
   execute(_server: Server, session: ClientSession | undefined): Promise<any> {
     if (this.options.session == null) {
       // An implicit session could have been created by 'executeOperation'

diff --git a/src/operations/aggregate.ts b/src/operations/aggregate.ts
@@ -82,6 +82,10 @@ export class AggregateOperation<T = Document> extends CommandOperation<T> {
     }
   }
 
+  override get commandName() {
+    return 'aggregate' as const;
+  }
+
   override get canRetryRead(): boolean {
     return !this.hasWriteStage;
   }

diff --git a/src/operations/bulk_write.ts b/src/operations/bulk_write.ts
@@ -26,6 +26,10 @@ export class BulkWriteOperation extends AbstractOperation<BulkWriteResult> {
     this.operations = operations;
   }
 
+  override get commandName() {
+    return 'bulkWrite' as const;
+  }
+
   override async execute(
     server: Server,
     session: ClientSession | undefined

diff --git a/src/operations/collections.ts b/src/operations/collections.ts
@@ -19,6 +19,10 @@ export class CollectionsOperation extends AbstractOperation<Collection[]> {
     this.db = db;
   }
 
+  override get commandName() {
+    return 'listCollections' as const;
+  }
+
   override async execute(
     server: Server,
     session: ClientSession | undefined

diff --git a/src/operations/count.ts b/src/operations/count.ts
@@ -32,6 +32,10 @@ export class CountOperation extends CommandOperation<number> {
     this.query = filter;
   }
 
+  override get commandName() {
+    return 'count' as const;
+  }
+
   override async execute(server: Server, session: ClientSession | undefined): Promise<number> {
     const options = this.options;
     const cmd: Document = {

diff --git a/src/operations/create_collection.ts b/src/operations/create_collection.ts
@@ -120,6 +120,10 @@ export class CreateCollectionOperation extends CommandOperation<Collection> {
     this.name = name;
   }
 
+  override get commandName() {
+    return 'create' as const;
+  }
+
   override async execute(server: Server, session: ClientSession | undefined): Promise<Collection> {
     const db = this.db;
     const name = this.name;

diff --git a/src/operations/delete.ts b/src/operations/delete.ts
@@ -53,6 +53,10 @@ export class DeleteOperation extends CommandOperation<DeleteResult> {
     this.statements = statements;
   }
 
+  override get commandName() {
+    return 'delete' as const;
+  }
+
   override get canRetryWrite(): boolean {
     if (super.canRetryWrite === false) {
       return false;

diff --git a/src/operations/distinct.ts b/src/operations/distinct.ts
@@ -38,6 +38,10 @@ export class DistinctOperation extends CommandOperation<any[]> {
     this.query = query;
   }
 
+  override get commandName() {
+    return 'distinct' as const;
+  }
+
   override async execute(server: Server, session: ClientSession | undefined): Promise<any[]> {
     const coll = this.collection;
     const key = this.key;

diff --git a/src/operations/drop.ts b/src/operations/drop.ts
@@ -25,6 +25,10 @@ export class DropCollectionOperation extends CommandOperation<boolean> {
     this.name = name;
   }
 
+  override get commandName() {
+    return 'drop' as const;
+  }
+
   override async execute(server: Server, session: ClientSession | undefined): Promise<boolean> {
     const db = this.db;
     const options = this.options;
@@ -88,6 +92,10 @@ export class DropDatabaseOperation extends CommandOperation<boolean> {
     super(db, options);
     this.options = options;
   }
+  override get commandName() {
+    return 'dropDatabase' as const;
+  }
+
   override async execute(server: Server, session: ClientSession | undefined): Promise<boolean> {
     await super.executeCommand(server, session, { dropDatabase: 1 });
     return true;

diff --git a/src/operations/estimated_document_count.ts b/src/operations/estimated_document_count.ts
@@ -26,6 +26,10 @@ export class EstimatedDocumentCountOperation extends CommandOperation<number> {
     this.collectionName = collection.collectionName;
   }
 
+  override get commandName() {
+    return 'count' as const;
+  }
+
   override async execute(server: Server, session: ClientSession | undefined): Promise<number> {
     const cmd: Document = { count: this.collectionName };
 

diff --git a/src/operations/find.ts b/src/operations/find.ts
@@ -97,6 +97,10 @@ export class FindOperation extends CommandOperation<Document> {
     this.filter = filter != null && filter._bsontype === 'ObjectId' ? { _id: filter } : filter;
   }
 
+  override get commandName() {
+    return 'find' as const;
+  }
+
   override async execute(server: Server, session: ClientSession | undefined): Promise<Document> {
     this.server = server;
 

diff --git a/src/operations/find_and_modify.ts b/src/operations/find_and_modify.ts
@@ -121,7 +121,7 @@ function configureFindAndModifyCmdBaseUpdateOpts(
 }
 
 /** @internal */
-class FindAndModifyOperation extends CommandOperation<Document> {
+export class FindAndModifyOperation extends CommandOperation<Document> {
   override options: FindOneAndReplaceOptions | FindOneAndUpdateOptions | FindOneAndDeleteOptions;
   cmdBase: FindAndModifyCmdBase;
   collection: Collection;
@@ -178,6 +178,10 @@ class FindAndModifyOperation extends CommandOperation<Document> {
     this.query = query;
   }
 
+  override get commandName() {
+    return 'findAndModify' as const;
+  }
+
   override async execute(server: Server, session: ClientSession | undefined): Promise<Document> {
     const coll = this.collection;
     const query = this.query;

diff --git a/src/operations/get_more.ts b/src/operations/get_more.ts
@@ -48,6 +48,9 @@ export class GetMoreOperation extends AbstractOperation {
     this.server = server;
   }
 
+  override get commandName() {
+    return 'getMore' as const;
+  }
   /**
    * Although there is a server already associated with the get more operation, the signature
    * for execute passes a server so we will just use that one.

diff --git a/src/operations/indexes.ts b/src/operations/indexes.ts
@@ -186,6 +186,10 @@ export class IndexesOperation extends AbstractOperation<Document[]> {
     this.collection = collection;
   }
 
+  override get commandName() {
+    return 'listIndexes' as const;
+  }
+
   override async execute(_server: Server, session: ClientSession | undefined): Promise<Document[]> {
     const coll = this.collection;
     const options = this.options;
@@ -235,6 +239,10 @@ export class CreateIndexesOperation<
     });
   }
 
+  override get commandName() {
+    return 'createIndexes';
+  }
+
   override async execute(server: Server, session: ClientSession | undefined): Promise<T> {
     const options = this.options;
     const indexes = this.indexes;
@@ -272,6 +280,7 @@ export class CreateIndexOperation extends CreateIndexesOperation<string> {
   ) {
     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];
@@ -295,6 +304,10 @@ export class EnsureIndexOperation extends CreateIndexOperation {
     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
@@ -328,6 +341,10 @@ export class DropIndexOperation extends CommandOperation<Document> {
     this.indexName = indexName;
   }
 
+  override get commandName() {
+    return 'dropIndexes' as const;
+  }
+
   override async execute(server: Server, session: ClientSession | undefined): Promise<Document> {
     const cmd = { dropIndexes: this.collection.collectionName, index: this.indexName };
     return super.executeCommand(server, session, cmd);
@@ -360,6 +377,10 @@ export class ListIndexesOperation extends CommandOperation<Document> {
     this.collectionNamespace = collection.s.namespace;
   }
 
+  override get commandName() {
+    return 'listIndexes' as const;
+  }
+
   override async execute(server: Server, session: ClientSession | undefined): Promise<Document> {
     const serverWireVersion = maxWireVersion(server);
 
@@ -394,6 +415,10 @@ export class IndexExistsOperation extends AbstractOperation<boolean> {
     this.indexes = indexes;
   }
 
+  override get commandName() {
+    return 'listIndexes' as const;
+  }
+
   override async execute(server: Server, session: ClientSession | undefined): Promise<boolean> {
     const coll = this.collection;
     const indexes = this.indexes;
@@ -423,6 +448,10 @@ export class IndexInformationOperation extends AbstractOperation<Document> {
     this.name = name;
   }
 
+  override get commandName() {
+    return 'listIndexes' as const;
+  }
+
   override async execute(server: Server, session: ClientSession | undefined): Promise<Document> {
     const db = this.db;
     const name = this.name;

diff --git a/src/operations/insert.ts b/src/operations/insert.ts
@@ -24,6 +24,10 @@ export class InsertOperation extends CommandOperation<Document> {
     this.documents = documents;
   }
 
+  override get commandName() {
+    return 'insert' as const;
+  }
+
   override async execute(server: Server, session: ClientSession | undefined): Promise<Document> {
     const options = this.options ?? {};
     const ordered = typeof options.ordered === 'boolean' ? options.ordered : true;
@@ -114,6 +118,10 @@ export class InsertManyOperation extends AbstractOperation<InsertManyResult> {
     this.docs = docs;
   }
 
+  override get commandName() {
+    return 'insert' as const;
+  }
+
   override async execute(
     server: Server,
     session: ClientSession | undefined

diff --git a/src/operations/is_capped.ts b/src/operations/is_capped.ts
@@ -15,6 +15,10 @@ export class IsCappedOperation extends AbstractOperation<boolean> {
     this.collection = collection;
   }
 
+  override get commandName() {
+    return 'listCollections' as const;
+  }
+
   override async execute(server: Server, session: ClientSession | undefined): Promise<boolean> {
     const coll = this.collection;
     const [collection] = await coll.s.db

diff --git a/src/operations/kill_cursors.ts b/src/operations/kill_cursors.ts
@@ -25,6 +25,10 @@ export class KillCursorsOperation extends AbstractOperation {
     this.server = server;
   }
 
+  override get commandName() {
+    return 'killCursors' as const;
+  }
+
   override async execute(server: Server, session: ClientSession | undefined): Promise<void> {
     if (server !== this.server) {
       throw new MongoRuntimeError('Killcursor must run on the same server operation began on');

diff --git a/src/operations/list_collections.ts b/src/operations/list_collections.ts
@@ -47,6 +47,10 @@ export class ListCollectionsOperation extends CommandOperation<Document> {
     }
   }
 
+  override get commandName() {
+    return 'listCollections' as const;
+  }
+
   override async execute(server: Server, session: ClientSession | undefined): Promise<Document> {
     return super.executeCommand(server, session, this.generateCommand(maxWireVersion(server)));
   }

diff --git a/src/operations/list_databases.ts b/src/operations/list_databases.ts
@@ -35,6 +35,10 @@ export class ListDatabasesOperation extends CommandOperation<ListDatabasesResult
     this.ns = new MongoDBNamespace('admin', '$cmd');
   }
 
+  override get commandName() {
+    return 'listDatabases' as const;
+  }
+
   override async execute(
     server: Server,
     session: ClientSession | undefined

diff --git a/src/operations/operation.ts b/src/operations/operation.ts
@@ -75,6 +75,10 @@ export abstract class AbstractOperation<TResult = any> {
     this.trySecondaryWrite = false;
   }
 
+  /** Must match the first key of the command object sent to the server.
+  Command name should be stateless (should not use 'this' keyword) */
+  abstract get commandName(): string;
+
   abstract execute(server: Server, session: ClientSession | undefined): Promise<TResult>;
 
   hasAspect(aspect: symbol): boolean {

diff --git a/src/operations/options_operation.ts b/src/operations/options_operation.ts
@@ -15,6 +15,9 @@ export class OptionsOperation extends AbstractOperation<Document> {
     this.options = options;
     this.collection = collection;
   }
+  override get commandName() {
+    return 'listCollections' as const;
+  }
 
   override async execute(server: Server, session: ClientSession | undefined): Promise<Document> {
     const coll = this.collection;

diff --git a/src/operations/profiling_level.ts b/src/operations/profiling_level.ts
@@ -16,6 +16,10 @@ export class ProfilingLevelOperation extends CommandOperation<string> {
     this.options = options;
   }
 
+  override get commandName() {
+    return 'profile' as const;
+  }
+
   override async execute(server: Server, session: ClientSession | undefined): Promise<string> {
     const doc = await super.executeCommand(server, session, { profile: -1 });
     if (doc.ok === 1) {

diff --git a/src/operations/remove_user.ts b/src/operations/remove_user.ts
@@ -18,6 +18,10 @@ export class RemoveUserOperation extends CommandOperation<boolean> {
     this.username = username;
   }
 
+  override get commandName() {
+    return 'dropUser' as const;
+  }
+
   override async execute(server: Server, session: ClientSession | undefined): Promise<boolean> {
     await super.executeCommand(server, session, { dropUser: this.username });
     return true;

diff --git a/src/operations/rename.ts b/src/operations/rename.ts
@@ -25,6 +25,10 @@ export class RenameOperation extends CommandOperation<Document> {
     this.ns = new MongoDBNamespace('admin', '$cmd');
   }
 
+  override get commandName(): string {
+    return 'renameCollection' as const;
+  }
+
   override async execute(server: Server, session: ClientSession | undefined): Promise<Collection> {
     // Build the command
     const renameCollection = this.collection.namespace;

diff --git a/src/operations/run_command.ts b/src/operations/run_command.ts
@@ -22,6 +22,10 @@ export class RunCommandOperation<T = Document> extends AbstractOperation<T> {
     this.ns = parent.s.namespace.withCollection('$cmd');
   }
 
+  override get commandName() {
+    return 'runCommand' as const;
+  }
+
   override async execute(server: Server, session: ClientSession | undefined): Promise<T> {
     this.server = server;
     return server.commandAsync(this.ns, this.command, {
@@ -44,6 +48,10 @@ export class RunAdminCommandOperation<T = Document> extends AbstractOperation<T>
     this.ns = new MongoDBNamespace('admin', '$cmd');
   }
 
+  override get commandName() {
+    return 'runCommand' as const;
+  }
+
   override async execute(server: Server, session: ClientSession | undefined): Promise<T> {
     this.server = server;
     return server.commandAsync(this.ns, this.command, {