fix: print playground results as ejson or text (VSCODE-203) (#206)

Author: alenakhineika

package-lock.json

@@ -821,9 +821,9 @@
     "@fortawesome/free-solid-svg-icons": "^5.13.0",
     "@fortawesome/react-fontawesome": "^0.1.9",
     "@leafygreen-ui/toggle": "3.0.1",
-    "@mongosh/browser-runtime-electron": "^0.5.0",
-    "@mongosh/service-provider-server": "^0.5.0",
-    "@mongosh/shell-api": "^0.5.0",
+    "@mongosh/browser-runtime-electron": "^0.5.2",
+    "@mongosh/service-provider-server": "^0.5.2",
+    "@mongosh/shell-api": "^0.5.2",
     "analytics-node": "^3.4.0-beta.1",
     "bson": "^4.0.3",
     "classnames": "^2.2.6",

package.json

@@ -13,6 +13,7 @@ import playgroundCreateIndexTemplate from '../templates/playgroundCreateIndexTem
 import { createLogger } from '../logging';
 import type { ExecuteAllResult } from '../utils/types';
 import { PLAYGROUND_RESULT_SCHEME } from './playgroundResultProvider';
+import type { OutputItem } from '../utils/types';
 
 const log = createLogger('playground controller');
 
@@ -23,7 +24,7 @@ export default class PlaygroundController {
   public connectionController: ConnectionController;
   public activeTextEditor?: TextEditor;
   public partialExecutionCodeLensProvider: PartialExecutionCodeLensProvider;
-  public playgroundResult?: any;
+  public playgroundResult?: OutputItem;
   private _context: vscode.ExtensionContext;
   private _languageServerController: LanguageServerController;
   private _telemetryController: TelemetryController;
@@ -290,15 +291,13 @@ export default class PlaygroundController {
     });
   }
 
