Fix PSVersion parameter version checks and error messages for PowerShell core remoting by PaulHigin · Pull Request #16228 · PowerShell/PowerShell

PaulHigin · 2021-10-12T16:15:50Z

PR Summary

This PR addresses issue #16062.

PR Context

Windows PowerShell supports remoting endpoint configurations that run on versions 2,3,4,5 of PowerShell. However, the PowerShell core WinRM plugin only supports endpoints that run in the currently installed version of PowerShell core, and ignores the -PSVersion parameter. This change removes the old supported version checks for the -PSVersion parameter on the configuration cmdlets and now throws a not supported error.

Also, Start-Job used to support running jobs in multiple WindowsPowerShell versions via the -PSVersion parameter, but now only supports version 5.1 in PowerShell core. So this fix updates the version check and error message to provide correct information.

PR Checklist

iSazonov · 2021-10-12T17:44:31Z

-  <data name="PowerShellNotInstalled" xml:space="preserve">
-    <value>PowerShell {0} is not installed. Install PowerShell {0}, and then try again.</value>
+  <data name="PowerShellVersionNotSupported" xml:space="preserve">
+    <value>PowerShell remoting endpoint versioning is not supported on PowerShell Core.</value>


Should we have PowerShell Committee for the decision?
Previously we support side-by-side scenarios, ex. 7.0 and 7.1 versions are installed simultaneously.

@PowerShell/powershell-committee reviewed this and we have an existing side-by-side story with PS7 which is to use the full path to pwsh to use a specific version of PS7. We don't believe there is a real world scenario where supporting -PSVersion to specify a PS7 version that would be unsupported by 3 years (at most). If there is a real world scenario that we are not aware of, we recommend opening a Discussion to help us understand. This PR doesn't prevent future support of such a feature if it makes sense.

daxian-dbw · 2021-11-02T05:37:31Z

@TravisEz13 and @SteveL-MSFT please review when you have time, thanks!

…tJob.cs Co-authored-by: James Truher [MSFT] <jimtru@microsoft.com>

SteveL-MSFT · 2021-11-10T23:27:41Z

-  <data name="PowerShellNotInstalled" xml:space="preserve">
-    <value>PowerShell {0} is not installed. Install PowerShell {0}, and then try again.</value>
+  <data name="PowerShellVersionNotSupported" xml:space="preserve">
+    <value>PowerShell remoting endpoint versioning is not supported on PowerShell Core.</value>


@PowerShell/powershell-committee reviewed this and we have an existing side-by-side story with PS7 which is to use the full path to pwsh to use a specific version of PS7. We don't believe there is a real world scenario where supporting -PSVersion to specify a PS7 version that would be unsupported by 3 years (at most). If there is a real world scenario that we are not aware of, we recommend opening a Discussion to help us understand. This PR doesn't prevent future support of such a feature if it makes sense.

…omShellCommands.cs Co-authored-by: Steve Lee <slee@microsoft.com>

…Shell into remote-psversion

pull-request-quantifier-deprecated · 2021-11-11T17:33:20Z

This PR has 61 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

Quantification details

Label      : Small
Size       : +15 -46
Percentile : 24.4%

Total files changed: 6

Change summary by file extension:
.cs : +4 -32
.resx : +3 -4
.ps1 : +8 -10

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

Fast and predictable releases to production:
- Optimal size changes are more likely to be reviewed faster with fewer
  iterations.
- Similarity in low PR complexity drives similar review times.
Review quality is likely higher as complexity is lower:
- Bugs are more likely to be detected.
- Code inconsistencies are more likely to be detetcted.
Knowledge sharing is improved within the participants:
- Small portions can be assimilated better.
Better engineering practices are exercised:
- Solving big problems by dividing them in well contained, smaller problems.
- Exercising separation of concerns within the code changes.

What can I do to optimize my changes

Use the PullRequestQuantifier to quantify your PR accurately
- Create a context profile for your repo using the context generator
- Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
- Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
- Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
Change your engineering behaviors
- For PRs that fall outside of the desired spectrum, review the details and check if:
  - Your PR could be split in smaller, self-contained PRs instead
  - Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

One line was added: +1 -0
One line was deleted: +0 -1
One line was modified: +1 -1 (git diff doesn't know about modified, it will
interpret that line like one addition plus one deletion)
Change percentiles: Change characteristics (addition, deletion, modification)
of this PR in relation to all other PRs within the repository.

Was this comment helpful? 👍 :ok_hand: :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

