Skip to content

Fix #20400, Start-Process with -NoNewWindow returns null ExitCode on Process object with -PassThru - #20749

Merged
Dongbo Wang (daxian-dbw) merged 5 commits into
PowerShell:masterfrom
CodeCyclone:dev/cc/startProcessNullExitCode
Dec 7, 2023
Merged

Fix #20400, Start-Process with -NoNewWindow returns null ExitCode on Process object with -PassThru#20749
Dongbo Wang (daxian-dbw) merged 5 commits into
PowerShell:masterfrom
CodeCyclone:dev/cc/startProcessNullExitCode

Conversation

@CodeCyclone

@CodeCyclone Chaz Beck (CodeCyclone) commented Nov 22, 2023 •
edited
Loading

Copy link
Copy Markdown
Contributor

PR Summary

Fixing issue #20400 along with some duplicates.

This issue was introduced by change #19096.
This change moved from .NET creating process objects to use P/Invoke (Windows APIs). The code would fetch the Process object from .NET but by design it throws an exception silently and ExitCode is null because it didn't handle spawning the process itself.

Calling the Handle property on the fetched Process will resolve ExitCode state because it fetches the underlying SafeHandle used to update the ExitCode property.

PR Context

When you call Start-Process with -NoNewWindow, ExitCode will be null. This breaks a lot of customers of PowerShell both internally and externally.

PR Checklist

@CodeCyclone
Update Process.cs to fix PowerShell#20400
d86c58f 
Fixing issue PowerShell#20400.

This issue was introduced by change PowerShell#19096.
This change moved from .NET creating process objects to use P/Invoke (Windows APIs). The code would fetch the Process object from .NET but by design it throws an exception silently and ExitCode is null because it didn't spawn the process.

Calling Handle property on the fetched Process will resolve ExitCode state because it fetches the underlying SafeHandle used to update the ExitCode property.
@iSazonov Ilya (iSazonov) added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Nov 22, 2023
@iSazonov

Ilya (iSazonov) commented Nov 22, 2023

Copy link
Copy Markdown
Collaborator

Chaz Beck (@CodeCyclone) Please add test(s) to avoid regressions.

SteveL-MSFT
Steve Lee (SteveL-MSFT) requested changes Nov 27, 2023
View reviewed changes

@SteveL-MSFT Steve Lee (SteveL-MSFT) left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Please add a test in https://github.com/PowerShell/PowerShell/blob/811efa46df822bf7be6179b6219f9f9d160eb7d5/test/powershell/Modules/Microsoft.PowerShell.Management/Start-Process.Tests.ps1

@microsoft-github-policy-service 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 Nov 27, 2023
@microsoft-github-policy-service 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 Nov 30, 2023
@CodeCyclone

Chaz Beck (CodeCyclone) commented Nov 30, 2023

Copy link
Copy Markdown
Contributor Author

Added test, addressed feedback on commenting change. Added more detail and referenced issue.
Screenshot of the test failing without my fix:
image

SteveL-MSFT
Steve Lee (SteveL-MSFT) approved these changes Dec 1, 2023
View reviewed changes

@SteveL-MSFT Steve Lee (SteveL-MSFT) left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

iSazonov
Ilya (iSazonov) reviewed Dec 1, 2023
View reviewed changes
Comment thread src/Microsoft.PowerShell.Commands.Management/commands/management/Process.cs Outdated
@CodeCyclone
Update Process.cs
d5b1928 
Removed referencing issue
@SteveL-MSFT Steve Lee (SteveL-MSFT) added the CommunityDay-Small A small PR that the PS team has identified to prioritize to review label Dec 6, 2023
daxian-dbw
Dongbo Wang (daxian-dbw) approved these changes Dec 7, 2023
View reviewed changes
Comment thread src/Microsoft.PowerShell.Commands.Management/commands/management/Process.cs Outdated
@pull-request-quantifier-deprecated

pull-request-quantifier-deprecated Bot commented Dec 7, 2023

Copy link
Copy Markdown

This PR has 4 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       : +4 -0
Percentile : 1.6%

Total files changed: 2

Change summary by file extension:
.cs : +1 -0
.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
Dongbo Wang (daxian-dbw) enabled auto-merge (squash) December 7, 2023 18:39
@daxian-dbw
Dongbo Wang (daxian-dbw) merged commit 3eda139 into PowerShell:master Dec 7, 2023
@microsoft-github-policy-service

microsoft-github-policy-service Bot commented Dec 7, 2023 •
edited by unfurl-links Bot
Loading

Copy link
Copy Markdown
Contributor

📣 Hey Chaz Beck (@CodeCyclone), how did we do? We would love to hear your feedback with the link below! 🗣️

🔗 https://forms.office.com/r/P926k48jRJ

Dongbo Wang (daxian-dbw) pushed a commit that referenced this pull request Dec 7, 2023
@CodeCyclone @daxian-dbw
Fix Start-Process -PassThru to make sure the ExitCode property is…
38cf1ea 
… accessible for the returned `Process` object (#20749)
@daxian-dbw Dongbo Wang (daxian-dbw) mentioned this pull request Dec 7, 2023
Merged
Dongbo Wang (daxian-dbw) added a commit that referenced this pull request Dec 8, 2023
@daxian-dbw
Fix Start-Process -PassThru to make sure the ExitCode property is…
851d21b 
… accessible for the returned `Process` object (#20749) (#20866)
Closed
5 tasks
@jborean93 Jordan Borean (jborean93) mentioned this pull request Mar 30, 2024
Merged
22 tasks
Chris Dent (chrisdent-de) pushed a commit to chrisdent-de/PowerShell that referenced this pull request Sep 12, 2024
@CodeCyclone @chrisdent-de
Fix Start-Process -PassThru to make sure the ExitCode property is…
91f94ec 
… accessible for the returned `Process` object (PowerShell#20749)
@jshigetomi Justin Chung (jshigetomi) mentioned this pull request Jan 21, 2025
Merged
21 tasks
@coderabbitai coderabbitai Bot mentioned this pull request Aug 3, 2026
Closed
Thatgfsj (Thatgfsj) pushed a commit to Thatgfsj/PowerShell that referenced this pull request Aug 6, 2026
@CodeCyclone
Fix Start-Process -PassThru to make sure the ExitCode property is…
a71d0aa 
… accessible for the returned `Process` object (PowerShell#20749)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@iSazonov Ilya (iSazonov) iSazonov left review comments
@daxian-dbw Dongbo Wang (daxian-dbw) daxian-dbw approved these changes
@SteveL-MSFT Steve Lee (SteveL-MSFT) SteveL-MSFT approved these changes
@adityapatwardhan Aditya Patwardhan (adityapatwardhan) Awaiting requested review from adityapatwardhan
+1 more reviewer
@jborean93 Jordan Borean (jborean93) jborean93 left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@daxian-dbw Dongbo Wang (daxian-dbw)

Labels

Backport-7.4.x-Done CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log CommunityDay-Small A small PR that the PS team has identified to prioritize to review Extra Small

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@CodeCyclone @iSazonov @daxian-dbw @jborean93 @SteveL-MSFT @TravisEz13