WebRequestPSCmdlet.Common.cs nullable comments #19162

CarloToso · 2023-02-16T01:43:56Z

PR Summary

Enable nullable annotations in WebRequestPSCmdlet.Common.cs, please review carefully.

PR Context

Discussed with @iSazonov in #19128
After #19249
After #19359

PR Checklist

CarloToso · 2023-02-16T11:04:01Z

Unrelated test failure

iSazonov

I don't comment all issues but only demonstrate my thoughts.

...t.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs

iSazonov · 2023-02-16T17:58:14Z

...t.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs

@@ -653,7 +654,7 @@ protected override void ProcessRecord()

                            if (_followRelLink)
                            {
-                                if (!_relationLink.ContainsKey("next"))
+                                if (!_relationLink!.ContainsKey("next"))


Perhaps we could set [MemberNotNull(nameof(_relationLink))] on ParseLinkHeader() method.

...t.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs

iSazonov · 2023-02-16T18:00:01Z

...t.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs

@@ -1251,7 +1252,7 @@ internal virtual HttpResponseMessage GetResponse(HttpClient client, HttpRequestM
                        CustomMethod = string.Empty;
                    }

-                    currentUri = new Uri(request.RequestUri, response.Headers.Location);
+                    currentUri = new Uri(request.RequestUri!, response.Headers.Location);


I still haven't found a way to correctly handle this, do you have some guidance?

If we don't use BaseAddress it is ok
https://source.dot.net/#System.Net.Http/System/Net/Http/HttpClient.cs,751

Implemented a possible solution, maybe i could have used currentUri = response.Headers.Location;

iSazonov · 2023-02-18T16:54:14Z

...t.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs

@@ -144,7 +146,7 @@ public abstract class WebRequestPSCmdlet : PSCmdlet
        /// </summary>
        [Parameter(Position = 0, Mandatory = true)]
        [ValidateNotNullOrEmpty]
-        public virtual Uri Uri { get; set; }
+        public virtual Uri? Uri { get; set; }


Consider [DisallowNull]

What's the difference between [ValidateNotNullOrEmpty] and [DisallowNull] ?

First is PowerShell attribute for parameters, second is .Net attribute for nullability annotations.

Thinking more I believe this could be non-nullable because it is mandatory and not null or empty. Also there are not intentions to create an object of the class directly - only PowerShell Engine creates live cmdlets.
Maybe try:

[DisallowNull] public virtual Uri Uri { get; set; } = null!;

CarloToso · 2023-02-19T03:09:57Z

@iSazonov is the solution I chose for WebSession correct and admissable?

CarloToso · 2023-02-19T21:08:24Z

@iSazonov I think I addressed all the problems except 2

...t.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs

CarloToso · 2023-03-07T19:15:13Z

@iSazonov #19249 was merged, we can now focus on this PR, could you please review it one more time?
After we merge this I can add nullable comments to other parts of webcmdlets

iSazonov · 2023-03-08T06:02:37Z

@CarloToso Since we merged large PR today I suggest to continue the work beginning with lowest level types like WebRequestSession and then move upwards.

ghost · 2023-03-15T14:01:02Z

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

pull-request-quantifier-deprecated · 2023-03-17T01:37:52Z

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

Quantification details

Label      : Medium
Size       : +70 -66
Percentile : 47.2%

Total files changed: 1

Change summary by file extension:
.cs : +70 -66

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.

...t.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs

…Cmdlet/Common/WebRequestPSCmdlet.Common.cs Co-authored-by: Ilya <[email protected]>

CarloToso · 2023-04-24T08:31:10Z

@iSazonov could you help me fix the 2 remaining errors?

iSazonov · 2023-04-24T14:08:38Z

@iSazonov could you help me fix the 2 remaining errors?

Probably on Wednesday.

iSazonov · 2023-04-26T06:13:14Z

These CIs fails come from #19330 (_cancelToken is used incorrectly) which is unnecessarily complicated, takes the wrong approach, and as we see here adds bugs. I would revert the PR. /cc @adityapatwardhan

ghost · 2023-05-09T02:00:51Z

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

microsoft-github-policy-service · 2024-04-24T20:23:14Z

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

nullable comments WebRequestPSCmdlet

f3d346e

CarloToso requested a review from PaulHigin as a code owner February 16, 2023 01:43

ghost assigned adityapatwardhan Feb 16, 2023

pull-request-quantifier-deprecated bot added the Medium label Feb 16, 2023

iSazonov reviewed Feb 16, 2023

View reviewed changes

move #nullable enable to the top

c7887d2

CarloToso changed the title ~~WebRequestPSCmdlet.Common.cs nullable comments~~ [W.I.P] WebRequestPSCmdlet.Common.cs nullable comments Feb 17, 2023

Uri?

6adf926

iSazonov reviewed Feb 18, 2023

View reviewed changes

iSazonov marked this pull request as draft February 18, 2023 16:55

CarloToso added 10 commits February 18, 2023 21:22

requestContentLength

e88266e

requestContentLength

d0acf91

QualifyFilePath

56f6235

QualifyFilePath(OutFile)

bf0df35

response.Content.Headers.ContentRange?

5ca37a7

object? fieldValue

d3a8d0d

encodedValue

49d220c

jsonNode

fb0ca03

WebSession

12b3546

credential

9391d50

_relationLink

983a42b

CarloToso marked this pull request as ready for review February 19, 2023 21:06

CarloToso requested review from iSazonov and removed request for PaulHigin February 19, 2023 21:08

iSazonov reviewed Feb 20, 2023

View reviewed changes

...t.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs Outdated Show resolved Hide resolved

CarloToso added 2 commits February 20, 2023 19:07

WebSession

994af88

_relationLink

f8bc141

remove spaces

3e342f4

This was referenced Mar 8, 2023

Add nullable annotations in WebRequestSession.cs #19291

Merged

Add warning to web cmdlets if it defaults to HTTP #19316

Closed

ghost added the Review - Needed The PR is being reviewed label Mar 15, 2023

Merge branch 'master' into webcmdlets-nullable

498f44a

Merge branch 'master' into webcmdlets-nullable

d5f692a

iSazonov reviewed Apr 24, 2023

View reviewed changes

...t.PowerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs Outdated Show resolved Hide resolved

CarloToso and others added 3 commits April 24, 2023 10:18

some fixes

e5a92d6

Update src/Microsoft.PowerShell.Commands.Utility/commands/utility/Web…

cd03c66

…Cmdlet/Common/WebRequestPSCmdlet.Common.cs Co-authored-by: Ilya <[email protected]>

more fixes

5a9d572

_qualifiedOutFile [AllowNull]

c5e9016

ghost removed the Review - Needed The PR is being reviewed label Apr 24, 2023

daxian-dbw added WG-Cmdlets general cmdlet issues Needs-Triage The issue is new and needs to be triaged by a work group. labels May 1, 2023

ghost added the Review - Needed The PR is being reviewed label May 9, 2023

SteveL-MSFT removed the WG-Cmdlets general cmdlet issues label Apr 17, 2024

microsoft-github-policy-service bot removed the Review - Needed The PR is being reviewed label Apr 17, 2024

microsoft-github-policy-service bot added the Review - Needed The PR is being reviewed label Apr 24, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WebRequestPSCmdlet.Common.cs nullable comments #19162

WebRequestPSCmdlet.Common.cs nullable comments #19162

CarloToso commented Feb 16, 2023 •

edited

Loading

CarloToso commented Feb 16, 2023

iSazonov left a comment •

edited

Loading

iSazonov Feb 16, 2023

iSazonov Feb 16, 2023

CarloToso Feb 22, 2023

iSazonov Feb 23, 2023

CarloToso Feb 23, 2023

iSazonov Feb 18, 2023

CarloToso Feb 19, 2023

iSazonov Feb 20, 2023

iSazonov Feb 23, 2023

CarloToso Feb 28, 2023

CarloToso commented Feb 19, 2023

CarloToso commented Feb 19, 2023

CarloToso commented Mar 7, 2023 •

edited

Loading

iSazonov commented Mar 8, 2023

ghost commented Mar 15, 2023

pull-request-quantifier-deprecated bot commented Mar 17, 2023

What can I do to optimize my changes

How to interpret the change counts in git diff output

CarloToso commented Apr 24, 2023

iSazonov commented Apr 24, 2023

iSazonov commented Apr 26, 2023

ghost commented May 9, 2023

microsoft-github-policy-service bot commented Apr 24, 2024

WebRequestPSCmdlet.Common.cs nullable comments #19162

Are you sure you want to change the base?

WebRequestPSCmdlet.Common.cs nullable comments #19162

Conversation

CarloToso commented Feb 16, 2023 • edited Loading

PR Summary

PR Context

PR Checklist

CarloToso commented Feb 16, 2023

iSazonov left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CarloToso commented Feb 19, 2023

CarloToso commented Feb 19, 2023

CarloToso commented Mar 7, 2023 • edited Loading

iSazonov commented Mar 8, 2023

ghost commented Mar 15, 2023

pull-request-quantifier-deprecated bot commented Mar 17, 2023

What can I do to optimize my changes

How to interpret the change counts in git diff output

CarloToso commented Apr 24, 2023

iSazonov commented Apr 24, 2023

iSazonov commented Apr 26, 2023

ghost commented May 9, 2023

microsoft-github-policy-service bot commented Apr 24, 2024

CarloToso commented Feb 16, 2023 •

edited

Loading

iSazonov left a comment •

edited

Loading

CarloToso commented Mar 7, 2023 •

edited

Loading