feat: DH-20578: Groovy remote file source (#273)

DH-20578: Adds Groovy support for remote file source features in VS Code
extension. The supporting plugin work has not fully landed yet mostly
waiting on tests, but I don't think that should block this PR:

**Related Pending PRs**
Changes for these are deployed to `bmingles-remote-file-source2` BHS
- deephaven/deephaven-core#7451
- deephaven-ent/iris#3878
- TBD: PR to integrate Core changes into gplus

## Testing
- Test on a grizzly or gplus server without the plugin installed. Verify
that we can still run python and groovy scripts without remote file
sourcing. This is just a regression test.
- `bmingles-remote-file-source2` has Groovy and Python remote plugins
installed, so full feature set can be tested there

### Setup
- Start `bmingles-remote-file-source2` vm if not already running
- Clone this test repo
`git@github.com:bmingles/deephaven-controller-script-test`
- Checkout the `local` git branch (the `main` branch is configured as a
controller source on `bmingles-remote-file-source2`).

### Local override tests
- Connect to `bmingles-remote-file-source2` server in VS Code
- Open and run `src/main/groovy/docs-sample.groovy` against the BHS
- Should see STDOUT entries in OUTPUT -> Deephaven panel with `"Server"`
prefix e.g.
   ```
   12:16:14.829 STDOUT Server: Notebook Level Var
   12:16:14.830 STDOUT Server: Notebook Level Var
   12:16:14.830 STDOUT Server: Top Level Var
   12:16:14.830 STDOUT Server: Top Level Var
   ...
   ```
- Cells in the `testTable` should also include the `"Server"` prefix
- Add `src/main/groovy/test` folder as a Groovy remote file source
- Run the script again. Should see `"Local"` prefix e.g.
   ```
   12:21:12.336 STDOUT Local: Notebook Level Var
   12:21:12.336 STDOUT Local: Notebook Level Var
   12:21:12.337 STDOUT Local: Top Level Var
   12:21:12.337 STDOUT Local: Top Level Var
   ...
   ```
- Cells in the `testTable` should also include the `"Local"` prefix
- Remove the `src/main/groovy/test` as a remote file source
- Run the script again. STDOUT and table cells should all go back to the
`"Server"` prefixes

### Tree Selection Behavior
There was a bug fixed in this PR that impacts how partial unmarking
works in the Remote file source tree view.
- Navigate to Deephaven activity bar tab (left sidebar)
- Expand Groovy workspace tree until you get to
`src/main/groovy/nested/ws1`
- Add `ws1` folder as remote source with the `+` button
- Should see ws1 and all of its children turn green
- Hover over `ws1/sub1` subfolder and click the `-` sign to remove it
- Result should be that `ws1/sub2` is now the marked folder. `ws1/sub1`
and `ws1/file1.groovy` should both be unmarked

Author: bmingles

__mocks__/vscode.ts

@@ -128,8 +128,20 @@ export class DiagnosticCollection
   }
 }
 
