fix(chat): avoid passing file path when its not used in playground run (#844)

Author: Anemy

package.json

@@ -192,11 +192,11 @@
         "title": "MongoDB: Change Active Connection with Participant"
       },
       {
-        "command": "mdb.runParticipantQuery",
+        "command": "mdb.runParticipantCode",
         "title": "Run Content Generated by Participant"
       },
       {
-        "command": "mdb.openParticipantQueryInPlayground",
+        "command": "mdb.openParticipantCodeInPlayground",
         "title": "Open Generated by Participant Content In Playground"
       },
       {
@@ -766,15 +766,15 @@
           "when": "false"
         },
         {
-          "command": "mdb.runParticipantQuery",
+          "command": "mdb.runParticipantCode",
           "when": "false"
         },
         {
-          "command": "mdb.openParticipantQueryInPlayground",
+          "command": "mdb.openParticipantCodeInPlayground",
           "when": "false"
         },
         {
-          "command": "mdb.runParticipantQuery",
+          "command": "mdb.runParticipantCode",
           "when": "false"
         },
         {

src/commands/index.ts

@@ -77,8 +77,8 @@ enum EXTENSION_COMMANDS {
   MDB_DROP_STREAM_PROCESSOR = 'mdb.dropStreamProcessor',
 
   // Chat participant.
-  OPEN_PARTICIPANT_QUERY_IN_PLAYGROUND = 'mdb.openParticipantQueryInPlayground',
-  RUN_PARTICIPANT_QUERY = 'mdb.runParticipantQuery',
+  OPEN_PARTICIPANT_CODE_IN_PLAYGROUND = 'mdb.openParticipantCodeInPlayground',
+  RUN_PARTICIPANT_CODE = 'mdb.runParticipantCode',
   CONNECT_WITH_PARTICIPANT = 'mdb.connectWithParticipant',
   SELECT_DATABASE_WITH_PARTICIPANT = 'mdb.selectDatabaseWithParticipant',
   SELECT_COLLECTION_WITH_PARTICIPANT = 'mdb.selectCollectionWithParticipant',

src/editors/playgroundController.ts

@@ -59,10 +59,14 @@ interface ToCompile {
 
 let dummySandbox;
 
+function getActiveEditorFilePath(): string | undefined {
+  return vscode.window.activeTextEditor?.document.uri.fsPath;
+}
+
 // TODO: this function was copied from the compass-export-to-language module
 // https://github.com/mongodb-js/compass/blob/7c4bc0789a7b66c01bb7ba63955b3b11ed40c094/packages/compass-export-to-language/src/modules/count-aggregation-stages-in-string.js
 // and should be updated as well when the better solution for the problem will be found.
-const countAggregationStagesInString = (str: string) => {
+const countAggregationStagesInString = (str: string): number => {
   if (!dummySandbox) {
     dummySandbox = vm.createContext(Object.create(null), {
       codeGeneration: { strings: false, wasm: false },
@@ -112,6 +116,9 @@ const exportModeMapping: Record<
   [ExportToLanguageMode.OTHER]: undefined,
 };
 
+const connectBeforeRunningMessage =
+  'Please connect to a database before running a playground.';
+
 /**
  * This controller manages playground.
  */
@@ -160,7 +167,7 @@ export default class PlaygroundController {
     this._playgroundSelectedCodeActionProvider =
       playgroundSelectedCodeActionProvider;
 
-    this._activeConnectionChangedHandler = () => {
+    this._activeConnectionChangedHandler = (): void => {
       void this._activeConnectionChanged();
     };
     this._connectionController.addEventListener(
@@ -170,7 +177,7 @@ export default class PlaygroundController {
 
     const onDidChangeActiveTextEditor = (
       editor: vscode.TextEditor | undefined
-    ) => {
+    ): void => {
       if (editor?.document.uri.scheme === PLAYGROUND_RESULT_SCHEME) {
         this._playgroundResultViewColumn = editor.viewColumn;
         this._playgroundResultTextDocument = editor?.document;
@@ -373,7 +380,7 @@ export default class PlaygroundController {
     return this._createPlaygroundFileWithContent(content);
   }
 
-  createPlaygroundFromParticipantQuery({
+  createPlaygroundFromParticipantCode({
     text,
   }: {
     text: string;
@@ -438,13 +445,17 @@ export default class PlaygroundController {
     return this._createPlaygroundFileWithContent(content);
   }
 
-  async _evaluate(codeToEvaluate: string): Promise<ShellEvaluateResult> {
+  async _evaluate({
+    codeToEvaluate,
+    filePath,
+  }: {
+    codeToEvaluate: string;
+    filePath?: string;
+  }): Promise<ShellEvaluateResult> {
     const connectionId = this._connectionController.getActiveConnectionId();
 
     if (!connectionId) {
-      throw new Error(
-        'Please connect to a database before running a playground.'
-      );
+      throw new Error(connectBeforeRunningMessage);
     }
 
     this._statusView.showMessage('Getting results...');
@@ -455,7 +466,7 @@ export default class PlaygroundController {
       result = await this._languageServerController.evaluate({
         codeToEvaluate,
         connectionId,
-        filePath: vscode.window.activeTextEditor?.document.uri.fsPath,
+        filePath,
       });
     } catch (error) {
       const msg =
@@ -482,13 +493,15 @@ export default class PlaygroundController {
     return this._activeTextEditor?.document.getText(selection) || '';
   }
 
-  async _evaluateWithCancelModal(
-    codeToEvaluate: string
-  ): Promise<ShellEvaluateResult> {
+  async _evaluateWithCancelModal({
+    codeToEvaluate,
+    filePath,
+  }: {
+    codeToEvaluate: string;
+    filePath?: string;
+  }): Promise<ShellEvaluateResult> {
     if (!this._connectionController.isCurrentlyConnected()) {
-      throw new Error(
-        'Please connect to a database before running a playground.'
-      );
+      throw new Error(connectBeforeRunningMessage);
     }
 
     try {
@@ -507,9 +520,10 @@ export default class PlaygroundController {
           });
 
           // Run all playground scripts.
-          const result: ShellEvaluateResult = await this._evaluate(
-            codeToEvaluate
-          );
+          const result: ShellEvaluateResult = await this._evaluate({
+            codeToEvaluate,
+            filePath,
+          });
 
           return result;
         }
@@ -572,11 +586,18 @@ export default class PlaygroundController {
     }
   }
 
-  async evaluateParticipantQuery(text: string): Promise<boolean> {
+  async evaluateParticipantCode(codeToEvaluate: string): Promise<boolean> {
     const shouldConfirmRunCopilotCode = vscode.workspace
       .getConfiguration('mdb')
       .get('confirmRunCopilotCode');
 
+    if (!this._connectionController.isCurrentlyConnected()) {
+      // TODO(VSCODE-618): Prompt user to connect when clicked.
+      void vscode.window.showErrorMessage(connectBeforeRunningMessage);
+
+      return false;
+    }
+
     if (shouldConfirmRunCopilotCode === true) {
       const name = this._connectionController.getActiveConnectionName();
       const confirmRunCopilotCode = await vscode.window.showInformationMessage(
@@ -591,7 +612,9 @@ export default class PlaygroundController {
     }
 
     const evaluateResponse: ShellEvaluateResult =
-      await this._evaluateWithCancelModal(text);
+      await this._evaluateWithCancelModal({
+        codeToEvaluate,
+      });
 
     if (!evaluateResponse || !evaluateResponse.result) {
       return false;
@@ -602,15 +625,19 @@ export default class PlaygroundController {
     return true;
   }
 
-  async _evaluatePlayground(text: string): Promise<boolean> {
+  async _evaluatePlayground({
+    codeToEvaluate,
+    filePath,
+  }: {
+    codeToEvaluate: string;
+    filePath?: string;
+  }): Promise<boolean> {
     const shouldConfirmRunAll = vscode.workspace
       .getConfiguration('mdb')
       .get('confirmRunAll');
 
     if (!this._connectionController.isCurrentlyConnected()) {
-      void vscode.window.showErrorMessage(
-        'Please connect to a database before running a playground.'
-      );
+      void vscode.window.showErrorMessage(connectBeforeRunningMessage);
 
       return false;
     }
@@ -629,7 +656,10 @@ export default class PlaygroundController {
     }
 
     const evaluateResponse: ShellEvaluateResult =
-      await this._evaluateWithCancelModal(text);
+      await this._evaluateWithCancelModal({
+        codeToEvaluate,
+        filePath,
+      });
 
     if (!evaluateResponse || !evaluateResponse.result) {
       return false;
@@ -652,7 +682,10 @@ export default class PlaygroundController {
 
     this._isPartialRun = true;
 
-    return this._evaluatePlayground(this._selectedText || '');
+    return this._evaluatePlayground({
+      codeToEvaluate: this._selectedText || '',
+      filePath: getActiveEditorFilePath(),
+    });
   }
 
   runAllPlaygroundBlocks(): Promise<boolean> {
@@ -669,7 +702,10 @@ export default class PlaygroundController {
 
     this._isPartialRun = false;
 
-    return this._evaluatePlayground(this._getAllText());
+    return this._evaluatePlayground({
+      codeToEvaluate: this._getAllText(),
+      filePath: getActiveEditorFilePath(),
+    });
   }
 
   runAllOrSelectedPlaygroundBlocks(): Promise<boolean> {
@@ -693,14 +729,17 @@ export default class PlaygroundController {
       codeToEvaluate = this._selectedText;
     }
 
-    return this._evaluatePlayground(codeToEvaluate);
+    return this._evaluatePlayground({
+      codeToEvaluate,
+      filePath: getActiveEditorFilePath(),
+    });
   }
 
   async fixThisInvalidInteractiveSyntax({
     documentUri,
     range,
     fix,
-  }: ThisDiagnosticFix) {
+  }: ThisDiagnosticFix): Promise<boolean> {
     const edit = new vscode.WorkspaceEdit();
     edit.replace(documentUri, range, fix);
     await vscode.workspace.applyEdit(edit);
@@ -710,7 +749,7 @@ export default class PlaygroundController {
   async fixAllInvalidInteractiveSyntax({
     documentUri,
     diagnostics,
-  }: AllDiagnosticFixes) {
+  }: AllDiagnosticFixes): Promise<boolean> {
     const edit = new vscode.WorkspaceEdit();
 
     for (const { range, fix } of diagnostics) {
@@ -884,7 +923,7 @@ export default class PlaygroundController {
           language,
           num_stages: selectedText
             ? countAggregationStagesInString(selectedText)
-            : null,
+            : undefined,
           with_import_statements: importStatements,
           with_builders: builders,
           with_driver_syntax: driverSyntax,

src/mdbExtensionController.ts

@@ -44,7 +44,7 @@ import { ConnectionStorage } from './storage/connectionStorage';
 import type StreamProcessorTreeItem from './explorer/streamProcessorTreeItem';
 import type {
   ParticipantCommand,
-  RunParticipantQueryCommandArgs,
+  RunParticipantCodeCommandArgs,
 } from './participant/participant';
 import ParticipantController from './participant/participant';
 import type { OpenSchemaCommandArgs } from './participant/prompts/schema';
@@ -296,17 +296,17 @@ export default class MDBExtensionController implements vscode.Disposable {
 
     // ------ CHAT PARTICIPANT ------ //
     this.registerParticipantCommand(
-      EXTENSION_COMMANDS.OPEN_PARTICIPANT_QUERY_IN_PLAYGROUND,
-      ({ runnableContent }: RunParticipantQueryCommandArgs) => {
-        return this._playgroundController.createPlaygroundFromParticipantQuery({
+      EXTENSION_COMMANDS.OPEN_PARTICIPANT_CODE_IN_PLAYGROUND,
+      ({ runnableContent }: RunParticipantCodeCommandArgs) => {
+        return this._playgroundController.createPlaygroundFromParticipantCode({
           text: runnableContent,
         });
       }
     );
     this.registerParticipantCommand(
-      EXTENSION_COMMANDS.RUN_PARTICIPANT_QUERY,
-      ({ runnableContent }: RunParticipantQueryCommandArgs) => {
-        return this._playgroundController.evaluateParticipantQuery(
+      EXTENSION_COMMANDS.RUN_PARTICIPANT_CODE,
+      ({ runnableContent }: RunParticipantCodeCommandArgs) => {
+        return this._playgroundController.evaluateParticipantCode(
           runnableContent
         );
       }

src/participant/participant.ts

@@ -55,7 +55,7 @@ interface NamespaceQuickPicks {
   data: string;
 }
 
-export type RunParticipantQueryCommandArgs = {
+export type RunParticipantCodeCommandArgs = {
   runnableContent: string;
 };
 
@@ -244,16 +244,16 @@ export default class ParticipantController {
       return;
     }
 
-    const commandArgs: RunParticipantQueryCommandArgs = {
+    const commandArgs: RunParticipantCodeCommandArgs = {
       runnableContent,
     };
     stream.button({
-      command: EXTENSION_COMMANDS.RUN_PARTICIPANT_QUERY,
+      command: EXTENSION_COMMANDS.RUN_PARTICIPANT_CODE,
       title: vscode.l10n.t('▶️ Run'),
       arguments: [commandArgs],
     });
     stream.button({
-      command: EXTENSION_COMMANDS.OPEN_PARTICIPANT_QUERY_IN_PLAYGROUND,
+      command: EXTENSION_COMMANDS.OPEN_PARTICIPANT_CODE_IN_PLAYGROUND,
       title: vscode.l10n.t('Open in playground'),
       arguments: [commandArgs],
     });

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

@@ -324,9 +324,9 @@ suite('Playground Controller Test Suite', function () {
           sandbox.fake.rejects(false)
         );
 
-        const result = await testPlaygroundController._evaluateWithCancelModal(
-          ''
-        );
+        const result = await testPlaygroundController._evaluateWithCancelModal({
+          codeToEvaluate: '',
+        });
 
         expect(result).to.deep.equal({ result: undefined });
       });