PowerShell icon indicating copy to clipboard operation
PowerShell copied to clipboard

Fix decompression in web cmdlets

Open iSazonov opened this issue 2 years ago • 5 comments

PR Summary

Follow doesn't work for original cmdlet:

Invoke-WebRequest https://httpbin.org/deflate

I don't know why our tests are passed.

I guess there was something changed .Net from early versions.

The fix removes old workaround and turn on embedded automatic decompression in HttpClient handler.

PR Context

PR Checklist

iSazonov avatar Aug 24 '22 07:08 iSazonov

@iSazonov

Overall, these changes look Ok to me. But I don't know what prompted this PR. Did the tests begin failing at some point? Or is this just code clean up to remove the current workaround and instead use the built-in automatic decompression setting?

PaulHigin avatar Aug 24 '22 15:08 PaulHigin

@PaulHigin The Invoke-WebRequest https://httpbin.org/deflate did not work before the PR but our tests for deflate was passed. And yes, .Net Runtime remove encoding headers after automatic decompression. I was wonder but it makes sense - if there was follow processing it shouldn't see any compression header since content is already not compressed. I checked this with Wireshark:

  1. Request image

  2. Response image

Then the cmdlets return the response without Content-Encoding: deflate.


Second issue was with tests. I tried to keep them as near to original as possible. But I started to check with httpbin.org. The site send another response than our WebListener. httpbin.org response has a flag for used decompression method, WebListener haven't. I don't know how enhance WebListener. So I had to change tests.


I don't know why our tests passed before the PR for deflate. I did not investigate either a root is in WebListener or in old workaround.

iSazonov avatar Aug 24 '22 18:08 iSazonov

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

ghost avatar Sep 06 '22 14:09 ghost

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

ghost avatar Sep 14 '22 14:09 ghost

This PR has 22 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       : +8 -14
Percentile : 8.8%

Total files changed: 3

Change summary by file extension:
.cs : +1 -7
.ps1 : +7 -7

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? :thumbsup:  :ok_hand:  :thumbsdown: (Email) Customize PullRequestQuantifier for this repository.

@PaulHigin Can you please take another look?

daxian-dbw avatar Oct 03 '22 22:10 daxian-dbw

This PR also fixes Invoke-WebRequest https://httpbin.org/brotli

CarloToso avatar Oct 04 '22 12:10 CarloToso

Is this going to make it into 7.4?

God-damnit-all avatar Dec 23 '22 22:12 God-damnit-all

It is already in v7.4.0-preview.1

iSazonov avatar Dec 24 '22 13:12 iSazonov

It is already in v7.4.0-preview.1

Oh, cool. Normally a bot responds to the PR saying if it made it in or whatever.

God-damnit-all avatar Dec 25 '22 00:12 God-damnit-all