-export class EventEmitter {
-  fire = vi.fn().mockName('fire');
+export class EventEmitter<T> {
+  listeners = new Set<(...args: any[]) => void>();
+  event = (listener: (e: T) => any) => {
+    this.listeners.add(listener);
+    return () => {
+      this.listeners.delete(listener);
+    };
+  };
+  fire = vi
+    .fn()
+    .mockName('fire')
+    .mockImplementation((event: T) => {
+      this.listeners.forEach(listener => listener(event));
+    });
 }
 
 export class MarkdownString {
@@ -306,6 +318,7 @@ export const workspace = {
     .fn()
     .mockName('createFileSystemWatcher')
     .mockReturnValue({
+      onDidChange: vi.fn().mockName('onDidChange'),
       onDidCreate: vi.fn().mockName('onDidCreate'),
       onDidDelete: vi.fn().mockName('onDidDelete'),
     }),

e2e-testing/src/runner.mts

@@ -10,7 +10,21 @@ const isSetup = args.includes('--setup');
 const __dirname = import.meta.dirname;
 const e2eTestingPath = path.resolve(__dirname, '..');
 
-const storagePath = path.join(e2eTestingPath, '.resources');
+const storagePath =
+  process.env.TEST_RESOURCES ?? path.join(e2eTestingPath, '.resources');
+
+// Warn about Unix socket path length constraints
+// Electron/VS Code creates an IPC socket under storagePath/settings/<version>-main.sock
+// Unix platforms (macOS, Linux) have varying socket path length limits.
+// Storage path length > 70 is conservative to avoid constraints on different OSs.
+if (process.platform !== 'win32' && storagePath.length > 70) {
+  console.warn(
+    `\nWARNING: Storage path length (${storagePath.length} chars) may hit socket path length ` +
+      `constraints on some OSs.\n` +
+      `  Path: ${storagePath}\n` +
+      `If e2e tests fail with connection errors, try setting a shorter TEST_RESOURCES path.\n`
+  );
+}
 const extensionsPath = path.join(e2eTestingPath, '.test-extensions');
 const testFilesPattern = path.join(e2eTestingPath, 'out', '**', '*.spec.js');
 const mochaConfig = path.join(

package.json

@@ -326,19 +326,34 @@
         "icon": "$(close)"
       },
       {
-        "command": "vscode-deephaven.addRemoteFileSource",
-        "title": "Add to Deephaven remote file sources",
+        "command": "vscode-deephaven.addGroovyRemoteFileSource",
+        "title": "Add to Deephaven Groovy remote file sources",
         "icon": "$(add)"
       },
       {
-        "command": "vscode-deephaven.removeRemoteFileSource",
-        "title": "Remove from Deephaven remote file sources",
+        "command": "vscode-deephaven.removeGroovyRemoteFileSource",
+        "title": "Remove from Deephaven Groovy remote file sources",
+        "icon": "$(remove)"
+      },
+      {
+        "command": "vscode-deephaven.addPythonRemoteFileSource",
+        "title": "Add to Deephaven Python remote file sources",
+        "icon": "$(add)"
+      },
+      {
+        "command": "vscode-deephaven.removePythonRemoteFileSource",
+        "title": "Remove from Deephaven Python remote file sources",
         "icon": "$(remove)"
       },
       {
         "command": "vscode-deephaven.deleteVariable",
         "title": "Delete Deephaven Variable",
         "icon": "$(trash)"
+      },
+      {
+        "command": "vscode-deephaven.revealInExplorer",
+        "title": "Reveal in Explorer",
+        "icon": "$(eye)"
       }
     ],
     "icons": {
@@ -865,16 +880,28 @@
           "when": "false"
         },
         {
-          "command": "vscode-deephaven.addRemoteFileSource",
+          "command": "vscode-deephaven.addGroovyRemoteFileSource",
           "when": "false"
         },
         {
-          "command": "vscode-deephaven.removeRemoteFileSource",
+          "command": "vscode-deephaven.removeGroovyRemoteFileSource",
+          "when": "false"
+        },
+        {
+          "command": "vscode-deephaven.addPythonRemoteFileSource",
+          "when": "false"
+        },
+        {
+          "command": "vscode-deephaven.removePythonRemoteFileSource",
           "when": "false"
         },
         {
           "command": "vscode-deephaven.deleteVariable",
           "when": "false"
+        },
+        {
+          "command": "vscode-deephaven.revealInExplorer",
+          "when": "false"
         }
       ],
       "editor/context": [
@@ -903,12 +930,22 @@
       ],
       "explorer/context": [
         {
-          "command": "vscode-deephaven.addRemoteFileSource",
+          "command": "vscode-deephaven.addGroovyRemoteFileSource",
           "group": "deephaven",
           "when": "explorerResourceIsFolder"
         },
         {
-          "command": "vscode-deephaven.removeRemoteFileSource",
+          "command": "vscode-deephaven.removeGroovyRemoteFileSource",
+          "group": "deephaven",
+          "when": "explorerResourceIsFolder"
+        },
+        {
+          "command": "vscode-deephaven.addPythonRemoteFileSource",
+          "group": "deephaven",
+          "when": "explorerResourceIsFolder"
+        },
+        {
+          "command": "vscode-deephaven.removePythonRemoteFileSource",
           "group": "deephaven",
           "when": "explorerResourceIsFolder"
         }
@@ -999,14 +1036,28 @@
           "group": "inline@2"
         },
         {
-          "command": "vscode-deephaven.addRemoteFileSource",
-          "when": "view == vscode-deephaven.view.remoteImportSourceTree && viewItem == canAddRemoteFileSource",
+          "command": "vscode-deephaven.addGroovyRemoteFileSource",
+          "when": "view == vscode-deephaven.view.remoteImportSourceTree && viewItem == canAddRemoteFileSource:groovy",
           "group": "inline"
         },
         {
-          "command": "vscode-deephaven.removeRemoteFileSource",
-          "when": "view == vscode-deephaven.view.remoteImportSourceTree && viewItem == canRemoveRemoteFileSource",
+          "command": "vscode-deephaven.removeGroovyRemoteFileSource",
+          "when": "view == vscode-deephaven.view.remoteImportSourceTree && viewItem == canRemoveRemoteFileSource:groovy",
           "group": "inline"
+        },
+        {
+          "command": "vscode-deephaven.addPythonRemoteFileSource",
+          "when": "view == vscode-deephaven.view.remoteImportSourceTree && viewItem == canAddRemoteFileSource:python",
+          "group": "inline"
+        },
+        {
+          "command": "vscode-deephaven.removePythonRemoteFileSource",
+          "when": "view == vscode-deephaven.view.remoteImportSourceTree && viewItem == canRemoveRemoteFileSource:python",
+          "group": "inline"
+        },
+        {
+          "command": "vscode-deephaven.revealInExplorer",
+          "when": "view == vscode-deephaven.view.remoteImportSourceTree && viewItem != root && viewItem != languageRoot"
         }
       ]
     },

