Skip to content

Improve .NET overload definition of generics #21326

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
Merged
merged 1 commit into from
Jul 1, 2024
Merged

Improve .NET overload definition of generics #21326

merged 1 commit into from
Jul 1, 2024

Conversation

jborean93
Copy link
Collaborator

PR Summary

This change ensures that generic methods created with MakeGenericMethod() will include the generic type information in the overload definition string so that consumers can easily see it is from a generic overload rather than another overload.

PR Context

This is related to #21320 where I found that doing [System.Runtime.InteropServices.Marshal]::SizeOf([int]) was selecting the SizeOf<T>() overload but as the output from GetMethodInfoOverloadDefinition() didn't include the generic type block it was hard to determine the overload chosen was this. This PR aligns the behaviour with other generic types.

Using the following, this is what this PR changes:

Add-Type -TypeDefinition @"
using System.Management.Automation;

namespace TestCodeMethodDefinition;

public static class TestClass1
{
    public static T Generic1<T>(PSObject obj, T val) => val;

    public static T1 Generic2<T1, T2>(PSObject obj, T1 val, T2 dummy) => val;
}
"@

$mi1 = [TestCodeMethodDefinition.TestClass1].GetMethod("Generic1")
$mi2 = [TestCodeMethodDefinition.TestClass1].GetMethod("Generic2")
$obj = [PSCustomObject]@{}
$obj | Add-Member -MemberType CodeMethod -Name FromGeneric1 -Value $mi1.MakeGenericMethod(@([int]))
$obj | Add-Member -MemberType CodeMethod -Name FromGeneric2 -Value $mi2.MakeGenericMethod(@([string], [int]))

$obj.FromGeneric1.OverloadDefinitions
$obj.FromGeneric2.OverloadDefinitions

# Before
static int Generic1(psobject obj, int val)
static string Generic2(psobject obj, string val, int dummy)

# After
static int Generic1[int](psobject obj, int val)
static string Generic2[string, int](psobject obj, string val, int dummy)

PR Checklist

@pull-request-quantifier-deprecated Pull Request Quantifier (deprecated)
Copy link

This PR has 30 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       : +29 -1
Percentile : 12%

Total files changed: 2

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

@microsoft-github-policy-service microsoft-github-policy-service bot added the Review - Needed The PR is being reviewed label Mar 18, 2024
@jborean93 jborean93 force-pushed the overload-generics branch from fd5b892 to ad04d27 Compare May 23, 2024 22:42
@jborean93
Improve .NET overload definition of generics
ad04d27 
This change ensures that generic methods created with
MakeGenericMethod() will include the generic type information in the
overload definition string so that consumers can easily see it is from
a generic overload rather than another overload.
@daxian-dbw daxian-dbw added WG-Engine core PowerShell engine, interpreter, and runtime WG-NeedsReview Needs a review by the labeled Working Group labels Jun 10, 2024
@rkeithhill rkeithhill self-assigned this Jun 24, 2024
@rkeithhill rkeithhill removed WG-NeedsReview Needs a review by the labeled Working Group labels Jun 24, 2024
@rkeithhill
Copy link
Collaborator

rkeithhill commented Jun 25, 2024 •
edited
Loading

The Engine WG discussed this today and agrees with the change/enhancement. There's a small possibility of a breaking change if folks are parsing the text returned from OverloadDefinitions in the generic method case, but not large enough to hold back this PR.

@rkeithhill rkeithhill removed their assignment Jun 25, 2024
@rkeithhill rkeithhill added the WG-Reviewed A Working Group has reviewed this and made a recommendation label Jun 25, 2024
SeeminglyScience
SeeminglyScience approved these changes Jun 28, 2024
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! Thanks Jordan! ❤️

@daxian-dbw daxian-dbw merged commit ab43c19 into PowerShell:master Jul 1, 2024
@microsoft-github-policy-service Microsoft GitHub Policy Service
Copy link
Contributor

microsoft-github-policy-service bot commented Jul 1, 2024 •
edited by unfurl-links bot
Loading

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

🔗 https://aka.ms/PSRepoFeedback

@microsoft-github-policy-service microsoft-github-policy-service bot removed the Review - Needed The PR is being reviewed label Jul 1, 2024
@jborean93 jborean93 deleted the overload-generics branch July 7, 2024 19:38
@SeeminglyScience SeeminglyScience added the CL-Engine Indicates that a PR should be marked as an engine change in the Change Log label Aug 20, 2024
chrisdent-de pushed a commit to chrisdent-de/PowerShell that referenced this pull request Sep 12, 2024
@jborean93 @chrisdent-de
Improve .NET overload definition of generic methods (PowerShell#21326)
a83d6e9
@jborean93 jborean93 mentioned this pull request Jul 15, 2025
Open
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@SeeminglyScience SeeminglyScience SeeminglyScience approved these changes

Assignees
No one assigned
Labels
CL-Engine Indicates that a PR should be marked as an engine change in the Change Log Extra Small WG-Engine core PowerShell engine, interpreter, and runtime WG-Reviewed A Working Group has reviewed this and made a recommendation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@jborean93 @rkeithhill @SeeminglyScience @daxian-dbw