Set default native arg passing to Legacy on Windows. #18706

JamesWTruher · 2022-12-01T21:56:20Z

PR Summary

The committee agreed to a new PSWindowsNativeCommandArgPassing experimental feature. When this feature is enabled:

On Windows
- $PSNativeCommandArgumentPassing = Windows
Non-Windows
- $PSNativeCommandArgumentPassing = Standard

When this feature is disabled:

On Windows
- $PSNativeCommandArgumentPassing = Legacy
Non-Windows
- $PSNativeCommandArgumentPassing = Standard

Additionally, new telemetry metric will be added for native command execution to inform the mode being used.

PR Context

PR Checklist

daxian-dbw

You can use PSVersionInfo.PSCurrentVersion.PreReleaseLabel to detect whether it's a stable version.

src/System.Management.Automation/engine/InitialSessionState.cs

daxian-dbw

This change makes stable and preview releases have different default behavior on native argument passing. Won't that inconsistency cause any problems and confusions to the preview adopters? If we choose to do this on purpose, then doc needs to be updated to reflect this inconsistency.

src/System.Management.Automation/engine/InitialSessionState.cs

test/powershell/Language/Scripting/NativeExecution/NativeCommandArguments.Tests.ps1

SteveL-MSFT · 2022-12-02T23:51:56Z

@daxian-dbw the difference between stable and preview is deliberate as to prioritize compat for stable while ensuring we have the new desired behavior in preview to continue to get feedback. Maybe an option we can take here to make this more clear is to wrap it in a new Experimental Feature. Specifically, Windows mode is experimental.

daxian-dbw · 2022-12-05T17:50:17Z

I understand there will be difference between stable and preview versions. However, the native arg passing feature is already official, so making an official feature behave differently seems confusing.

Introducing a new experimental feature for the different arg passing behavior in preview versions sounds like a good idea. A doc issue needs to be opened for the new experimental feature.

SteveL-MSFT · 2022-12-05T22:01:30Z

@daxian-dbw We should probably advertise that Windows mode is still experimental and changes will continue until we can get to an acceptable level of compatibility

ghost · 2022-12-14T02:01:03Z

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

daxian-dbw · 2023-05-01T18:45:10Z

@PowerShell/powershell-committee Please review this PR and decide whether this PR should be closed or accepted.

SteveL-MSFT · 2023-05-10T21:38:23Z

@PowerShell/powershell-committee discussed this. We agreed to a new PSWindowsNativeCommandArgPassing experimental feature. When this feature is enabled:

On Windows
- $PSNativeCommandArgumentPassing = Windows
Non-Windows
- $PSNativeCommandArgumentPassing = Standard

When this feature is disabled:

On Windows
- $PSNativeCommandArgumentPassing = Legacy
Non-Windows
- $PSNativeCommandArgumentPassing = Standard

Additionally, new telemetry metric will be added for native command execution to inform the mode being used.

src/System.Management.Automation/engine/InitialSessionState.cs

daxian-dbw

LGTM

If the PS release is a preview, then set it to Windows.

Co-authored-by: Dongbo Wang <dongbow@microsoft.com>

use compile time rather than runtime check Co-authored-by: Dongbo Wang <dongbow@microsoft.com>

pull-request-quantifier-deprecated · 2023-06-19T22:57:49Z

This PR has 24 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       : +21 -3
Percentile : 9.6%

Total files changed: 4

Change summary by file extension:
.cs : +17 -2
.ps1 : +4 -1

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.

ghost · 2023-06-29T22:08:16Z

🎉v7.4.0-preview.4 has been released which incorporates this pull request.:tada:

Handy links:

Release Notes

God-damnit-all · 2023-06-30T16:14:41Z

So the default behavior in 7.2 is Legacy, then in 7.3 it's Windows, now it's going to be Legacy in 7.4 unless an experimental feature is enabled which makes it into Windows by default unless you set a new variable to Legacy, do I have that right?

TravisEz13 · 2023-07-12T18:38:50Z

@ImportTaste, this is marked to backport to 7.3.

TravisEz13 · 2023-09-06T21:09:47Z

@PowerShell/powershell-committee Are we okay with making this change to 7.3 after it has been release?

SteveL-MSFT · 2023-09-07T16:24:50Z

PS-Committee decided to make this feature stable in 7.4, so the default will be Windows in 7.4. Based on the telemetry, it seems that most Windows (like 99%) have not changed the default in 7.4 previews to Legacy or Standard. As such, there is no reason to backport to 7.3 which will be supported for just 1 more year.

God-damnit-all · 2023-09-28T19:22:45Z

it seems that most Windows (like 99%) have not changed the default in 7.4 previews to Legacy or Standard

What's the difference between Windows and Standard on Windows?

pull-request-quantifier-deprecated bot added the Extra Small label Dec 1, 2022

ghost assigned PaulHigin Dec 1, 2022

daxian-dbw requested changes Dec 2, 2022

View reviewed changes

src/System.Management.Automation/engine/InitialSessionState.cs Outdated Show resolved Hide resolved

ghost added Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept and removed Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept labels Dec 2, 2022

daxian-dbw requested changes Dec 2, 2022

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 Dec 2, 2022

daxian-dbw added the Backport-7.3.x-Consider label Dec 2, 2022

ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Dec 2, 2022

