Ensure folders are added to sourcekit-lsp in multi root workspaces

plemarquand · plemarquand · commit d498a45c8747 · 2025-06-30T11:40:44.000-04:00
`addFolder` in the LSP client was checking to see if the folder being added was a root folder. If the user is working in a multi root workspace this meant folders may not be added, and so indexing would not occur. This also prevented the test explorer from properly initializing. Check to see if the folder being added is in the list of VS Code workspace folders, and add if it is. Issue: #1669
diff --git a/src/FolderContext.ts b/src/FolderContext.ts
@@ -211,6 +211,25 @@ export class FolderContext implements vscode.Disposable {
         });
         return target;
     }
+
+    /**
+     * Called whenever we have new document symbols
+     */
+    onDocumentSymbols(
+        document: vscode.TextDocument,
+        symbols: vscode.DocumentSymbol[] | null | undefined
+    ) {
+        const uri = document?.uri;
+        if (
+            this.testExplorer &&
+            symbols &&
+            uri &&
+            uri.scheme === "file" &&
+            isPathInsidePath(uri.fsPath, this.folder.fsPath)
+        ) {
+            void this.testExplorer.getDocumentTests(this, uri, symbols);
+        }
+    }
 }
 
 export interface EditedPackage {
diff --git a/src/TestExplorer/TestExplorer.ts b/src/TestExplorer/TestExplorer.ts
@@ -15,7 +15,6 @@
 import * as vscode from "vscode";
 import { FolderContext } from "../FolderContext";
 import { getErrorDescription } from "../utilities/utilities";
-import { isPathInsidePath } from "../utilities/filesystem";
 import { FolderOperation, WorkspaceContext } from "../WorkspaceContext";
 import { TestRunProxy, TestRunner } from "./TestRunner";
 import { LSPTestDiscovery } from "./LSPTestDiscovery";
@@ -141,7 +140,6 @@ export class TestExplorer {
                             if (targets.length === 0) {
                                 return;
                             }
-
                             folder.addTestExplorer();
                             // discover tests in workspace but only if disableAutoResolve is not on.
                             // discover tests will kick off a resolve if required
@@ -196,45 +194,29 @@ export class TestExplorer {
         });
     }
 
