Request headers in Get-WebHeaders
#1733
Conversation
Request headers support in `Get-WebHeaders` is required for fixing bug in `Get-ChocolateyWebFile`. When no checksum is passed to `Get-ChocolateyWebFile`, it's check file length: response headers is fetched by `Get-WebHeaders` using `HEAD` request and then compared with file length which got from file fetched with `GET` request. File length check should succeed, because `HEAD` request to equal URL, using same request headers as `GET` request, will return same `Content-Length`. Actually file length check will not succeed, because `Get-WebHeaders` does not support request headers except `User-Agent`, and therefore headers accepted by `Get-ChocolateyWebFile` is not passed to `Get-WebHeaders`. Monkey-patched version of `Get-ChocolateyWebFile` is used by [`AU`](https://github.com/majkinetor/au) for generating checksums on-the-fly. This PR is part of effort introducing support of request headers in `AU`. Request headers passed as `-Options @{Headers=@{}}`, not as just `-Headers @{}`, for mantaining consistency with others `Chocolatey`'s helper functions, such as `Get-ChocolateyWebFile`.
| [parameter(ValueFromRemainingArguments = $true)][Object[]] $ignoredArguments | ||
| [parameter(Mandatory=$false, Position=1)][string] $userAgent, | ||
| [parameter(ValueFromRemainingArguments = $true)][Object[]] $ignoredArguments, | ||
| [parameter(Mandatory=$false)][hashtable] $options = @{Headers=@{}} |
There was a problem hiding this comment.
This needs to be before $ignoredArguments. Those are the last items to be passed.
| if ($userAgent -ne $null) { | ||
|
|
||
| #Mimic previous behaviour with default User-Agent | ||
| $request.UserAgent = 'chocolatey command line' |
| .PARAMETER Options | ||
| Specify request headers. Please note that UserAgent function parameter, if specified, overwrite header present in this parameter. | ||
There was a problem hiding this comment.
This should also specify the first version this was available in. I would venture a guess that it is 0.10.13. At least include that here (search other parameters for examples of this and keep it consistent.). Thanks!
|
Oh and one more thing - this needs an issue created (if there is not one), and then the commit message needs to refer to that - see https://github.com/chocolatey/choco/blob/master/CONTRIBUTING.md for more information. |
|
Specifically this bit - https://github.com/chocolatey/choco/blob/master/CONTRIBUTING.md#prepare-commits |
|
@galeksandrp are you in a place to make changes? |
|
We are also experiencing this issue. What is holding up getting this merged? |
|
|
|
Thanks for your contribution here! This work is encompassed and added to by the work done in #3395, so I'll be closing this one for now. |
5 participants
Request headers support in
Get-WebHeadersis required for fixing bug inGet-ChocolateyWebFile.When no checksum is passed to
Get-ChocolateyWebFile, it's check file length: response headers is fetched byGet-WebHeadersusingHEADrequest and then compared with file length which got from file fetched withGETrequest.File length check should succeed, because
HEADrequest to equal URL, using same request headers asGETrequest, will return sameContent-Length.Actually file length check will not succeed, because
Get-WebHeadersdoes not support request headers exceptUser-Agent, and therefore headers accepted byGet-ChocolateyWebFileis not passed toGet-WebHeaders.Monkey-patched version of
Get-ChocolateyWebFileis used byAUfor generating checksums on-the-fly. This PR is part of effort introducing support of request headers inAU.Request headers passed as
-Options @{Headers=@{}}, not as just-Headers @{}, for mantaining consistency with othersChocolatey's helper functions, such asGet-ChocolateyWebFile.