fix: restore manually-added projects after Save Workspace As

sharma1208 · sharma1208 · commit 5869bdde26e3 · 2026-07-08T11:29:47.000-05:00
diff --git a/src/extension.ts b/src/extension.ts
@@ -45,6 +45,10 @@ export async function activate(context: vscode.ExtensionContext): Promise<void>
     item.tooltip = localize("liberty.ls.starting");
     toggleItem(window.activeTextEditor, item);
 
+    // Run after getJavaExtensionAPI so VS Code APIs (findFiles etc.) are ready,
+    // but before startLangServer so we don't wait for LS startup.
+    handleWorkspaceSaveInProgress(context).catch(err => console.error('[handleWorkspaceSaveInProgress] uncaught error:', err));
+
     resolveLclsRequirements(api).then().catch((error => {
         window.showErrorMessage(error.message, error.label).then((selection) => {
             if (error.label && error.label === selection && error.openUrl) {
@@ -60,7 +64,6 @@ export async function activate(context: vscode.ExtensionContext): Promise<void>
             item.text = localize("liberty.ls.thumbs.up");
             item.tooltip = localize("liberty.ls.started");
             toggleItem(window.activeTextEditor, item);
-            handleWorkspaceSaveInProgress(context);
             registerCommands(context);
         }, (error: any) => {
             console.log("Liberty client was not ready. Did not initialize");
@@ -107,6 +110,10 @@ function registerCommands(context: ExtensionContext) {
     if (vscode.workspace.workspaceFolders !== undefined) {
         registerFileWatcher(projectProvider);
         vscode.window.registerTreeDataProvider("liberty-dev", projectProvider);
+        // Re-run refresh so that any project written to workspaceState by
+        // handleWorkspaceSaveInProgress (which ran before the tree was registered)
+        // is picked up and displayed immediately.
+        projectProvider.refresh();
     }
 
     context.subscriptions.push(
@@ -303,13 +310,21 @@ async function getJavaExtensionAPI(): Promise<JavaExtensionAPI> {
     return Promise.resolve(api);
 }
 
-function handleWorkspaceSaveInProgress(context: vscode.ExtensionContext) {
-    let projectProvider = getProjectProvider(context);
-    if (projectProvider.getContext().globalState.get('workspaceSaveInProgress') &&
-        projectProvider.getContext().globalState.get('selectedProject') !== undefined) {
-        devCommands.addProjectsToTheDashBoard(projectProvider, projectProvider.getContext().globalState.get('selectedProject') as string);
+async function handleWorkspaceSaveInProgress(context: vscode.ExtensionContext): Promise<boolean> {
+    const projectProvider = getProjectProvider(context);
+    const wip = projectProvider.getContext().globalState.get('workspaceSaveInProgress');
+    const sel = projectProvider.getContext().globalState.get('selectedProject');
+    if (wip && sel !== undefined) {
+        // Wait for the initial refresh() to finish so the project map is fully populated.
+        await projectProvider.initialRefresh;
+        // Write the project into workspaceState. Do NOT call fireChangeEvent here —
+        // the tree data provider may not be registered yet. registerCommands() will
+        // call refresh() after registering the tree, which will display it.
+        await projectProvider.addUserSelectedPath(sel as string, projectProvider.getProjects());
         helperUtil.clearDataSavedInGlobalState(projectProvider.getContext());
+        return true;
     }
+    return false;
 }
 
 function getProjectProvider(context: vscode.ExtensionContext): ProjectProvider {
diff --git a/src/liberty/libertyProject.ts b/src/liberty/libertyProject.ts
@@ -9,7 +9,7 @@ import * as gradleUtil from "../util/gradleUtil";
 import * as mavenUtil from "../util/mavenUtil";
 import * as util from "../util/helperUtil";
 import { localize } from "../util/i18nUtil";
-import { EXCLUDED_DIR_PATTERN, LIBERTY_GRADLE_PROJECT, LIBERTY_GRADLE_PROJECT_CONTAINER, LIBERTY_MAVEN_PROJECT, LIBERTY_MAVEN_PROJECT_CONTAINER, UNTITLED_WORKSPACE } from "../definitions/constants";
+import { EXCLUDED_DIR_PATTERN, LIBERTY_GRADLE_PROJECT, LIBERTY_GRADLE_PROJECT_CONTAINER, LIBERTY_MAVEN_PROJECT, LIBERTY_MAVEN_PROJECT_CONTAINER } from "../definitions/constants";
 import { BuildFileImpl, GradleBuildFile } from "../util/buildFile";
 import { DashboardData } from "./dashboard";
 import { BaseLibertyProject } from "./baseLibertyProject";
@@ -31,11 +31,15 @@ export class ProjectProvider implements vscode.TreeDataProvider<LibertyProject>
 
 	private _context: vscode.ExtensionContext;
 
+	// Resolves when the first refresh() completes. Callers that need a stable
+	// project map before acting (e.g. handleWorkspaceSaveInProgress) must await this.
+	public readonly initialRefresh: Promise<void>;
+
 	constructor(context: vscode.ExtensionContext) {
 		this._context = context;
 		this._onDidChangeTreeData = new vscode.EventEmitter<LibertyProject | undefined>();
 		this.onDidChangeTreeData = this._onDidChangeTreeData.event;
-		this.refresh();
+		this.initialRefresh = this.refresh();
 	}
 
 	public getContext(): vscode.ExtensionContext {
@@ -212,20 +216,20 @@ export class ProjectProvider implements vscode.TreeDataProvider<LibertyProject>
 					'Save Workspace'
 				).then(async (selection) => {
 					if (selection === 'Save Workspace') {
+							await this._context.globalState.update('workspaceSaveInProgress', true);
+							console.log('[checkUntitledWorkspaceAndSaveIt] wrote workspaceSaveInProgress=true, selectedProject=' + this._context.globalState.get('selectedProject'));
+							// Do NOT clear globalState here: the new session needs workspaceSaveInProgress
+							// and selectedProject to restore the manually-added project to the dashboard.
+							await vscode.commands.executeCommand('workbench.action.saveWorkspaceAs');
+							console.log('[checkUntitledWorkspaceAndSaveIt] saveWorkspaceAs command returned');
+					} else {
 						/**
-						 * setting workspaceSaveInProgress to true and storing it in globalstate for identifyting that the
-						 * workspace is saved and needs to save the manually added projects to the dashboard
+						 * If the user cancels saving the workspace and exits without saving, the data stays in the global state,
+						 * which is shared across all VS Code instances. To prevent this data from being mistakenly used in other
+						 * sessions and added to the dashboard, it should be cleared if the user cancels the save.
 						 */
-						await this._context.globalState.update('workspaceSaveInProgress', true);
-						//opens the saveWorkspace as dialog box
-						await vscode.commands.executeCommand('workbench.action.saveWorkspaceAs');
+						util.clearDataSavedInGlobalState(this._context);
 					}
-					/**
-					 * If the user cancels saving the workspace and exits without saving, the data stays in the global state, 
-					 * which is shared across all VS Code instances. To prevent this data from being mistakenly used in other 
-					 * sessions and added to the dashboard, it should be cleared if the user cancels the save.
-					 */
-					util.clearDataSavedInGlobalState(this._context);
 					resolve();
 				});
 			} catch (error) {
@@ -237,12 +241,15 @@ export class ProjectProvider implements vscode.TreeDataProvider<LibertyProject>
 	}
 
 	/*
-	This method identifies a workspace that is untitled and contains more than one project 
-	*/
+	 * Returns true when the workspace has not yet been saved to a .code-workspace file,
+	 * meaning workspaceState will be lost if the user does "Save Workspace As...".
+	 * This covers both plain single-folder windows (workspace.name == folder name)
+	 * and VS Code's auto-created "Untitled (Workspace)" multi-root workspaces.
+	 */
 	public isMultiProjectUntitledWorkspace(): boolean {
 		const workspaceFolders = vscode.workspace.workspaceFolders;
-		if ((workspaceFolders && workspaceFolders.length > 1
-			&& vscode.workspace.name === UNTITLED_WORKSPACE)) {
+		if (workspaceFolders && workspaceFolders.length >= 1
+			&& vscode.workspace.workspaceFile === undefined) {
 			return true;
 		}
 		return false;
diff --git a/src/test/unit/fakeVscode.ts b/src/test/unit/fakeVscode.ts
@@ -31,10 +31,40 @@ export interface FakeVscode {
     workspace: {
         workspaceFolders: any;
         name: any;
+        workspaceFile: any;
     };
 }
 
-export function installFakeVscode(windowOverrides: Partial<FakeVscode["window"]> = {}): FakeVscode {
+// Paths that must be evicted from Node's require cache so that re-importing
+// libertyProject (or anything that transitively imports it) picks up the new
+// fake instead of a version bound to a previously-installed fake.
+const EXTENSION_CACHE_KEYS = [
+    "liberty/libertyProject",
+    "liberty/dashboard",
+    "liberty/baseLibertyProject",
+    "util/helperUtil",
+    "util/gradleUtil",
+    "util/mavenUtil",
+    "util/buildFile",
+    "util/i18nUtil",
+    "definitions/constants",
+];
+
+/**
+ * @param windowOverrides  Optional overrides for window methods (e.g. a sinon stub).
+ * @param clearCache       Pass true to evict all cached extension modules before
+ *                         installing the fake. Required when another test file may
+ *                         have already loaded these modules against a different fake.
+ *                         Defaults to false so existing callers are unaffected.
+ */
+export function installFakeVscode(windowOverrides: Partial<FakeVscode["window"]> = {}, clearCache = false): FakeVscode {
+    if (clearCache) {
+        Object.keys(require.cache).forEach(key => {
+            if (EXTENSION_CACHE_KEYS.some(segment => key.includes(segment))) {
+                delete require.cache[key];
+            }
+        });
+    }
     const fakeVscode: FakeVscode = {
         EventEmitter: class { event = () => {}; fire() {} },
         TreeItemCollapsibleState: { None: 0 },
@@ -54,7 +84,8 @@ export function installFakeVscode(windowOverrides: Partial<FakeVscode["window"]>
         },
         workspace: {
             workspaceFolders: undefined,
-            name: undefined
+            name: undefined,
+            workspaceFile: undefined
         }
     };
 
diff --git a/src/test/unit/isMultiProjectUntitledWorkspace.test.ts b/src/test/unit/isMultiProjectUntitledWorkspace.test.ts
@@ -0,0 +1,95 @@
+/*
+ * IBM Confidential
+ * Copyright IBM Corp. 2026
+ */
+
+// This test runs in plain Node, not inside a real VS Code window.
+import { installFakeVscode, FakeVscode } from "./fakeVscode";
+
+// Install the fake and clear any previously cached extension modules so this
+// file's import of libertyProject binds to our fake, regardless of test order.
+const fakeVscode: FakeVscode = installFakeVscode({}, true);
+
+import * as assert from "assert";
+import { ProjectProvider } from "../../liberty/libertyProject";
+
+// Minimal fake ExtensionContext — ProjectProvider needs one to construct.
+const fakeContext: any = {
+    workspaceState: {
+        get: () => undefined,
+        update: () => Promise.resolve()
+    },
+    globalState: {
+        get: () => undefined,
+        update: () => Promise.resolve()
+    }
+};
+
+// Helper: build a fake workspaceFolders array with n entries.
+function makeFolders(n: number) {
+    return Array.from({ length: n }, (_, i) => ({ uri: { fsPath: `/project${i}` } }));
+}
+
+describe("isMultiProjectUntitledWorkspace", () => {
+
+    let provider: ProjectProvider;
+
+    before(() => {
+        provider = new ProjectProvider(fakeContext);
+    });
+
+    // resets fake back to clean slate so test behavior is not affected by last test
+    afterEach(() => {
+        fakeVscode.workspace.workspaceFolders = undefined;
+        fakeVscode.workspace.name = undefined;
+        fakeVscode.workspace.workspaceFile = undefined;
+    });
+
+    // ─── Test 1 ───────────────────────────────────────────────────────────────
+    // Plain single-folder window (the video scenario) where workspace.name is the
+    // folder name (like gradleappadd) and no workspaceFile is saved. workspaceState
+    // is lost when user does "Save Workspace As..." so isMultiProjectUntitledWorkspace()
+    // must return true to trigger the globalState update and prevent the project from being lost.
+    it("returns true for a plain single-folder window (no .code-workspace file)", () => {
+        fakeVscode.workspace.workspaceFolders = makeFolders(1);
+        fakeVscode.workspace.name = "gradleappadd";
+        fakeVscode.workspace.workspaceFile = undefined;
+
+        assert.strictEqual(provider.isMultiProjectUntitledWorkspace(), true,
+            "A plain single-folder window loses workspaceState on Save Workspace As " +
+            "so the safe-path must trigger.");
+    });
+
+    // ─── Test 2 ───────────────────────────────────────────────────────────────
+    // VS Code auto-created "Untitled (Workspace)" (multiple folders not yet saved):
+    // workspaceFile is undefined here too, so must return true.
+    it("returns true for an auto-created untitled workspace (multiple folders)", () => {
+        fakeVscode.workspace.workspaceFolders = makeFolders(2);
+        fakeVscode.workspace.name = "Untitled (Workspace)";
+        fakeVscode.workspace.workspaceFile = undefined;
+
+        assert.strictEqual(provider.isMultiProjectUntitledWorkspace(), true);
+    });
+
+    // ─── Test 3 ───────────────────────────────────────────────────────────────
+    // Workspace already saved to a .code-workspace file: workspaceState is
+    // stable, no prompt needed.
+    it("returns false when workspace is already saved to a .code-workspace file", () => {
+        fakeVscode.workspace.workspaceFolders = makeFolders(1);
+        fakeVscode.workspace.name = "testIssue";
+        fakeVscode.workspace.workspaceFile = { fsPath: "/home/user/testIssue.code-workspace" };
+
+        assert.strictEqual(provider.isMultiProjectUntitledWorkspace(), false);
+    });
+
+    // ─── Test 4 ───────────────────────────────────────────────────────────────
+    // No folders open at all: nothing to protect, should return false.
+    it("returns false when there are no folders open", () => {
+        fakeVscode.workspace.workspaceFolders = undefined;
+        fakeVscode.workspace.name = undefined;
+        fakeVscode.workspace.workspaceFile = undefined;
+
+        assert.strictEqual(provider.isMultiProjectUntitledWorkspace(), false);
+    });
+
+});
