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

Register the assembly/library resolvers at early stage #21361

Merged
merged 3 commits into from Mar 21, 2024

Conversation

daxian-dbw
Copy link
Member

@daxian-dbw daxian-dbw commented Mar 21, 2024

PR Summary

Fix #20740, Fix #21319

This is an unexpected regression caused by #18356, specifically this line of change in ExternalScriptInfo.
The native lib resolver and GAC assembly resolvers are registered within the static constructor of ClrFacade, and that change reduced the reference surface of ClrFacade, which caused them to not be registered when running pwsh -exe bypass -nop -c "ipmo pki".

The fix is to do the registration to an early stage. PowerShellAssemblyLoadContext.InitializeSingleton(string.Empty) is added to the static constructor of RunspaceBase, which will run as soon as anything in the startup code path references LocalRunspace or RunspaceBase. This is to make sure we register the resolvers before PowerShell is ready to run any scripts/cmdlets.

However, we still need to keep the singleton initialization in ClrFacade because ClrFacade can be used without a Runspace created, for example, by calling the type conversion methods in LanguagePrimitive. So, we attempt to do the singleton initialization at both places.

Many thanks to @SeeminglyScience for the help in investigation and validation.

PR Checklist

@daxian-dbw daxian-dbw self-assigned this Mar 21, 2024
@daxian-dbw daxian-dbw added the CL-Engine Indicates that a PR should be marked as an engine change in the Change Log label Mar 21, 2024

This PR has 14 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       : +11 -3
Percentile : 5.6%

Total files changed: 3

Change summary by file extension:
.cs : +3 -3
.ps1 : +8 -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.

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!

Copy link
Member

@SteveL-MSFT SteveL-MSFT 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 comment was marked as outdated.

1 similar comment

This comment was marked as outdated.

Copy link
Member

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

can you think of a way to tickle this to validate the throw behavior?I'm not sure it can be done easily without a hosting scenario, but I wonder if we should. This isn't blocking or imperative for this PR, but I wonder if it would be useful.

@daxian-dbw
Copy link
Member Author

@JamesWTruher It's easy to validate the throw-on-reentry behavior. The method PowerShellAssemblyLoadContextInitializer.SetPowerShellAssemblyLoadContext is intended to be called by a native host, but it can be called from within PowerShell too:

image

@daxian-dbw daxian-dbw merged commit ad7278b into PowerShell:master Mar 21, 2024
37 of 38 checks passed
@daxian-dbw daxian-dbw deleted the register branch March 21, 2024 23:25
Copy link
Contributor

microsoft-github-policy-service bot commented Mar 21, 2024

📣 Hey @daxian-dbw, how did we do? We would love to hear your feedback with the link below! 🗣️

🔗 https://aka.ms/PSRepoFeedback

Copy link

@Moazzem-Hossain-pixel Moazzem-Hossain-pixel left a comment

Choose a reason for hiding this comment

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

Thanks for your contributions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
BackPort-7.4.x-Done CL-Engine Indicates that a PR should be marked as an engine change in the Change Log Extra Small
Projects
None yet
6 participants