Add PreserveHttpMethodOnRedirect switch to Web cmdlets #18894

CarloToso · 2023-01-06T00:16:52Z

PR Summary

Add -PreserveHttpMethodOnRedirect switch to preserve the original HTTP method used in Invoke-RestMethod, and Invoke-WebRequest upon redirect.

Replace some code with switch expressions

PR Context

Fixes #14531

PR Checklist

iSazonov · 2023-01-06T05:07:22Z

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

+            switch (statusCode)
+            {
+                case HttpStatusCode.Moved:
+                case HttpStatusCode.Found:
+                case HttpStatusCode.MultipleChoices:
+                    return requestMethod == WebRequestMethod.Post;
+                case HttpStatusCode.SeeOther:
+                    return requestMethod != WebRequestMethod.Get && requestMethod != WebRequestMethod.Head;
+                default:
+                    return false;


It is the same as https://source.dot.net/#System.Net.Http/System/Net/Http/SocketsHttpHandler/RedirectHandler.cs,141
This is used here https://source.dot.net/#System.Net.Http/System/Net/Http/SocketsHttpHandler/SocketsHttpHandler.cs,495

It seems SocketsHttpHandler already implemented the behavior, doesn't it?

Yes, the only difference is SocketsHttpHandler uses HttpMethod requestMethod and we use WebRequestMethod requestMethod.

Maybe we could replace Method with httpMethod

We have private HttpMethod GetHttpMethod(WebRequestMethod method) for the conversion.

We need RequestRequiresForceGet for the cases when we set handler.AllowAutoRedirect = false and WebRequestPSCmdlet handles the redirect

I see. Thanks for clarify!

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

iSazonov · 2023-01-07T06:55:33Z

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

+                bool sessionRedirect = WebSession.MaximumRedirection > 0 || WebSession.MaximumRedirection == -1;

-                if (keepAuthorization && IsRedirectCode(response.StatusCode) && response.Headers.Location is not null)
+                if ((keepAuthorization || (PreserveHTTPMethodOnRedirect && sessionRedirect)) && IsRedirectCode(response.StatusCode) && response.Headers.Location is not null)


~~If we use sessionRedirect only here we can put PreserveHTTPMethodOnRedirect in line 1328 too.~~
Condition looks too complex :-) Is it correct?

I think the current behaviour of if (keepAuthorization..) is wrong, I tested it by setting keepAuthorization = true --> this sets handleRetirect = true --> and then handler.AllowAutoRedirect = false. Without sessionRedirect it ignores MaximumRedirection.
Test: maunally set keepAuthorization = true before the if, then
Invoke-WebRequest "http://mockbin.org/redirect/308?to=https://mockbin.org/redirect/302?to=https://mockbin.org/status/200" -MaximumRedirection 0 -SkipHttpErrorCheck --> expected 308, result 200

Proposed fix --> if (keepAuthorization && sessionRedirect && IsRedirectCode(response.StatusCode) && response.Headers.Location is not null)

