Skip to content

Preserve WebSession.MaximumRedirection from changes #19190

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

Merged

Conversation

CarloToso
Copy link
Contributor

@CarloToso CarloToso commented Feb 22, 2023

PR Summary

The WebSession.MaximumRedirection parameter shouldn't change as we handle redirections.
This bug appears in edge cases when we use -WebSession -AllowInsecureRedirect -MaximumRedirection together.

Add some tests to check that WebSession doesn't change during usage

PR Context

Fix #19183

PR Checklist

@iSazonov iSazonov self-assigned this Feb 26, 2023
@iSazonov iSazonov changed the title WebCmdlets fix bug -WebSession -AllowInsecureRedirect -MaximumRedirection together wrong number of redirections Fix WebCmdlets bug -WebSession -AllowInsecureRedirect -MaximumRedirection together wrong number of redirections Feb 26, 2023
@iSazonov
Copy link
Collaborator

iSazonov commented Feb 27, 2023

@CarloToso I suggest don't modify existing test and add new one - create WebRequestSession $session = [WebRequestSession]::new(), assign properties, iwr -WebSession $session and check that properties are unchanged.

@iSazonov iSazonov closed this Feb 28, 2023
@iSazonov iSazonov reopened this Feb 28, 2023
@iSazonov iSazonov added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Feb 28, 2023
@iSazonov
Copy link
Collaborator

@CarloToso Please update the PR title and description.

CarloToso and others added 3 commits March 1, 2023 10:16
…Cmdlet/Common/WebRequestPSCmdlet.Common.cs

Co-authored-by: Ilya <darpa@yandex.ru>
@iSazonov iSazonov changed the title Fix WebCmdlets bug -WebSession -AllowInsecureRedirect -MaximumRedirection together wrong number of redirections Preserve WebSession.MaximumRedirection from changes Mar 1, 2023

$session = [Microsoft.PowerShell.Commands.WebRequestSession]::new()
$session.Proxy = [System.Net.WebProxy]::new($proxy)
$null = Invoke-WebRequest -Uri http://httpbin.org -PreserveAuthorizationOnRedirect -WebSession $session -Headers $headers
Copy link
Collaborator

Choose a reason for hiding this comment

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

We shouldn't use external server for tests.

Copy link
Contributor Author

@CarloToso CarloToso Mar 1, 2023

Choose a reason for hiding this comment

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

The same was done in line 2419 with this comment:
# use external url, but with proxy the external url should not actually be called

Copy link
Collaborator

Choose a reason for hiding this comment

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

If possible it must be replaced with our helper.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Up.

@pull-request-quantifier-deprecated

This PR has 70 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       : +66 -4
Percentile : 28%

Total files changed: 2

Change summary by file extension:
.cs : +5 -3
.ps1 : +61 -1

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 merged commit f1ab653 into PowerShell:master Mar 1, 2023
@CarloToso CarloToso deleted the fix-bug-WebSession.MaximumRedirects branch March 1, 2023 19:10
@ghost
Copy link

ghost commented Mar 14, 2023

🎉v7.4.0-preview.2 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
Labels
CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Small
Projects
None yet
Development

Successfully merging this pull request may close these issues.

InvokeWeb-Request -WebSession -AllowInsecureRedirect -MaximumRedirection together wrong number of redirections
2 participants