Skip to content

Fix Switch-Process to copy the current env to the new process #18452

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.

Sign up for GitHub

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
Merged
daxian-dbw merged 2 commits into from
Nov 7, 2022
Merged

Fix Switch-Process to copy the current env to the new process #18452

daxian-dbw merged 2 commits into from
Nov 7, 2022

Conversation

@SteveL-MSFT
Copy link
Member

@SteveL-MSFT SteveL-MSFT commented Nov 3, 2022 •
edited
Loading

PR Summary

The execv() API is documented to copy the env to the new process, but doesn't do that. Apparently it requires use of a global variable in C. Switch to execve() and manually copy the current env to the new process.

PR Context

Fix #18432

PR Checklist

@ghost ghost assigned anmenaga Nov 3, 2022
@SteveL-MSFT SteveL-MSFT mentioned this pull request Nov 3, 2022
Closed
2 tasks
@iSazonov
Copy link
Collaborator

iSazonov commented Nov 3, 2022 •
edited
Loading

It seems bug in .Net. They cache env variables https://github.com/dotnet/runtime/blob/9b9aeafbecbdae09dbcad7110d9d38ee04138d5b/src/libraries/System.Private.CoreLib/src/System/Environment.Variables.Unix.cs#L38 but don't update environ if an env variable is changed.

GitHub
.NET is a cross-platform runtime for cloud, mobile, desktop, and IoT apps. - runtime/Environment.Variables.Unix.cs at 9b9aeafbecbdae09dbcad7110d9d38ee04138d5b · dotnet/runtime

JamesWTruher
JamesWTruher approved these changes Nov 4, 2022
View reviewed changes
Copy link
Collaborator

@JamesWTruher JamesWTruher left a comment

Choose a reason for hiding this comment

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

LGTM

@pull-request-quantifier-deprecated
Copy link

pull-request-quantifier-deprecated bot commented Nov 4, 2022

This PR has 16 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 -3
Percentile : 6.4%

Total files changed: 2

Change summary by file extension:
.cs : +10 -3
.ps1 : +3 -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 daxian-dbw added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Nov 7, 2022
@daxian-dbw daxian-dbw merged commit 0ddf89e into PowerShell:master Nov 7, 2022
@SteveL-MSFT SteveL-MSFT deleted the switchprocess-env branch November 7, 2022 19:13
@daxian-dbw daxian-dbw assigned daxian-dbw and unassigned anmenaga Nov 8, 2022
@TravisEz13
Copy link
Member

TravisEz13 commented Nov 15, 2022

/backport to release/v7.3.1

@github-actions
Copy link
Contributor

github-actions bot commented Nov 15, 2022

@TravisEz13 backporting to release/v7.3.1 failed, the patch most likely resulted in conflicts:

$ git am --3way --ignore-whitespace --keep-non-patch changes.patch

Applying: Fix `Switch-Process` to copy the current env to the new process
Using index info to reconstruct a base tree...
M	src/System.Management.Automation/engine/Modules/SwitchProcessCommand.cs
M	test/powershell/Modules/Microsoft.PowerShell.Core/Exec.Tests.ps1
Falling back to patching base and 3-way merge...
Auto-merging test/powershell/Modules/Microsoft.PowerShell.Core/Exec.Tests.ps1
CONFLICT (content): Merge conflict in test/powershell/Modules/Microsoft.PowerShell.Core/Exec.Tests.ps1
Auto-merging src/System.Management.Automation/engine/Modules/SwitchProcessCommand.cs
CONFLICT (content): Merge conflict in src/System.Management.Automation/engine/Modules/SwitchProcessCommand.cs
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 Fix `Switch-Process` to copy the current env to the new process
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".
Error: The process '/usr/bin/git' failed with exit code 128

Please backport manually!

TravisEz13 pushed a commit to TravisEz13/PowerShell that referenced this pull request Nov 21, 2022
@SteveL-MSFT @TravisEz13
Fix Switch-Process to copy the current env to the new process (Powe…
e98d165 
…rShell#18452)
@TravisEz13 TravisEz13 mentioned this pull request Nov 21, 2022
Closed
@TravisEz13
Copy link
Member

TravisEz13 commented Nov 21, 2022

/backport to release/v7.3.1

@github-actions
Copy link
Contributor

github-actions bot commented Nov 21, 2022

@TravisEz13 backporting to release/v7.3.1 failed, the patch most likely resulted in conflicts:

$ git am --3way --ignore-whitespace --keep-non-patch changes.patch

Applying: Fix `Switch-Process` to copy the current env to the new process
Using index info to reconstruct a base tree...
M	src/System.Management.Automation/engine/Modules/SwitchProcessCommand.cs
M	test/powershell/Modules/Microsoft.PowerShell.Core/Exec.Tests.ps1
Falling back to patching base and 3-way merge...
Auto-merging test/powershell/Modules/Microsoft.PowerShell.Core/Exec.Tests.ps1
CONFLICT (content): Merge conflict in test/powershell/Modules/Microsoft.PowerShell.Core/Exec.Tests.ps1
Auto-merging src/System.Management.Automation/engine/Modules/SwitchProcessCommand.cs
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 Fix `Switch-Process` to copy the current env to the new process
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".
Error: The process '/usr/bin/git' failed with exit code 128

Please backport manually!

@TravisEz13 TravisEz13 mentioned this pull request Nov 21, 2022
Merged
TravisEz13 pushed a commit to TravisEz13/PowerShell that referenced this pull request Nov 21, 2022
@SteveL-MSFT @TravisEz13
Fix Switch-Process to copy the current env to the new process (Powe…
06745b1 
…rShell#18452)
TravisEz13 added a commit that referenced this pull request Nov 21, 2022
@TravisEz13 @SteveL-MSFT
[release/v7.3.1] Fix Switch-Process to copy the current env to the ne…
15666cf 
…w process (#18632)

* Fix `Switch-Process` to copy the current env to the new process (#18452)

* Update test/powershell/Modules/Microsoft.PowerShell.Core/Exec.Tests.ps1

Co-authored-by: Steve Lee <slee@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@iSazonov iSazonov iSazonov approved these changes

+1 more reviewer

@JamesWTruher JamesWTruher JamesWTruher approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@daxian-dbw daxian-dbw

Labels

Backport-7.3.x-Done CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Extra Small

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Switch-Process (exec) fails to make the replacement process inherit the calling process' environment variables

6 participants

@SteveL-MSFT @iSazonov @TravisEz13 @JamesWTruher @daxian-dbw @anmenaga