-    /**
-     * Called whenever we have new document symbols
-     */
-    static onDocumentSymbols(
+    async getDocumentTests(
         folder: FolderContext,
-        document: vscode.TextDocument,
-        symbols: vscode.DocumentSymbol[] | null | undefined
-    ) {
-        const uri = document?.uri;
-        const testExplorer = folder?.testExplorer;
-        if (testExplorer && symbols && uri && uri.scheme === "file") {
-            if (isPathInsidePath(uri.fsPath, folder.folder.fsPath)) {
-                void folder.swiftPackage.getTarget(uri.fsPath).then(target => {
-                    if (target && target.type === "test") {
-                        testExplorer.lspTestDiscovery
-                            .getDocumentTests(folder.swiftPackage, uri)
-                            .then(tests => {
-                                TestDiscovery.updateTestsForTarget(
-                                    testExplorer.controller,
-                                    { id: target.c99name, label: target.name },
-                                    tests,
-                                    uri
-                                );
-                                testExplorer.onTestItemsDidChangeEmitter.fire(
-                                    testExplorer.controller
-                                );
-                            })
-                            // Fallback to parsing document symbols for XCTests only
-                            .catch(() => {
-                                const tests = parseTestsFromDocumentSymbols(
-                                    target.name,
-                                    symbols,
-                                    uri
-                                );
-                                testExplorer.updateTests(testExplorer.controller, tests, uri);
-                            });
-                    }
-                });
-            }
+        uri: vscode.Uri,
+        symbols: vscode.DocumentSymbol[]
+    ): Promise<void> {
+        const target = await folder.swiftPackage.getTarget(uri.fsPath);
+        if (!target || target.type !== "test") {
+            return;
+        }
+
+        try {
+            const tests = await this.lspTestDiscovery.getDocumentTests(folder.swiftPackage, uri);
+            TestDiscovery.updateTestsForTarget(
+                this.controller,
+                { id: target.c99name, label: target.name },
+                tests,
+                uri
+            );
+            this.onTestItemsDidChangeEmitter.fire(this.controller);
+        } catch {
+            // Fallback to parsing document symbols for XCTests only
+            const tests = parseTestsFromDocumentSymbols(target.name, symbols, uri);
+            this.updateTests(this.controller, tests, uri);
         }
     }
 
diff --git a/src/WorkspaceContext.ts b/src/WorkspaceContext.ts
@@ -37,7 +37,6 @@ import { isValidWorkspaceFolder, searchForPackages } from "./utilities/workspace
 import { SwiftPluginTaskProvider } from "./tasks/SwiftPluginTaskProvider";
 import { SwiftTaskProvider } from "./tasks/SwiftTaskProvider";
 import { LLDBDebugConfigurationProvider } from "./debugger/debugAdapterFactory";
-import { TestExplorer } from "./TestExplorer/TestExplorer";
 
 /**
  * Context for whole workspace. Holds array of contexts for each workspace folder
@@ -82,7 +81,7 @@ export class WorkspaceContext implements vscode.Disposable {
         this.buildStatus = new SwiftBuildStatus(this.statusItem);
         this.languageClientManager = new LanguageClientToolchainCoordinator(this, {
             onDocumentSymbols: (folder, document, symbols) => {
-                TestExplorer.onDocumentSymbols(folder, document, symbols);
+                folder.onDocumentSymbols(document, symbols);
             },
         });
         this.tasks = new TaskManager(this);
diff --git a/src/sourcekit-lsp/LanguageClientManager.ts b/src/sourcekit-lsp/LanguageClientManager.ts
@@ -97,7 +97,7 @@ export class LanguageClientManager implements vscode.Disposable {
     private singleServerSupport: boolean;
     // used by single server support to keep a record of the project folders
     // that are not at the root of their workspace
-    public subFolderWorkspaces: vscode.Uri[];
+    public subFolderWorkspaces: FolderContext[];
     private namedOutputChannels: Map<string, LSPOutputChannel> = new Map();
     private swiftVersion: Version;
     private activeDocumentManager = new LSPActiveDocumentManager();
@@ -242,10 +242,10 @@ export class LanguageClientManager implements vscode.Disposable {
     }
 
     async addFolder(folderContext: FolderContext) {
-        if (!folderContext.isRootFolder) {
+        if (!folderContext.isRootFolder || this.isFolderInWorkspace(folderContext.folder)) {
             await this.useLanguageClient(async client => {
                 const uri = folderContext.folder;
-                this.subFolderWorkspaces.push(folderContext.folder);
+                this.subFolderWorkspaces.push(folderContext);
 
                 const workspaceFolder = {
                     uri: client.code2ProtocolConverter.asUri(uri),
@@ -262,7 +262,9 @@ export class LanguageClientManager implements vscode.Disposable {
         if (!folderContext.isRootFolder) {
             await this.useLanguageClient(async client => {
                 const uri = folderContext.folder;
-                this.subFolderWorkspaces = this.subFolderWorkspaces.filter(item => item !== uri);
+                this.subFolderWorkspaces = this.subFolderWorkspaces.filter(
+                    item => item.folder !== uri
+                );
 
                 const workspaceFolder = {
                     uri: client.code2ProtocolConverter.asUri(uri),
@@ -275,11 +277,19 @@ export class LanguageClientManager implements vscode.Disposable {
         }
     }
 
+    private isFolderInWorkspace(folder: vscode.Uri): boolean {
+        return (
+            vscode.workspace.workspaceFolders?.find(
+                workspaceFolder => workspaceFolder.uri.fsPath === folder.fsPath
+            ) !== undefined
+        );
+    }
+
     private async addSubFolderWorkspaces(client: LanguageClient) {
-        for (const uri of this.subFolderWorkspaces) {
+        for (const folderContext of this.subFolderWorkspaces) {
             const workspaceFolder = {
-                uri: client.code2ProtocolConverter.asUri(uri),
-                name: FolderContext.uriName(uri),
+                uri: client.code2ProtocolConverter.asUri(folderContext.folder),
+                name: FolderContext.uriName(folderContext.folder),
             };
             await client.sendNotification(DidChangeWorkspaceFoldersNotification.type, {
                 event: { added: [workspaceFolder], removed: [] },
@@ -440,7 +450,20 @@ export class LanguageClientManager implements vscode.Disposable {
             this.activeDocumentManager,
             errorHandler,
             (document, symbols) => {
-                this.options.onDocumentSymbols?.(this.folderContext, document, symbols);
+                const documentFolderContext = [
+                    this.folderContext,
+                    ...this.subFolderWorkspaces,
+                ].find(folderContext =>
+                    document.uri.fsPath.startsWith(folderContext.folder.fsPath)
+                );
+                if (!documentFolderContext) {
+                    this.languageClientOutputChannel?.log(
+                        "Unable to find folder for document: " + document.uri.fsPath,
+                        "WARN"
+                    );
+                    return;
+                }
+                this.options.onDocumentSymbols?.(documentFolderContext, document, symbols);
             }
         );
 
diff --git a/test/integration-tests/ExtensionActivation.test.ts b/test/integration-tests/ExtensionActivation.test.ts
@@ -116,7 +116,9 @@ suite("Extension Activation/Deactivation Tests", () => {
             assert(folder);
 
             const languageClient = workspaceContext.languageClientManager.get(folder);
-            const lspWorkspaces = languageClient.subFolderWorkspaces.map(({ fsPath }) => fsPath);
+            const lspWorkspaces = languageClient.subFolderWorkspaces.map(
+                ({ folder }) => folder.fsPath
+            );
             assertContains(lspWorkspaces, testAssetUri("cmake").fsPath);
         });
 
@@ -125,7 +127,9 @@ suite("Extension Activation/Deactivation Tests", () => {
             assert(folder);
 
             const languageClient = workspaceContext.languageClientManager.get(folder);
-            const lspWorkspaces = languageClient.subFolderWorkspaces.map(({ fsPath }) => fsPath);
+            const lspWorkspaces = languageClient.subFolderWorkspaces.map(
+                ({ folder }) => folder.fsPath
+            );
             assertContains(lspWorkspaces, testAssetUri("cmake-compile-flags").fsPath);
         });
     });
diff --git a/test/integration-tests/testexplorer/TestExplorerIntegration.test.ts b/test/integration-tests/testexplorer/TestExplorerIntegration.test.ts
