Fix up debugger configuration resolvers

Ok so we removed the notion of IDs (which are integers) being strings
because that broke serialization with recent updates. But on inspection
we realized the whole point was to be able to say "current" and have the
attach configuration attach to the currently running Extension Terminal.
Except that this was an unsupported, half-baked scenario (sure, it
attached, but it couldn't actually be debugged properly). So now that
throws warnings in both the client and server. The defaults for
`processId` and `runspaceId` where changed to `null` (again, now they're
just integers) which means to query for them. The supplied but
half-baked configuration was removed.

Author: andyleejordan

package.json

@@ -486,18 +486,7 @@
             "body": {
               "name": "PowerShell Attach to Host Process",
               "type": "PowerShell",
-              "request": "attach",
-              "runspaceId": 1
-            }
-          },
-          {
-            "label": "PowerShell: Attach Interactive Session Runspace",
-            "description": "Open runspace picker to select runspace to attach debugger to",
-            "body": {
-              "name": "PowerShell Attach Interactive Session Runspace",
-              "type": "PowerShell",
-              "request": "attach",
-              "processId": "current"
+              "request": "attach"
             }
           },
           {
@@ -588,29 +577,27 @@
             "properties": {
               "computerName": {
                 "type": "string",
-                "description": "Optional: The computer name to which a remote session will be established.  Works only on PowerShell 4 and above."
+                "description": "Optional: The computer name to which a remote session will be established.",
+                "default": null
               },
               "processId": {
-                "type": "string",
-                "description": "The process id of the PowerShell host process to attach to.  Works only on PowerShell 5 and above.",
+                "type": "number",
+                "description": "Optional: The ID of the PowerShell host process that should be attached. Will prompt if unspecified.",
                 "default": null
               },
               "runspaceId": {
-                "type": [
-                  "string",
-                  "number"
-                ],
-                "description": "Optional: The ID of the runspace to debug in the attached process.  Defaults to 1.  Works only on PowerShell 5 and above.",
+                "type": "number",
+                "description": "Optional: The ID of the runspace to debug in the attached process. Will prompt if unspecified.",
                 "default": null
               },
               "runspaceName": {
                 "type": "string",
-                "description": "Optional: The Name of the runspace to debug in the attached process.  Works only on PowerShell 5 and above.",
+                "description": "Optional: The name of the runspace to debug in the attached process.",
                 "default": null
               },
               "customPipeName": {
                 "type": "string",
-                "description": "The custom pipe name of the PowerShell host process to attach to.  Works only on PowerShell 6.2 and above.",
+                "description": "The custom pipe name of the PowerShell host process to attach to.",
                 "default": null
               }
             }

src/features/DebugSession.ts

@@ -87,15 +87,14 @@ export const DebugConfigurations: Record<DebugConfig, DebugConfiguration> = {
         name: "PowerShell: Attach to PowerShell Host Process",
         type: "PowerShell",
         request: "attach",
-        runspaceId: 1,
     },
     [DebugConfig.RunPester]: {
         name: "PowerShell: Run Pester Tests",
         type: "PowerShell",
         request: "launch",
         script: "Invoke-Pester",
         createTemporaryIntegratedConsole: true,
-        attachDotnetDebugger: true
+        attachDotnetDebugger: true,
     },
     [DebugConfig.ModuleInteractiveSession]: {
         name: "PowerShell: Module Interactive Session",
@@ -109,15 +108,15 @@ export const DebugConfigurations: Record<DebugConfig, DebugConfiguration> = {
         request: "launch",
         script: "Enter command to import your binary module, for example: \"Import-Module -Force ${workspaceFolder}/path/to/module.psd1|dll\"",
         createTemporaryIntegratedConsole: true,
-        attachDotnetDebugger: true
+        attachDotnetDebugger: true,
     },
     [DebugConfig.BinaryModulePester]: {
         name: "PowerShell: Binary Module Pester Tests",
         type: "PowerShell",
         request: "launch",
         script: "Invoke-Pester",
         createTemporaryIntegratedConsole: true,
-        attachDotnetDebugger: true
+        attachDotnetDebugger: true,
     }
 };
 
@@ -131,7 +130,7 @@ export class DebugSessionFeature extends LanguageClientConsumer
 
     constructor(context: ExtensionContext, private sessionManager: SessionManager, private logger: ILogger) {
         super();
-        // This "activates" the debug adapter for use with  You can only do this once.
+        // This "activates" the debug adapter. You can only do this once.
         [
             DebugConfigurationProviderTriggerKind.Initial,
             DebugConfigurationProviderTriggerKind.Dynamic
@@ -276,11 +275,15 @@ export class DebugSessionFeature extends LanguageClientConsumer
         return resolvedConfig;
     }
 
-    // This is our factory entrypoint hook to when a debug session starts, and where we will lazy initialize everything needed to do the debugging such as a temporary console if required
+    // This is our factory entrypoint hook to when a debug session starts, and
+    // where we will lazy initialize everything needed to do the debugging such
+    // as a temporary console if required.
+    //
+    // NOTE: A Promise meets the shape of a ProviderResult, which allows us to
+    // make this method async.
     public async createDebugAdapterDescriptor(
         session: DebugSession,
         _executable: DebugAdapterExecutable | undefined): Promise<DebugAdapterDescriptor | undefined> {
-        // NOTE: A Promise meets the shape of a ProviderResult, which allows us to make this method async.
 
         await this.sessionManager.start();
 
@@ -426,6 +429,7 @@ export class DebugSessionFeature extends LanguageClientConsumer
             this.logger.writeVerbose(`Dotnet attach debug configuration: ${JSON.stringify(dotnetAttachConfig, undefined, 2)}`);
             this.logger.writeVerbose(`Attached dotnet debugger to process: ${pid}`);
         }
+
         return this.tempSessionDetails;
     }
 
@@ -452,7 +456,7 @@ export class DebugSessionFeature extends LanguageClientConsumer
         };
     }
 
-    /** Fetches all available vscode launch configurations. This is abstracted out for easier testing */
+    /** Fetches all available vscode launch configurations. This is abstracted out for easier testing. */
     private getLaunchConfigurations(): DebugConfiguration[] {
         return workspace.getConfiguration("launch").get<DebugConfiguration[]>("configurations") ?? [];
     }
@@ -480,6 +484,23 @@ export class DebugSessionFeature extends LanguageClientConsumer
             }
         }
 
+        // If we were given a stringified int from the user, or from the picker
+        // command, we need to parse it here.
+        if (typeof config.processId === "string" && config.processId != "current") {
+            config.processId = parseInt(config.processId);
+        }
+
+        // NOTE: We don't support attaching to the Extension Terminal, even
+        // though in the past it looked like we did. The implementation was
+        // half-baked and left things unusable.
+        if (config.processId === "current" || config.processId === await this.sessionManager.getLanguageServerPid()) {
+            // TODO: When (if ever) it's supported, we need to convert 0 and the
+            // old notion of "current" to the actual process ID, like this:
+            // config.processId = await this.sessionManager.getLanguageServerPid();
+            void this.logger.writeAndShowError("Attaching to the PowerShell Extension terminal is not supported. Please use the 'PowerShell: Interactive Session' debug configuration instead.");
+            return PREVENT_DEBUG_START_AND_OPEN_DEBUGCONFIG;
+        }
+
         if (!config.runspaceId && !config.runspaceName) {
             config.runspaceId = await commands.executeCommand("PowerShell.PickRunspace", config.processId);
             // No runspace selected. Cancel attach.
@@ -528,12 +549,13 @@ export class SpecifyScriptArgsFeature implements Disposable {
         if (text !== undefined) {
             await this.context.workspaceState.update(powerShellDbgScriptArgsKey, text);
         }
+
         return text;
     }
 }
 
 interface IProcessItem extends QuickPickItem {
-    pid: string;    // payload for the QuickPick UI
+    processId: number; // payload for the QuickPick UI
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
@@ -542,7 +564,7 @@ interface IGetPSHostProcessesArguments {
 
 interface IPSHostProcessInfo {
     processName: string;
-    processId: string;
+    processId: number;
     appDomainName: string;
     mainWindowTitle: string;
 }
@@ -551,19 +573,16 @@ export const GetPSHostProcessesRequestType =
     new RequestType<IGetPSHostProcessesArguments, IPSHostProcessInfo[], string>("powerShell/getPSHostProcesses");
 
 export class PickPSHostProcessFeature extends LanguageClientConsumer {
-
     private command: Disposable;
     private waitingForClientToken?: CancellationTokenSource;
     private getLanguageClientResolve?: (value: LanguageClient) => void;
 
     constructor(private logger: ILogger) {
         super();
 
-        this.command =
-            commands.registerCommand("PowerShell.PickPSHostProcess", () => {
-                return this.getLanguageClient()
-                    .then((_) => this.pickPSHostProcess(), (_) => undefined);
-            });
+        this.command = commands.registerCommand("PowerShell.PickPSHostProcess", async () => {
+            return this.pickPSHostProcess();
+        });
     }
 
     public override setLanguageClient(languageClient: LanguageClient): void {
@@ -617,25 +636,24 @@ export class PickPSHostProcessFeature extends LanguageClientConsumer {
         }
     }
 
-    private async pickPSHostProcess(): Promise<string | undefined> {
+    private async pickPSHostProcess(): Promise<number | undefined> {
+        // We need the language client in order to send the request.
+        await this.getLanguageClient();
+
         // Start with the current PowerShell process in the list.
-        const items: IProcessItem[] = [{
-            label: "Current",
-            description: "The current PowerShell Extension process.",
-            pid: "current",
-        }];
+        const items: IProcessItem[] = [];
 
         const response = await this.languageClient?.sendRequest(GetPSHostProcessesRequestType, {});
         for (const process of response ?? []) {
             let windowTitle = "";
             if (process.mainWindowTitle) {
-                windowTitle = `, Title: ${process.mainWindowTitle}`;
+                windowTitle = `, ${process.mainWindowTitle}`;
             }
 
             items.push({
                 label: process.processName,
                 description: `PID: ${process.processId.toString()}${windowTitle}`,
-                pid: process.processId,
+                processId: process.processId,
             });
         }
 
@@ -648,9 +666,10 @@ export class PickPSHostProcessFeature extends LanguageClientConsumer {
             matchOnDescription: true,
             matchOnDetail: true,
         };
+
         const item = await window.showQuickPick(items, options);
 
-        return item ? item.pid : undefined;
+        return item?.processId ?? undefined;
     }
 
     private clearWaitingToken(): void {
@@ -660,7 +679,7 @@ export class PickPSHostProcessFeature extends LanguageClientConsumer {
 }
 
 interface IRunspaceItem extends QuickPickItem {
-    id: string;    // payload for the QuickPick UI
+    id: number; // payload for the QuickPick UI
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
@@ -677,18 +696,16 @@ export const GetRunspaceRequestType =
     new RequestType<IGetRunspaceRequestArguments, IRunspace[], string>("powerShell/getRunspace");
 
 export class PickRunspaceFeature extends LanguageClientConsumer {
-
     private command: Disposable;
     private waitingForClientToken?: CancellationTokenSource;
     private getLanguageClientResolve?: (value: LanguageClient) => void;
 
     constructor(private logger: ILogger) {
         super();
-        this.command =
-            commands.registerCommand("PowerShell.PickRunspace", (processId) => {
-                return this.getLanguageClient()
-                    .then((_) => this.pickRunspace(processId), (_) => undefined);
-            }, this);
+
+        this.command = commands.registerCommand("PowerShell.PickRunspace",
+            async (processId) => { return this.pickRunspace(processId); },
+            this);
     }
 
     public override setLanguageClient(languageClient: LanguageClient): void {
@@ -734,28 +751,26 @@ export class PickRunspaceFeature extends LanguageClientConsumer {
                             this.clearWaitingToken();
                             reject();
 
-                            void this.logger.writeAndShowError("Attach to PowerShell host process: PowerShell session took too long to start.");
+                            void this.logger.writeAndShowError(
+                                "Attach to PowerShell host process: PowerShell session took too long to start.");
                         }
                     }, 60000);
                 },
             );
         }
     }
 
-    private async pickRunspace(processId: string): Promise<string | undefined> {
+    private async pickRunspace(processId: number): Promise<number | undefined> {
+        // We need the language client in order to send the request.
+        await this.getLanguageClient();
+
         const response = await this.languageClient?.sendRequest(GetRunspaceRequestType, { processId });
         const items: IRunspaceItem[] = [];
         for (const runspace of response ?? []) {
-            // Skip default runspace
-            if ((runspace.id === 1 || runspace.name === "PSAttachRunspace")
-                && processId === "current") {
-                continue;
-            }
-
             items.push({
                 label: runspace.name,
                 description: `ID: ${runspace.id} - ${runspace.availability}`,
-                id: runspace.id.toString(),
+                id: runspace.id,
             });
         }
 
@@ -764,9 +779,10 @@ export class PickRunspaceFeature extends LanguageClientConsumer {
             matchOnDescription: true,
             matchOnDetail: true,
         };
+
         const item = await window.showQuickPick(items, options);
 
-        return item ? item.id : undefined;
+        return item?.id ?? undefined;
     }
 
     private clearWaitingToken(): void {

src/session.ts

@@ -303,6 +303,13 @@ export class SessionManager implements Middleware {
         return this.sessionDetails;
     }
 
+    public async getLanguageServerPid(): Promise<number | undefined> {
+        if (this.languageServerProcess === undefined) {
+            void this.logger.writeAndShowError("PowerShell Extension Terminal unavailable!");
+        }
+        return this.languageServerProcess?.getPid();
+    }
+
     public getPowerShellVersionDetails(): IPowerShellVersionDetails | undefined {
         return this.versionDetails;
     }