Skip to content

Allow a blank/empty ContentType to be passed to Invoke-WebRequest for compatibility with PS6 and earlier #11421

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 4 commits into from
Jan 6, 2020
Merged

Allow a blank/empty ContentType to be passed to Invoke-WebRequest for compatibility with PS6 and earlier #11421

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
aed7203
Fix for issue 11396 regarding blank ContentType for web request with …
Dec 21, 2019
c332183
Merge pull request #1 from spongemike2/spongemike2/FixIssue11396
spongemike2 Dec 21, 2019
1ffa16f
Add a test for blank ContentType in Invoke-WebRequest
Dec 28, 2019
31c63d8
Add a test for blank ContentType in Invoke-RestMethod
Dec 28, 2019
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
25 changes: 14 additions & 11 deletions ...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 @@ -1260,21 +1260,24 @@ internal virtual void FillRequestStream(HttpRequestMessage request)

foreach (var entry in WebSession.ContentHeaders)
{
if (SkipHeaderValidation)
{
request.Content.Headers.TryAddWithoutValidation(entry.Key, entry.Value);
}
else
if (!string.IsNullOrWhiteSpace(entry.Value))
{
try
if (SkipHeaderValidation)
Copy link
Copy Markdown
Collaborator

@iSazonov iSazonov Dec 23, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

If our intention is to follow Core (that is to send headers with empty value) the check should be here: Update.

Also please add a test.

{
request.Content.Headers.Add(entry.Key, entry.Value);
request.Content.Headers.TryAddWithoutValidation(entry.Key, entry.Value);
}
catch (FormatException ex)
else
{
var outerEx = new ValidationMetadataException(WebCmdletStrings.ContentTypeException, ex);
ErrorRecord er = new ErrorRecord(outerEx, "WebCmdletContentTypeException", ErrorCategory.InvalidArgument, ContentType);
ThrowTerminatingError(er);
try
{
request.Content.Headers.Add(entry.Key, entry.Value);
}
catch (FormatException ex)
{
var outerEx = new ValidationMetadataException(WebCmdletStrings.ContentTypeException, ex);
ErrorRecord er = new ErrorRecord(outerEx, "WebCmdletContentTypeException", ErrorCategory.InvalidArgument, ContentType);
ThrowTerminatingError(er);
}
}
}
}
Expand Down
20 changes: 20 additions & 0 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 @@ -447,6 +447,16 @@ Describe "Invoke-WebRequest tests" -Tags "Feature", "RequireAdminOnWindows" {
$jsonContent.headers.Host | Should -Be $Uri.Authority
}

It "Invoke-WebRequest with blank ContentType succeeds" {
$uri = Get-WebListenerUrl -Test 'Get'
$command = "Invoke-WebRequest -Uri '$uri' -ContentType ''"

$result = ExecuteWebCommand -command $command

# Validate response
ValidateResponse -response $result
}

It "Validate Invoke-WebRequest -DisableKeepAlive" {
# Operation options
$uri = Get-WebListenerUrl -Test 'Get'
Expand Down Expand Up @@ -1995,6 +2005,16 @@ Describe "Invoke-RestMethod tests" -Tags "Feature", "RequireAdminOnWindows" {
$result.Output.headers.'User-Agent' | Should -MatchExactly '.*\(Windows NT \d+\.\d*;.*\) PowerShell\/\d+\.\d+\.\d+.*'
}

It "Invoke-RestMethod with blank ContentType succeeds" {
$uri = Get-WebListenerUrl -Test 'Get'
$command = "Invoke-RestMethod -Uri '$uri' -ContentType ''"

$result = ExecuteWebCommand -command $command

# Validate response
$result.Error | Should -BeNullOrEmpty
}

It "Invoke-RestMethod returns headers dictionary" {
$uri = Get-WebListenerUrl -Test 'Get'
$command = "Invoke-RestMethod -Uri '$uri'"
Expand Down