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

Treat [NullString]::Value as the string type when resolving methods #18080

Merged
merged 2 commits into from Sep 16, 2022

Conversation

daxian-dbw
Copy link
Member

PR Summary

Fix #18072
Treat [NullString]::Value as the string type when resolving methods.

PR Checklist

@pull-request-quantifier-deprecated

This PR has 59 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!


Quantification details

Label      : Small
Size       : +42 -17
Percentile : 23.6%

Total files changed: 3

Change summary by file extension:
.cs : +22 -17
.ps1 : +20 -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!

@daxian-dbw daxian-dbw added the CL-Engine Indicates that a PR should be marked as an engine change in the Change Log label Sep 13, 2022
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 notice.

Comment on lines +1704 to +1711
internal static Type GetObjectType(object obj, bool debase)
{
if (debase)
{
return typeof(LanguagePrimitives.Null);
obj = PSObject.Base(obj);
}

return obj == NullString.Value ? typeof(string) : obj?.GetType();
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is it really hot path code? If so we could think about more tier-compilation-friendly methods:

        internal static Type GetObjectTypeAfterDebase(object obj)
        {
            obj = PSObject.Base(obj);

            return obj == NullString.Value ? typeof(string) : obj?.GetType();
    }

        internal static Type GetObjectTypeWithoutDebase(object obj) => 
obj == NullString.Value ? typeof(string) : obj?.GetType();

Copy link
Contributor

Choose a reason for hiding this comment

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

I think I know C# pretty well but never considered it from performance side. In C++, this function would be almost guaranteed to be inlined and the if discarded or made unconditional. Is C#'s optimizer really not capable of it? Do you have some optimization guidelines I could read, e.g. when to use [AggressivelyInline] I saw in some WriteToConsole overloads?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Copy link
Member Author

Choose a reason for hiding this comment

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

This seems to be a micro-optimization that we should avoid, as I don't think the difference is measurable.

@daxian-dbw daxian-dbw merged commit 1a82574 into PowerShell:master Sep 16, 2022
@daxian-dbw daxian-dbw deleted the nullstring branch September 16, 2022 00:35
@TravisEz13 TravisEz13 mentioned this pull request Sep 30, 2022
22 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CL-Engine Indicates that a PR should be marked as an engine change in the Change Log Small
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Method overload resolution: [NullString]::Value doesn't guide toward picking a [string]-based overload
4 participants