MONGOSH-237 - Allow custom print/printjson for individual platforms (#378)

Author: addaleax

packages/browser-repl/package.json

@@ -42,7 +42,7 @@
     "@mongosh/history": "^0.4.2",
     "@mongosh/i18n": "^0.4.2",
     "@mongosh/service-provider-core": "^0.4.2",
-    "@mongosh/shell-api": "^0.4.2",
+    "@mongosh/shell-evaluator": "^0.4.2",
     "pretty-bytes": "^5.3.0",
     "text-table": "^0.2.0"
   },

packages/browser-repl/src/components/shell.spec.tsx

@@ -35,7 +35,8 @@ describe('<Shell />', () => {
     elementFocus = sinon.spy(HTMLElement.prototype, 'focus');
 
     fakeRuntime = {
-      evaluate: sinon.fake.returns({ printable: 'some result' })
+      evaluate: sinon.fake.returns({ printable: 'some result' }),
+      setEvaluationListener: () => {}
     };
 
     onOutputChangedSpy = sinon.spy();
@@ -247,7 +248,8 @@ describe('<Shell />', () => {
           return new Promise(resolve => {
             onInputDone = resolve;
           });
-        }
+        },
+        setEvaluationListener: () => {}
       } as any}
     />);
 
@@ -355,4 +357,12 @@ describe('<Shell />', () => {
 
     expect(HTMLElement.prototype.focus).to.not.have.been.called;
   });
+
+  it('updated the output when .onPrint is called', () => {
+    wrapper.instance().onPrint([{ type: null, printable: 42 }]);
+
+    expect(onOutputChangedSpy).to.have.been.calledWith([
+      { format: 'output', value: 42, type: null }
+    ]);
+  });
 });

packages/browser-repl/src/components/shell.tsx

