Fix failing windows builds (#1432)

plemarquand · web-flow · commit 91a5b94d9c11 · 2025-04-04T14:59:26.000-04:00
diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml
@@ -47,7 +47,6 @@ jobs:
       # Windows
       windows_env_vars: |
         CI=1
-        VSCODE_TEST=1
       windows_pre_build_command: .github\workflows\scripts\windows\install-nodejs.ps1
       windows_build_command: scripts\test_windows.ps1
       enable_windows_docker: false
@@ -63,15 +62,13 @@ jobs:
         NODE_PATH=/usr/local/nvm/versions/node/v20.18.2/bin
         NVM_DIR=/usr/local/nvm
         CI=1
-        VSCODE_TEST=1
         VSCODE_VERSION=insiders
       linux_pre_build_command: . .github/workflows/scripts/setup-linux.sh
       linux_build_command: ./scripts/test.sh
       # Windows
       windows_exclude_swift_versions: '[{"swift_version": "5.9"}, {"swift_version": "nightly-6.1"}, {"swift_version": "nightly"}]'
       windows_env_vars: |
         CI=1
-        VSCODE_TEST=1
         VSCODE_VERSION=insiders
       windows_pre_build_command: .github\workflows\scripts\windows\install-nodejs.ps1
       windows_build_command: scripts\test_windows.ps1
diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml
@@ -16,15 +16,13 @@ jobs:
         NODE_PATH=/usr/local/nvm/versions/node/v20.18.2/bin
         NVM_DIR=/usr/local/nvm
         CI=1
-        VSCODE_TEST=1
         FAST_TEST_RUN=${{ contains(github.event.pull_request.labels.*.name, 'full-test-run') && '0' || '1'}}
       linux_pre_build_command: . .github/workflows/scripts/setup-linux.sh
       linux_build_command: ./scripts/test.sh
       # Windows
       windows_exclude_swift_versions: '[{"swift_version": "nightly-6.1"},{"swift_version": "nightly"}]'
       windows_env_vars: |
         CI=1
-        VSCODE_TEST=1
         FAST_TEST_RUN=${{ contains(github.event.pull_request.labels.*.name, 'full-test-run') && '0' || '1'}}
       windows_pre_build_command: .github\workflows\scripts\windows\install-nodejs.ps1
       windows_build_command: scripts\test_windows.ps1
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -25,8 +25,7 @@
       "args": ["--profile=testing-debug"],
       "outFiles": ["${workspaceFolder}/dist/**/*.js"],
       "env": {
-        "VSCODE_DEBUG": "1",
-        "VSCODE_TEST": "1"
+        "VSCODE_DEBUG": "1"
       },
       "preLaunchTask": "compile-tests"
     },
diff --git a/scripts/test_windows.ps1 b/scripts/test_windows.ps1
@@ -12,8 +12,54 @@
 ##
 ##===----------------------------------------------------------------------===##
 
