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

WebCmdlets get Retry-After from headers if StatusCode is 429 #18717

Conversation

CarloToso
Copy link
Contributor

PR Summary

If the Status Code is 429 it tries to get the Retry-After property from the headers and use it as WebSession.RetryIntervalInSeconds

(I decided to use an if-else instead of a ternary operator for better code readability)

PR Context

Fixes #13188

@kilasuit
Copy link
Collaborator

kilasuit commented Dec 3, 2022

Whilst I agree with you about the readability aspect, we should make use of the language features here to reduce the overall size of the codebase, which the ternary operator gives us. What we really need is a mechanism for a reader to convert a file on the fly to a more readable means, though that doesn't yet exist, so we have to do our best with what we have available today.

Therefore I'd ask that you make use of the ternary operator in this PR as I'm sure others would either ask you to or would accept this pr and then add another in future to move to that.
What I'd ask is that you keep the commit showing it like this as that can be used to show what it looks like in an if/else vs using the ternary operator which is very useful for learning & teaching purposes.

@CarloToso
Copy link
Contributor Author

CarloToso commented Dec 3, 2022

@kilasuit Done

Copy link
Collaborator

@kilasuit kilasuit left a comment

Choose a reason for hiding this comment

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

Approving based on my prior comment

@kilasuit kilasuit self-requested a review December 3, 2022 16:09
@iSazonov iSazonov closed this Dec 13, 2022
@iSazonov iSazonov reopened this Dec 13, 2022
@iSazonov iSazonov closed this Dec 14, 2022
@iSazonov iSazonov reopened this Dec 14, 2022
@iSazonov iSazonov closed this Dec 14, 2022
@iSazonov iSazonov reopened this Dec 14, 2022
@iSazonov iSazonov closed this Dec 14, 2022
@iSazonov iSazonov reopened this Dec 14, 2022
@pull-request-quantifier-deprecated

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


Quantification details

Label      : Extra Small
Size       : +9 -2
Percentile : 4.4%

Total files changed: 1

Change summary by file extension:
.cs : +9 -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.

@iSazonov iSazonov merged commit b7096e8 into PowerShell:master Dec 14, 2022
@iSazonov iSazonov added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Dec 14, 2022
@CarloToso CarloToso deleted the WebCmdlets-respect-Retry-After-header-in-429 branch December 14, 2022 09:28
CarloToso added a commit to CarloToso/PowerShell that referenced this pull request Jan 15, 2023
gregsdennis pushed a commit to gregsdennis/PowerShell that referenced this pull request Mar 15, 2023
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 Extra Small
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Invoke-RestMethod and Invoke-WebRequest do not respect Retry-After header in 429 responses.
3 participants