feat: Add preferredECLWatch setting

fixes #438

Signed-off-by: Gordon Smith <[email protected]>

Author: GordonSmith

README.md

@@ -11,6 +11,9 @@ This extension adds rich language support for [HPCC Systems](https://hpccsystems
 
 ## Recent Highlights
 
+### v2.30.x
+* Added `ecl.preferredECLWatch` setting, allows user to nominate preferred version of ECL Watch when opening "external" pages.
+
 ### v2.24.x
 * Added context menu to ECL bundles and ECL Client Tools
 * Added `ecl.WUShowResults` setting, allows user to control how results are displayed after submitting a workunit.
@@ -265,6 +268,9 @@ The following Visual Studio Code settings are available for the ECL extension.
 
   // Ping interval (secs, -1 to disable)
   "ecl.pingInterval": 5
+
+  // Preferred version of ECL Watch (default v9).
+  "ecl.preferredECLWatch": v9 | v5
 ```
 
 #### ECL Launch Settings

package-lock.json

@@ -56,66 +56,66 @@
     "html-to-text": "9.0.5"
   },
   "devDependencies": {
-    "@eslint/js": "9.9.1",
-    "@fluentui/react": "8.120.7",
-    "@hpcc-js/common": "2.72.0",
-    "@hpcc-js/comms": "2.95.0",
-    "@hpcc-js/ddl-shim": "2.21.0",
-    "@hpcc-js/dgrid2": "2.4.0",
-    "@hpcc-js/esbuild-plugins": "1.1.2",
-    "@hpcc-js/loader": "2.106.7",
-    "@hpcc-js/marshaller": "2.26.4",
+    "@eslint/js": "9.21.0",
+    "@fluentui/react": "8.122.11",
+    "@hpcc-js/common": "2.73.0",
+    "@hpcc-js/comms": "2.99.0",
+    "@hpcc-js/ddl-shim": "2.22.0",
+    "@hpcc-js/dgrid2": "2.5.0",
+    "@hpcc-js/esbuild-plugins": "1.4.0",
+    "@hpcc-js/loader": "2.107.2",
+    "@hpcc-js/marshaller": "2.27.2",
     "@hpcc-js/observable-shim": "2.6.0",
-    "@hpcc-js/observablehq-compiler": "1.3.0",
-    "@hpcc-js/util": "2.52.0",
-    "@hpcc-js/wasm-expat": "1.3.0",
+    "@hpcc-js/observablehq-compiler": "1.4.0",
+    "@hpcc-js/util": "2.53.0",
+    "@hpcc-js/wasm-expat": "1.3.2",
     "@hpcc-js/wasm-llama": "1.0.0",
-    "@hpcc-js/wasm-zstd": "1.2.0",
+    "@hpcc-js/wasm-zstd": "1.2.1",
     "@langchain/community": "0.3.10",
     "@langchain/core": "0.2.31",
     "@langchain/ollama": "0.0.4",
     "@observablehq/inspector": "5.0.1",
     "@observablehq/parser": "6.1.0",
     "@observablehq/runtime": "5.9.9",
     "@observablehq/stdlib": "5.8.8",
-    "@octokit/rest": "21.0.2",
-    "@types/mocha": "10.0.7",
-    "@types/node": "20.16.5",
-    "@types/react": "17.0.80",
-    "@types/react-dom": "17.0.25",
+    "@octokit/rest": "21.1.1",
+    "@types/mocha": "10.0.10",
+    "@types/node": "20.17.19",
+    "@types/react": "17.0.83",
+    "@types/react-dom": "17.0.26",
     "@types/tmp": "0.2.6",
     "@types/vscode": "1.92.0",
     "@types/vscode-notebook-renderer": "1.72.3",
-    "@typescript-eslint/eslint-plugin": "8.4.0",
-    "@typescript-eslint/parser": "8.4.0",
-    "@vscode/debugadapter": "1.67.0",
-    "@vscode/debugprotocol": "1.67.0",
-    "@vscode/extension-telemetry": "0.9.7",
-    "@vscode/vsce": "3.1.0",
+    "@typescript-eslint/eslint-plugin": "8.25.0",
+    "@typescript-eslint/parser": "8.25.0",
+    "@vscode/debugadapter": "1.68.0",
+    "@vscode/debugprotocol": "1.68.0",
+    "@vscode/extension-telemetry": "0.9.8",
+    "@vscode/vsce": "3.2.2",
     "adm-zip": "0.5.16",
     "antlr4": "4.13.2",
     "assert": "2.1.0",
     "copy-to-clipboard": "3.3.3",
     "copyfiles": "2.4.1",
     "csv-writer": "1.6.0",
     "diff": "5.2.0",
-    "esbuild": "0.23.1",
+    "esbuild": "0.25.0",
     "esbuild-copy-static-files": "0.1.0",
     "esbuild-plugin-text-replace": "1.3.0",
     "esbuild-plugin-umd-wrapper": "3.0.0",
-    "eslint": "8.57.0",
+    "eslint": "8.57.1",
     "eslint-plugin-react-hooks": "4.6.2",
     "langchain": "0.2.20",
-    "mocha": "10.7.3",
+    "mocha": "10.8.2",
     "npm-run-all": "4.1.5",
     "react": "17.0.2",
     "react-dom": "17.0.2",
     "rimraf": "6.0.1",
     "run-script-os": "^1.1.6",
     "standard-version": "9.5.0",
-    "tslib": "2.7.0",
+    "tslib": "2.8.1",
     "typescript": "5.5.4",
-    "typescript-eslint": "8.4.0",
+    "typescript-eslint": "8.25.0",
     "use-resize-observer": "9.1.0",
     "uuid": "10.0.0",
     "yargs": "^17.7.2"
@@ -1415,6 +1415,16 @@
           "default": "internal",
           "description": "%Show results after submitting a workunit%"
         },
+        "ecl.preferredECLWatch": {
+          "type": "string",
+          "scope": "resource",
+          "enum": [
+            "v9",
+            "v5"
+          ],
+          "default": "v9",
+          "description": "%Preferred version of ECL Watch%"
+        },
         "ecl.forceProxySupport": {
           "type": "boolean",
           "scope": "resource",
@@ -1686,4 +1696,4 @@
       }
     ]
   }
-}
+}

package.json

@@ -16,9 +16,9 @@
     "Back": "Back",
     "Blocked": "Blocked",
     "Browse Details": "Browse Details",
-    "Browse Results": "Browse Results",
     "Browse Metrics": "Browse Metrics",
     "Browse Result": "Browse Result",
+    "Browse Results": "Browse Results",
     "Build flags, to be passed to the eclcc compiler": "Build flags, to be passed to the eclcc compiler",
     "Bundles": "Bundles",
     "Bundles Homepage": "Bundles Homepage",
@@ -89,6 +89,7 @@
     "Pin launch configuration to current document": "Pin launch configuration to current document",
     "Ping interval (secs, -1 to disable)": "Ping interval (secs, -1 to disable)",
     "Pinned launch configurations": "Pinned launch configurations",
+    "Preferred version of ECL Watch": "Preferred version of ECL Watch",
     "Private": "Private",
     "Protect Workunit": "Protect Workunit",
     "Public": "Public",
@@ -105,10 +106,10 @@
     "Running": "Running",
     "Save + check syntax of current file": "Save + check syntax of current file",
     "Save All + check syntax of all files": "Save All + check syntax of all files",
-    "Save Results": "Save Results",
     "Save file prior to submission": "Save file prior to submission",
     "Save file prior to syntax check": "Save file prior to syntax check",
     "Save Result": "Save Result",
+    "Save Results": "Save Results",
     "Scheduled": "Scheduled",
     "Select Client Tools Version": "Select Client Tools Version",
     "Select Client Tools Version from available options": "Select Client Tools Version from available options",

package.nls.json

@@ -112,8 +112,8 @@ export class ECLCommands {
         }
     }
 
-    showWUDetails(launchRequestArgs: LaunchRequestArguments, wuid: string, result?: number) {
-        eclWatchPanelView.navigateTo(launchRequestArgs, wuid, result);
+    showWUDetails(launchRequestArgs: LaunchRequestArguments, wuid: string, resultName?: string) {
+        eclWatchPanelView.navigateTo(launchRequestArgs, wuid, resultName);
     }
 
     openECLWatchExternal(source: ECLWUNode | ECLResultNode) {
@@ -126,7 +126,7 @@ export class ECLCommands {
     }
 
     openResult(source: ECLResultNode) {
-        eclWatchPanelView.navigateTo(sessionManager.session.launchRequestArgs, source.getWU().Wuid, source.getResult().Sequence);
+        eclWatchPanelView.navigateTo(sessionManager.session.launchRequestArgs, source.getWU().Wuid, source.getResult().Name);
     }
 
     browseResult(source: ECLResultNode) {

src/ecl/command.ts

@@ -95,7 +95,7 @@ export class ECLDocumentSymbolProvider implements vscode.DocumentSymbolProvider
             metaWorkspace = attachWorkspace(wsFolder.uri.fsPath);
         } else if (vscode.workspace.workspaceFolders) {
             for (const wuf of vscode.workspace.workspaceFolders) {
-                if (wuf.uri !== wsFolder.uri) {
+                if (wuf.uri !== wsFolder?.uri) {
                     metaWorkspace = attachWorkspace(wuf.uri.fsPath);
                     break;
                 }

src/ecl/documentSymbolProvider.ts

@@ -8,7 +8,7 @@ import type { Messages } from "../eclwatch/messages";
 
 interface NavigateParams extends LaunchRequestArguments {
     wuid: string;
-    result?: number;
+    resultName?: string;
     show: boolean;
 }
 
@@ -33,15 +33,15 @@ export class ECLWatchPanelView implements vscode.WebviewViewProvider {
         }));
 
         sessionManager.onDidChangeSession(launchRequestArgs => {
-            this.navigateTo(launchRequestArgs, "", 0, false);
+            this.navigateTo(launchRequestArgs, undefined, undefined, false);
         });
 
         vscode.commands.registerCommand("ecl.watch.lite.openECLWatchExternal", async () => {
             if (this._currParams) {
-                if (this._currParams.result === undefined) {
+                if (this._currParams.resultName === undefined) {
                     vscode.env.openExternal(vscode.Uri.parse(wuDetailsUrl(this._currParams, this._currParams.wuid)));
                 } else {
-                    vscode.env.openExternal(vscode.Uri.parse(wuResultUrl(this._currParams, this._currParams.wuid, this._currParams.result)));
+                    vscode.env.openExternal(vscode.Uri.parse(wuResultUrl(this._currParams, this._currParams.wuid, this._currParams.resultName)));
                 }
             }
         });
@@ -78,7 +78,7 @@ export class ECLWatchPanelView implements vscode.WebviewViewProvider {
             switch (message.command) {
                 case "loaded":
                     if (this._initialParams) {
-                        this.navigateTo(this._initialParams, this._initialParams.wuid, this._initialParams.result, this._initialParams.show);
+                        this.navigateTo(this._initialParams, this._initialParams.wuid, this._initialParams.resultName, this._initialParams.show);
                         delete this._initialParams;
                     } else {
                         this._webviewView.title = this._currParams?.wuid;
@@ -114,9 +114,9 @@ export class ECLWatchPanelView implements vscode.WebviewViewProvider {
     }
 
     private _prevHash: string;
-    navigateTo(launchRequestArgs: LaunchRequestArguments, wuid: string, result?: number, show = true) {
+    navigateTo(launchRequestArgs: LaunchRequestArguments, wuid: string, resultName?: string, show = true) {
         const { protocol, serverAddress, port, path, user, password, rejectUnauthorized, name, type, targetCluster } = launchRequestArgs;
-        this._currParams = { protocol, serverAddress, port, path, user, password, rejectUnauthorized, name, type, targetCluster, wuid, result, show };
+        this._currParams = { protocol, serverAddress, port, path, user, password, rejectUnauthorized, name, type, targetCluster, wuid, resultName, show };
         if (!this._webviewView) {
             this._initialParams = this._currParams;
             if (show) {
@@ -136,7 +136,7 @@ export class ECLWatchPanelView implements vscode.WebviewViewProvider {
                         rejectUnauthorized: this._currParams.rejectUnauthorized,
                         timeoutSecs: this._currParams.timeoutSecs,
                         wuid: this._currParams.wuid,
-                        result: this._currParams.result
+                        result: this._currParams.resultName
                     }
                 } as Messages);
                 if (show) {

src/ecl/eclWatchPanelView.ts

@@ -5,6 +5,7 @@ import localize from "../util/localize";
 import { Item, Tree } from "./tree";
 import { eclWatchPanelView } from "./eclWatchPanelView";
 import { SaveData } from "./saveData";
+import { formatWorkunitURL, formatResultURL, formatResultsURL, formatMetricsURL } from "./util";
 
 const PrevWeeks: string[] = [localize("Last Week"), localize("Two Weeks Ago"), localize("Three Weeks Ago"), localize("Four Weeks Ago"), localize("Five Weeks Ago"), localize("Six Weeks Ago"), localize("Seven Weeks Ago")];
 
@@ -35,8 +36,7 @@ export class ECLWatchTree extends Tree {
                     case "disabled":
                         break;
                     case "external":
-                        // vscode.env.openExternal(vscode.Uri.parse(`${evt.workunit.BaseUrl}/esp/files/stub.htm?Widget=WUDetailsWidget&Wuid=${evt.workunit.Wuid}`));
-                        vscode.env.openExternal(vscode.Uri.parse(`${evt.workunit.BaseUrl}/esp/files/index.html#/workunits/${evt.workunit.Wuid}`));
+                        vscode.env.openExternal(vscode.Uri.parse(formatWorkunitURL(evt.workunit.BaseUrl, evt.workunit.Wuid)));
                         break;
                     case "internal":
                     default:
@@ -326,7 +326,7 @@ export class ECLResultNode extends Item<ECLWatchTree> {
 
     constructor(wu: Workunit, tree: ECLWatchTree, private _result: Result) {
         super(tree);
-        this.url = `${this._result.BaseUrl}esp/files/index.html#/workunits/${this._result.Wuid}/outputs/${this._result.Name}`;
+        this.url = formatResultURL(this._result.BaseUrl, this._result.Wuid, this._result.Name);
         this.wu = wu;
     }
 
@@ -390,11 +390,15 @@ export class ECLWUNode extends Item<ECLWatchTree> {
     private _wu: Workunit;
 
     readonly url: string;
+    readonly resultsUrl: string;
+    readonly metricsUrl: string;
 
     constructor(tree: ECLWatchTree, wu: Workunit) {
         super(tree);
         this._wu = wu;
-        this.url = `${wu.BaseUrl}esp/files/index.html#/workunits/${wu.Wuid}`;
+        this.url = formatWorkunitURL(wu.BaseUrl, wu.Wuid);
+        this.resultsUrl = formatResultsURL(wu.BaseUrl, wu.Wuid);
+        this.metricsUrl = formatMetricsURL(wu.BaseUrl, wu.Wuid);
         if (!this._wu.isComplete()) {
             this._wu.watchUntilComplete(changes => {
                 tree.refresh(this);
@@ -455,11 +459,11 @@ export class ECLWUNode extends Item<ECLWatchTree> {
     }
 
     browseResults() {
-        vscode.env.openExternal(vscode.Uri.parse(this.url + "/outputs"));
+        vscode.env.openExternal(vscode.Uri.parse(this.resultsUrl));
     }
 
     browseMetrics() {
-        vscode.env.openExternal(vscode.Uri.parse(this.url + "/metrics"));
+        vscode.env.openExternal(vscode.Uri.parse(this.metricsUrl));
     }
 
     browseWUDetails() {

src/ecl/eclWatchTree.ts

@@ -25,3 +25,48 @@ export function initLogger(level: Level) {
     logger.writer(new VSCodeWriter());
     logger.level(level);
 }
+
+export function formatECLWatchURL(baseUrl: string): string {
+    const eclConfig = vscode.workspace.getConfiguration("ecl");
+    if (eclConfig.get("preferredECLWatch") === "v5") {
+        return `${baseUrl}esp/files/stub.htm`;
+    } else {
+        return `${baseUrl}esp/files/index.html`;
+    }
+}
+
+export function formatWorkunitURL(baseUrl: string, wuid: string): string {
+    const eclConfig = vscode.workspace.getConfiguration("ecl");
+    if (eclConfig.get("preferredECLWatch") === "v5") {
+        return `${baseUrl}esp/files/stub.htm?Wuid=${wuid}&Widget=WUDetailsWidget#/stub/Summary`;
+    } else {
+        return `${baseUrl}esp/files/index.html#/workunits/${wuid}`;
+    }
+}
+
+export function formatResultsURL(baseUrl: string, wuid: string): string {
+    const eclConfig = vscode.workspace.getConfiguration("ecl");
+    if (eclConfig.get("preferredECLWatch") === "v5") {
+        return `${baseUrl}esp/files/stub.htm?Wuid=${wuid}&Widget=ResultsWidget#/stub/Grid`;
+    } else {
+        return `${baseUrl}esp/files/index.html#/workunits/${wuid}/outputs`;
+    }
+}
+
+export function formatMetricsURL(baseUrl: string, wuid: string): string {
+    const eclConfig = vscode.workspace.getConfiguration("ecl");
+    if (eclConfig.get("preferredECLWatch") === "v5") {
+        return `${baseUrl}esp/files/stub.htm?Wuid=${wuid}&Widget=GraphsWUWidget#/stub/Grid`;
+    } else {
+        return `${baseUrl}esp/files/index.html#/workunits/${wuid}/metrics`;
+    }
+}
+
+export function formatResultURL(baseUrl: string, wuid: string, name: string): string {
+    const eclConfig = vscode.workspace.getConfiguration("ecl");
+    if (eclConfig.get("preferredECLWatch") === "v5") {
+        return `${baseUrl}esp/files/stub.htm?Wuid=${wuid}&Name=${name}&Widget=ResultWidget`;
+    } else {
+        return `${baseUrl}esp/files/index.html#/workunits/${wuid}/outputs/${name}`;
+    }
+}

src/ecl/util.ts

@@ -18,7 +18,7 @@ export const Frame: React.FunctionComponent<FrameProps> = () => {
     return <ThemeProvider style={{ height: "100%" }}>
         {
             state ?
-                <WUDetails opts={state} wuid={state.wuid} sequence={state.result}></WUDetails> :
+                <WUDetails opts={state} wuid={state.wuid} name={state.resultName}></WUDetails> :
                 <div>...loading...</div>
         }
     </ThemeProvider >;