-$env:CI = "1"
-$env:FAST_TEST_RUN = "1"
+# In newer Visual C++ Tools they've added compiler intrinsics headers in wchar.h
+# that end up creating a cyclic dependency between the `ucrt` and compiler intrinsics modules.
+# Newer versions of swift (6.2) have a fixed modulemap that resolves the issue: https://github.com/swiftlang/swift/pull/79751
+$windowsSdkVersion = "10.0.22000.0"
+$vcToolsVersion = "14.43.34808"
+
+# As a workaround we can pin the tools/SDK versions to older versions that are present in the GH Actions Windows image.
+# In the future we may only want to apply this workaround to older versions of Swift that don't have the fixed module map.
+$jsonFilePath = "./assets/test/.vscode/settings.json"
+try {
+    $jsonContent = Get-Content -Raw -Path $jsonFilePath | ConvertFrom-Json
+} catch {
+    Write-Host "Invalid JSON content in $jsonFilePath"
+    exit 1
+}
+if ($jsonContent.PSObject.Properties['swift.buildArguments']) {
+    $jsonContent.PSObject.Properties.Remove('swift.buildArguments')
+}
+
+$windowsSdkRoot = "C:\Program Files (x86)\Windows Kits\10\"
+
+$jsonContent | Add-Member -MemberType NoteProperty -Name "swift.buildArguments" -Value @(
+    "-Xbuild-tools-swiftc", "-windows-sdk-root", "-Xbuild-tools-swiftc", $windowsSdkRoot,
+    "-Xbuild-tools-swiftc", "-windows-sdk-version", "-Xbuild-tools-swiftc", $windowsSdkVersion,
+    "-Xbuild-tools-swiftc", "-visualc-tools-version", "-Xbuild-tools-swiftc", $vcToolsVersion,
+    "-Xswiftc", "-windows-sdk-root", "-Xswiftc", $windowsSdkRoot,
+    "-Xswiftc", "-windows-sdk-version", "-Xswiftc", $windowsSdkVersion,
+    "-Xswiftc", "-visualc-tools-version", "-Xswiftc", $vcToolsVersion
+)
+
+if ($jsonContent.PSObject.Properties['swift.packageArguments']) {
+    $jsonContent.PSObject.Properties.Remove('swift.packageArguments')
+}
+
+$jsonContent | Add-Member -MemberType NoteProperty -Name "swift.packageArguments" -Value @(
+    "-Xbuild-tools-swiftc", "-windows-sdk-root", "-Xbuild-tools-swiftc", $windowsSdkRoot,
+    "-Xbuild-tools-swiftc", "-windows-sdk-version", "-Xbuild-tools-swiftc", $windowsSdkVersion,
+    "-Xbuild-tools-swiftc", "-visualc-tools-version", "-Xbuild-tools-swiftc", $vcToolsVersion,
+    "-Xswiftc", "-windows-sdk-root", "-Xswiftc", $windowsSdkRoot,
+    "-Xswiftc", "-windows-sdk-version", "-Xswiftc", $windowsSdkVersion,
+    "-Xswiftc", "-visualc-tools-version", "-Xswiftc", $vcToolsVersion
+)
+
+$jsonContent | ConvertTo-Json -Depth 32 | Set-Content -Path $jsonFilePath
+
+Write-Host "Contents of ${jsonFilePath}:"
+Get-Content -Path $jsonFilePath
+
 npm ci -ignore-script node-pty
 npm run lint
 npm run format
diff --git a/src/FolderContext.ts b/src/FolderContext.ts
@@ -22,6 +22,7 @@ import { WorkspaceContext, FolderOperation } from "./WorkspaceContext";
 import { BackgroundCompilation } from "./BackgroundCompilation";
 import { TaskQueue } from "./tasks/TaskQueue";
 import { isPathInsidePath } from "./utilities/filesystem";