If you think there is a bug in redirection please open new PR and keep the PR only for adding new parameter.
(I believe the new parameter shouldn't change redirection logic.)

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

iSazonov · 2023-01-09T05:27:21Z

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


            // This indicates GetResponse will handle redirects.
-            if (handleRedirect)
+            if (handleRedirect || PreserveHTTPMethodOnRedirect)


I suggest changing the code block as in your another PR to avoid merge conflict.

I will change it after we merge the other PR

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

ghost · 2023-01-21T14:00:55Z

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

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

iSazonov · 2023-02-10T11:05:20Z

@SteveL-MSFT @PaulHigin Do you have any objections to this new parameter?

SteveL-MSFT · 2023-02-13T20:01:37Z

@iSazonov I think the parameter name is fine

SteveL-MSFT

LGTM

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

pull-request-quantifier-deprecated · 2023-02-14T09:06:53Z

This PR has 76 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       : +47 -29
Percentile : 30.4%

Total files changed: 2

Change summary by file extension:
.cs : +21 -27
.ps1 : +26 -2

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.

ghost · 2023-03-14T22:29:01Z

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

Handy links:

Release Notes

CarloToso added 6 commits January 6, 2023 00:31

Add PersistHTTPMethod parameter

b4467aa

PersistHTTPMethod handle redirect

720ece8

PersistHTTPMethod manual redirect

20520e6

replace IsRedirectToGet with RequestRequiresForceGet from dotnet

1335810

Update IsRedirectCode with code from RedirectHandler.cs

a36718c

Add PersistHTTPMethod

9499548

CarloToso requested a review from PaulHigin as a code owner January 6, 2023 00:16

pull-request-quantifier-deprecated bot added the Small label Jan 6, 2023

ghost assigned daxian-dbw Jan 6, 2023

CarloToso added 2 commits January 6, 2023 01:23

Fix error

689455b

fix test error (pasted else in the wrong place)

25ee798

iSazonov reviewed Jan 6, 2023

View reviewed changes

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

Convert to SwitchParameter and PreserveHTTPMethodOnRedirect

5278cf7

iSazonov added WG-Cmdlets-Utility cmdlets in the Microsoft.PowerShell.Utility module CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log labels Jan 6, 2023

iSazonov reviewed Jan 6, 2023

View reviewed changes

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

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

Follow suggestions

127d94c

iSazonov reviewed Jan 7, 2023

View reviewed changes

join if

575e076

pull-request-quantifier-deprecated bot added Extra Small and removed Small labels Jan 7, 2023

Should Retry remove maximumretrycount add switch

b7e889a

pull-request-quantifier-deprecated bot added Small and removed Extra Small labels Jan 7, 2023

add static

c9b5003

CarloToso mentioned this pull request Jan 7, 2023

Fix bug with managing redirection and keepAuthorization in Web cmdlets #18902

Merged

RequestRequiresForceGet WebRequestMethod --> HttpMethod

065aa1f

iSazonov reviewed Jan 9, 2023

View reviewed changes

switch expressions

a3438f6

CarloToso commented Feb 7, 2023

View reviewed changes

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

Merge branch 'master' into WebCmdlets-persist-HTTP-method

bad7544

CarloToso mentioned this pull request Feb 7, 2023

Fix redirection for -CustomMethod "POST" in WebCmdlets #19111

Merged

22 tasks

iSazonov requested a review from SteveL-MSFT February 7, 2023 17:13

CarloToso added 2 commits February 8, 2023 13:03

Merge branch 'master' into WebCmdlets-persist-HTTP-method

a52207d

merge

c8aae98

pull-request-quantifier-deprecated bot added Extra Large and removed Small labels Feb 10, 2023

Merge branch 'master' into WebCmdlets-persist-HTTP-method

1cedff2

pull-request-quantifier-deprecated bot added Small and removed Extra Large labels Feb 10, 2023

ghost removed the Review - Needed The PR is being reviewed label Feb 10, 2023

SteveL-MSFT approved these changes Feb 13, 2023

View reviewed changes

Merge branch 'master' into WebCmdlets-persist-HTTP-method

ffa89b3

daxian-dbw requested changes Feb 14, 2023

View reviewed changes

ghost added Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept and removed Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept labels Feb 14, 2023

CarloToso added 2 commits February 14, 2023 10:03

Merge branch 'PowerShell:master' into WebCmdlets-persist-HTTP-method

c23befb

moved or

c91c8f3

CarloToso requested review from daxian-dbw and removed request for PaulHigin February 14, 2023 09:07

daxian-dbw approved these changes Feb 14, 2023

View reviewed changes

daxian-dbw merged commit 60b4e97 into PowerShell:master Feb 14, 2023

CarloToso deleted the WebCmdlets-persist-HTTP-method branch February 14, 2023 21:56

ghost mentioned this pull request Mar 14, 2023

Feature Request: create switch to persist HTTP method when following a redirect for Invoke-RestMethod or Invoke-WebRequest #14531

Closed

Add PreserveHttpMethodOnRedirect switch to Web cmdlets #18894

Add PreserveHttpMethodOnRedirect switch to Web cmdlets #18894

Uh oh!

Conversation

CarloToso commented Jan 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Context

PR Checklist

Uh oh!

iSazonov Jan 6, 2023

Choose a reason for hiding this comment

Uh oh!

CarloToso Jan 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iSazonov Jan 6, 2023

Choose a reason for hiding this comment

Uh oh!

CarloToso Jan 6, 2023

Choose a reason for hiding this comment

Uh oh!

iSazonov Jan 6, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

iSazonov Jan 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

CarloToso Jan 7, 2023

Choose a reason for hiding this comment

Uh oh!

iSazonov Jan 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

iSazonov Jan 9, 2023

Choose a reason for hiding this comment

Uh oh!

CarloToso Jan 9, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ghost commented Jan 21, 2023

Uh oh!

Uh oh!

iSazonov commented Feb 10, 2023

Uh oh!

SteveL-MSFT commented Feb 13, 2023

Uh oh!

SteveL-MSFT left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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

What can I do to optimize my changes

How to interpret the change counts in git diff output

Uh oh!

ghost commented Mar 14, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

CarloToso commented Jan 6, 2023 •

edited

Loading

CarloToso Jan 6, 2023 •

edited

Loading

iSazonov Jan 7, 2023 •

edited

Loading

iSazonov Jan 7, 2023 •

edited

Loading