Skip to content

Fix decompression in web cmdlets #17955

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.

Sign up for GitHub

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
daxian-dbw merged 8 commits into from
Oct 4, 2022
Merged

Fix decompression in web cmdlets #17955

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c17df7f
Fix decompression in web cmdlets
iSazonov Aug 24, 2022
7852223
Fix tests
iSazonov Aug 24, 2022
3ec5f92
Fix tests 2
iSazonov Aug 24, 2022
8d3a69c
Fix tests 3
iSazonov Aug 24, 2022
e7097d7
Fix tests 4
iSazonov Aug 24, 2022
4700f54
Fix tests 5
iSazonov Aug 24, 2022
e7917ad
Feedback
iSazonov Sep 27, 2022
0849d44
Update test/powershell/Modules/Microsoft.PowerShell.Utility/WebCmdlet…
iSazonov Sep 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...owerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -992,9 +992,9 @@ private HttpMethod GetHttpMethod(WebRequestMethod method)
// and PreserveAuthorizationOnRedirect is NOT set.
internal virtual HttpClient GetHttpClient(bool handleRedirect)
{
// By default the HttpClientHandler will automatically decompress GZip and Deflate content
HttpClientHandler handler = new();
handler.CookieContainer = WebSession.Cookies;
handler.AutomaticDecompression = DecompressionMethods.All;

// set the credentials used by this request
if (WebSession.UseDefaultCredentials)
Expand Down
16 changes: 0 additions & 16 deletions src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/StreamHelper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@

using System;
using System.IO;
using System.IO.Compression;
using System.Management.Automation;
using System.Management.Automation.Internal;
using System.Net.Http;
Expand Down Expand Up @@ -468,21 +467,6 @@ internal static byte[] EncodeToBytes(string str)
internal static Stream GetResponseStream(HttpResponseMessage response)
{
Stream responseStream = response.Content.ReadAsStreamAsync().GetAwaiter().GetResult();
var contentEncoding = response.Content.Headers.ContentEncoding;

// HttpClient by default will automatically decompress GZip and Deflate content.
// We keep this decompression logic here just in case.
if (contentEncoding != null && contentEncoding.Count > 0)
{
if (contentEncoding.Contains("gzip"))
{
responseStream = new GZipStream(responseStream, CompressionMode.Decompress);
}
else if (contentEncoding.Contains("deflate"))
{
responseStream = new DeflateStream(responseStream, CompressionMode.Decompress);
}
}

return responseStream;
}
Expand Down
14 changes: 7 additions & 7 deletions test/powershell/Modules/Microsoft.PowerShell.Utility/WebCmdlets.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -587,8 +587,8 @@ Describe "Invoke-WebRequest tests" -Tags "Feature", "RequireAdminOnWindows" {
# $dataEncodings = @("Chunked", "Compress", "Deflate", "GZip", "Identity")
# Note: These are the supported options, but we do not have a web service to test them all.
It "Invoke-WebRequest supports request that returns <DataEncoding>-encoded data." -TestCases @(
@{ DataEncoding = "gzip"}
@{ DataEncoding = "deflate"}
@{ DataEncoding = "gzip" }
@{ DataEncoding = "deflate" }
) {
param($dataEncoding)
$uri = Get-WebListenerUrl -Test 'Compression' -TestValue $dataEncoding
Expand All @@ -598,7 +598,7 @@ Describe "Invoke-WebRequest tests" -Tags "Feature", "RequireAdminOnWindows" {
ValidateResponse -response $result

# Validate response content
$result.Output.Headers.'Content-Encoding'[0] | Should -BeExactly $dataEncoding
# The content should be de-compressed, and otherwise converting from JSON will fail.
$jsonContent = $result.Output.Content | ConvertFrom-Json
$jsonContent.Headers.Host | Should -BeExactly $uri.Authority
}
Expand Down Expand Up @@ -2246,15 +2246,15 @@ Describe "Invoke-RestMethod tests" -Tags "Feature", "RequireAdminOnWindows" {
# $dataEncodings = @("Chunked", "Compress", "Deflate", "GZip", "Identity")
# Note: These are the supported options, but we do not have a web service to test them all.
It "Invoke-RestMethod supports request that returns <DataEncoding>-encoded data." -TestCases @(
@{ DataEncoding = "gzip"}
@{ DataEncoding = "deflate"}
@{ DataEncoding = "gzip" }
@{ DataEncoding = "deflate" }
) {
param($dataEncoding)
$uri = Get-WebListenerUrl -Test 'Compression' -TestValue $dataEncoding
$result = Invoke-RestMethod -Uri $uri -ResponseHeadersVariable 'headers'
$result = Invoke-RestMethod -Uri $uri

# Validate response content
$headers.'Content-Encoding'[0] | Should -BeExactly $dataEncoding
# The content should be de-compressed. Otherwise, the above 'Invoke-RestMethod' would have thrown because converting to JSON internally would fail.
$result.Headers.Host | Should -BeExactly $uri.Authority
}

Expand Down