Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 9 commits into from Jun 19, 2023
Merged

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

merged 9 commits into from Jun 19, 2023

Conversation

JamesWTruher
Copy link
Member

@JamesWTruher JamesWTruher commented Dec 1, 2022 •
edited by daxian-dbw

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
daxian-dbw requested changes Dec 2, 2022
View reviewed changes
Copy link
Member

@daxian-dbw daxian-dbw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

src/System.Management.Automation/engine/InitialSessionState.cs Outdated Show resolved Hide resolved
@msftbot msftbot bot 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
daxian-dbw requested changes Dec 2, 2022
View reviewed changes
Copy link
Member

@daxian-dbw daxian-dbw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 Outdated Show resolved Hide resolved
src/System.Management.Automation/engine/InitialSessionState.cs Outdated Show resolved Hide resolved
test/powershell/Language/Scripting/NativeExecution/NativeCommandArguments.Tests.ps1 Show resolved Hide resolved
@msftbot msftbot bot added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Dec 2, 2022
@msftbot msftbot bot removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Dec 2, 2022
@SteveL-MSFT
Copy link
Member

SteveL-MSFT commented Dec 2, 2022 •
edited

@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
Copy link
Member

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
Copy link
Member

@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

@JamesWTruher 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 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
@msftbot msftbot bot added the Review - Needed The PR is being reviewed label Dec 14, 2022
@msftbot
Copy link

msftbot bot commented Dec 14, 2022

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

@JamesWTruher 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 JamesWTruher mentioned this pull request Jan 24, 2023
Closed
2 tasks
@daxian-dbw daxian-dbw added the Review - Committee The PR/Issue needs a review from the PowerShell Committee label May 1, 2023
@daxian-dbw
Copy link
Member

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

@msftbot msftbot bot removed the Review - Needed The PR is being reviewed label May 1, 2023
@daxian-dbw daxian-dbw added the Needs-Triage The issue is new and needs to be triaged by a work group. label May 1, 2023
@SteveL-MSFT
Copy link
Member

SteveL-MSFT commented May 10, 2023 •
edited

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

@SteveL-MSFT 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
@StevenBucher98 StevenBucher98 added the PowerShell-Docs needed The PR was reviewed and a PowerShell Docs update is needed label May 15, 2023
@msftbot msftbot bot added the Review - Needed The PR is being reviewed label May 23, 2023
@msftbot
Copy link

msftbot bot commented May 23, 2023

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
daxian-dbw approved these changes Jun 19, 2023
View reviewed changes
Copy link
Member

@daxian-dbw daxian-dbw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@daxian-dbw 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
@pull-request-quantifier
Copy link

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? 👍  👌  👎 (Email)
Customize PullRequestQuantifier for this repository.

@daxian-dbw daxian-dbw merged commit 5437f38 into PowerShell:master Jun 19, 2023
40 checks passed
@daxian-dbw daxian-dbw mentioned this pull request Jun 23, 2023
Open
5 tasks
@msftbot
Copy link

msftbot bot commented Jun 29, 2023

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

Handy links:

@ImportTaste
Copy link

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@daxian-dbw daxian-dbw daxian-dbw approved these changes

@PaulHigin PaulHigin PaulHigin approved these changes

Assignees

@PaulHigin PaulHigin

Labels
Backport-7.3.x-Consider CL-Engine Indicates that a PR should be marked as an engine change in the Change Log Committee-Reviewed PS-Committee has reviewed this and made a decision Extra Small PowerShell-Docs needed The PR was reviewed and a PowerShell Docs update is needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@JamesWTruher @SteveL-MSFT @daxian-dbw @ImportTaste @PaulHigin @StevenBucher98