Adds a new trace source called MethodInvocation which can be used to trace what .NET methods PowerShell invokes. This is useful for both seeing what .NET methods the code is calling but also for seeing what overload PowerShell has selected based on the arguments provided.

This only applies to .NET methods, ETS members are not covered by this trace source but could potentially be added in the future.

PR Context

To be able to debug PowerShell behaviour like why" ".Split(" ") has changed across .NET versions. Also provides an analogue ofParameterBinding but for .NET methods.

For example

Trace-Command-PSHost-NameMethodInvocation-Expression {"abcdefghi".Split("", 2)}

Shows

DEBUG: 2024-03-08 12:05:54.6860 MethodInvocation Information: 0 : Invoking method: string[] Split(string separator, int count, System.StringSplitOptions options = System.StringSplitOptions.None)

PR Checklist

PR has a meaningful title
- Use the present tense and imperative mood when describing your changes
Summarized changes
Make sure all.h,.cpp,.cs,.ps1 and.psm1 files have the correct copyright header
This PR is ready to merge and is notWork in Progress.
- If the PR is work in progress, please add the prefixWIP: or[ WIP ] to the beginning of the title (theWIP bot will keep its status check atPending while the prefix is present) and remove the prefix when the PR is ready.
Breaking changes
- None
- OR
- Experimental feature(s) needed
  - Experimental feature name(s):
User-facing changes
- Not Applicable
- OR
- Documentation needed
  - Issue filed:
Testing - New and feature
- N/A or can only be tested interactively
- OR
- Make sure you've added a new test if existing tests do not effectively test the code changed
Tooling
- I have considered the user experience from a tooling perspective and don't believe tooling will be impacted.
- OR
- I have considered the user experience from a tooling perspective and opened an issue in the relevant tool repository. This may include:
  - Impact onPowerShell Editor Services which is used in thePowerShell extension for VSCode
    (which runs in a different PS Host).
    - Issue filed:
  - Impact on Completions (both in the console and in editors) - one of PowerShell's most powerful features.
    - Issue filed:
  - Impact onPSScriptAnalyzer (which provides linting & formatting in the editor extensions).
    - Issue filed:
  - Impact onEditorSyntax (which provides syntax highlighting with in VSCode, GitHub, and many other editors).
    - Issue filed:

jborean93 requested a review fromdaxian-dbw as acode owner

March 8, 2024 01:56

pull-request-quantifier-deprecatedbot added the Medium label

Mar 8, 2024

Copy link

pull-request-quantifier-deprecatedbot commentedMar 8, 2024

This PR has111 quantified lines of changes. In general, a change size of upto200 lines is ideal for the best PR experience!

Quantification details

Label      : MediumSize       : +111 -0Percentile : 42.2%Total files changed: 3Change summary by file extension:.cs : +16 -0.ps1 : +95 -0

Change counts above are quantified counts, based on thePullRequestQuantifier 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 thecontext 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 theExcluded section from yourprquantifier.yaml context profile.
- Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in yourprquantifier.yaml context profile.
- Only use the labels that matter to you,see context specification to customize yourprquantifier.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.

jborean93 force-pushed themethod-invocation branch froma37cc7e tob041aa8Compare

March 8, 2024 02:00

Copy link

pull-request-quantifier-deprecatedbot commentedMar 8, 2024

This PR has113 quantified lines of changes. In general, a change size of upto200 lines is ideal for the best PR experience!

Quantification details

Label      : MediumSize       : +113 -0Percentile : 42.6%Total files changed: 3Change summary by file extension:.cs : +16 -0.ps1 : +97 -0

Change counts above are quantified counts, based on thePullRequestQuantifier customizations.

Why proper sizing of changes matters

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 thecontext 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 theExcluded section from yourprquantifier.yaml context profile.
- Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in yourprquantifier.yaml context profile.
- Only use the labels that matter to you,see context specification to customize yourprquantifier.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.

jborean93 mentioned this pull request

Mar 10, 2024

Improve .NET overload definition of generics#21326

Merged

22 tasks

microsoft-github-policy-servicebot added the Review - NeededThe PR is being reviewed label

Mar 15, 2024

jborean93 force-pushed themethod-invocation branch fromb041aa8 to07d6f4eCompare

May 23, 2024 22:41

jborean93 force-pushed themethod-invocation branch from07d6f4e to25b209aCompare

July 7, 2024 22:18

kilasuit added WG-Interactive-Debugging

debugging PowerShell script

WG-Cmdlets-Utility

cmdlets in the Microsoft.PowerShell.Utility module

WG-NeedsReviewNeeds a review by the labeled Working Group labels

Jul 26, 2024

kilasuit approved these changes

Jul 26, 2024

View reviewed changes

