X Tutup
Skip to content

Use ArgumentException.ThrowIfNullOrEmpty part 1#19215

Merged
daxian-dbw merged 3 commits intoPowerShell:masterfrom
xtqqczze:string-IsNullOrWhiteSpace-p1
Feb 28, 2023
Merged

Use ArgumentException.ThrowIfNullOrEmpty part 1#19215
daxian-dbw merged 3 commits intoPowerShell:masterfrom
xtqqczze:string-IsNullOrWhiteSpace-p1

Conversation

@xtqqczze
Copy link
Copy Markdown
Contributor

@xtqqczze xtqqczze commented Feb 24, 2023 •
edited
Loading

Use ArgumentException.ThrowIfNullOrEmpty in Microsoft.PowerShell.Commands.Management.

Contributes to #19212.

Changes

  • Throws ArgumentException instead of ArgumentNullException when a string is empty.
    • Possible breaking change as ArgumentException is a less derived type.
  • Throws ArgumentNullException instead of ArgumentException when a string is null.
    • Clearly non-breaking as ArgumentNullException is a more derived type.

Breaking changes contract

Bucket 4: Clearly Non-Public

  • Modifies internal class Microsoft.PowerShell.Cmdletization.Cim.CimQuery
  • Modifies internal class Microsoft.PowerShell.Commands.CIMHelper

Other changes

608186d is a related refactoring that does not change behavior.

@ghost ghost assigned iSazonov Feb 24, 2023
@xtqqczze xtqqczze mentioned this pull request Feb 24, 2023
Merged
22 tasks
@daxian-dbw daxian-dbw changed the title Use ArgumentNullException.ThrowIfNull part 1 Use ArgumentException.ThrowIfNullOrEmpty part 1 Feb 24, 2023
@daxian-dbw
Copy link
Copy Markdown
Member

daxian-dbw commented Feb 24, 2023

@xtqqczze The change is for adopting ArgumentException.ThrowIfNullOrEmpty instead of ArgumentNullException.ThrowIfNull, right?

@xtqqczze

This comment was marked as resolved.

Sign in to view
@xtqqczze
Copy link
Copy Markdown
Contributor Author

xtqqczze commented Feb 24, 2023

@xtqqczze The change is for adopting ArgumentException.ThrowIfNullOrEmpty instead of ArgumentNullException.ThrowIfNull, right?

My bad, this is why I'm trying to keep PRs small.

Although I've mixed the following changes when they could have been seperated.:

  • Throws ArgumentException instead of ArgumentNullException when a string is empty.
  • Throws ArgumentNullException instead of ArgumentException when a string is null.

In any case the changes are to non-public APIS.

CarloToso
CarloToso reviewed Feb 24, 2023
View reviewed changes
src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/cim/cimQuery.cs Outdated
}

ArgumentException.ThrowIfNullOrEmpty(optionName);

Copy link
Copy Markdown
Contributor

@CarloToso CarloToso Feb 24, 2023

Choose a reason for hiding this comment

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

Suggested change

Copy link
Copy Markdown
Contributor Author

@xtqqczze xtqqczze Feb 24, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

My personal preference is to separate the method calls with a blank line when the type of the ArgumentException differs.

Copy link
Copy Markdown
Contributor

@CarloToso CarloToso Feb 24, 2023

Choose a reason for hiding this comment

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

I like it, I'll update my PR following your style 👍

Copy link
Copy Markdown
Member

@daxian-dbw daxian-dbw Feb 27, 2023

Choose a reason for hiding this comment

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

I think it's better to group them together as they are doing the same kind of things. For example, we group Dbg.Assert(xxx) together at the beginning of some methods, even though they do different checks.

@iSazonov 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 25, 2023
daxian-dbw
daxian-dbw approved these changes Feb 27, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@daxian-dbw 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

@pull-request-quantifier-deprecated
Copy link
Copy Markdown

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

This PR has 25 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       : +11 -14
Percentile : 10%

Total files changed: 3

Change summary by file extension:
.cs : +11 -14

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.

@daxian-dbw daxian-dbw merged commit fe8cc5d into PowerShell:master Feb 28, 2023
@xtqqczze xtqqczze deleted the string-IsNullOrWhiteSpace-p1 branch February 28, 2023 23:48
@unfurl-links unfurl-links bot mentioned this pull request Nov 22, 2023
Open
5 tasks
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

@iSazonov iSazonov iSazonov approved these changes

@adityapatwardhan adityapatwardhan Awaiting requested review from adityapatwardhan

+1 more reviewer

@CarloToso CarloToso CarloToso left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@iSazonov iSazonov

Labels

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 Extra Small

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@xtqqczze @daxian-dbw @iSazonov @CarloToso
X Tutup