@@ -104,6 +104,7 @@ export class Shell extends Component<ShellProps, ShellState> {
     let outputLine;
 
     try {
+      this.props.runtime.setEvaluationListener(this);
       const result = await this.props.runtime.evaluate(code);
       outputLine = {
         format: 'output',
@@ -156,6 +157,16 @@ export class Shell extends Component<ShellProps, ShellState> {
     this.props.onOutputChanged(output);
   };
 
+  onPrint = (result: { type: string | null; printable: any }[]): void => {
+    const output = this.addEntriesToOutput(result.map((entry) => ({
+      format: 'output',
+      type: entry.type,
+      value: entry.printable
+    })));
+    this.setState({ output });
+    this.props.onOutputChanged(output);
+  };
+
   private onInput = async(code: string): Promise<void> => {
     if (!code || code.trim() === '') {
       this.appendEmptyInput();
@@ -167,25 +178,22 @@ export class Shell extends Component<ShellProps, ShellState> {
       value: code
     };
 
+    let output = this.addEntriesToOutput([inputLine]);
     this.setState({
-      operationInProgress: true
+      operationInProgress: true,
+      output
     });
+    this.props.onOutputChanged(output);
 
     const outputLine = await this.evaluate(code);
 
-    const output = this.addEntriesToOutput([
-      inputLine,
-      outputLine
-    ]);
-
+    output = this.addEntriesToOutput([outputLine]);
     const history = this.addEntryToHistory(code);
-
     this.setState({
       operationInProgress: false,
       output,
       history
     });
-
     this.props.onOutputChanged(output);
     this.props.onHistoryChanged(history);
   };

packages/browser-repl/src/iframe-runtime/iframe-runtime.ts

@@ -9,18 +9,28 @@ import {
 } from '@mongosh/browser-runtime-core';
 
 import { ServiceProvider } from '@mongosh/service-provider-core';
-import { ShellResult } from '@mongosh/shell-api';
+import { ShellResult, EvaluationListener } from '@mongosh/shell-evaluator';
 
 export class IframeRuntime implements Runtime {
   private openContextRuntime: OpenContextRuntime;
   private iframe: HTMLIFrameElement;
   private container: HTMLDivElement;
   private serviceProvider: ServiceProvider;
+  private evaluationListener: EvaluationListener | null = null;
 
   constructor(serviceProvider: ServiceProvider) {
     this.serviceProvider = serviceProvider;
   }
 
+  setEvaluationListener(listener: EvaluationListener): EvaluationListener | null {
+    const prev = this.evaluationListener;
+    this.evaluationListener = listener;
+    if (this.openContextRuntime) {
+      this.openContextRuntime.setEvaluationListener(listener);
+    }
+    return prev;
+  }
+
   async evaluate(code: string): Promise<ShellResult> {
     if (!this.openContextRuntime) {
       await this.initialize();
@@ -60,6 +70,9 @@ export class IframeRuntime implements Runtime {
 
     const environment = new IframeInterpreterEnvironment(this.iframe.contentWindow);
     this.openContextRuntime = new OpenContextRuntime(this.serviceProvider, environment);
+    if (this.evaluationListener) {
+      this.openContextRuntime.setEvaluationListener(this.evaluationListener);
+    }
 
     return await ready;
   }

packages/browser-runtime-core/src/open-context-runtime.ts

@@ -6,7 +6,7 @@ import { Runtime } from './runtime';
 import { EventEmitter } from 'events';
 import { ShellInternalState, ShellResult } from '@mongosh/shell-api';
 
-import ShellEvaluator from '@mongosh/shell-evaluator';
+import { ShellEvaluator, EvaluationListener } from '@mongosh/shell-evaluator';
 
 /**
  * This class is the core implementation for a runtime which is not isolated
@@ -22,6 +22,7 @@ export class OpenContextRuntime implements Runtime {
   private autocompleter: ShellApiAutocompleter;
   private shellEvaluator: ShellEvaluator;
   private internalState: ShellInternalState;
+  private evaluationListener: EvaluationListener | null = null;
 
   constructor(
     serviceProvider: ServiceProvider,
@@ -55,4 +56,10 @@ export class OpenContextRuntime implements Runtime {
       ''
     );
   }
+
+  setEvaluationListener(listener: EvaluationListener): EvaluationListener | null {
+    const prev = this.evaluationListener;
+    this.shellEvaluator.setEvaluationListener(listener);
+    return prev;
+  }
 }

packages/browser-runtime-core/src/runtime.ts

@@ -1,9 +1,18 @@
 import { Completion } from './autocompleter/autocompleter';
-import { ShellResult } from '@mongosh/shell-api';
+import { ShellResult, EvaluationListener } from '@mongosh/shell-evaluator';
 
 export type ContextValue = any;
 
 export interface Runtime {
+  /**
+   * Sets a listener for certain events, e.g. onPrint() when print() is called
+   * in the shell.
+   *
+   * @param {EvaluationListener} listener - The new listener.
+   * @return {EvaluationListener | null} The previous listener, if any.
+   */
+  setEvaluationListener(listener: EvaluationListener): EvaluationListener | null;
+
   /**
    * Evaluates code
    *

packages/browser-runtime-electron/package.json

@@ -31,7 +31,7 @@
   "dependencies": {
     "@mongosh/browser-runtime-core": "^0.4.2",
     "@mongosh/service-provider-core": "^0.4.2",
-    "@mongosh/shell-api": "^0.4.2"
+    "@mongosh/shell-evaluator": "^0.4.2"
   },
   "devDependencies": {
     "@mongosh/service-provider-server": "^0.4.2",

packages/browser-runtime-electron/src/electron-runtime.spec.ts

@@ -8,17 +8,23 @@ import { CliServiceProvider } from '@mongosh/service-provider-server';
 import { bson } from '@mongosh/service-provider-core';
 import { ElectronRuntime } from './electron-runtime';
 import { EventEmitter } from 'events';
+import { EvaluationListener } from '@mongosh/shell-evaluator';
 
 describe('Electron runtime', function() {
   let serviceProvider: SinonStubbedInstance<CliServiceProvider>;
   let messageBus: SinonStubbedInstance<EventEmitter>;
+  let evaluationListener: SinonStubbedInstance<EvaluationListener>;
   let electronRuntime: ElectronRuntime;
 
   beforeEach(async() => {
     serviceProvider = sinon.createStubInstance(CliServiceProvider);
     serviceProvider.bsonLibrary = bson;
+    serviceProvider.getConnectionInfo.resolves({ extraInfo: { uri: '' } });
     messageBus = sinon.createStubInstance(EventEmitter);
+    evaluationListener = sinon.createStubInstance(class FakeListener {});
+    evaluationListener.onPrint = sinon.stub();
     electronRuntime = new ElectronRuntime(serviceProvider, messageBus);
+    electronRuntime.setEvaluationListener(evaluationListener);
   });
 
   it('can evaluate simple js', async() => {
@@ -79,4 +85,36 @@ describe('Electron runtime', function() {
     await electronRuntime.evaluate('use db1');
     expect(messageBus.emit).to.have.been.calledWith('mongosh:use');
   });
+
+  describe('onPrint', () => {
+    it('allows getting the output of print() statements', async() => {
+      await electronRuntime.evaluate('print("foo");');
+      expect(evaluationListener.onPrint).to.have.been.calledWithMatch(
+        sinon.match((array) => (
+          array.length === 1 &&
+          array[0].type === null &&
+          array[0].printable === 'foo')));
+    });
+
+    it('allows getting the output of console.log() statements', async() => {
+      await electronRuntime.evaluate('console.log("foo");');
+      expect(evaluationListener.onPrint).to.have.been.calledWithMatch(
+        sinon.match((array) => (
+          array.length === 1 &&
+          array[0].type === null &&
+          array[0].printable === 'foo')));
+    });
+
+    it('allows getting the output of multi-arg console.log() statements', async() => {
+      await electronRuntime.evaluate('console.log("foo", "bar");');
+      expect(evaluationListener.onPrint).to.have.been.calledWithMatch(
+        sinon.match((array) => (
+          array.length === 2 &&
+          array[0].type === null &&
+          array[0].printable === 'foo' &&
+          array[1].type === null &&
+          array[1].printable === 'bar')));
+      expect(evaluationListener.onPrint).to.have.been.calledOnce;
+    });
+  });
 });

packages/browser-runtime-electron/src/electron-runtime.ts

@@ -10,7 +10,7 @@ import {
 } from '@mongosh/browser-runtime-core';
 
 import { ServiceProvider } from '@mongosh/service-provider-core';
-import { ShellResult } from '@mongosh/shell-api';
+import { ShellResult, EvaluationListener } from '@mongosh/shell-evaluator';
 
 declare const __webpack_require__: any;
 declare const __non_webpack_require__: any;
@@ -43,6 +43,10 @@ export class ElectronRuntime implements Runtime {
     );
   }
 
+  setEvaluationListener(listener: EvaluationListener): EvaluationListener | null {
+    return this.openContextRuntime.setEvaluationListener(listener);
+  }
+
   async evaluate(code: string): Promise<ShellResult> {
     return await this.openContextRuntime.evaluate(code);
   }

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

@@ -2,7 +2,7 @@
 
 import { CliServiceProvider, NodeOptions, CliOptions } from '@mongosh/service-provider-server';
 import { getShellApiType, ShellInternalState } from '@mongosh/shell-api';
-import ShellEvaluator from '@mongosh/shell-evaluator';
+import { ShellEvaluator, ShellResult } from '@mongosh/shell-evaluator';
 import formatOutput, { formatError } from './format-output';
 import { LineByLineInput } from './line-by-line-input';
 import { TELEMETRY, MONGOSH_WIKI } from './constants';
@@ -84,6 +84,7 @@ class CliRepl {
     const initialServiceProvider = await this.connect(driverUri, driverOptions);
     this.internalState = new ShellInternalState(initialServiceProvider, this.bus, this.options);
     this.shellEvaluator = new ShellEvaluator(this.internalState, this);
+    this.shellEvaluator.setEvaluationListener(this);
     await this.internalState.fetchConnectionInfo();
     this.start();
   }
@@ -467,6 +468,13 @@ class CliRepl {
     console.error(formatError(error));
     return process.exit(1);
   }
+
+  onPrint(values: ShellResult[]): void {
+    const joined = values.map(this.writer).join(' ');
+    // `as any` becomes unnecessary after
+    // https://github.com/DefinitelyTyped/DefinitelyTyped/pull/48646
+    (this.repl as any).output.write(joined + '\n');
+  }
 }
 
 export default CliRepl;