Skip to content

Fix race condition between DisconnectAsync and Dispose#16536

Merged
iSazonov merged 4 commits intoPowerShell:masterfrom
i3arnon:dispose-race
Dec 2, 2021
Merged

Fix race condition between DisconnectAsync and Dispose#16536
iSazonov merged 4 commits intoPowerShell:masterfrom
i3arnon:dispose-race

Conversation

@i3arnon
Copy link
Copy Markdown
Contributor

@i3arnon i3arnon commented Dec 1, 2021

PR Summary

Make StartDisconnectAsync running on a background thread able to run after Dispose has been invoked.

PR Context

There is an inherent race condition in offloading to the ThreadPool.
Dispose can run before RemoteSession.DisconnectAsync.
This will result in an NRE inside ClientRemoteSession.
An unhandled exception in a ThreadPool thread crashes the process.

PR Checklist

There is an inherent race condition in offloading to the ThreadPool.
Dispose can run before RemoteSession.DisconnectAsync.
This will result in an NRE inside ClientRemoteSession.
An unhandled exception in a ThreadPool thread crashes the process.
@iSazonov iSazonov closed this Dec 1, 2021
@iSazonov iSazonov reopened this Dec 1, 2021
Comment thread src/System.Management.Automation/engine/remoting/client/RemotingProtocol2.cs Outdated
@ghost ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Dec 1, 2021
…ngProtocol2.cs

Co-authored-by: Paul Higinbotham <paulhi@microsoft.com>
@ghost ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Dec 1, 2021
@i3arnon i3arnon requested a review from PaulHigin December 1, 2021 18:51
Comment thread src/System.Management.Automation/engine/remoting/client/RemotingProtocol2.cs Outdated
@iSazonov iSazonov added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Dec 2, 2021
@pull-request-quantifier-deprecated
Copy link
Copy Markdown

This PR has 9 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       : +6 -3
Percentile : 3.6%

Total files changed: 1

Change summary by file extension:
.cs : +6 -3

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 detetcted.
  • 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
Copy link
Copy Markdown

ghost commented Dec 2, 2021

CLA assistant check
All CLA requirements met.

@i3arnon i3arnon requested a review from iSazonov December 2, 2021 11:08
@iSazonov iSazonov merged commit 1920b1b into PowerShell:master Dec 2, 2021
@iSazonov
Copy link
Copy Markdown
Collaborator

iSazonov commented Dec 2, 2021

@i3arnon Thanks for your contribution!

@ghost
Copy link
Copy Markdown

ghost commented Dec 16, 2021

🎉v7.3.0-preview.1 has been released which incorporates this pull request.:tada:

Handy links:

@i3arnon i3arnon deleted the dispose-race branch December 17, 2021 21:41
TrapGodBrim pushed a commit to TrapGodBrim/PowerShell that referenced this pull request Jan 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants