Use ArgumentException.ThrowIfNullOrEmpty() in more places by CarloToso · Pull Request #19213 · PowerShell/PowerShell

CarloToso · 2023-02-24T18:25:39Z

PR Summary

Use ArgumentException.ThrowIfNullOrEmpty(); where possible

PR Context

Contributes to #19212

PR Checklist

xtqqczze · 2023-02-24T20:07:01Z

@CarloToso Please rebase to remove changes in:

~~src/Microsoft.Management.UI.Internal (this module is frozen)~~
src/Microsoft.PowerShell.Commands.Management (changes are in Use ArgumentException.ThrowIfNullOrEmpty part 1 #19215)

I would also suggest in future making changes on a module-by module basis as this makes life easier for code reviewers.

xtqqczze · 2023-02-24T20:40:01Z

@daxian-dbw Can we make changes to Microsoft.Management.UI.Internal. Notably, #18784 made changes there.

Previous guidance has been the module is frozen, but we have not documented this in the repository.

daxian-dbw · 2023-02-24T22:00:16Z

For Microsoft.Management.UI.Internal, we ship it and own the code, so I think it's OK to make changes to it. But

for code that we don't build/ship (e.g. ScheduledJob, LocalAccounts), we should avoid changing it.
for the code that came from .NET (e.g. ComInterop), we should avoid changing it unless the original code in dotnet/runtime was also updated to use ArgumentException.ThrowIfNullOrEmpty.

xtqqczze · 2023-02-24T23:48:13Z

@CarloToso I see you have a few pull requests that have been open for some time. In the case of this PR, although it is marked as Small , the changes cover multiple modules, so it may take reviewers some time to review and approve the changes. If you would like, I can use git cherry-pick to split your contribution (preserving attribution).

xtqqczze · 2023-02-24T23:52:02Z

@CarloToso I could also document which changes are affected by the PowerShell breaking changes contract.

CarloToso · 2023-02-24T23:54:25Z

@xtqqczze Thank you very much, I'll gladly accept your help 😄

src/System.Management.Automation/utils/perfCounters/PSPerfCountersMgr.cs

iSazonov · 2023-02-25T15:10:15Z

For Microsoft.Management.UI.Internal, we ship it and own the code, so I think it's OK to make changes to it. But

for code that we don't build/ship (e.g. ScheduledJob, LocalAccounts), we should avoid changing it.

for the code that came from .NET (e.g. ComInterop), we should avoid changing it unless the original code in dotnet/runtime was also updated to use ArgumentException.ThrowIfNullOrEmpty.

Also WinRM code. Very sensitive.

src/Microsoft.Management.UI.Internal/ManagementList/Common/WpfHelp.cs

src/Microsoft.WSMan.Management/CurrentConfigurations.cs

src/Microsoft.Management.UI.Internal/ManagementList/FilterProviders/FilterRulePanelItem.cs

src/Microsoft.WSMan.Management/WsManHelper.cs

src/System.Management.Automation/cimSupport/cmdletization/ObjectModelWrapper.cs

daxian-dbw

LGTM

daxian-dbw · 2023-02-27T21:56:41Z

@CarloToso There is a legit test failure resulted by changing the exception type to be thrown, can you please update that test?

PSTests.Parallel.FileSystemProviderTests.TestCreateJunctionFails
Assert.Throws() Failure
Expected: typeof(System.ArgumentNullException)
Actual:   typeof(System.ArgumentException): The value cannot be an empty string. (Parameter 'path')
---- System.ArgumentException : The value cannot be an empty string. (Parameter 'path')

pull-request-quantifier-deprecated · 2023-02-27T22:15:49Z

This PR has 93 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       : +32 -61
Percentile : 37.2%

Total files changed: 21

Change summary by file extension:
.cs : +32 -61

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 · 2023-02-28T05:45:56Z

src/Microsoft.Management.UI.Internal/ManagementList/Common/WpfHelp.cs

-            {
-                throw new ArgumentNullException("childName");
-            }
+            ArgumentException.ThrowIfNullOrEmpty(childName);


Extra blank line 😄

@CarloToso you and I both missed this one ...

😅 (I fixed it in #19241)

Thank you! 😄

ghost · 2023-03-14T22:26:31Z

🎉v7.4.0-preview.2 has been released which incorporates this pull request.:tada:

Handy links:

Release Notes

5 files

e2c0848

ghost assigned iSazonov Feb 24, 2023

pull-request-quantifier-deprecated bot added the Extra Small label Feb 24, 2023

CarloToso added 2 commits February 24, 2023 19:31

8 files

532b7d7

6 files

d30aa17

pull-request-quantifier-deprecated bot added Small and removed Extra Small labels Feb 24, 2023

CarloToso marked this pull request as ready for review February 24, 2023 18:43

CarloToso requested review from PaulHigin, adityapatwardhan, anmenaga and daxian-dbw as code owners February 24, 2023 18:43

iSazonov added CL-BreakingChange Indicates that a PR should be marked as a breaking change in the Change Log CL-CodeCleanup Indicates that a PR should be marked as a Code Cleanup change in the Change Log labels Feb 24, 2023

1 file

4eef59d

xtqqczze mentioned this pull request Feb 24, 2023

Document which parts of the codebase are frozen #19220

Open

CarloToso added 2 commits February 24, 2023 23:29

Rebase cimQuery.cs @xtqqczze

bdd6754

separate the method calls with a blank line

8cbe758

iSazonov reviewed Feb 25, 2023

View reviewed changes

src/System.Management.Automation/utils/perfCounters/PSPerfCountersMgr.cs Outdated Show resolved Hide resolved

use nameof

69cefdd

iSazonov approved these changes Feb 26, 2023

View reviewed changes

iSazonov changed the title ~~ArgumentException.ThrowIfNullOrEmpty();~~ Use ArgumentException.ThrowIfNullOrEmpty() in more places Feb 26, 2023

daxian-dbw reviewed Feb 27, 2023

View reviewed changes

remove empty lines as suggested

e7efc17

daxian-dbw approved these changes Feb 27, 2023

View reviewed changes

Fix test

13699ab

daxian-dbw approved these changes Feb 27, 2023

View reviewed changes

daxian-dbw merged commit c48e5cb into PowerShell:master Feb 27, 2023

daxian-dbw removed the CL-BreakingChange Indicates that a PR should be marked as a breaking change in the Change Log label Feb 27, 2023

CarloToso deleted the ArgumentException.ThrowIfNullOrEmpty() branch February 27, 2023 22:48

iSazonov reviewed Feb 28, 2023

View reviewed changes

CarloToso mentioned this pull request Feb 28, 2023

Small style changes #19241

Merged

22 tasks

Conversation

CarloToso commented Feb 24, 2023

PR Summary

PR Context

PR Checklist

Uh oh!

xtqqczze commented Feb 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

xtqqczze commented Feb 24, 2023

Uh oh!

daxian-dbw commented Feb 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

xtqqczze commented Feb 24, 2023

Uh oh!

xtqqczze commented Feb 24, 2023

Uh oh!

CarloToso commented Feb 24, 2023

Uh oh!

Uh oh!

iSazonov commented Feb 25, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

daxian-dbw left a comment

Choose a reason for hiding this comment

Uh oh!

daxian-dbw commented Feb 27, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pull-request-quantifier-deprecated bot commented Feb 27, 2023

What can I do to optimize my changes

How to interpret the change counts in git diff output

Uh oh!

iSazonov Feb 28, 2023

Choose a reason for hiding this comment

Uh oh!

daxian-dbw Feb 28, 2023

Choose a reason for hiding this comment

Uh oh!

CarloToso Feb 28, 2023

Choose a reason for hiding this comment

Uh oh!

daxian-dbw Feb 28, 2023

Choose a reason for hiding this comment

Uh oh!

ghost commented Mar 14, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

xtqqczze commented Feb 24, 2023 •

edited

Loading

daxian-dbw commented Feb 24, 2023 •

edited

Loading

daxian-dbw commented Feb 27, 2023 •

edited

Loading