listCollections

Author: baileympearson

src/operations/list_collections.ts

@@ -1,13 +1,11 @@
+import { type Connection } from '..';
 import type { Binary, Document } from '../bson';
-import { CursorResponse } from '../cmap/wire_protocol/responses';
+import { CursorResponse, ExplainedCursorResponse } from '../cmap/wire_protocol/responses';
 import { type CursorTimeoutContext, type CursorTimeoutMode } from '../cursor/abstract_cursor';
 import type { Db } from '../db';
 import { type Abortable } from '../mongo_types';
-import type { Server } from '../sdam/server';
-import type { ClientSession } from '../sessions';
-import { type TimeoutContext } from '../timeout';
 import { maxWireVersion } from '../utils';
-import { CommandOperation, type CommandOperationOptions } from './command';
+import { type CommandOperationOptions, ModernizedCommandOperation } from './command';
 import { Aspect, defineAspects } from './operation';
 
 /** @public */
@@ -28,7 +26,8 @@ export interface ListCollectionsOptions
 }
 
 /** @internal */
-export class ListCollectionsOperation extends CommandOperation<CursorResponse> {
+export class ListCollectionsOperation extends ModernizedCommandOperation<CursorResponse> {
+  override SERVER_COMMAND_RESPONSE_TYPE = CursorResponse;
   /**
    * @remarks WriteConcern can still be present on the options because
    * we inherit options from the client/db/collection.  The
@@ -56,28 +55,15 @@ export class ListCollectionsOperation extends CommandOperation<CursorResponse> {
     if (typeof this.options.batchSize === 'number') {
       this.batchSize = this.options.batchSize;
     }
+
+    this.SERVER_COMMAND_RESPONSE_TYPE = this.explain ? ExplainedCursorResponse : CursorResponse;
   }
 
   override get commandName() {
     return 'listCollections' as const;
   }
 
-  override async execute(
-    server: Server,
-    session: ClientSession | undefined,
-    timeoutContext: TimeoutContext
-  ): Promise<CursorResponse> {
-    return await super.executeCommand(
-      server,
-      session,
-      this.generateCommand(maxWireVersion(server)),
-      timeoutContext,
-      CursorResponse
-    );
-  }
-
-  /* This is here for the purpose of unit testing the final command that gets sent. */
-  generateCommand(wireVersion: number): Document {
+  override buildCommandDocument(connection: Connection): Document {
     const command: Document = {
       listCollections: 1,
       filter: this.filter,
@@ -88,12 +74,18 @@ export class ListCollectionsOperation extends CommandOperation<CursorResponse> {
 
     // we check for undefined specifically here to allow falsy values
     // eslint-disable-next-line no-restricted-syntax
-    if (wireVersion >= 9 && this.options.comment !== undefined) {
+    if (maxWireVersion(connection) >= 9 && this.options.comment !== undefined) {
       command.comment = this.options.comment;
     }
 
     return command;
   }
+
+  override handleOk(
+    response: InstanceType<typeof this.SERVER_COMMAND_RESPONSE_TYPE>
+  ): CursorResponse {
+    return response;
+  }
 }
 
 /** @public */

test/unit/operations/list_collections.test.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const { expect } = require('chai');
-const { ListCollectionsOperation } = require('../../mongodb');
+const { ListCollectionsOperation, StreamDescription } = require('../../mongodb');
 
 describe('ListCollectionsOperation', function () {
   const db = 'test';
@@ -65,6 +65,8 @@ describe('ListCollectionsOperation', function () {
   });
 
   describe('#generateCommand', function () {
+    const description = new StreamDescription();
+
     context('when comment is provided', function () {
       context('when the wireVersion < 9', function () {
         it('does not set a comment on the command', function () {
@@ -73,7 +75,10 @@ describe('ListCollectionsOperation', function () {
             {},
             { dbName: db, comment: 'test comment' }
           );
-          const command = operation.generateCommand(8);
+          description.maxWireVersion = 8;
+          const command = operation.buildCommandDocument({
+            description
+          });
           expect(command).not.to.haveOwnProperty('comment');
         });
       });
@@ -85,7 +90,10 @@ describe('ListCollectionsOperation', function () {
             {},
             { dbName: db, comment: 'test comment' }
           );
-          const command = operation.generateCommand(9);
+          description.maxWireVersion = 9;
+          const command = operation.buildCommandDocument({
+            description
+          });
           expect(command).to.have.property('comment').that.equals('test comment');
         });
       });
@@ -95,7 +103,11 @@ describe('ListCollectionsOperation', function () {
         const operation = new ListCollectionsOperation(db, {}, { nameOnly: true, dbName: db });
 
         it('sets nameOnly to true', function () {
-          expect(operation.generateCommand(8)).to.deep.equal({
+          description.maxWireVersion = 8;
+          const command = operation.buildCommandDocument({
+            description
+          });
+          expect(command).to.deep.equal({
             listCollections: 1,
             cursor: {},
             filter: {},
@@ -109,7 +121,11 @@ describe('ListCollectionsOperation', function () {
         const operation = new ListCollectionsOperation(db, {}, { nameOnly: false, dbName: db });
 
         it('sets nameOnly to false', function () {
-          expect(operation.generateCommand(8)).to.deep.equal({
+          description.maxWireVersion = 8;
+          const command = operation.buildCommandDocument({
+            description
+          });
+          expect(command).to.deep.equal({
             listCollections: 1,
             cursor: {},
             filter: {},
@@ -129,7 +145,11 @@ describe('ListCollectionsOperation', function () {
         );
 
         it('sets authorizedCollections to true', function () {
-          expect(operation.generateCommand(8)).to.deep.equal({
+          description.maxWireVersion = 8;
+          const command = operation.buildCommandDocument({
+            description
+          });
+          expect(command).to.deep.equal({
             listCollections: 1,
             cursor: {},
             filter: {},
@@ -147,7 +167,11 @@ describe('ListCollectionsOperation', function () {
         );
 
         it('sets authorizedCollections to false', function () {
-          expect(operation.generateCommand(8)).to.deep.equal({
+          description.maxWireVersion = 8;
+          const command = operation.buildCommandDocument({
+            description
+          });
+          expect(command).to.deep.equal({
             listCollections: 1,
             cursor: {},
             filter: {},
@@ -162,7 +186,11 @@ describe('ListCollectionsOperation', function () {
       const operation = new ListCollectionsOperation(db, {}, { dbName: db });
 
       it('sets nameOnly and authorizedCollections properties to false', function () {
-        expect(operation.generateCommand(8)).to.deep.equal({
+        description.maxWireVersion = 8;
+        const command = operation.buildCommandDocument({
+          description
+        });
+        expect(command).to.deep.equal({
           listCollections: 1,
           cursor: {},
           filter: {},