JamesWTruher changed the title ~~WIP:Set default native arg passing to Legacy on Windows.~~ Set default native arg passing to Legacy on Windows. Dec 6, 2022

JamesWTruher changed the title ~~Set default native arg passing to Legacy on Windows.~~ WIP:Set default native arg passing to Legacy on Windows. Dec 6, 2022

JamesWTruher force-pushed the WindowNativeArgumentDefaults branch from 4788f33 to 11e8a6b Compare December 6, 2022 22:29

ghost added the Review - Needed The PR is being reviewed label Dec 14, 2022

JamesWTruher force-pushed the WindowNativeArgumentDefaults branch from 11e8a6b to 647eabe Compare January 23, 2023 19:45

JamesWTruher changed the title ~~WIP:Set default native arg passing to Legacy on Windows.~~ Set default native arg passing to Legacy on Windows. Jan 23, 2023

JamesWTruher mentioned this pull request Jan 24, 2023

Native argument passing on Windows default changes MicrosoftDocs/PowerShell-Docs#9739

Closed

2 tasks

daxian-dbw added the Review - Committee The PR/Issue needs a review from the PowerShell Committee label May 1, 2023

ghost removed the Review - Needed The PR is being reviewed label May 1, 2023

daxian-dbw added the Needs-Triage The issue is new and needs to be triaged by a work group. label May 1, 2023

PaulHigin approved these changes May 10, 2023

View reviewed changes

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 May 10, 2023

JamesWTruher force-pushed the WindowNativeArgumentDefaults branch from 647eabe to 4e1f2d5 Compare May 10, 2023 21:59

StevenBucher98 added the PowerShell-Docs needed The PR was reviewed and a PowerShell Docs update is needed label May 15, 2023

JamesWTruher force-pushed the WindowNativeArgumentDefaults branch from 5038016 to 8d88665 Compare June 6, 2023 16:09

daxian-dbw reviewed Jun 19, 2023

View reviewed changes

src/System.Management.Automation/engine/InitialSessionState.cs Outdated Show resolved Hide resolved

daxian-dbw approved these changes Jun 19, 2023

View reviewed changes

daxian-dbw added CL-Engine Indicates that a PR should be marked as an engine change in the Change Log and removed Review - Needed The PR is being reviewed Needs-Triage The issue is new and needs to be triaged by a work group. labels Jun 19, 2023

JamesWTruher and others added 9 commits June 19, 2023 15:57

Set default native arg passing to Legacy on Windows.

ef5a174

If the PS release is a preview, then set it to Windows.

remove whitespace following '!'

a85e54e

Update src/System.Management.Automation/engine/InitialSessionState.cs

57959e9

Co-authored-by: Dongbo Wang <dongbow@microsoft.com>

Update src/System.Management.Automation/engine/InitialSessionState.cs

44543d6

Co-authored-by: Dongbo Wang <dongbow@microsoft.com>

update message to accurately reflect the code changes.

ce2e5f4

merge conflict fixes

70d06c9

Fix CodeFactor issue with regard to NativeCommandProcessor.cs

7b8850d

fix typo

221e3ab

Update src/System.Management.Automation/engine/InitialSessionState.cs

b37a98b

use compile time rather than runtime check Co-authored-by: Dongbo Wang <dongbow@microsoft.com>

JamesWTruher force-pushed the WindowNativeArgumentDefaults branch from 29c58b1 to b37a98b Compare June 19, 2023 22:57

daxian-dbw merged commit 5437f38 into PowerShell:master Jun 19, 2023

daxian-dbw mentioned this pull request Jun 23, 2023

Add msbuild to NativeCommandProcessor (s_legacyCommands) in PWSH 7.3 #18660

Open

5 tasks

TravisEz13 added Backport-7.3.x-Approved and removed Backport-7.3.x-Consider labels Jul 12, 2023

TravisEz13 removed the Backport-7.3.x-Consider label Sep 7, 2023

Set default native arg passing to Legacy on Windows. #18706

Set default native arg passing to Legacy on Windows. #18706

Uh oh!

Conversation

JamesWTruher commented Dec 1, 2022 • 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 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

daxian-dbw left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

SteveL-MSFT commented Dec 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

daxian-dbw commented Dec 5, 2022

Uh oh!

SteveL-MSFT commented Dec 5, 2022

Uh oh!

ghost commented Dec 14, 2022

Uh oh!

daxian-dbw commented May 1, 2023

Uh oh!

SteveL-MSFT commented May 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

daxian-dbw left a comment

Choose a reason for hiding this comment

Uh oh!

pull-request-quantifier-deprecated bot commented Jun 19, 2023

What can I do to optimize my changes

How to interpret the change counts in git diff output

Uh oh!

ghost commented Jun 29, 2023

Uh oh!

God-damnit-all commented Jun 30, 2023

Uh oh!

TravisEz13 commented Jul 12, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TravisEz13 commented Sep 6, 2023

Uh oh!

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

Uh oh!

Uh oh!

God-damnit-all commented Sep 28, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

JamesWTruher commented Dec 1, 2022 •

edited by daxian-dbw

Loading

SteveL-MSFT commented Dec 2, 2022 •

edited

Loading

SteveL-MSFT commented May 10, 2023 •

edited

Loading

TravisEz13 commented Jul 12, 2023 •

edited

Loading

SteveL-MSFT commented Sep 7, 2023 •

edited

Loading