Skip to content
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.

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

Rewrite Get-FileHash to use static HashData methods #18471

Merged
merged 4 commits into from Nov 23, 2022
Merged

Rewrite Get-FileHash to use static HashData methods #18471

merged 4 commits into from Nov 23, 2022

Conversation

turbedi
Copy link
Contributor

@turbedi turbedi commented Nov 5, 2022 •
edited

PR Summary

The HashData(Stream s) methods have been added in .NET 7
The static HashData methods are more optimized and preferred over the ComputeHash methods.
Still need to test if anything broke, therefore WIP

PR Context

PR Checklist

@iSazonov iSazonov added the CL-CodeCleanup Indicates that a PR should be marked as a Code Cleanup change in the Change Log label Nov 5, 2022
@turbedi turbedi changed the title WIP: Rewrite Get-FileHash to use static HashData methods Rewrite Get-FileHash to use static HashData methods Nov 6, 2022
@turbedi
Copy link
Contributor Author

turbedi commented Nov 6, 2022

Tests still pass, PR is ready.

@xtqqczze
Copy link
Contributor

xtqqczze commented Nov 9, 2022

Please resolve CodeFactor issues regarding Xml documentation headers.

@msftbot msftbot bot added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Nov 9, 2022
xtqqczze
xtqqczze suggested changes Nov 9, 2022
View changes
src/Microsoft.PowerShell.Commands.Utility/commands/utility/GetHash.cs
/// <returns>The computed hash data</returns>
private byte[] ComputeHash(Stream stream)
{
switch (Algorithm)
Copy link
Contributor

Choose a reason for hiding this comment

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

Use C# 8.0 switch expression.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have kept the old switch expression for now, because in the C# 8 switch expression I can't use Assert.Debug() and return SHA256 hash as default.

src/Microsoft.PowerShell.Commands.Utility/commands/utility/GetHash.cs Outdated Show resolved Hide resolved
@msftbot msftbot bot removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Nov 10, 2022
@daxian-dbw
Copy link
Member

@PaulHigin and @TravisEz13 please review, thanks!

@msftbot msftbot bot added the Review - Needed The PR is being reviewed label Nov 22, 2022
@msftbot
Copy link

msftbot bot commented Nov 22, 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

PaulHigin
PaulHigin approved these changes Nov 22, 2022
View changes
Copy link
Collaborator

@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

xtqqczze
xtqqczze approved these changes Nov 23, 2022
View changes
Copy link
Contributor

@xtqqczze xtqqczze left a comment

Choose a reason for hiding this comment

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

Approved, with a suggested code quality change.

src/Microsoft.PowerShell.Commands.Utility/commands/utility/GetHash.cs
case HashAlgorithmNames.MD5:
return MD5.HashData(stream);
}
Debug.Assert(false, "invalid hash algorithm");
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: use Debug.Fail

@pull-request-quantifier
Copy link

This PR has 52 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       : +18 -34
Percentile : 20.8%

Total files changed: 3

Change summary by file extension:
.cs : +18 -31
.resx : +0 -3

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? 👍  👌  👎 (Email)
Customize PullRequestQuantifier for this repository.

@iSazonov iSazonov assigned iSazonov and unassigned daxian-dbw Nov 23, 2022
@msftbot msftbot bot removed the Review - Needed The PR is being reviewed label Nov 23, 2022
@iSazonov iSazonov enabled auto-merge (squash) November 23, 2022 16:55
@iSazonov iSazonov merged commit cba9dac into PowerShell:master Nov 23, 2022
40 checks passed
@turbedi turbedi deleted the static_hash branch November 23, 2022 18:51
@msftbot
Copy link

msftbot bot commented Dec 20, 2022

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

Handy links:

CarloToso pushed a commit to CarloToso/PowerShell that referenced this pull request Jan 15, 2023
@turbedi @CarloToso
Rewrite Get-FileHash to use static HashData methods (PowerShell#18471)
25b4744
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@iSazonov iSazonov

@PaulHigin PaulHigin

@xtqqczze xtqqczze

@TravisEz13 TravisEz13

Assignees

@iSazonov iSazonov

Labels
CL-CodeCleanup Indicates that a PR should be marked as a Code Cleanup change in the Change Log Small
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@turbedi @xtqqczze @daxian-dbw @PaulHigin @iSazonov