Skip to content

Ignore headers with null values in web cmdlets #11424

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
TravisEz13 merged 1 commit into from
Jan 7, 2020
Merged

Ignore headers with null values in web cmdlets #11424

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 9 additions & 2 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 @@ -663,8 +663,15 @@ internal virtual void PrepareSession()
{
foreach (string key in Headers.Keys)
{
// add the header value (or overwrite it if already present)
WebSession.Headers[key] = Headers[key].ToString();
var value = Headers[key];

// null is not valid value for header.
// We silently ignore header if value is null.
if (!(value is null))
{
// add the header value (or overwrite it if already present)
WebSession.Headers[key] = value.ToString();
}
}
}

Expand Down
15 changes: 15 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 @@ -3476,4 +3476,19 @@ Describe "Web cmdlets tests using the cmdlet's aliases" -Tags "CI", "RequireAdmi
$result = Invoke-RestMethod $uri
$result.Hello | Should -Be "world"
}

It "Web cmdlets ignore headers with null value" {
$query = @{
body = "hello"
contenttype = 'text/plain'
}
$uri = Get-WebListenerUrl -Test 'Response' -Query $query

# Core throws if a header has null value.
# We ignore such headers so no exception is expected.
{ Invoke-WebRequest -Uri $uri -Headers @{ "Location" = $null } } | Should -Not -Throw
{ Invoke-WebRequest -Uri $uri -ContentType $null } | Should -Not -Throw
{ Invoke-RestMethod -Uri $uri -Headers @{ "Location" = $null } } | Should -Not -Throw
{ Invoke-RestMethod -Uri $uri -ContentType $null } | Should -Not -Throw
}
}