convert "pid" property in launch configuration to an integer (#1465)

Author: matthewbastien

src/debugger/debugAdapterFactory.ts

@@ -88,6 +88,29 @@ export class LLDBDebugConfigurationProvider implements vscode.DebugConfiguration
             launchConfig.program += ".exe";
         }
 
+        // Convert "pid" property from a string to a number to make the process picker work.
+        if ("pid" in launchConfig) {
+            const pid = Number.parseInt(launchConfig.pid, 10);
+            if (isNaN(pid)) {
+                return await vscode.window
+                    .showErrorMessage(
+                        "Failed to launch debug session",
+                        {
+                            modal: true,
+                            detail: `Invalid process ID: "${launchConfig.pid}" is not a valid integer. Please update your launch configuration`,
+                        },
+                        "Configure"
+                    )
+                    .then(userSelection => {
+                        if (userSelection === "Configure") {
+                            return null; // Opens the launch configuration when returned from a DebugConfigurationProvider
+                        }
+                        return undefined; // Only stops the debug session from starting
+                    });
+            }
+            launchConfig.pid = pid;
+        }
+
         // Delegate to the appropriate debug adapter extension
         launchConfig.type = DebugAdapter.getLaunchConfigType(this.toolchain.swiftVersion);
         if (launchConfig.type === LaunchConfigType.CODE_LLDB) {

test/unit-tests/debugger/debugAdapterFactory.test.ts

@@ -46,6 +46,84 @@ suite("LLDBDebugConfigurationProvider Tests", () => {
         });
     });
 
+    test("allows specifying a 'pid' in the launch configuration", async () => {
+        const configProvider = new LLDBDebugConfigurationProvider(
+            "darwin",
+            instance(mockToolchain),
+            instance(mockOutputChannel)
+        );
+        const launchConfig = await configProvider.resolveDebugConfigurationWithSubstitutedVariables(
+            undefined,
+            {
+                name: "Test Launch Config",
+                type: SWIFT_LAUNCH_CONFIG_TYPE,
+                request: "attach",
+                pid: 41038,
+            }
+        );
+        expect(launchConfig).to.containSubset({ pid: 41038 });
+    });
+
+    test("converts 'pid' property from a string to a number", async () => {
+        const configProvider = new LLDBDebugConfigurationProvider(
+            "darwin",
+            instance(mockToolchain),
+            instance(mockOutputChannel)
+        );
+        const launchConfig = await configProvider.resolveDebugConfigurationWithSubstitutedVariables(
+            undefined,
+            {
+                name: "Test Launch Config",
+                type: SWIFT_LAUNCH_CONFIG_TYPE,
+                request: "attach",
+                pid: "41038",
+            }
+        );
+        expect(launchConfig).to.containSubset({ pid: 41038 });
+    });
+
+    test("shows an error when the 'pid' property is a string that isn't a number", async () => {
+        // Simulate the user clicking the "Configure" button
+        mockWindow.showErrorMessage.resolves("Configure" as any);
+
+        const configProvider = new LLDBDebugConfigurationProvider(
+            "darwin",
+            instance(mockToolchain),
+            instance(mockOutputChannel)
+        );
+        const launchConfig = await configProvider.resolveDebugConfigurationWithSubstitutedVariables(
+            undefined,
+            {
+                name: "Test Launch Config",
+                type: SWIFT_LAUNCH_CONFIG_TYPE,
+                request: "attach",
+                pid: "not-a-number",
+            }
+        );
+        expect(launchConfig).to.be.null;
+    });
+
+    test("shows an error when the 'pid' property isn't a number or string", async () => {
+        // Simulate the user clicking the "Configure" button
+        mockWindow.showErrorMessage.resolves("Configure" as any);
+
+        const configProvider = new LLDBDebugConfigurationProvider(
+            "darwin",
+            instance(mockToolchain),
+            instance(mockOutputChannel)
+        );
+        const launchConfig = await configProvider.resolveDebugConfigurationWithSubstitutedVariables(
+            undefined,
+            {
+                name: "Test Launch Config",
+                type: SWIFT_LAUNCH_CONFIG_TYPE,
+                request: "attach",
+                pid: {},
+            }
+        );
+        expect(launchConfig).to.be.null;
+    });
+
     suite("CodeLLDB selected in settings", () => {
         let mockLldbConfiguration: MockedObject<vscode.WorkspaceConfiguration>;
         const mockLLDB = mockGlobalModule(lldb);