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.

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

Make PowerShell class not affiliate with Runspace when declaring the NoRunspaceAffinity attribute #18138

Merged
merged 4 commits into from
Sep 22, 2022
Merged

Make PowerShell class not affiliate with Runspace when declaring the NoRunspaceAffinity attribute #18138

merged 4 commits into from
Sep 22, 2022

Conversation

daxian-dbw
Copy link
Member

@daxian-dbw daxian-dbw commented Sep 20, 2022 •
edited
Loading

PR Summary

Fix #12801

Make PowerShell class not affiliate with Runspace when declaring the NoRunspaceAffinity attribute.

By default, a PowerShell class is affiliated with the Runspace where it's created. This makes it not work in a parallel workflow, such as ForEach-Object -Parallel -- method invocations on the class would be marshalled back to the Runspace it was created, which could cause corruption to the state of that Runsapce or a deadlock. See #4003 and #3651 for examples.

With this PR, if the attribute NoRunspaceAffinity is declared for a PowerShell class, then the PowerShell class will not be affiliated with a particular Runspace/SessionState, and its method invocation (both instance and static) will use the default Runspace of the running thread and its current session state.

Of course, once declaring the attribute to the class, the class implementation should not depend on any states of a particular session state, because there is no guarantee the dependencies would be available at runtime.

PR Checklist

@ghost ghost assigned TravisEz13 Sep 20, 2022
@daxian-dbw daxian-dbw assigned daxian-dbw and unassigned TravisEz13 Sep 20, 2022
PaulHigin
PaulHigin approved these changes Sep 20, 2022
View reviewed changes
Copy link
Contributor

@PaulHigin PaulHigin left a comment

Choose a reason for hiding this comment

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

Changes look good except for test typo. Please create a document issue for this new attribute, that will describe what it does and possible consequences for using it.

test/powershell/Language/Parser/TypeAccelerator.Tests.ps1 Outdated Show resolved Hide resolved
@daxian-dbw daxian-dbw mentioned this pull request Sep 20, 2022
Closed
2 tasks
@daxian-dbw
Copy link
Member Author

Thanks @PaulHigin, the doc issue was opened: MicrosoftDocs/PowerShell-Docs#9231.

iSazonov
iSazonov approved these changes Sep 21, 2022
View reviewed changes
Copy link
Collaborator

@iSazonov iSazonov left a comment

Choose a reason for hiding this comment

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

LGTM with one minor question.

src/System.Management.Automation/engine/parser/PSType.cs Show resolved Hide resolved
@iSazonov iSazonov added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Sep 21, 2022
SeeminglyScience
SeeminglyScience approved these changes Sep 21, 2022
View reviewed changes
Copy link
Collaborator

@SeeminglyScience SeeminglyScience left a comment

Choose a reason for hiding this comment

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

LGTM! This adds a very clean option here ❤️ love it

One very skippable suggestion

test/powershell/Language/Classes/Scripting.Classes.NoRunspaceAffinity.Tests.ps1 Outdated Show resolved Hide resolved
@pull-request-quantifier-deprecated
Copy link

This PR has 50 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       : +46 -4
Percentile : 20%

Total files changed: 6

Change summary by file extension:
.cs : +6 -2
.ps1 : +40 -2

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 merged commit 79b8140 into PowerShell:master Sep 22, 2022
@daxian-dbw daxian-dbw deleted the class-2 branch September 22, 2022 17:49
@TravisEz13 TravisEz13 mentioned this pull request Sep 30, 2022
Merged
22 tasks
@SeeminglyScience SeeminglyScience mentioned this pull request Oct 10, 2022
Closed
5 tasks
@fatherofinvention fatherofinvention mentioned this pull request May 31, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@PaulHigin PaulHigin PaulHigin approved these changes

@iSazonov iSazonov iSazonov approved these changes

@SeeminglyScience SeeminglyScience SeeminglyScience approved these changes

@SteveL-MSFT SteveL-MSFT Awaiting requested review from SteveL-MSFT

Assignees

@daxian-dbw daxian-dbw

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

ForEach-Object -Parallel situationally drops pipeline input
5 participants
@daxian-dbw @PaulHigin @iSazonov @SeeminglyScience @TravisEz13