WebResponseObject.Common merge partials atomic commits #18703

CarloToso · 2022-12-01T19:27:18Z

PR Summary

Merge partial classes in WebResponseObject.Common, rearrange Properties and Methods in alphabetical order and RawContentStream to auto-implemented property.

PR Context

Justification: // TODO: Merge Partials
Replaces #18692

xtqqczze · 2022-12-01T22:03:19Z

...ft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebResponseObject.Common.cs

-        }
-
-        private MemoryStream _rawContentStream;
+        public MemoryStream RawContentStream { get; protected set; }


Why the change to protected?

I followed the same convention as :

public byte[] Content { get; protected set; }

and

public string RawContent { get; protected set; }

...ft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebResponseObject.Common.cs

iSazonov

LGTM with two comments.

iSazonov · 2022-12-02T12:01:26Z

...ft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebResponseObject.Common.cs

-        {
-            get { return (WebResponseHelper.GetStatusDescription(BaseResponse)); }
-        }
+        [SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]


Eh, this rule is not active in the repo today so we can remove the line.

iSazonov · 2022-12-02T12:01:26Z

...ft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebResponseObject.Common.cs

@@ -178,21 +118,23 @@ private void InitializeRawContent(HttpResponseMessage baseResponse)
            this.RawContent = raw.ToString();
        }

+        private static bool IsPrintable(char c) => char.IsLetterOrDigit(c) || char.IsPunctuation(c) || char.IsSeparator(c) || char.IsSymbol(c) || char.IsWhiteSpace(c);


Oh, too long string. Maybe:

private static bool IsPrintable(char c) => char.IsLetterOrDigit(c) || char.IsPunctuation(c) || char.IsSeparator(c) || char.IsSymbol(c) || char.IsWhiteSpace(c); `

pull-request-quantifier · 2022-12-02T13:43:54Z

This PR has 71 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       : +30 -41
Percentile : 28.4%

Total files changed: 1

Change summary by file extension:
.cs : +30 -41

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.

msftbot · 2022-12-10T02:00:57Z

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

iSazonov · 2022-12-13T13:19:20Z

@CarloToso Thanks!
There are some this.* prefixes which could be removed now.

msftbot · 2022-12-20T22:57:49Z

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

Handy links:

Release Notes

)

CarloToso added 9 commits December 1, 2022 18:36

remove useless ()

2b54924

merge Properties

3fd2b6e

merge Constructors

4ea8904

merge Methods

92429c9

alphabetical order Properties

c4a7648

alphabetica order Methods

bc89264

remove _rawContentStream

1425b07

replace == with is

cc5054f

replace get { return with =>

a61f5b7

CarloToso requested a review from PaulHigin as a code owner December 1, 2022 19:27

pull-request-quantifier bot added the Small label Dec 1, 2022

msftbot bot assigned adityapatwardhan Dec 1, 2022

xtqqczze reviewed Dec 1, 2022

View changes

...ft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebResponseObject.Common.cs Outdated Show resolved Hide resolved

use expression-bodied members

53524f7

iSazonov reviewed Dec 2, 2022

View changes

...ft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebResponseObject.Common.cs Outdated Show resolved Hide resolved

remove extra ()

99d18bb

iSazonov reviewed Dec 2, 2022

View changes

CarloToso added 4 commits December 2, 2022 09:59

fix endregion

2b53488

convert to expression body

b6a2d1a

Headers to expression body

54efdf4

fix comment

a9a7bee

iSazonov reviewed Dec 2, 2022

View changes

CarloToso added 2 commits December 2, 2022 14:36

remove SuppressMessage

8640037

IsPrintable cleanup

a3d92a9

iSazonov approved these changes Dec 2, 2022

View changes

iSazonov added the CL-CodeCleanup Indicates that a PR should be marked as a Code Cleanup change in the Change Log label Dec 2, 2022

msftbot bot added the Review - Needed The PR is being reviewed label Dec 10, 2022

iSazonov assigned iSazonov and unassigned adityapatwardhan Dec 13, 2022

msftbot bot removed the Review - Needed The PR is being reviewed label Dec 13, 2022

iSazonov merged commit c3a080c into PowerShell:master Dec 13, 2022
40 checks passed

CarloToso deleted the WebResponseObject.Common-merge-partials2 branch December 13, 2022 22:00

CarloToso added a commit to CarloToso/PowerShell that referenced this pull request Jan 15, 2023

WebResponseObject.Common merge partials atomic commits (PowerShell#18703

19c359b

)

gregsdennis pushed a commit to gregsdennis/PowerShell that referenced this pull request Mar 15, 2023

WebResponseObject.Common merge partials atomic commits (PowerShell#18703

0a0668f

)

WebResponseObject.Common merge partials atomic commits #18703

WebResponseObject.Common merge partials atomic commits #18703

CarloToso commented Dec 1, 2022

xtqqczze Dec 1, 2022

CarloToso Dec 1, 2022

iSazonov left a comment

iSazonov Dec 2, 2022

CarloToso Dec 2, 2022

iSazonov Dec 2, 2022

CarloToso Dec 2, 2022

pull-request-quantifier bot commented Dec 2, 2022

What can I do to optimize my changes

How to interpret the change counts in git diff output

msftbot bot commented Dec 10, 2022

iSazonov commented Dec 13, 2022

msftbot bot commented Dec 20, 2022

WebResponseObject.Common merge partials atomic commits #18703

WebResponseObject.Common merge partials atomic commits #18703

Conversation

CarloToso commented Dec 1, 2022

PR Summary

PR Context

xtqqczze Dec 1, 2022

Choose a reason for hiding this comment

CarloToso Dec 1, 2022

Choose a reason for hiding this comment

iSazonov left a comment

Choose a reason for hiding this comment

iSazonov Dec 2, 2022

Choose a reason for hiding this comment

CarloToso Dec 2, 2022

Choose a reason for hiding this comment

iSazonov Dec 2, 2022

Choose a reason for hiding this comment

CarloToso Dec 2, 2022

Choose a reason for hiding this comment

pull-request-quantifier bot commented Dec 2, 2022

What can I do to optimize my changes

How to interpret the change counts in git diff output

msftbot bot commented Dec 10, 2022

iSazonov commented Dec 13, 2022

msftbot bot commented Dec 20, 2022