+import { SwiftOutputChannel } from "./ui/SwiftOutputChannel";
 
 export class FolderContext implements vscode.Disposable {
     private packageWatcher: PackageWatcher;
@@ -135,8 +136,8 @@ export class FolderContext implements vscode.Disposable {
     }
 
     /** Load Swift Plugins and store in Package */
-    async loadSwiftPlugins() {
-        await this.swiftPackage.loadSwiftPlugins(this.workspaceContext.toolchain);
+    async loadSwiftPlugins(outputChannel: SwiftOutputChannel) {
+        await this.swiftPackage.loadSwiftPlugins(this.workspaceContext.toolchain, outputChannel);
     }
 
     /**
diff --git a/src/SwiftPackage.ts b/src/SwiftPackage.ts
@@ -19,6 +19,7 @@ import { execSwift, getErrorDescription, hashString } from "./utilities/utilitie
 import { isPathInsidePath } from "./utilities/filesystem";
 import { SwiftToolchain } from "./toolchain/toolchain";
 import { BuildFlags } from "./toolchain/BuildFlags";
+import { SwiftOutputChannel } from "./ui/SwiftOutputChannel";
 
 /** Swift Package Manager contents */
 export interface PackageContents {
@@ -278,7 +279,8 @@ export class SwiftPackage implements PackageContents {
 
     private static async loadPlugins(
         folder: vscode.Uri,
-        toolchain: SwiftToolchain
+        toolchain: SwiftToolchain,
+        outputChannel: SwiftOutputChannel
     ): Promise<PackagePlugin[]> {
         try {
             const { stdout } = await execSwift(["package", "plugin", "--list"], toolchain, {
@@ -298,7 +300,8 @@ export class SwiftPackage implements PackageContents {
                 }
             }
             return plugins;
-        } catch {
+        } catch (error) {
+            outputChannel.appendLine(`Failed to laod plugins: ${error}`);
             // failed to load resolved file return undefined
             return [];
         }
@@ -338,8 +341,8 @@ export class SwiftPackage implements PackageContents {
         this.workspaceState = await SwiftPackage.loadWorkspaceState(this.folder);
     }
 
-    public async loadSwiftPlugins(toolchain: SwiftToolchain) {
-        this.plugins = await SwiftPackage.loadPlugins(this.folder, toolchain);
+    public async loadSwiftPlugins(toolchain: SwiftToolchain, outputChannel: SwiftOutputChannel) {
+        this.plugins = await SwiftPackage.loadPlugins(this.folder, toolchain, outputChannel);
     }
 
     /** Return if has valid contents */
diff --git a/src/TestExplorer/TestExplorer.ts b/src/TestExplorer/TestExplorer.ts
@@ -412,6 +412,9 @@ export class TestExplorer {
      * @param errorDescription Error description to display
      */
     private setErrorTestItem(errorDescription: string | undefined, title = "Test Discovery Error") {
+        this.folderContext.workspaceContext.outputChannel.log(
+            `Test Discovery Error: ${errorDescription}`
+        );
         this.controller.items.forEach(item => {
             this.controller.items.delete(item.id);
         });
diff --git a/src/extension.ts b/src/extension.ts
@@ -203,7 +203,7 @@ export async function activate(context: vscode.ExtensionContext): Promise<Api> {
                                     folder.workspaceFolder.uri
                                 )})`,
                                 async () => {
-                                    await folder.loadSwiftPlugins();
+                                    await folder.loadSwiftPlugins(outputChannel);
                                     workspace.updatePluginContextKey();
                                     folder.fireEvent(FolderOperation.pluginsUpdated);
                                 }
diff --git a/src/process-list/BaseProcessList.ts b/src/process-list/BaseProcessList.ts
@@ -42,7 +42,9 @@ export abstract class BaseProcessList implements ProcessList {
     protected abstract createParser(): ProcessListParser;
 
     async listAllProcesses(): Promise<Process[]> {
-        const execCommand = exec(this.getCommand(), this.getCommandArguments());
+        const execCommand = exec(this.getCommand(), this.getCommandArguments(), {
+            maxBuffer: 10 * 1024 * 1024, // Increase the max buffer size to 10Mb
+        });
         const parser = this.createParser();
         return (await execCommand).stdout.split("\n").flatMap(line => {
             const process = parser(line.toString());
diff --git a/src/toolchain/BuildFlags.ts b/src/toolchain/BuildFlags.ts
@@ -71,11 +71,14 @@ export class BuildFlags {
 
     withSwiftPackageFlags(args: string[]): string[] {
         switch (args[0]) {
-            case "package":
-                if (args[1] === "resolve" || args[1] === "update") {
-                    return [...args, ...configuration.packageArguments];
+            case "package": {
+                if (args[1] === "init") {
+                    return args;
                 }
-                return args;
+                const newArgs = [...args];
+                newArgs.splice(1, 0, ...configuration.packageArguments);
+                return newArgs;
+            }
             case "build":
             case "run":
             case "test":
diff --git a/src/toolchain/toolchain.ts b/src/toolchain/toolchain.ts
@@ -121,24 +121,28 @@ export class SwiftToolchain {
         const swiftFolderPath = await this.getSwiftFolderPath();
         const toolchainPath = await this.getToolchainPath(swiftFolderPath);
         const targetInfo = await this.getSwiftTargetInfo();
-        const swiftVersion = await this.getSwiftVersion(targetInfo);
-        const runtimePath = await this.getRuntimePath(targetInfo);
-        const defaultSDK = await this.getDefaultSDK();
+        const swiftVersion = this.getSwiftVersion(targetInfo);
+        const [runtimePath, defaultSDK] = await Promise.all([
+            this.getRuntimePath(targetInfo),
+            this.getDefaultSDK(),
+        ]);
         const customSDK = this.getCustomSDK();
-        const xcTestPath = await this.getXCTestPath(
-            targetInfo,
-            swiftFolderPath,
-            swiftVersion,
-            runtimePath,
-            customSDK ?? defaultSDK
-        );
-        const swiftTestingPath = await this.getSwiftTestingPath(
-            targetInfo,
-            swiftVersion,
-            runtimePath,
-            customSDK ?? defaultSDK
-        );
-        const swiftPMTestingHelperPath = await this.getSwiftPMTestingHelperPath(toolchainPath);
+        const [xcTestPath, swiftTestingPath, swiftPMTestingHelperPath] = await Promise.all([
+            this.getXCTestPath(
+                targetInfo,
+                swiftFolderPath,
+                swiftVersion,
+                runtimePath,
+                customSDK ?? defaultSDK
+            ),
+            this.getSwiftTestingPath(
+                targetInfo,
+                swiftVersion,
+                runtimePath,
+                customSDK ?? defaultSDK
+            ),
+            this.getSwiftPMTestingHelperPath(toolchainPath),
+        ]);
 
         return new SwiftToolchain(
             swiftFolderPath,
diff --git a/src/ui/ProjectPanelProvider.ts b/src/ui/ProjectPanelProvider.ts
@@ -348,7 +348,7 @@ class ErrorNode {
  *
  * Can be either a {@link PackageNode}, {@link FileNode}, {@link TargetNode}, {@link TaskNode}, {@link ErrorNode} or {@link HeaderNode}.
  */
-type TreeNode = PackageNode | FileNode | HeaderNode | TaskNode | TargetNode | ErrorNode;
+export type TreeNode = PackageNode | FileNode | HeaderNode | TaskNode | TargetNode | ErrorNode;
 
 /**
  * A {@link vscode.TreeDataProvider<T> TreeDataProvider} for project dependencies, tasks and commands {@link vscode.TreeView TreeView}.
diff --git a/src/utilities/utilities.ts b/src/utilities/utilities.ts
@@ -113,8 +113,9 @@ export async function execFile(
         cp.execFile(executable, args, options, (error, stdout, stderr) => {
             if (error) {
                 reject(new ExecFileError(error, stdout, stderr));
+            } else {
+                resolve({ stdout, stderr });
             }
-            resolve({ stdout, stderr });
         });
     });
 }
diff --git a/test/integration-tests/DiagnosticsManager.test.ts b/test/integration-tests/DiagnosticsManager.test.ts
@@ -60,7 +60,7 @@ function assertWithoutDiagnostic(uri: vscode.Uri, expected: vscode.Diagnostic) {
 
 suite("DiagnosticsManager Test Suite", async function () {
     // Was hitting a timeout in suiteSetup during CI build once in a while
-    this.timeout(5000);
+    this.timeout(15000);
 
     const swiftConfig = vscode.workspace.getConfiguration("swift");
 
@@ -126,7 +126,7 @@ suite("DiagnosticsManager Test Suite", async function () {
 
     activateExtensionForSuite({
         async setup(ctx) {
-            this.timeout(60000 * 2);
+            this.timeout(60000 * 5);
 
             workspaceContext = ctx;
             toolchain = workspaceContext.toolchain;
diff --git a/test/integration-tests/SwiftPackage.test.ts b/test/integration-tests/SwiftPackage.test.ts
@@ -18,23 +18,24 @@ import { SwiftPackage } from "../../src/SwiftPackage";
 import { SwiftToolchain } from "../../src/toolchain/toolchain";
 import { Version } from "../../src/utilities/version";
 
-let toolchain: SwiftToolchain;
+suite("SwiftPackage Test Suite", function () {
+    this.timeout(5 * 60 * 1000); // 5 minute timeout
+    let toolchain: SwiftToolchain;
 
-suite("SwiftPackage Test Suite", () => {
     setup(async () => {
         toolchain = await SwiftToolchain.create();
     });
 
     test("No package", async () => {
         const spmPackage = await SwiftPackage.create(testAssetUri("empty-folder"), toolchain);
         assert.strictEqual(spmPackage.foundPackage, false);
-    }).timeout(10000);
+    });
 
     test("Invalid package", async () => {
         const spmPackage = await SwiftPackage.create(testAssetUri("invalid-package"), toolchain);
         assert.strictEqual(spmPackage.foundPackage, true);
         assert.strictEqual(spmPackage.isValid, false);
-    }).timeout(10000);
+    });
 
     test("Library package", async () => {
         const spmPackage = await SwiftPackage.create(testAssetUri("package2"), toolchain);
@@ -43,7 +44,7 @@ suite("SwiftPackage Test Suite", () => {
         assert.strictEqual(spmPackage.libraryProducts[0].name, "package2");
         assert.strictEqual(spmPackage.dependencies.length, 0);
         assert.strictEqual(spmPackage.targets.length, 2);
-    }).timeout(10000);
+    });
 
     test("Package resolve v2", async function () {
         if (!toolchain) {
@@ -59,7 +60,7 @@ suite("SwiftPackage Test Suite", () => {
         const spmPackage = await SwiftPackage.create(testAssetUri("package5.6"), toolchain);
         assert.strictEqual(spmPackage.isValid, true);
         assert(spmPackage.resolved !== undefined);
-    }).timeout(20000);
+    });
 
     test("Identity case-insensitivity", async () => {
         const spmPackage = await SwiftPackage.create(testAssetUri("identity-case"), toolchain);
@@ -68,7 +69,7 @@ suite("SwiftPackage Test Suite", () => {
         assert(spmPackage.resolved !== undefined);
         assert.strictEqual(spmPackage.resolved.pins.length, 1);
         assert.strictEqual(spmPackage.resolved.pins[0].identity, "yams");
-    }).timeout(10000);
+    });
 
     test("Identity different from name", async () => {
         const spmPackage = await SwiftPackage.create(testAssetUri("identity-different"), toolchain);
@@ -77,5 +78,5 @@ suite("SwiftPackage Test Suite", () => {
         assert(spmPackage.resolved !== undefined);
         assert.strictEqual(spmPackage.resolved.pins.length, 1);
         assert.strictEqual(spmPackage.resolved.pins[0].identity, "swift-log");
-    }).timeout(10000);
+    });
 });
diff --git a/test/integration-tests/WorkspaceContext.test.ts b/test/integration-tests/WorkspaceContext.test.ts
diff --git a/test/integration-tests/commands/dependency.test.ts b/test/integration-tests/commands/dependency.test.ts
diff --git a/test/integration-tests/tasks/SwiftPluginTaskProvider.test.ts b/test/integration-tests/tasks/SwiftPluginTaskProvider.test.ts
diff --git a/test/integration-tests/testexplorer/TestExplorerIntegration.test.ts b/test/integration-tests/testexplorer/TestExplorerIntegration.test.ts
diff --git a/test/integration-tests/ui/ProjectPanelProvider.test.ts b/test/integration-tests/ui/ProjectPanelProvider.test.ts
diff --git a/test/integration-tests/utilities/testutilities.ts b/test/integration-tests/utilities/testutilities.ts
diff --git a/test/utilities/tasks.ts b/test/utilities/tasks.ts

Original file line number	Diff line number	Diff line change
`@@ -203,7 +203,7 @@ export async function activate(context: vscode.ExtensionContext): Promise<Api> {`
`203`	`203`	`folder.workspaceFolder.uri`
`204`	`204`	)})`,
`205`	`205`	`async () => {`
`206`		`- await folder.loadSwiftPlugins();`
	`206`	`+ await folder.loadSwiftPlugins(outputChannel);`
`207`	`207`	`workspace.updatePluginContextKey();`
`208`	`208`	`folder.fireEvent(FolderOperation.pluginsUpdated);`
`209`	`209`	`}`