feat: update session management to store launch configuration and target cluster in workspace state

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

Author: GordonSmith

.github/copilot-instructions.md

@@ -128,7 +128,7 @@ How to apply:
 - Before adding a new contribution, confirm an existing pattern in `package.json` (e.g. replicate a command object, adjust `enablement`).
 - For a new Tree View / data provider, follow existing HPCC platform tree patterns under `src/hpccplatform/` and reference TreeDataProvider docs.
 - For new notebook renderer: add entry in `esbuild.mjs` (browser target) + `notebookRenderer` contribution + MIME type contract.
-- For status bar interactions replicate existing approach (search for usages setting `ecl.launchConfiguration` & `ecl.targetCluster`).
+- For status bar interactions replicate existing approach (launch configuration and target cluster state is stored in workspace state, not settings).
 
 When unsure of an API surface (e.g. `WorkspaceEdit`, `TextDocumentContentProvider`, etc.) prefer stable APIs listed in the vscode-api reference; avoid proposed APIs unless already adopted in this repo.
 

.vscode/launch.json

@@ -144,6 +144,19 @@
                 "<node_internals>/**"
             ],
             "type": "node"
+        },
+        {
+            "name": "localhost",
+            "type": "ecl",
+            "request": "launch",
+            "protocol": "http",
+            "serverAddress": "localhost",
+            "port": 8010,
+            "targetCluster": "thor",
+            "rejectUnauthorized": true,
+            "resultLimit": 100,
+            "timeoutSecs": 60,
+            "user": "vscode_user",
         }
     ]
 }

package.json

@@ -1625,13 +1625,15 @@
           "type": "string",
           "scope": "resource",
           "default": "",