Copy link

Collaborator

kilasuit left a comment

Choose a reason for hiding this comment

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

I think this looks good and would be a great help in script debugging & would be good to get this merged in!

Copy link

Member

SteveL-MSFT commentedAug 21, 2024

The @PowerShell/wg-powershell-cmdlets discussed this, we are in favor of adding more diagnosability to PowerShell, but defer to the Engine WG to review.

SteveL-MSFT added WG-Enginecore PowerShell engine, interpreter, and runtime and removed WG-Interactive-Debugging

debugging PowerShell script

WG-Cmdlets-Utilitycmdlets in the Microsoft.PowerShell.Utility module labels

Aug 21, 2024

microsoft-github-policy-servicebot removed the Review - NeededThe PR is being reviewed label

Aug 21, 2024

microsoft-github-policy-servicebot added the Review - NeededThe PR is being reviewed label

Aug 28, 2024

jborean93 force-pushed themethod-invocation branch from25b209a to2e67e70Compare

September 2, 2024 02:36

jborean93 force-pushed themethod-invocation branch from2e67e70 to357fb02Compare

October 4, 2024 00:46

iSazonov approved these changes

Oct 4, 2024

View reviewed changes

IISResetMe self-assigned this

Feb 10, 2025

IISResetMe added WG-ReviewedA Working Group has reviewed this and made a recommendation and removed WG-NeedsReviewNeeds a review by the labeled Working Group labels

Feb 10, 2025

Copy link

Collaborator

IISResetMe commentedFeb 10, 2025

WG-Engine reviewed this PR, and we endorse the proposed new trace source.

IISResetMe removed their assignment

Feb 10, 2025

powercode removed the Review - NeededThe PR is being reviewed label

Feb 12, 2025

microsoft-github-policy-servicebot added the Review - NeededThe PR is being reviewed label

Feb 19, 2025

iSazonov requested a review fromSeeminglyScience

February 20, 2025 03:48

iSazonov added PowerShell-Docs neededThe PR was reviewed and a PowerShell Docs update is needed and removed PowerShell-Docs neededThe PR was reviewed and a PowerShell Docs update is needed labels

Feb 20, 2025

microsoft-github-policy-servicebot removed the Review - NeededThe PR is being reviewed label

Feb 20, 2025

microsoft-github-policy-servicebot added the Review - NeededThe PR is being reviewed label

Feb 27, 2025

jborean93 added2 commits

April 14, 2025 04:48

Add MethodInvocation trace for overload tracing

cc0abaa

Adds a new trace source called MethodInvocation which can be used totrace what .NET methods PowerShell invokes. This is useful for bothseeing what .NET methods the code is calling but also for seeing whatoverload PowerShell has selected based on the arguments provided.This only applies to .NET methods, ETS members are not covered by thistrace source but could potentially be added in the future.

Update expectations after overload method string change

d1facfe

jborean93 force-pushed themethod-invocation branch from357fb02 tod1facfeCompare

April 13, 2025 18:51

jborean93 mentioned this pull request

Apr 13, 2025

Using[System.String]::Join($null, ...) joins with\0 rather than a truly null value.#25351

Closed

5 tasks

iSazonov added the CL-GeneralIndicates that a PR should be marked as a general cmdlet change in the Change Log label

Apr 14, 2025

Tadas mentioned this pull request

Apr 23, 2025

Add tests for overloads changed in .Netjanestreet/PS7CompatibilityRules#1

Open

daxian-dbw approved these changes

Jul 14, 2025

View reviewed changes

Copy link

Member

daxian-dbw left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you,@jborean93!

Merge branch 'master' into method-invocation

c0a8358

SeeminglyScience approved these changes

Jul 14, 2025

View reviewed changes

Copy link

Collaborator

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 merged commitc6329dd intoPowerShell:master

Jul 14, 2025

34 checks passed

daxian-dbw removed Review - Needed

The PR is being reviewed

Medium labels

Jul 14, 2025

daxian-dbw moved this toDone inPowerShell Team Reviews/Investigations

Jul 14, 2025

daxian-dbw added this toPowerShell Team Reviews/Investigations

Jul 14, 2025

daxian-dbw self-assigned this

Jul 14, 2025

jborean93 deleted the method-invocation branch

July 14, 2025 22:45

jborean93 mentioned this pull request

Jul 15, 2025

Add docs for new .NET MethodInvocation tracingMicrosoftDocs/PowerShell-Docs#12226

Open

4 tasks

Copy link

CollaboratorAuthor

jborean93 commentedJul 15, 2025

Thanks for the review and merge, I've opened a PR to document this new featureMicrosoftDocs/PowerShell-Docs#12226. Up to the docs gods to make it prettier and more presentable.