fix(shell-api): Fix invalid regular expression error in db.currentOp() MONGOSH-1703 (#2187)

Fixes a bug where a regular expression error in db.currentOp() would cause it to error.

Author: gagik

packages/e2e-tests/test/e2e.spec.ts

@@ -21,6 +21,7 @@ import { createServer as createHTTPServer } from 'http';
 import { once } from 'events';
 import type { AddressInfo } from 'net';
 const { EJSON } = bson;
+import { sleep } from './util-helpers';
 
 const jsContextFlagCombinations: `--jsContext=${'plain-vm' | 'repl'}`[][] = [
   [],
@@ -1938,4 +1939,73 @@ describe('e2e', function () {
       shell.assertContainsOutput('610');
     });
   });
+
+  describe('currentOp', function () {
+    context('with 2 shells', function () {
+      let helperShell: TestShell;
+      let currentOpShell: TestShell;
+
+      const CURRENT_OP_WAIT_TIME = 400;
+      const OPERATION_TIME = CURRENT_OP_WAIT_TIME * 2;
+
+      beforeEach(async function () {
+        helperShell = this.startTestShell({
+          args: [await testServer.connectionString()],
+        });
+        currentOpShell = this.startTestShell({
+          args: [await testServer.connectionString()],
+        });
+        await helperShell.waitForPrompt();
+        await currentOpShell.waitForPrompt();
+
+        // Insert a dummy object so find commands will actually run with the delay.
+        await helperShell.executeLine('db.coll.insertOne({})');
+      });
+
+      it('should return the current operation and clear when it is complete', async function () {
+        const currentCommand = helperShell.executeLine(
+          `db.coll.find({$where: function() { sleep(${OPERATION_TIME}) }}).projection({testProjection: 1})`
+        );
+        helperShell.assertNoErrors();
+        await sleep(CURRENT_OP_WAIT_TIME);
+        let currentOpCall = await currentOpShell.executeLine(`db.currentOp()`);
+
+        currentOpShell.assertNoErrors();
+
+        expect(currentOpCall).to.include('testProjection');
+
+        await currentCommand;
+
+        currentOpCall = await currentOpShell.executeLine(`db.currentOp()`);
+
+        currentOpShell.assertNoErrors();
+        expect(currentOpCall).not.to.include('testProjection');
+      });
+
+      it('should work when the operation contains regex', async function () {
+        const regExpString = String.raw`^(?i)\Qchho0842\E`;
+
+        // Stringify the reg exp and drop the quotation marks.
+        // Meant to account for JS escaping behavior and to compare with output later.
+        const stringifiedRegExpString = `${JSON.stringify(regExpString)}`.slice(
+          1,
+          -1
+        );
+
+        void helperShell.executeLine(
+          `db.coll.find({$where: function() { sleep(${OPERATION_TIME}) }}).projection({re: BSONRegExp('${stringifiedRegExpString}')})`
+        );
+        helperShell.assertNoErrors();
+
+        await sleep(CURRENT_OP_WAIT_TIME);
+
+        const currentOpCall = await currentOpShell.executeLine(
+          `db.currentOp()`
+        );
+        currentOpShell.assertNoErrors();
+
+        expect(currentOpCall).to.include(stringifiedRegExpString);
+      });
+    });
+  });
 });

packages/e2e-tests/test/util-helpers.ts

@@ -0,0 +1,3 @@
+export function sleep(ms: number): Promise<void> {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}

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

@@ -1796,10 +1796,11 @@ describe('Database', function () {
         },
       });
 
-      const READ_PREFERENCE = {
+      const AGGREGATE_OPTIONS = {
         $readPreference: {
           mode: 'primaryPreferred',
         },
+        bsonRegExp: true,
       };
 
       beforeEach(function () {
@@ -1824,7 +1825,7 @@ describe('Database', function () {
               })
             );
             expect(serviceProvider.aggregateDb.firstCall.args[2]).to.deep.equal(
-              READ_PREFERENCE
+              AGGREGATE_OPTIONS
             );
           }
         });
@@ -1846,7 +1847,7 @@ describe('Database', function () {
             })
           );
           expect(serviceProvider.aggregateDb.firstCall.args[2]).to.deep.equal(
-            READ_PREFERENCE
+            AGGREGATE_OPTIONS
           );
         });
       });
@@ -1868,7 +1869,7 @@ describe('Database', function () {
           );
           expect(matchStage).to.deep.equals({ $match: {} });
           expect(serviceProvider.aggregateDb.firstCall.args[2]).to.deep.equal(
-            READ_PREFERENCE
+            AGGREGATE_OPTIONS
           );
         });
       });
@@ -1890,7 +1891,7 @@ describe('Database', function () {
           );
           expect(matchStage).to.deep.equals({ $match: {} });
           expect(serviceProvider.aggregateDb.firstCall.args[2]).to.deep.equal(
-            READ_PREFERENCE
+            AGGREGATE_OPTIONS
           );
         });
       });
@@ -1914,7 +1915,7 @@ describe('Database', function () {
             );
             expect(matchStage).to.deep.equals({ $match: {} });
             expect(serviceProvider.aggregateDb.firstCall.args[2]).to.deep.equal(
-              READ_PREFERENCE
+              AGGREGATE_OPTIONS
             );
           });
         }
@@ -1945,7 +1946,7 @@ describe('Database', function () {
               $match: { waitingForLock: true },
             });
             expect(serviceProvider.aggregateDb.firstCall.args[2]).to.deep.equal(
-              READ_PREFERENCE
+              AGGREGATE_OPTIONS
             );
           });
 

packages/shell-api/src/database.ts

@@ -1063,7 +1063,12 @@ export default class Database extends ShellApiWithMongoClass {
     }
 
     const adminDb = this.getSiblingDB('admin');
-    const aggregateOptions = { $readPreference: { mode: 'primaryPreferred' } };
+    const aggregateOptions = {
+      $readPreference: { mode: 'primaryPreferred' },
+      // Regex patterns should be instances of BSONRegExp
+      // as there can be issues during conversion otherwise.
+      bsonRegExp: true,
+    };
 
     try {
       const cursor = await adminDb.aggregate(pipeline, aggregateOptions);