Fix launch configs not being found when using symlinked binary path (#1837)

* Fix launch configs not being found when using symlinked binary path

Launch configs generated prior to #1831 used the symlinked `debug`
folder in the program path.

Launch confgs are now generated with the bin-path returned from a
`swift build --show-bin-path` invocation, which is the full path and not
the symlink.

In order to find the right launch config when doing a `> Swift: Run` or
`> Swift: Debug` we need to follow any symlinks in the launch config
path to check for equivalence with the real path when searching for the
launch config to use.

* Fixup paths in SwiftSnippet tests

Author: plemarquand

src/debugger/launch.ts

@@ -11,6 +11,7 @@
 // SPDX-License-Identifier: Apache-2.0
 //
 //===----------------------------------------------------------------------===//
+import { realpathSync } from "fs";
 import * as path from "path";
 import { isDeepStrictEqual } from "util";
 import * as vscode from "vscode";
@@ -130,7 +131,6 @@ export async function getLaunchConfiguration(
         : vscode.workspace.getConfiguration("launch", folderCtx.workspaceFolder);
     const launchConfigs = wsLaunchSection.get<vscode.DebugConfiguration[]>("configurations") || [];
     const { folder } = getFolderAndNameSuffix(folderCtx);
-
     try {
         // Use dynamic path resolution with --show-bin-path
         const binPath = await folderCtx.toolchain.buildFlags.getBuildBinaryPath(
@@ -141,10 +141,21 @@ export async function getLaunchConfiguration(
         );
         const targetPath = path.join(binPath, target);
 
+        const expandPath = (p: string) =>
+            p.replace(
+                `$\{workspaceFolder:${folderCtx.workspaceFolder.name}}`,
+                folderCtx.folder.fsPath
+            );
+
         // Users could be on different platforms with different path annotations,
         // so normalize before we compare.
         const launchConfig = launchConfigs.find(
-            config => path.normalize(config.program) === path.normalize(targetPath)
+            config =>
+                // Old launch configs had program paths that looked like ${workspaceFolder:test}/defaultPackage/.build/debug,
+                // where `debug` was a symlink to the host-triple-folder/debug. Because targetPath is determined by `--show-bin-path`
+                // in `getBuildBinaryPath` we need to follow this symlink to get the real path if we want to compare them.
+                path.normalize(realpathSync(expandPath(config.program))) ===
+                path.normalize(targetPath)
         );
         return launchConfig;
     } catch (error) {

test/integration-tests/SwiftSnippet.test.ts

@@ -12,6 +12,7 @@
 //
 //===----------------------------------------------------------------------===//
 import { expect } from "chai";
+import { realpathSync } from "fs";
 import * as vscode from "vscode";
 
 import { WorkspaceContext } from "@src/WorkspaceContext";
@@ -78,9 +79,12 @@ tag("large").suite("SwiftSnippet Test Suite", function () {
         expect(succeeded).to.be.true;
         const session = await sessionPromise;
         expect(vscode.Uri.file(session.configuration.program).fsPath).to.equal(
-            testAssetUri(
-                "defaultPackage/.build/debug/hello" + (process.platform === "win32" ? ".exe" : "")
-            ).fsPath
+            realpathSync(
+                testAssetUri(
+                    "defaultPackage/.build/debug/hello" +
+                        (process.platform === "win32" ? ".exe" : "")
+                ).fsPath
+            )
         );
         expect(session.configuration).to.have.property("noDebug", true);
     });
@@ -115,9 +119,12 @@ tag("large").suite("SwiftSnippet Test Suite", function () {
 
         const session = await sessionPromise;
         expect(vscode.Uri.file(session.configuration.program).fsPath).to.equal(
-            testAssetUri(
-                "defaultPackage/.build/debug/hello" + (process.platform === "win32" ? ".exe" : "")
-            ).fsPath
+            realpathSync(
+                testAssetUri(
+                    "defaultPackage/.build/debug/hello" +
+                        (process.platform === "win32" ? ".exe" : "")
+                ).fsPath
+            )
         );
         expect(session.configuration).to.not.have.property("noDebug");
     });