Fix implicit remoting proxy cmdlets to act on common parameters by SteveL-MSFT · Pull Request #20367 · PowerShell/PowerShell

SteveL-MSFT · 2023-09-25T21:30:07Z

PR Summary

The PR to add ProgressAction common parameter caused this regression due to an internal helper to determine if the proxy is for a cmdlet. It expected CommonParameters to never change so if they differ, then the parameter is treated as custom so it doesn't work as expected. This works remoting from latest PS7 to latest PS7 since the common parameters match. However, latest to older PS7 or WinPS5.1 (like via WinCompat layer) fails as the new ProgressAction isn't found on the target.

Fix is to exclude ProgressAction from this check to enable it to work for the other common parameters.

PR Context

Fix #20209

PR Checklist

daxian-dbw · 2023-09-25T23:35:52Z

-            foreach (string commonParameterName in Cmdlet.CommonParameters)
+            // need to exclude `ProgressAction` which may not exist for downlevel platforms
+            var commonParameters = Cmdlet.CommonParameters;
+            commonParameters.Remove("ProgressAction");


The calling to Remove here removes ProgressAction from the static hash set s_commonParameters. It will likely cause problems with other places that depends on s_commonParameters.

We should ignore ProgressAction only if the server side is a down-level version that doesn't support this common parameter. You may be able to use the same check code from here:

PowerShell/src/Microsoft.PowerShell.Commands.Utility/commands/utility/ImplicitRemotingCommands.cs

Lines 1576 to 1581 in 963bf1e

// For remote PS version 5.1 and greater, we need to include the new -PowerShellVersion parameter

if ((Session.Runspace is RemoteRunspace remoteRunspace) && (remoteRunspace.ServerVersion != null) &&

(remoteRunspace.ServerVersion >= new Version(5, 1)))

{

powerShell.AddParameter("PowerShellVersion", PSVersionInfo.PSVersion);

}

…remove progressaction for older PS

SteveL-MSFT · 2023-09-26T00:30:52Z

The 1 CodeFactor issue is by-design

pull-request-quantifier-deprecated · 2023-09-26T17:03:25Z

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

Quantification details

Label      : Extra Small
Size       : +13 -2
Percentile : 6%

Total files changed: 2

Change summary by file extension:
.cs : +7 -2
.ps1 : +6 -0

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 detected.
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.

daxian-dbw

LGTM

…) (#20530)

Fix implicit remoting proxy cmdlets to act on common parameters

1cd71a7

SteveL-MSFT requested a review from daxian-dbw September 25, 2023 21:30

SteveL-MSFT assigned daxian-dbw Sep 25, 2023

pull-request-quantifier-deprecated Bot added the Extra Small label Sep 25, 2023

daxian-dbw requested changes Sep 25, 2023

View reviewed changes

microsoft-github-policy-service Bot added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Sep 25, 2023

address Dongbo's feedback creating copy of commonparameters and only …

b0b5470

…remove progressaction for older PS

microsoft-github-policy-service Bot removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Sep 25, 2023

fix codefactor

88ccf44

daxian-dbw reviewed Sep 26, 2023

View reviewed changes

Comment thread src/Microsoft.PowerShell.Commands.Utility/commands/utility/ImplicitRemotingCommands.cs Outdated

address Dongbo's feedback

55c8f89

daxian-dbw approved these changes Sep 26, 2023

View reviewed changes

daxian-dbw added the Backport-7.4.x-Consider label Sep 26, 2023

daxian-dbw merged commit 9ebeca3 into PowerShell:master Sep 26, 2023

SteveL-MSFT deleted the implicit-stop branch September 26, 2023 23:11

daxian-dbw added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Sep 26, 2023

adityapatwardhan added Backport-7.4.x-Approved and removed Backport-7.4.x-Consider labels Oct 19, 2023

adityapatwardhan pushed a commit that referenced this pull request Oct 19, 2023

Fix implicit remoting proxy cmdlets to act on common parameters (#20367)

47e819c

adityapatwardhan mentioned this pull request Oct 19, 2023

[release/v7.4.0-preview.7]Fix implicit remoting proxy cmdlets to act on common parameters #20530

Merged

adityapatwardhan added a commit that referenced this pull request Oct 19, 2023

Fix implicit remoting proxy cmdlets to act on common parameters (#20367…

dd1fe75

…) (#20530)

adityapatwardhan added Backport-7.4.x-Done and removed Backport-7.4.x-Approved labels Oct 19, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix implicit remoting proxy cmdlets to act on common parameters#20367

Fix implicit remoting proxy cmdlets to act on common parameters#20367
daxian-dbw merged 4 commits intoPowerShell:masterfrom
SteveL-MSFT:implicit-stop

SteveL-MSFT commented Sep 25, 2023 •

edited by daxian-dbw

Loading

Uh oh!

daxian-dbw Sep 25, 2023

Uh oh!

SteveL-MSFT commented Sep 26, 2023

Uh oh!

Uh oh!

pull-request-quantifier-deprecated Bot commented Sep 26, 2023

What can I do to optimize my changes

How to interpret the change counts in git diff output

Uh oh!

daxian-dbw left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	// For remote PS version 5.1 and greater, we need to include the new -PowerShellVersion parameter
	if ((Session.Runspace is RemoteRunspace remoteRunspace) && (remoteRunspace.ServerVersion != null) &&
	(remoteRunspace.ServerVersion >= new Version(5, 1)))
	{
	powerShell.AddParameter("PowerShellVersion", PSVersionInfo.PSVersion);
	}

Conversation

SteveL-MSFT commented Sep 25, 2023 • edited by daxian-dbw Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Context

PR Checklist

Uh oh!

daxian-dbw Sep 25, 2023

Choose a reason for hiding this comment

Uh oh!

SteveL-MSFT commented Sep 26, 2023

Uh oh!

Uh oh!

pull-request-quantifier-deprecated Bot commented Sep 26, 2023

What can I do to optimize my changes

How to interpret the change counts in git diff output

Uh oh!

daxian-dbw left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

SteveL-MSFT commented Sep 25, 2023 •

edited by daxian-dbw

Loading