-          "description": "%Default launch configuration%"
+          "description": "%Default launch configuration%",
+          "deprecationMessage": "%This setting is deprecated. Launch configuration state is now stored in workspace state.%"
         },
         "ecl.targetCluster": {
           "type": "object",
           "scope": "resource",
           "default": {},
-          "description": "%Target cluster (per launch configuration)%"
+          "description": "%Target cluster (per launch configuration)%",
+          "deprecationMessage": "%This setting is deprecated. Target cluster state is now stored in workspace state.%"
         },
         "ecl.pinnedLaunchConfigurations": {
           "type": "object",

package.nls.json

@@ -52,6 +52,8 @@
     "Database Name": "Database Name",
     "Debug level logging (requires restart)": "Debug level logging (requires restart)",
     "Default launch configuration": "Default launch configuration",
+    "This setting is deprecated. Launch configuration state is now stored in workspace state.": "This setting is deprecated. Launch configuration state is now stored in workspace state.",
+    "This setting is deprecated. Target cluster state is now stored in workspace state.": "This setting is deprecated. Target cluster state is now stored in workspace state.",
     "Dismiss": "Dismiss",
     "Default timeout (secs)": "Default timeout (secs)",
     "Delete Workunit": "Delete Workunit",

src/ecl/main.ts

@@ -12,7 +12,7 @@ import { ECLWatchPanelView } from "./eclWatchPanelView";
 import { HPCCResources } from "./hpccResources";
 import { ECLChat } from "./lm/chat";
 import { ECLLMTools } from "./lm/tools";
-import { sessionManager } from "../hpccplatform/session";
+import { SessionManager } from "../hpccplatform/session";
 
 const eclConfig = vscode.workspace.getConfiguration("ecl");
 initLogger(eclConfig.get<boolean>("debugLogging") ? Level.debug : Level.info);
@@ -21,7 +21,7 @@ const logger = scopedLogger("ecl/main.ts");
 
 export function activate(ctx: vscode.ExtensionContext): void {
     logger.debug("Activating SessionManager");
-    sessionManager.initialize();
+    SessionManager.attach(ctx);
     logger.debug("Activating ECLDiagnostic");
     ECLDiagnostic.attach(ctx);
     logger.debug("Activating ECLCommands");

src/hpccplatform/session.ts

@@ -149,8 +149,11 @@ export interface ICreateWorkunit {
     workunit: Workunit
 }
 
-class SessionManager {
+export let sessionManager: SessionManager;
 
+export class SessionManager {
+
+    private _context?: vscode.ExtensionContext;
     private _globalSession?: Session;
     private _pinnedSession?: Session;
 
@@ -164,12 +167,10 @@ class SessionManager {
     private _statusBarTargetCluster: vscode.StatusBarItem;
     private _statusBarPin: vscode.StatusBarItem;
 
-    constructor() {
+    private constructor(context: vscode.ExtensionContext) {
+        this._context = context;
         this._statusBarLaunch = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Left, Number.MIN_VALUE + 2);
         this._statusBarLaunch.command = "hpccPlatform.switch";
-    }
-
-    initialize() {
         this._statusBarTargetCluster = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Left, Number.MIN_VALUE + 1);
         this._statusBarTargetCluster.command = "hpccPlatform.switchTargetCluster";
 
@@ -260,17 +261,14 @@ class SessionManager {
                     void this.switchTo(this.session.id, this.session.overriddenTargetCluster);
                 }
             }
-            if (e.affectsConfiguration("ecl.launchConfiguration") || e.affectsConfiguration("ecl.targetCluster")) {
-                const currentEclConfig = vscode.workspace.getConfiguration("ecl", null);
-                const launchConfig = currentEclConfig.get<string>("launchConfiguration");
-                const targetCluster = currentEclConfig.get<object>("targetCluster")[launchConfig];
-                void this.switchTo(launchConfig, targetCluster);
-            }
         });
 
         const eclConfig = vscode.workspace.getConfiguration("ecl", null);
-        const launchConfig = eclConfig.get<string>("launchConfiguration");
-        const targetCluster = eclConfig.get<object>("targetCluster")[launchConfig];
+        const settingsLaunchConfig = eclConfig.get<string>("launchConfiguration");
+        const launchConfig = this._context.workspaceState.get<string>("ecl.launchConfiguration") || settingsLaunchConfig;
+        const targetClusters = this._context.workspaceState.get<Record<string, string>>("ecl.targetCluster") || eclConfig.get<object>("targetCluster");
+        const targetCluster = targetClusters[launchConfig];
+
         this.switchTo(launchConfig, targetCluster).then(() => {
             vscode.commands.executeCommand("setContext", "hpccPlatformActive", true);
         }).finally(() => {
@@ -280,6 +278,13 @@ class SessionManager {
         });
     }
 
+    static attach(ctx: vscode.ExtensionContext): SessionManager {
+        if (!sessionManager) {
+            sessionManager = new SessionManager(ctx);
+        }
+        return sessionManager;
+    }
+
     private get activeDocument() {
         return vscode.window.activeTextEditor?.document;
     }
@@ -438,16 +443,16 @@ class SessionManager {
                 }
             }
         } else {
-            const currentLaunchConfig = eclConfig.get<string>("launchConfiguration");
-            const targetClusters = eclConfig.get<object>("targetCluster");
+            const currentLaunchConfig = this._context.workspaceState.get<string>("ecl.launchConfiguration");
+            const targetClusters = this._context.workspaceState.get<Record<string, string>>("ecl.targetCluster") || {};
             const currentTargetCluster = targetClusters[this.session.id];
 
             if (currentLaunchConfig !== this.session.id) {
-                eclConfig.update("launchConfiguration", this.session.id);
+                void this._context.workspaceState.update("ecl.launchConfiguration", this.session.id);
             }
             if (currentTargetCluster !== this.session.overriddenTargetCluster) {
                 targetClusters[this.session.id] = this.session.overriddenTargetCluster;
-                eclConfig.update("targetCluster", targetClusters);
+                void this._context.workspaceState.update("ecl.targetCluster", targetClusters);
             }
         }
     }
@@ -611,7 +616,6 @@ class SessionManager {
         this.refreshPinStatusBar();
     }
 }
-export const sessionManager: SessionManager = new SessionManager();
 
 export function isPlatformConnected(): boolean {
     return !!sessionManager.session;