Fix Invoke-Command missing error on session termination.

[PaulHigin]

PR Summary

This change fixes a problem in Invoke-Command against a remote session and that session is abruptly terminated, but no error is reported.

PR Context

In certain conditions, an abrupt session termination results in an Invoke-Command pipeline state going to 'Stopped' with an exception. Currently this is ignored in job processing because a user initiated stop is not an error. But a stopped state due to an error that is not 'PipelineStoppedException' (such as a remote transport exception) should not be ignored, but instead be treated as an error so that Invoke-Command will report it.

The fix is to update job error processing to correctly handle this error state.

Repro steps

$session = New-PSSession -cn vm1
Invoke-Command -Session $session -ScriptBlock { 1..1000 | % { sleep 1; "Output $_" } }

# Turn off virtual machine vm1

# Result
# No error is reported by Invoke-Command

# Expected
OpenError: [vm1] Processing data from remote server vm1 failed with the following error message: The request for the Windows Remote Shell with ShellId 8E31C82A-7B31-41F0-B882-E60EF7634D33 failed because the shell was not found on the server. Possible causes are: the specified ShellId is incorrect or the shell no longer exists on the server. Provide the correct ShellId or create a new shell and retry the operation. For more information, see the about_Remote_Troubleshooting Help topic.

PR Checklist

• PR has a meaningful title
  • Use the present tense and imperative mood when describing your changes
• Summarized changes
• Make sure all .h, .cpp, .cs, .ps1 and .psm1 files have the correct copyright header
• This PR is ready to merge and is not Work in Progress.
  • If the PR is work in progress, please add the prefix WIP: or [ WIP ] to the beginning of the title (the WIP bot will keep its status check at Pending while the prefix is present) and remove the prefix when the PR is ready.
• Breaking changes
  • None
  • OR
  • Experimental feature(s) needed
    • Experimental feature name(s):
• User-facing changes
  • Not Applicable
  • OR
  • Documentation needed
    • Issue filed:
• Testing - New and feature
  • N/A or can only be tested interactively
  • OR
  • Make sure you've added a new test if existing tests do not effectively test the code changed
• Tooling
  • I have considered the user experience from a tooling perspective and don't believe tooling will be impacted.
  • OR
  • I have considered the user experience from a tooling perspective and enumerated concerns in the summary. This may include:
    • Impact on PowerShell Editor Services which is used in the PowerShell extension for VSCode (which runs in a different PS Host).
    • Impact on Completions (both in the console and in editors) - one of PowerShell's most powerful features.
    • Impact on PSScriptAnalyzer (which provides linting & formatting in the editor extensions).
    • Impact on EditorSyntax (which provides syntax highlighting with in VSCode, GitHub, and many other editors).

[PaulHigin]

This is a possible breaking change. Some job ending states that used to be 'Stopped' with Exception, will now be 'Failed' with Exception. But I feel this is the correct behavior. The only time a 'Stopped' state is not an error is if there is no associated exception, or the exception is 'PipelineStopped'.

[PaulHigin]

@PoshChan Please retry windows

[PoshChan]

@PaulHigin, successfully started retry of PowerShell-CI-Windows

[JamesWTruher]

are there tests that can be added for this?

[PaulHigin]

@JamesWTruher No, the repro is difficult to automate and still get the right error path. We don't need another fragile test.

[SteveL-MSFT]

@PowerShell/powershell-committee reviewed this and agree that the scenario where the pipeline is stopped with an error that is not a PipelineStoppedException it is a failure case, so this change is accepted.

[PaulHigin]

@TravisEz13 This change created a subtle regression. Please hold off merging until I have pushed the fix.

[PaulHigin]

@SteveL-MSFT , @JamesWTruher Please re-review the changes. I have added a fix to the regression and also fixed the Stop-Job tests so that they will catch bad final state.

The regression was due to the pipeline returning a RemoteException exception on a pipeline stop instead of a PipelineStoppedException exception I was previously checking. A pipeline stopped RemoteException will contain an ErrorRecord with FQEID of 'PipelineStopped'.

The Stop-Job tests were not catching the incorrect final state because they ran before the job was actually running. Fix is to wait until job is running and returning data to the client.

[PaulHigin]

@SteveL-MSFT Please re-review.

[PaulHigin]

@SteveL-MSFT ping...

[ghost]

🎉v7.0.0-rc.3 has been released which incorporates this pull request.:tada:

Handy links:

• Release Notes