Skip to content

Cleanup webrequestpscmdlet.common.cs #18596

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
iSazonov merged 20 commits into from
Dec 15, 2022
Merged

Cleanup webrequestpscmdlet.common.cs #18596

iSazonov merged 20 commits into from
Dec 15, 2022

Conversation

@CarloToso
Copy link
Contributor

@CarloToso CarloToso commented Nov 17, 2022

PR Summary

Small cleanup for better readibility

@CarloToso CarloToso requested a review from PaulHigin as a code owner November 17, 2022 11:11
@ghost ghost assigned anmenaga Nov 17, 2022
@iSazonov iSazonov added the CL-CodeCleanup Indicates that a PR should be marked as a Code Cleanup change in the Change Log label Nov 17, 2022
@CarloToso
Copy link
Contributor Author

CarloToso commented Nov 17, 2022

Should I remove redundant brackets ? (example: if (PassThru && (OutFile == null)))

@iSazonov
Copy link
Collaborator

iSazonov commented Nov 18, 2022

@CarloToso You could look CodeFactor issues reported for the file and fix some ones.

@ghost ghost added the Review - Needed The PR is being reviewed label Nov 25, 2022
@ghost
Copy link

ghost commented Nov 25, 2022

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

@ghost ghost added Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept and removed Review - Needed The PR is being reviewed labels Dec 13, 2022
@ghost ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Dec 13, 2022
@CarloToso CarloToso mentioned this pull request Dec 14, 2022
Merged
@iSazonov
Copy link
Collaborator

iSazonov commented Dec 14, 2022

@CarloToso Please squash last commits after "revert =0" - difficult to review last changes.
To be clear - I ask you only use is null and is not null.

@CarloToso
!= -> is not - remove leftover ;
e803d64 
== -> is

remove useless return;

fixed errors

revert
@CarloToso CarloToso force-pushed the cleanup-WebRequestPSCmdlet.Common.cs branch from b893b60 to e803d64 Compare December 15, 2022 00:27
@CarloToso
Copy link
Contributor Author

CarloToso commented Dec 15, 2022

Squashed

iSazonov
iSazonov reviewed Dec 15, 2022
View reviewed changes
...t.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs Outdated
}

if (Authentication != WebAuthenticationType.None && Token != null && Credential != null)
if (Authentication is not WebAuthenticationType.None && Token is not null && Credential is not null)
Copy link
Collaborator

@iSazonov iSazonov Dec 15, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

Please revert patterns like Authentication is not WebAuthenticationType.None. Let's limit the PR only to is null and is not null.

Copy link
Collaborator

@iSazonov iSazonov Dec 15, 2022

Choose a reason for hiding this comment

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

Or better move this in follow PR after we merge that.

Copy link
Contributor Author

@CarloToso CarloToso Dec 15, 2022

Choose a reason for hiding this comment

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

Done

iSazonov
iSazonov reviewed Dec 15, 2022
View reviewed changes
...t.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs
Comment on lines 1713 to 1714
if (xmlNode is null)
return 0;
Copy link
Collaborator

@iSazonov iSazonov Dec 15, 2022

Choose a reason for hiding this comment

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

Suggested change
if (xmlNode is null)
return 0;
if (xmlNode is null)
{
return 0;
}

@pull-request-quantifier-deprecated
Copy link

pull-request-quantifier-deprecated bot commented Dec 15, 2022

This PR has 228 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

Quantification details 

Label      : Large
Size       : +101 -127
Percentile : 62.8%

Total files changed: 1

Change summary by file extension:
.cs : +101 -127

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 iSazonov assigned iSazonov and unassigned anmenaga Dec 15, 2022
@iSazonov iSazonov merged commit bcb0a94 into PowerShell:master Dec 15, 2022
@CarloToso CarloToso deleted the cleanup-WebRequestPSCmdlet.Common.cs branch December 15, 2022 18:00
@ghost
Copy link

ghost commented Dec 20, 2022

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

Handy links:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@iSazonov iSazonov iSazonov approved these changes

@PaulHigin PaulHigin Awaiting requested review from PaulHigin

Assignees

@iSazonov iSazonov

Labels

CL-CodeCleanup Indicates that a PR should be marked as a Code Cleanup change in the Change Log Large

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@CarloToso @iSazonov @anmenaga