releases/vscode-deephaven-1.0.18-remote-file-source.0.vsix

@@ -76,12 +76,14 @@ Community servers always support panel URLs. Enterprise servers require Grizzly+
 
 ### Remote File Sources
 
-Enable server to fetch source files during execution:
+Configure which workspace folders the server fetches source files from during execution:
 
 - Add folder URIs as remote sources (`addRemoteFileSources`)
 - List current sources (`listRemoteFileSources`)
 - Remove sources when done (`removeRemoteFileSources`)
 
+If an import error occurs, follow the hint in the tool response — it will specify how to resolve it.
+
 ### Troubleshooting
 
 **MCP Server Not Running:**
@@ -114,6 +116,10 @@ Server connections are managed through MCP tools. Use `listConnections`, `listSe
 
 All MCP tools are available when the MCP server is enabled via `deephaven.mcp.enabled` setting. If tools aren't available, ensure MCP is enabled (see Troubleshooting).
 
+### Tool Response Hints
+
+Tool responses may include hints that guide next steps. Consider them before deciding how to proceed.
+
 ### Variable Management
 
 - Only list panel variables when explicitly asked

skills/deephaven-vscode-using/SKILL.md

@@ -10,8 +10,9 @@ import type {
   WorkerURL,
 } from '../types';
 
-/** Arguments passed to `ADD_REMOTE_FILE_SOURCE_CMD` handler */
+/** Arguments passed to `ADD_GROOVY_REMOTE_FILE_SOURCE_CMD` and `ADD_PYTHON_REMOTE_FILE_SOURCE_CMD` handlers */
 export type AddRemoteFileSourceCmdArgs = [
+  languageId: 'groovy' | 'python',
   folderElementOrUri:
     | RemoteImportSourceTreeFolderElement
     | vscode.Uri
@@ -37,8 +38,9 @@ export type RefreshVariablePanelsCmdArgs = [
   variables: NonEmptyArray<VariableDefintion>,
 ];
 
-/** Arguments passed to `REMOVE_REMOTE_FILE_SOURCE_CMD` handler */
+/** Arguments passed to `REMOVE_GROOVY_REMOTE_FILE_SOURCE_CMD` and `REMOVE_PYTHON_REMOTE_FILE_SOURCE_CMD` handlers */
 export type RemoveRemoteFileSourceCmdArgs = [
+  languageId: 'groovy' | 'python',
   folderElementOrUri:
     | RemoteImportSourceTreeFolderElement
     | vscode.Uri
@@ -77,6 +79,12 @@ function cmd<T extends string>(cmd: T): `${typeof EXTENSION_ID}.${T}` {
   return `${EXTENSION_ID}.${cmd}`;
 }
 
+export const ADD_GROOVY_REMOTE_FILE_SOURCE_CMD = cmd(
+  'addGroovyRemoteFileSource'
+);
+export const ADD_PYTHON_REMOTE_FILE_SOURCE_CMD = cmd(
+  'addPythonRemoteFileSource'
+);
 export const CLEAR_SECRET_STORAGE_CMD = cmd('clearSecretStorage');
 export const CLOSE_CREATE_QUERY_VIEW_CMD = cmd('view.createQuery.close');
 export const CONNECT_TO_SERVER_CMD = cmd('connectToServer');
@@ -106,6 +114,13 @@ export const REFRESH_SERVER_CONNECTION_TREE_CMD = cmd(
 );
 export const REFRESH_PANELS_TREE_CMD = cmd('refreshPanelsTree');
 export const REFRESH_VARIABLE_PANELS_CMD = cmd('refreshVariablePanels');
+export const REMOVE_GROOVY_REMOTE_FILE_SOURCE_CMD = cmd(
+  'removeGroovyRemoteFileSource'
+);
+export const REMOVE_PYTHON_REMOTE_FILE_SOURCE_CMD = cmd(
+  'removePythonRemoteFileSource'
+);
+export const REVEAL_IN_EXPLORER_CMD = cmd('revealInExplorer');
 export const RUN_CODE_COMMAND = cmd('runCode');
 export const RUN_MARKDOWN_CODEBLOCK_CMD = cmd('runMarkdownCodeBlock');
 export const RUN_SELECTION_COMMAND = cmd('runSelection');
@@ -116,17 +131,22 @@ export const SHOW_MCP_QUICK_PICK_CMD = cmd('showMcpQuickPick');
 export const START_SERVER_CMD = cmd('startServer');
 export const STOP_SERVER_CMD = cmd('stopServer');
 export const TOGGLE_MCP_CMD = cmd('toggleMcp');
-export const ADD_REMOTE_FILE_SOURCE_CMD = cmd('addRemoteFileSource');
-export const REMOVE_REMOTE_FILE_SOURCE_CMD = cmd('removeRemoteFileSource');
 
 /**
  * Execute the add remote file source command with type safety.
- * @param uris The folder URIs to add as remote file sources.
+ * @param args The arguments for adding the remote file source, including the language ID and folder URI(s).
+ * @returns A Thenable that resolves when the command has been executed.
  */
 export function execAddRemoteFileSource(
   ...args: AddRemoteFileSourceCmdArgs
 ): Thenable<void> {
-  return vscode.commands.executeCommand(ADD_REMOTE_FILE_SOURCE_CMD, ...args);
+  const [languageId, ...rest] = args;
+  return vscode.commands.executeCommand(
+    languageId === 'groovy'
+      ? ADD_GROOVY_REMOTE_FILE_SOURCE_CMD
+      : ADD_PYTHON_REMOTE_FILE_SOURCE_CMD,
+    ...rest
+  );
 }
 
 /**
@@ -153,12 +173,21 @@ export function execOpenVariablePanels(
 
 /**
  * Execute the remove remote file source command with type safety.
- * @param uris The folder URIs to remove as remote file sources.
+ * @param args The arguments for removing the remote file source, including the
+ * language ID and folder URI(s).
+ * @returns A Thenable that resolves when the command has been executed.
  */
 export function execRemoveRemoteFileSource(
   ...args: RemoveRemoteFileSourceCmdArgs
 ): Thenable<void> {
-  return vscode.commands.executeCommand(REMOVE_REMOTE_FILE_SOURCE_CMD, ...args);
+  const [languageId, ...rest] = args;
+
+  return vscode.commands.executeCommand(
+    languageId === 'groovy'
+      ? REMOVE_GROOVY_REMOTE_FILE_SOURCE_CMD
+      : REMOVE_PYTHON_REMOTE_FILE_SOURCE_CMD,
+    ...rest
+  );
 }
 
 /**

src/common/commands.ts

@@ -123,6 +123,8 @@ export const ICON_ID = {
   connected: 'vm-connect',
   connecting: 'sync~spin',
   disconnected: 'plug',
+  groovy: 'coffee',
+  python: 'dh-python',
   runAll: 'run-all',
   runSelection: 'run',
   runningCode: 'sync~spin',