-  private getVirtualDocumentUri() {
+  public getVirtualDocumentUri(content?: any) {
     let extension = '';
 
-    if (this.playgroundResult) {
-      if (typeof this.playgroundResult === 'object') {
-        extension = 'json';
-      } else {
-        extension = 'txt';
-      }
+    if (typeof content === 'object') {
+      extension = 'json';
+    } else {
+      extension = 'txt';
     }
 
     return vscode.Uri.parse(
@@ -312,7 +311,9 @@ export default class PlaygroundController {
 
   private openResultAsVirtualDocument(viewColumn) {
     vscode.workspace
-      .openTextDocument(this.getVirtualDocumentUri())
+      .openTextDocument(
+        this.getVirtualDocumentUri(this.playgroundResult?.content)
+      )
       .then((doc) => {
         this._playgroundResultTextDocument = doc;
         vscode.window.showTextDocument(doc, { preview: false, viewColumn });
@@ -359,7 +360,7 @@ export default class PlaygroundController {
         return resolve(false);
       }
 
-      this.playgroundResult = evaluateResponse.result?.content;
+      this.playgroundResult = evaluateResponse.result;
 
       let viewColumn: vscode.ViewColumn =
         this._playgroundResultViewColumn || vscode.ViewColumn.Beside;

src/editors/playgroundController.ts

@@ -4,7 +4,8 @@ import PlaygroundController from './playgroundController';
 
 export const PLAYGROUND_RESULT_SCHEME = 'PLAYGROUND_RESULT_SCHEME';
 
-export default class PlaygroundResultProvider implements vscode.TextDocumentContentProvider {
+export default class PlaygroundResultProvider
+  implements vscode.TextDocumentContentProvider {
   _playgroundController: PlaygroundController;
   _statusView: StatusView;
 
@@ -23,7 +24,21 @@ export default class PlaygroundResultProvider implements vscode.TextDocumentCont
     return new Promise((resolve) => {
       this._statusView.showMessage('Getting results...');
 
-      return resolve(JSON.stringify(this._playgroundController.playgroundResult, null, 2));
+      if (
+        typeof this._playgroundController.playgroundResult?.content ===
+          'object' ||
+        this._playgroundController.playgroundResult?.type !== 'string'
+      ) {
+        return resolve(
+          JSON.stringify(
+            this._playgroundController.playgroundResult?.content,
+            null,
+            2
+          )
+        );
+      }
+
+      return resolve(this._playgroundController.playgroundResult?.content);
     });
   }
 }

src/editors/playgroundResultProvider.ts

@@ -4,12 +4,13 @@ import {
   CliServiceProvider,
   NodeOptions
 } from '@mongosh/service-provider-server';
-import formatOutput from '../utils/formatOutput';
 import parseSchema = require('mongodb-schema');
 import { ServerCommands } from './serverCommands';
 import { CompletionItemKind } from 'vscode-languageserver';
 import type { OutputItem } from '../utils/types';
 
+const { EJSON } = require('bson');
+
 type EvaluationResult = {
   printable: any;
   type: string | null;
@@ -45,12 +46,13 @@ const executeAll = async (
         }
       }
     });
-    const { type, printable } = await runtime.evaluate(
-      codeToEvaluate
-    );
+    const { type, printable } = await runtime.evaluate(codeToEvaluate);
     const result = {
-      type,
-      content: printable
+      type: type ? type : typeof printable,
+      content:
+        typeof printable === 'string'
+          ? printable
+          : JSON.parse(EJSON.stringify(printable))
     };
 
     return [null, { outputLines, result }];

src/language/worker.ts

@@ -323,6 +323,66 @@ suite('Playground Controller Test Suite', function () {
 
         expect(isEditprOpened).to.be.equal(true);
       });
+
+      test('getVirtualDocumentUri should return json uri if content is object', async () => {
+        await vscode.workspace
+          .getConfiguration('mdb')
+          .update('confirmRunAll', false);
+        const uri = await testPlaygroundController.getVirtualDocumentUri({
+          test: 'value'
+        });
+
+        expect(uri.scheme).to.be.equal('PLAYGROUND_RESULT_SCHEME');
+        expect(uri.path).to.be.equal('Playground Result.json');
+      });
+
+      test('getVirtualDocumentUri should return json uri if content is array', async () => {
+        await vscode.workspace
+          .getConfiguration('mdb')
+          .update('confirmRunAll', false);
+        const uri = await testPlaygroundController.getVirtualDocumentUri([
+          { test: 'value' }
+        ]);
+
+        expect(uri.scheme).to.be.equal('PLAYGROUND_RESULT_SCHEME');
+        expect(uri.path).to.be.equal('Playground Result.json');
+      });
+
+      test('getVirtualDocumentUri should return json uri if content is object with BSON value', async () => {
+        await vscode.workspace
+          .getConfiguration('mdb')
+          .update('confirmRunAll', false);
+        const uri = await testPlaygroundController.getVirtualDocumentUri({
+          _id: {
+            $oid: '5d973ae7443762aae72a160'
+          }
+        });
+
+        expect(uri.scheme).to.be.equal('PLAYGROUND_RESULT_SCHEME');
+        expect(uri.path).to.be.equal('Playground Result.json');
+      });
+
+      test('getVirtualDocumentUri should return txt uri if content is string', async () => {
+        await vscode.workspace
+          .getConfiguration('mdb')
+          .update('confirmRunAll', false);
+        const uri = await testPlaygroundController.getVirtualDocumentUri(
+          'I am a string'
+        );
+
+        expect(uri.scheme).to.be.equal('PLAYGROUND_RESULT_SCHEME');
+        expect(uri.path).to.be.equal('Playground Result.txt');
+      });
+
+      test('getVirtualDocumentUri should return txt uri if content is number', async () => {
+        await vscode.workspace
+          .getConfiguration('mdb')
+          .update('confirmRunAll', false);
+        const uri = await testPlaygroundController.getVirtualDocumentUri(12);
+
+        expect(uri.scheme).to.be.equal('PLAYGROUND_RESULT_SCHEME');
+        expect(uri.path).to.be.equal('Playground Result.txt');
+      });
     });
   });
 });

src/test/suite/editors/playgroundController.test.ts

