Fixing up SDK behavior

CHANGELOG.md

@@ -14,8 +14,8 @@ Version 0.5.0 of vscode-swift now requires v1.65.0 of Visual Studio Code
 - Experimental background compilation option. Whenever you save a file it will instigate a build task. This is currently defaulted to off.
 - Setting to set environment variables while running tests.
 - Setting to output more detailed diagnostics to Swift output pane.
-- Setting to set SDK folder (supporting non-standard SDK layout on Windows and custom SDKs).
-- Setting to set additional runtime path (supporting non-standard SDK layout on Windows).
+- Setting to set SDK folder (supporting custom SDKs).
+- Setting to set additional runtime path (supporting non-standard installation on Windows).
 - More informative error messaging when Swift Package fails to load.
 
 ### Changed
@@ -37,7 +37,7 @@ Version 0.5.0 of vscode-swift now requires v1.65.0 of Visual Studio Code
 - Windows: Test Explorer messaging when nothing is built.
 - Windows: Launching of tests
 - Windows: Use Swift LLDB to improve debugging experience.
-- Centos7: Fix the code finding `swift`.
+- CentOS7: Fix the code finding `swift`.
 
 ### Removed
 

src/SwiftPackage.ts

@@ -165,13 +165,9 @@ export class SwiftPackage implements PackageContents {
      */
     static async loadPackage(folder: vscode.Uri): Promise<SwiftPackageState> {
         try {
-            let { stdout } = await execSwift(
-                ["package", "describe", "--type", "json"],
-                {
-                    cwd: folder.fsPath,
-                },
-                true
-            );
+            let { stdout } = await execSwift(["package", "describe", "--type", "json"], {
+                cwd: folder.fsPath,
+            });
             // remove lines from `swift package describe` until we find a "{"
             while (!stdout.startsWith("{")) {
                 const firstNewLine = stdout.indexOf("\n");

src/TestExplorer/TestExplorer.ts

@@ -124,7 +124,6 @@ export class TestExplorer {
                 {
                     cwd: this.folderContext.folder.fsPath,
                 },
-                true,
                 this.folderContext
             );
 

src/commands.ts

@@ -330,7 +330,6 @@ async function uneditFolderDependency(
             {
                 cwd: folder.folder.fsPath,
             },
-            true,
             folder
         );
         ctx.fireEvent(folder, FolderEvent.resolvedUpdated);

src/toolchain/toolchain.ts

@@ -69,7 +69,7 @@ export class SwiftToolchain {
             targetInfo,
             swiftVersion,
             runtimePath,
-            defaultSDK
+            customSDK ?? defaultSDK
         );
         return new SwiftToolchain(
             toolchainPath,
@@ -182,8 +182,10 @@ export class SwiftToolchain {
     }
 
     /**
+     * @param targetInfo swift target info
+     * @param swiftVersion parsed swift version
      * @param runtimePath path to Swift runtime
-     * @param sdkroot path to default SDK
+     * @param sdkroot path to swift SDK
      * @returns path to folder where xctest can be found
      */
     private static async getXCTestPath(
@@ -198,17 +200,22 @@ export class SwiftToolchain {
                 return path.join(stdout.trimEnd(), "usr", "bin");
             }
             case "win32": {
+                // look up runtime library directory for XCTest alternatively
+                const fallbackPath =
+                    runtimePath !== undefined &&
+                    (await pathExists(path.join(runtimePath, "XCTest.dll")))
+                        ? runtimePath
+                        : undefined;
                 if (!sdkroot) {
-                    return undefined;
+                    return fallbackPath;
                 }
                 const platformPath = path.dirname(path.dirname(path.dirname(sdkroot)));
                 const platformManifest = path.join(platformPath, "Info.plist");
                 if ((await pathExists(platformManifest)) !== true) {
-                    // look up runtime library directory for XCTest
-                    if (runtimePath && (await pathExists(path.join(runtimePath, "XCTest.dll")))) {
-                        return runtimePath;
+                    if (fallbackPath) {
+                        return fallbackPath;
                     }
-                    await vscode.window.showWarningMessage(
+                    vscode.window.showWarningMessage(
                         "XCTest not found due to non-standardized library layout. Tests explorer won't work as expected."
                     );
                     return undefined;

src/utilities/utilities.ts

@@ -142,13 +142,10 @@ export async function execFileStreamOutput(
 export async function execSwift(
     args: string[],
     options: cp.ExecFileOptions = {},
-    setSDKFlags = false,
     folderContext?: FolderContext
 ): Promise<{ stdout: string; stderr: string }> {
     const swift = getSwiftExecutable();
-    if (setSDKFlags) {
-        args = withSwiftSDKFlags(args);
-    }
+    args = withSwiftSDKFlags(args);
     return await execFile(swift, args, options, folderContext);
 }
 
@@ -158,23 +155,30 @@ export async function execSwift(
  * @param args original commandline arguments
  */
 export function withSwiftSDKFlags(args: string[]): string[] {
-    switch (args.length > 0 ? args[0] : null) {
-        case "package": {
-            // swift-package requires SDK flags to be placed before subcommand options
-            // eg. ["package", "describe", "--type", "json"] should be turned into
-            // ["package", "describe", "--sdk", "/path/to/sdk", "--type", "json"]
-            if (args.length <= 2) {
-                return args.concat(swiftpmSDKFlags());
+    switch (args[0]) {
+        case "package":
+            switch (args[1]) {
+                case "dump-symbol-graph":
+                case "diagnose-api-breaking-changes": {
+                    // These two tools require building the package, so SDK
+                    // flags are needed. Destination control flags are
+                    // required to be placed before subcommand options.
+                    const subcommand = args.splice(0, 2);
+                    return [...subcommand, ...swiftpmSDKFlags(), ...args];
+                }
+                default:
+                    // Other swift-package subcommands operate on the host,
+                    // so it doesn't need to know about the destination.
+                    return args;
             }
-            const subcommand = args.splice(0, 2);
-            return [...subcommand, ...swiftpmSDKFlags(), ...args];
-        }
         case "build":
         case "run":
         case "test":
             return args.concat(swiftpmSDKFlags());
         default:
-            return args.concat(swiftDriverSDKFlags());
+            // We're not going to call the Swift compiler directly for cross-compiling
+            // and the destination settings are package-only, so do nothing here.
+            return args;
     }
 }