ghost · 2021-11-19T02:00:59Z

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

ghost · 2021-12-16T20:01:36Z

🎉v7.3.0-preview.1 has been released which incorporates this pull request.:tada:

Handy links:

Release Notes

…Shell 7 remoting (PowerShell#16228)

Fix PSVersion parameter for PSCore remoting

03719d2

ghost assigned daxian-dbw Oct 12, 2021

PaulHigin requested a review from iSazonov October 12, 2021 17:19

iSazonov reviewed Oct 12, 2021

View reviewed changes

daxian-dbw added the CL-Engine Indicates that a PR should be marked as an engine change in the Change Log label Oct 20, 2021

daxian-dbw requested review from SteveL-MSFT and TravisEz13 October 28, 2021 18:52

PaulHigin added the Review - Committee The PR/Issue needs a review from the PowerShell Committee label Nov 2, 2021

JamesWTruher reviewed Nov 10, 2021

View reviewed changes

Comment thread src/System.Management.Automation/engine/remoting/commands/StartJob.cs Outdated

Update src/System.Management.Automation/engine/remoting/commands/Star…

ea52114

…tJob.cs Co-authored-by: James Truher [MSFT] <jimtru@microsoft.com>

pull-request-quantifier-deprecated Bot added the Small label Nov 10, 2021

SteveL-MSFT requested changes Nov 11, 2021

View reviewed changes

ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Nov 11, 2021

Update src/System.Management.Automation/engine/remoting/commands/Cust…

96b2361

…omShellCommands.cs Co-authored-by: Steve Lee <slee@microsoft.com>

ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Nov 11, 2021

SteveL-MSFT added Committee-Reviewed PS-Committee has reviewed this and made a decision and removed Review - Committee The PR/Issue needs a review from the PowerShell Committee labels Nov 11, 2021

SteveL-MSFT reviewed Nov 11, 2021

View reviewed changes

Comment thread test/powershell/Modules/Microsoft.PowerShell.Core/Job.Tests.ps1 Outdated

PaulHigin added 2 commits November 11, 2021 09:32

remove test skip

217a702

Merge branch 'remote-psversion' of https://github.com/PaulHigin/Power…

9f1cbf8

…Shell into remote-psversion

ghost added the Review - Needed The PR is being reviewed label Nov 19, 2021

SteveL-MSFT approved these changes Nov 26, 2021

View reviewed changes

daxian-dbw removed the Review - Needed The PR is being reviewed label Dec 1, 2021

daxian-dbw merged commit 64d2fe2 into PowerShell:master Dec 1, 2021

TrapGodBrim pushed a commit to TrapGodBrim/PowerShell that referenced this pull request Jan 19, 2022

Fix PSVersion parameter version checks and error messages for Power…

f445077

…Shell 7 remoting (PowerShell#16228)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix PSVersion parameter version checks and error messages for PowerShell core remoting#16228

Fix PSVersion parameter version checks and error messages for PowerShell core remoting#16228
daxian-dbw merged 5 commits intoPowerShell:masterfrom
PaulHigin:remote-psversion

PaulHigin commented Oct 12, 2021

Uh oh!

Uh oh!

Uh oh!

iSazonov Oct 12, 2021

Uh oh!

SteveL-MSFT Nov 10, 2021

Uh oh!

daxian-dbw commented Nov 2, 2021

Uh oh!

Uh oh!

Uh oh!

SteveL-MSFT Nov 10, 2021

Uh oh!

Uh oh!

Uh oh!

pull-request-quantifier-deprecated Bot commented Nov 11, 2021

What can I do to optimize my changes

How to interpret the change counts in git diff output

Uh oh!

ghost commented Nov 19, 2021

Uh oh!

ghost commented Dec 16, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

PaulHigin commented Oct 12, 2021

PR Summary

PR Context

PR Checklist

Uh oh!

Uh oh!

Uh oh!

iSazonov Oct 12, 2021

Choose a reason for hiding this comment

Uh oh!

SteveL-MSFT Nov 10, 2021

Choose a reason for hiding this comment

Uh oh!

daxian-dbw commented Nov 2, 2021

Uh oh!

Uh oh!

Uh oh!

SteveL-MSFT Nov 10, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

pull-request-quantifier-deprecated Bot commented Nov 11, 2021

What can I do to optimize my changes

How to interpret the change counts in git diff output

Uh oh!

ghost commented Nov 19, 2021

Uh oh!

ghost commented Dec 16, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants