Debugger won't run until `ENTER` is pressed in integrated console

[andyleejordan]

Prerequisites

• I have written a descriptive issue title.
• I have searched all issues to ensure it has not already been reported.
• I have read the troubleshooting guide.
• I have verified that I am using the latest version of Visual Studio Code and the PowerShell extension.

Summary

This is currently only happening with v2021.8.1-preview (the PowerShell Preview extension) and PowerShell 7, but it happens on Windows and macOS. @SeeminglyScience confirmed for me: run any PowerShell script in the debugger, it won't actually do anything (like run to a breakpoint or completion) until you manually go to the integrated console and press ENTER.

PowerShell Version

Name                           Value
----                           -----
PSVersion                      7.1.4
PSEdition                      Core
GitCommitId                    7.1.4
OS                             Microsoft Windows 10.0.22000
Platform                       Win32NT
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
WSManStackVersion              3.0

Visual Studio Code Version

1.59.1
3866c3553be8b268c8a7f8c0482c0c0177aa8bfa
x64

Extension Version

ms-vscode.powershell-preview@2021.8.1

Steps to Reproduce

1. Run PowerShell script in debugger
2. It hangs until ENTER is sent

Visuals

No response

Logs

No response

[andyleejordan]

Before ENTER is pressed the logs are:

[Trace - 4:10:56 PM] Received notification 'window/logMessage'.
Params: {
    "type": 4,
    "message": "Microsoft.PowerShell.EditorServices.Services.PowerShellContextService: Attempting to execute command(s):     c:\\Users\\andschwa\\src\\vscode-powershell\\examples\\ContentViewTest.ps1\r\n | "
}


Microsoft.PowerShell.EditorServices.Services.PowerShellContextService: Attempting to execute command(s):     c:\Users\andschwa\src\vscode-powershell\examples\ContentViewTest.ps1
 | 
[Trace - 4:10:56 PM] Received notification 'window/logMessage'.
Params: {
    "type": 4,
    "message": "Microsoft.PowerShell.EditorServices.Services.PowerShellContextService: Sending executionStatusChanged notification | "
}


Microsoft.PowerShell.EditorServices.Services.PowerShellContextService: Sending executionStatusChanged notification | 
[Trace - 4:10:56 PM] Received notification 'powerShell/executionStatusChanged'.
Params: {
    "executionOptions": {
        "writeOutputToHost": true,
        "writeErrorsToHost": true,
        "addToHistory": true,
        "interruptCommandPrompt": false,
        "writeInputToHost": true,
        "inputString": null,
        "useNewScope": false
    },
    "executionStatus": 1,
    "hadErrors": false
}

[andyleejordan]

And then afterwards:

[Trace - 4:12:48 PM] Received notification 'window/logMessage'.
Params: {
    "type": 1,
    "message": "Microsoft.PowerShell.EditorServices.Services.PowerShellContextService: Execution of the following command(s) completed with errors:\r\n\r\n    __Invoke-ReadLineForEditorServices -CancellationToken System.Threading.CancellationToken\r\n\r\n | "
}


[Error - 4:12:48 PM] Microsoft.PowerShell.EditorServices.Services.PowerShellContextService: Execution of the following command(s) completed with errors:

    __Invoke-ReadLineForEditorServices -CancellationToken System.Threading.CancellationToken

 | 
[Trace - 4:12:48 PM] Received notification 'window/logMessage'.
Params: {
    "type": 4,
    "message": "Microsoft.PowerShell.EditorServices.Services.PowerShellContextService: Passing to PowerShell | "
}


Microsoft.PowerShell.EditorServices.Services.PowerShellContextService: Passing to PowerShell | 
[Trace - 4:12:48 PM] Received notification 'window/logMessage'.
Params: {
    "type": 4,
    "message": "Microsoft.PowerShell.EditorServices.Services.PowerShellContextService: Sending executionStatusChanged notification | "
}


Microsoft.PowerShell.EditorServices.Services.PowerShellContextService: Sending executionStatusChanged notification | 
[Trace - 4:12:48 PM] Received notification 'window/logMessage'.
Params: {
    "type": 4,
    "message": "Microsoft.PowerShell.EditorServices.Services.PowerShellContextService: Session state changed --\r\n\r\n    Old state: Ready\r\n    New state: Running\r\n    Result: NotFinished | "
}


Microsoft.PowerShell.EditorServices.Services.PowerShellContextService: Session state changed --

    Old state: Ready
    New state: Running
    Result: NotFinished | 
[Trace - 4:12:48 PM] Received notification 'window/logMessage'.
Params: {
    "type": 4,
    "message": "Microsoft.PowerShell.EditorServices.Services.PowerShellContextService: Debugger stopped execution. | "
}


Microsoft.PowerShell.EditorServices.Services.PowerShellContextService: Debugger stopped execution. |

[andyleejordan]

Ah ha, I think I broke it here:

https://github.com/PowerShell/PowerShellEditorServices/blob/3c27ec396bbd73d8e6f3daac8dba32622ed870ef/src/PowerShellEditorServices/Services/PowerShellContext/Session/PSReadLinePromptContext.cs#L147

[JustinGrote]

I was bit by this in the pester test adapter, glad to see it's a known issue.

[SeeminglyScience]

@andschwa I think it's this:

https://github.com/PowerShell/PowerShellEditorServices/blob/6a19daf5bc3e8547fbdc10f351ac2a81d76f9cec/src/PowerShellEditorServices/Services/PowerShellContext/PowerShellContextService.cs#L768

        public async Task<IEnumerable<TResult>> ExecuteCommandAsync<TResult>(
            PSCommand psCommand,
            StringBuilder errorMessages,
            ExecutionOptions executionOptions,
            CancellationToken cancellationToken = default)
        {
            // (...)
            cancellationToken.Register(() => shell.Stop());

Linked cancellation token sources work by essentially registering a cancellation handler on the target token. I'm guessing the handlers are invoked sequentially on the same thread, and if that's the case then the link handler will never fire because shell.Stop won't finish. The pipeline won't stop until ReadLine returns, and ReadLine won't return until the next cancel handler fires.

Might get away with just changing it to shell.BeginStop()

[andyleejordan]

Haha, oops, our bad. @rjmholt and I added the Stop() registration at the last minute. That explains why this was only in 2.4.8 and not 2.4.7.