@@ -15,7 +15,6 @@ import MongoDBService, {
 import { mdbTestExtension } from '../stubbableMdbExtension';
 
 const expect = chai.expect;
-
 const INCREASED_TEST_TIMEOUT = 5000;
 
 suite('MongoDBService Test Suite', () => {
@@ -992,15 +991,15 @@ suite('MongoDBService Test Suite', () => {
         },
         source.token
       );
-      const res = {
+      const expectedResult = {
         outputLines: [],
-        result: { type: null, content: 2 }
+        result: { type: 'number', content: 2 }
       };
 
-      expect(result).to.deep.equal(res);
+      expect(result).to.deep.equal(expectedResult);
     });
 
-    test('evaluate multiple commands at once', async function () {
+    test('evaluate multiplies commands at once', async function () {
       this.timeout(INCREASED_TEST_TIMEOUT);
 
       const source = new CancellationTokenSource();
@@ -1010,12 +1009,12 @@ suite('MongoDBService Test Suite', () => {
         },
         source.token
       );
-      const res = {
+      const expectedResult = {
         outputLines: [],
-        result: { type: null, content: 3 }
+        result: { type: 'number', content: 3 }
       };
 
-      expect(result).to.deep.equal(res);
+      expect(result).to.deep.equal(expectedResult);
     });
 
     test('create each time a new runtime', async function () {
@@ -1030,7 +1029,7 @@ suite('MongoDBService Test Suite', () => {
       );
       const firstRes = {
         outputLines: [],
-        result: { type: null, content: 2 }
+        result: { type: 'number', content: 2 }
       };
 
       expect(firstEvalResult).to.deep.equal(firstRes);
@@ -1043,12 +1042,87 @@ suite('MongoDBService Test Suite', () => {
       );
       const secondRes = {
         outputLines: [],
-        result: { type: null, content: 3 }
+        result: { type: 'number', content: 3 }
       };
 
       expect(secondEvalResult).to.deep.equal(secondRes);
     });
 
+    test('evaluate returns valid EJSON', async function () {
+      this.timeout(INCREASED_TEST_TIMEOUT);
+
+      const source = new CancellationTokenSource();
+      const result = await testMongoDBService.executeAll(
+        {
+          codeToEvaluate: `const { ObjectId } = require('bson');
+          const x = { _id: new ObjectId('5fb292760ece2dc9c0362075') };
+          x`
+        },
+        source.token
+      );
+      const expectedResult = {
+        outputLines: [],
+        result: {
+          type: 'object',
+          content: {
+            _id: {
+              $oid: '5fb292760ece2dc9c0362075'
+            }
+          }
+        }
+      };
+
+      expect(result).to.deep.equal(expectedResult);
+    });
+
+    test('evaluate returns single line strings', async function () {
+      this.timeout(INCREASED_TEST_TIMEOUT);
+
+      const source = new CancellationTokenSource();
+      const result = await testMongoDBService.executeAll(
+        {
+          codeToEvaluate: `const x = 'A single line string';
+          x`
+        },
+        source.token
+      );
+      const expectedResult = {
+        outputLines: [],
+        result: {
+          type: 'string',
+          content: 'A single line string'
+        }
+      };
+
+      expect(result).to.deep.equal(expectedResult);
+    });
+
+    test('evaluate returns multiline strings', async function () {
+      this.timeout(INCREASED_TEST_TIMEOUT);
+
+      const source = new CancellationTokenSource();
+      const result = await testMongoDBService.executeAll(
+        {
+          codeToEvaluate: `const x = \`vscode
+          is
+          awesome\`;
+          x`
+        },
+        source.token
+      );
+      const expectedResult = {
+        outputLines: [],
+        result: {
+          type: 'string',
+          content: `vscode
+          is
+          awesome`
+        }
+      };
+
+      expect(result).to.deep.equal(expectedResult);
+    });
+
     test('includes results from print() and console.log()', async function () {
       this.timeout(INCREASED_TEST_TIMEOUT);
 
@@ -1059,17 +1133,17 @@ suite('MongoDBService Test Suite', () => {
         },
         source.token
       );
-      const res = {
+      const expectedResult = {
         outputLines: [
           { type: null, content: 'Hello' },
           { type: null, content: 1 },
           { type: null, content: 2 },
           { type: null, content: 3 }
         ],
-        result: { type: null, content: 42 }
+        result: { type: 'number', content: 42 }
       };
 
-      expect(result).to.deep.equal(res);
+      expect(result).to.deep.equal(expectedResult);
     });
   });
 });