fixed bsp config file location issue (#1792)

* fixed bsp config file location issue

* format code

---------

Co-authored-by: Wang Lun <[email protected]>
Co-authored-by: aelam <[email protected]>

Author: 3 people

src/WorkspaceContext.ts

@@ -443,7 +443,8 @@ export class WorkspaceContext implements vscode.Disposable {
         const folders = await searchForPackages(
             workspaceFolder.uri,
             configuration.disableSwiftPMIntegration,
-            configuration.folder(workspaceFolder).searchSubfoldersForPackages
+            configuration.folder(workspaceFolder).searchSubfoldersForPackages,
+            this.globalToolchainSwiftVersion
         );
 
         for (const folder of folders) {
@@ -627,7 +628,11 @@ export class WorkspaceContext implements vscode.Disposable {
      * Package.swift or a CMake compile_commands.json, compile_flags.txt, or a BSP buildServer.json.
      */
     async isValidWorkspaceFolder(folder: string): Promise<boolean> {
-        return await isValidWorkspaceFolder(folder, configuration.disableSwiftPMIntegration);
+        return await isValidWorkspaceFolder(
+            folder,
+            configuration.disableSwiftPMIntegration,
+            this.globalToolchainSwiftVersion
+        );
     }
 
     /** send unfocus event to current focussed folder and clear current folder */

src/utilities/workspace.ts

@@ -11,21 +11,25 @@
 // SPDX-License-Identifier: Apache-2.0
 //
 //===----------------------------------------------------------------------===//
+import * as fs from "fs/promises";
+import * as path from "path";
 import { basename } from "path";
 import * as vscode from "vscode";
 
 import { globDirectory, pathExists } from "./filesystem";
+import { Version } from "./version";
 
 export async function searchForPackages(
     folder: vscode.Uri,
     disableSwiftPMIntegration: boolean,
-    searchSubfoldersForPackages: boolean
+    searchSubfoldersForPackages: boolean,
+    swiftVersion: Version
 ): Promise<Array<vscode.Uri>> {
     const folders: Array<vscode.Uri> = [];
 
     async function search(folder: vscode.Uri) {
         // add folder if Package.swift/compile_commands.json/compile_flags.txt/buildServer.json exists
-        if (await isValidWorkspaceFolder(folder.fsPath, disableSwiftPMIntegration)) {
+        if (await isValidWorkspaceFolder(folder.fsPath, disableSwiftPMIntegration, swiftVersion)) {
             folders.push(folder);
         }
         // should I search sub-folders for more Swift Packages
@@ -47,16 +51,61 @@ export async function searchForPackages(
     return folders;
 }
 
+export async function hasBSPConfigurationFile(
+    folder: string,
+    swiftVersion: Version
+): Promise<boolean> {
+    // buildServer.json
+    const buildServerPath = path.join(folder, "buildServer.json");
+    const buildServerStat = await fs.stat(buildServerPath).catch(() => undefined);
+    if (buildServerStat && buildServerStat.isFile()) {
+        return true;
+    }
+    // .bsp/*.json for Swift >= 6.1.0
+    if (swiftVersion.isGreaterThanOrEqual(new Version(6, 1, 0))) {
+        const bspDir = path.join(folder, ".bsp");
+        const bspStat = await fs.stat(bspDir).catch(() => undefined);
+        if (bspStat && bspStat.isDirectory()) {
+            const files = await fs.readdir(bspDir).catch(() => []);
+            if (files.some((f: string) => f.endsWith(".json"))) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
 export async function isValidWorkspaceFolder(
     folder: string,
-    disableSwiftPMIntegration: boolean
+    disableSwiftPMIntegration: boolean,
+    swiftVersion: Version
 ): Promise<boolean> {
-    return (
-        (!disableSwiftPMIntegration && (await pathExists(folder, "Package.swift"))) ||
-        (await pathExists(folder, "compile_commands.json")) ||
-        (await pathExists(folder, "compile_flags.txt")) ||
-        (await pathExists(folder, "buildServer.json")) ||
-        (await pathExists(folder, "build")) ||
-        (await pathExists(folder, "out"))
-    );
+    // Check Package.swift first (most common case)
+    if (!disableSwiftPMIntegration && (await pathExists(folder, "Package.swift"))) {
+        return true;
+    }
+
+    // Check other common build files
+    if (await pathExists(folder, "compile_commands.json")) {
+        return true;
+    }
+
+    if (await pathExists(folder, "compile_flags.txt")) {
+        return true;
+    }
+
+    if (await pathExists(folder, "build")) {
+        return true;
+    }
+
+    if (await pathExists(folder, "out")) {
+        return true;
+    }
+
+    // Check BSP configuration last (potentially more expensive)
+    if (await hasBSPConfigurationFile(folder, swiftVersion)) {
+        return true;
+    }
+
+    return false;
 }

test/integration-tests/utilities/workspace.test.ts

@@ -14,15 +14,19 @@
 import { expect } from "chai";
 import * as vscode from "vscode";
 
+import { Version } from "@src/utilities/version";
 import { searchForPackages } from "@src/utilities/workspace";
 
 suite("Workspace Utilities Test Suite", () => {
     suite("searchForPackages", () => {
+        const testSwiftVersion = new Version(5, 9, 0);
+
         test("ignores excluded file", async () => {
             const folders = await searchForPackages(
                 (vscode.workspace.workspaceFolders ?? [])[0]!.uri,
                 false,
-                true
+                true,
+                testSwiftVersion
             );
 
             expect(folders.find(f => f.fsPath.includes("defaultPackage"))).to.not.be.undefined;

test/unit-tests/utilities/workspace.test.ts

@@ -14,6 +14,7 @@
 import { expect } from "chai";
 import * as vscode from "vscode";
 
+import { Version } from "@src/utilities/version";
 import { searchForPackages } from "@src/utilities/workspace";
 
 import { testAssetUri } from "../../fixtures";
@@ -23,15 +24,16 @@ suite("Workspace Utilities Unit Test Suite", () => {
         const packageFolder = testAssetUri("ModularPackage");
         const firstModuleFolder = vscode.Uri.joinPath(packageFolder, "Module1");
         const secondModuleFolder = vscode.Uri.joinPath(packageFolder, "Module2");
+        const testSwiftVersion = new Version(5, 9, 0);
 
         test("returns only root package when search for subpackages disabled", async () => {
-            const folders = await searchForPackages(packageFolder, false, false);
+            const folders = await searchForPackages(packageFolder, false, false, testSwiftVersion);
 
             expect(folders.map(folder => folder.fsPath)).eql([packageFolder.fsPath]);
         });
 
         test("returns subpackages when search for subpackages enabled", async () => {
-            const folders = await searchForPackages(packageFolder, false, true);
+            const folders = await searchForPackages(packageFolder, false, true, testSwiftVersion);
 
             expect(folders.map(folder => folder.fsPath).sort()).deep.equal([
                 packageFolder.fsPath,