8000 Make experimental feature `PSAMSIMethodInvocationLogging` stable by SteveL-MSFT · Pull Request #18041 · PowerShell/PowerShell · GitHub
[go: up one dir, main page]
Skip to content

Make experimental feature PSAMSIMethodInvocationLogging stable #18041

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
Sep 12, 2022
Merged

Make experimental feature PSAMSIMethodInvocationLogging stable #18041

merged 1 commit into from
Sep 12, 2022

Conversation

SteveL-MSFT
Copy link
Member
@SteveL-MSFT SteveL-MSFT commented Sep 6, 2022 •
edited
Loading

PR Summary

PS-Committee reviewed this and agreed that based on validation by AMSI team, this feature is ready to be stable for 7.3

PR Context

Per #17962 making this feature non-experimental

PR Checklist

@ghost ghost assigned TravisEz13 Sep 6, 2022
PaulHigin
PaulHigin approved these changes Sep 6, 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.

LGTM

@iSazonov
Copy link
Collaborator
iSazonov commented Sep 7, 2022

Please look #18033 before merge.

@iSazonov iSazonov self-requested a review September 7, 2022 05:07
@PaulHigin PaulHigin self-requested a review September 7, 2022 16:13
@PaulHigin
Copy link
Contributor

@SteveL-MSFT I verified issue #18033, and we should address it before we make this feature non-experimental.

@iSazonov iSazonov marked this pull request as draft September 8, 2022 05:18
@iSazonov
Copy link
Collaborator
iSazonov commented Sep 8, 2022

Convert to draft until #18033

PaulHigin
PaulHigin approved these changes Sep 8, 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.

I don't think this needs to be a draft and that we can take this change now. We can address the #18033 issue separately.

@SteveL-MSFT SteveL-MSFT force-pushed the PSAMSIMethodInvocationLogging-stable branch from 4008cb9 to 7653de7 Compare September 8, 2022 19:12
@SteveL-MSFT SteveL-MSFT marked this pull request as ready for review September 8, 2022 19:12
@pull-request-quantifier-deprecated
Copy link

This PR has 27 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       : +10 -17
Percentile : 10.8%

Total files changed: 4

Change summary by file extension:
.json : +0 -2
.cs : +10 -15

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.

@iSazonov
Copy link
Collaborator
iSazonov commented Sep 9, 2022

Turns out it has a big negative impact on performance even if it is slightly improved in #18060>
In #18060 I made my arguments in more detail and I am against this feature.

daxian-dbw
daxian-dbw approved these changes Sep 12, 2022
View reviewed changes
Copy link
Member
@daxian-dbw daxian-dbw left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM
@iSazonov Please see #18060 (comment) for why to enable this feature.

@daxian-dbw daxian-dbw added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Sep 12, 2022
@daxian-dbw daxian-dbw assigned daxian-dbw and unassigned TravisEz13 Sep 12, 2022
@daxian-dbw daxian-dbw merged commit ce74696 into PowerShell:master Sep 12, 2022
@SteveL-MSFT SteveL-MSFT deleted the PSAMSIMethodInvocationLogging-stable branch September 12, 2022 20:22
@adityapatwardhan
Copy link
Member

/backport to release/v7.3.0-rc.1

@github-actions
Copy link
Contributor

@adityapatwardhan backporting to release/v7.3.0-rc.1 failed, the patch most likely resulted in conflicts:

$ git am --3way --ignore-whitespace --keep-non-patch changes.patch

Applying: Make experimental feature `PSAMSIMethodInvocationLogging` stable
Using index info to reconstruct a base tree...
M	experimental-feature-linux.json
M	experimental-feature-windows.json
M	src/System.Management.Automation/engine/ExperimentalFeature/ExperimentalFeature.cs
Falling back to patching base and 3-way merge...
Auto-merging src/System.Management.Automation/engine/ExperimentalFeature/ExperimentalFeature.cs
CONFLICT (content): Merge conflict in src/System.Management.Automation/engine/ExperimentalFeature/ExperimentalFeature.cs
Auto-merging experimental-feature-windows.json
Auto-merging experimental-feature-linux.json
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 Make experimental feature `PSAMSIMethodInvocationLogging` stable
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".
Error: The process '/usr/bin/git' failed with exit code 128

Please backport manually!

@adityapatwardhan
Copy link
Member

/backport to release/v7.3.0-rc.1

@github-actions
Copy link
Contributor

@adityapatwardhan backporting to release/v7.3.0-rc.1 failed, the patch most likely resulted in conflicts:

$ git am --3way --ignore-whitespace --keep-non-patch changes.patch

Applying: Make experimental feature `PSAMSIMethodInvocationLogging` stable
Using index info to reconstruct a base tree...
M	experimental-feature-linux.json
M	experimental-feature-windows.json
M	src/System.Management.Automation/engine/ExperimentalFeature/ExperimentalFeature.cs
Falling back to patching base and 3-way merge...
Auto-merging src/System.Management.Automation/engine/ExperimentalFeature/ExperimentalFeature.cs
CONFLICT (content): Merge conflict in src/System.Management.Automation/engine/ExperimentalFeature/ExperimentalFeature.cs
Auto-merging experimental-feature-windows.json
CONFLICT (content): Merge conflict in experimental-feature-windows.json
Auto-merging experimental-feature-linux.json
CONFLICT (content): Merge conflict in experimental-feature-linux.json
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 Make experimental feature `PSAMSIMethodInvocationLogging` stable
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".
Error: The process '/usr/bin/git' failed with exit code 128

Please backport manually!

adityapatwardhan pushed a commit to adityapatwardhan/PowerShell that referenced this pull request Sep 13, 2022
@SteveL-MSFT @adityapatwardhan
Make experimental feature PSAMSIMethodInvocationLogging stable (Pow…
ee32ce4 
…erShell#18041)
@adityapatwardhan adityapatwardhan mentioned this pull request Sep 13, 2022
Merged
22 tasks
daxian-dbw pushed a commit that referenced this pull request Sep 13, 2022
@adityapatwardhan
Make experimental feature PSAMSIMethodInvocationLogging stable (#18041
d1bd7eb 
) (#18083)
@ghost
Copy link
ghost commented Sep 20, 2022

🎉v7.3.0-preview.8 has been released which incorporates this pull request.:tada:

Handy links:

@michaeltlombardi michaeltlombardi mentioned this pull request Sep 21, 2022
Closed
2 tasks
@TravisEz13 TravisEz13 mentioned this pull request Sep 30, 2022
Merged
22 tasks
@KalleOlaviNiemitalo KalleOlaviNiemitalo mentioned this pull request Apr 17, 2024
Open
5 tasks
@rhubarb-geek-nz rhubarb-geek-nz mentioned this pull request May 8, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@daxian-dbw daxian-dbw daxian-dbw approved these changes

@PaulHigin PaulHigin PaulHigin approved these changes

@iSazonov iSazonov Awaiting requested review from iSazonov

Assignees

@daxian-dbw daxian-dbw

Labels
Backport-7.3.x-Done 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.
6 participants
@SteveL-MSFT @iSazonov @PaulHigin @adityapatwardhan @daxian-dbw @TravisEz13
0