Integrated Console - Write-Progress messes things up

[Tiberriver256]

Issue Description

Running a script with Write-Progress screws up the console.

Example Script

function MyAwesomeScript {

	[CmdletBinding()]
	param (
		[Parameter()]
		[string]
		$Name
	)

	$WelcomeMessage = @();

	for ($i = 0; $i -lt 50; $i++) {
		Write-Progress -Activity "Getting ready to greet you!" -PercentComplete ($i/50*100)
		$WelcomeMessage += "Hello $Name"
	}

	$WelcomeMessage
}

MyAwesomeScript -Name Micah

Expected Behaviour

Should look like this (example taken from pwsh running in VSCode):

Actual Behaviour

Looks like this:

The prompt is getting rendered towards the top instead of at the end of the content

[andyleejordan]

That is indeed a bug, thanks for reporting it. It's unfortunately a bit difficult to fix as its a custom PowerShell host. We will look into this.

[andyleejordan]

@rjmholt thinks this a race condition between Write-Progress and the printing of the prompt. This may be fixed by PowerShell/PowerShellEditorServices#1295

[Tiberriver256]

🤞

[andyleejordan]

Hello, and thank you for your patience! The latest PowerShell Preview for VS Code is now out, and includes the reworking of our pipeline and threading architecture in PowerShell/PowerShellEditorServices#1295. Could you verify if this issue still reproduces using v2021.10.3-preview? Please note that this preview is likely to include other bugs, and you should feel free to file new issues for those so we can work through them. Thanks again!

[Tiberriver256]

Thanks for reaching out. Looks like it's still an issue in the preview version.

[StevenBucher98]

Thanks for checking @Tiberriver256! We will leave this issue open and continue to track it.

[SeeminglyScience]

A couple of things missing from the old host implementation:

https://github.com/PowerShell/PowerShellEditorServices/blob/6b1e77d6223ff61c4af3cbeedf687e1f65f3ac18/src/PowerShellEditorServices/Services/PowerShellContext/Session/Host/EditorServicesPSHostUserInterface.cs#L609-L622

Track current progress messages so they can be cleared up when a the top level pipeline completes. Also a little bit under that it's hooking into an execution status event to call ClearProgress after pipeline completion.

---

Since it's not very obvious why you'd need to do that, I'll copy and paste an explanation from when I was suggesting it as the fix:

I still think the best bet is to reuse the existing ConsoleHost. I tested it, it does work. The problem is that since ConsoleHost isn't the one creating pipelines, it isn't cleaning up progress messages after each pipeline invocation. There's a few options

1. Keep track of the progress messages we send to ConsoleHost and send clean up progress messages for any that the user did not. This would be my suggestion (assuming it works)

(it does)

[andyleejordan]

Hey so the good news is that this appears fixed in the latest Preview: the prompt now shows up where it should (the end). There is a remaining bug, but it's #3807 (Write-Progress doesn't quite finish).

[andyleejordan]

[ghost]

This issue has been marked as fixed. It has been automatically closed for housekeeping purposes.

[andyleejordan]

The remaining fix for this is out in PowerShell Preview v2022.2.2!