fix(shell-api): do not validate explain verbosity in mongosh MONGOSH-811

Author: addaleax

packages/shell-api/src/collection.spec.ts

@@ -1477,8 +1477,8 @@ describe('Collection', () => {
 
       it('throws in case of non valid verbosity', () => {
         expect(() => {
-          collection.explain('badVerbosityArgument' as any);
-        }).to.throw('verbosity can only be one of queryPlanner, executionStats, allPlansExecution. Received badVerbosityArgument.');
+          collection.explain(0 as any);
+        }).to.throw('verbosity must be a string');
       });
 
       it('sets the right default verbosity', () => {

packages/shell-api/src/explainable.spec.ts

@@ -10,7 +10,6 @@ import Collection from './collection';
 import Explainable from './explainable';
 import { ServiceProvider, bson, Document } from '@mongosh/service-provider-core';
 import ShellInternalState from './shell-internal-state';
-import { CommonErrors, MongoshInvalidInputError } from '@mongosh/errors';
 
 describe('Explainable', () => {
   describe('help', () => {
@@ -93,15 +92,11 @@ describe('Explainable', () => {
         expect(explainable._verbosity).to.equal('allPlansExecution');
       });
 
-      it('validates the verbosity', () => {
-        try {
-          explainable.setVerbosity('badVerbosityArgument' as any);
-          expect.fail('expected error');
-        } catch (e) {
-          expect(e).to.be.instanceOf(MongoshInvalidInputError);
-          expect(e.message).to.contain('verbosity can only be one of queryPlanner, executionStats, allPlansExecution. Received badVerbosityArgument.');
-          expect(e.code).to.equal(CommonErrors.InvalidArgument);
-        }
+
+      it('throws in case of non valid verbosity', () => {
+        expect(() => {
+          collection.explain(0 as any);
+        }).to.throw('verbosity must be a string');
       });
     });
 

packages/shell-api/src/helpers.ts

@@ -67,17 +67,8 @@ export function validateExplainableVerbosity(verbosity: ExplainVerbosityLike): E
     verbosity = 'queryPlanner';
   }
 
-  const allowedVerbosity = [
-    'queryPlanner',
-    'executionStats',
-    'allPlansExecution'
-  ];
-
-  if (!allowedVerbosity.includes(verbosity as string)) {
-    throw new MongoshInvalidInputError(
-      `verbosity can only be one of ${allowedVerbosity.join(', ')}. Received ${verbosity}.`,
-      CommonErrors.InvalidArgument
-    );
+  if (typeof verbosity !== 'string') {
+    throw new MongoshInvalidInputError('verbosity must be a string', CommonErrors.InvalidArgument);
   }
 
   return verbosity;

packages/shell-api/src/integration.spec.ts

@@ -1452,6 +1452,17 @@ describe('Shell API (integration)', function() {
         expect(explained.stages[0].$cursor).to.include.all.keys(['queryPlanner', 'executionStats']);
       });
     });
+
+    describe('invalid verbosity', () => {
+      it('rejects with a server error', async() => {
+        try {
+          await collection.find().explain('foo');
+          expect.fail('missed exception');
+        } catch (err) {
+          expect(err.name).to.equal('MongoServerError');
+        }
+      });
+    });
   });
 
   describe('Bulk API', async() => {