Integrated Console - Write-Progress messes things up

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

[andschwa]

[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)