feat(cli-repl): add history() command MONGOSH-2013 (#2369)

Author: gagik

packages/cli-repl/src/mongosh-repl.spec.ts

@@ -10,7 +10,7 @@ import type { Duplex } from 'stream';
 import { PassThrough } from 'stream';
 import type { StubbedInstance } from 'ts-sinon';
 import { stubInterface } from 'ts-sinon';
-import { promisify } from 'util';
+import { inspect, promisify } from 'util';
 import {
   expect,
   fakeTTYProps,
@@ -526,18 +526,48 @@ describe('MongoshNodeRepl', function () {
       ]) {
         context(mode, function () {
           let getHistory: () => string[];
+          let getAllHistoryItems: () => string[];
 
           beforeEach(function () {
             const { history } = mongoshRepl.runtimeState().repl as unknown as {
               history: string[];
             };
             getHistory = () =>
               history.filter((line) => !line.startsWith('prefill-'));
+            getAllHistoryItems = () => history;
             for (let i = 0; i < prefill; i++) {
               history.unshift(`prefill-${i}`);
             }
           });
 
+          describe('history() command', function () {
+            it('returns a formatted array of history', async function () {
+              output = '';
+              input.write('history()\n');
+              await waitEval(bus);
+              expect(output).includes(
+                inspect(
+                  getAllHistoryItems()
+                    .slice(1, getAllHistoryItems().length)
+                    .reverse(),
+                  { maxArrayLength: Infinity }
+                )
+              );
+            });
+
+            it('works with array operations', async function () {
+              output = '';
+              input.write('history().slice(history().length-10).reverse()\n');
+              await waitEval(bus);
+              const history = getAllHistoryItems().slice(1).reverse();
+              expect(output).includes(
+                inspect(history.slice(history.length - 10).reverse(), {
+                  maxArrayLength: Infinity,
+                })
+              );
+            });
+          });
+
           it('looks up existing entries, if there are any', async function () {
             output = '';
             input.write(arrowUp);

packages/cli-repl/src/mongosh-repl.ts

@@ -47,6 +47,7 @@ import { markTime } from './startup-timing';
 import type { Context } from 'vm';
 import { Script, createContext, runInContext } from 'vm';
 import { installPasteSupport } from './repl-paste-support';
+import util from 'util';
 
 declare const __non_webpack_require__: any;
 
@@ -365,6 +366,8 @@ class MongoshNodeRepl implements EvaluationListener {
     await this.finishInitializingNodeRepl();
     instanceState.setCtx(context);
 
+    this.setupHistoryCommand();
+
     if (!this.shellCliOptions.nodb && !this.shellCliOptions.quiet) {
       // cf. legacy shell:
       // https://github.com/mongodb/mongo/blob/a6df396047a77b90bf1ce9463eecffbee16fb864/src/mongo/shell/mongo_main.cpp#L1003-L1026
@@ -391,6 +394,35 @@ class MongoshNodeRepl implements EvaluationListener {
     return { __initialized: 'yes' };
   }
 
+  setupHistoryCommand(): void {
+    const history = () => {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      const replHistory: string[] = (this.runtimeState().repl as any).history;
+      const formattedHistory =
+        // Remove the history call from the formatted history
+        replHistory.slice(1).reverse();
+
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      formattedHistory[util.inspect.custom as any] = ((
+        depth: number | null,
+        options: util.InspectOptions,
+        inspect: typeof util.inspect
+      ) => {
+        // We pass a copy of the array without the util.inspect.custom set
+        // to prevent infinite recursion.
+        return inspect(formattedHistory.concat(), {
+          ...options,
+          depth,
+          maxArrayLength: Infinity,
+        });
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      }) as any;
+      return formattedHistory;
+    };
+
+    this.runtimeState().context.history = history;
+  }
+
   private async finishInitializingNodeRepl(): Promise<void> {
     const { repl, instanceState } = this.runtimeState();
     if (!repl) return;