Allow Web Cmdlets to Ignore HTTP Error Statuses #10466
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The -SkipHttpErrorCheck flag causes web request cmdlets (Invoke-WebRequest and Invoke-RestMethod) to ignore HTTP statuses that are error statuses and treat them as successful requests. This allows users to handle the responses using their own error handler and gives them access to the full, unmodified response body and headers.
This allows the user to specify a variable to set to the integer value of the respons's status code, Analogous to using -ResponseHeadersVariable to retrieve the headers of the response. This can be used to distinguish error messages from success messages when used with -SkipHttpErrorCheck.
|
|
The summary for the SkipHttpErrorCheck property didn't conform to style guidelines. This changes the summary to start with "Gets or sets".
markekraus
suggested changes
Aug 30, 2019
This flag supresses terminating errors on web cmdlets. The tests are written to check that it properly supressed the errors.
Th -StatusCodeVariable parameter specifies an output variable for the status code with Invoke-RestMethod. This test makes sure it functions properly.
Contributor
Author
|
I've added the tests, as requested. |
iSazonov
reviewed
Aug 30, 2019
test/powershell/Modules/Microsoft.PowerShell.Utility/WebCmdlets.Tests.ps1
Show resolved
Hide resolved
test/powershell/Modules/Microsoft.PowerShell.Utility/WebCmdlets.Tests.ps1
Outdated
Show resolved
Hide resolved
markekraus
approved these changes
Aug 30, 2019
Contributor
There was a problem hiding this comment.
Approved pending minor fixes suggested by @iSazonov
Variables had different cases from each other and some parameter names were lower case.
Variables had different cases from each other and some parameter names were lower case.
These tests ensure that Web Cmdlets fail when -SkipHttpErrorCheck is missing.
8 tasks
iSazonov
approved these changes
Sep 3, 2019
adityapatwardhan
requested changes
Sep 3, 2019
test/powershell/Modules/Microsoft.PowerShell.Utility/WebCmdlets.Tests.ps1
Outdated
Show resolved
Hide resolved
test/powershell/Modules/Microsoft.PowerShell.Utility/WebCmdlets.Tests.ps1
Outdated
Show resolved
Hide resolved
test/powershell/Modules/Microsoft.PowerShell.Utility/WebCmdlets.Tests.ps1
Outdated
Show resolved
Hide resolved
test/powershell/Modules/Microsoft.PowerShell.Utility/WebCmdlets.Tests.ps1
Outdated
Show resolved
Hide resolved
test/powershell/Modules/Microsoft.PowerShell.Utility/WebCmdlets.Tests.ps1
Outdated
Show resolved
Hide resolved
test/powershell/Modules/Microsoft.PowerShell.Utility/WebCmdlets.Tests.ps1
Show resolved
Hide resolved
test/powershell/Modules/Microsoft.PowerShell.Utility/WebCmdlets.Tests.ps1
Outdated
Show resolved
Hide resolved
test/powershell/Modules/Microsoft.PowerShell.Utility/WebCmdlets.Tests.ps1
Outdated
Show resolved
Hide resolved
TravisEz13
previously requested changes
Sep 4, 2019
|
|
||
| $uri = Get-WebListenerUrl -Test 'Response' -Query $query | ||
| Invoke-RestMethod -SkipHttpErrorCheck -StatusCodeVariable code -Uri "$uri" | ||
| $code | Should -Be 200 |
Member
There was a problem hiding this comment.
Can we add test for status codes other than 200?
At least one 400 and 500?
Contributor
Author
There was a problem hiding this comment.
I've added a 404 and a 500 test. Let me know if you meant 400 specifically and not just any 4XX-range status.
Member
There was a problem hiding this comment.
I meant just anything in the range
Per discussion on the pull requests. This commit fixes up style problems with the tests for -SkipHttpErrorCheck.
Previously, the -StatusCodeVariable flag in Invoke-RestMethod only had tests for 200 status. This commit adds tests for 404 and 500 statuses and removes -SkipHttpErrorCheck from the 200 check.
The test was copy/pastes from the 200 status test. The body indicated success. This commit fixes that so it is also an error indicator.
TravisEz13
reviewed
Sep 6, 2019
Member
There was a problem hiding this comment.
looks good pending @adityapatwardhan updated review
Contributor
Author
|
Is there anything else I need to do to get this done? |
Member
|
@adityapatwardhan Can you update your review? |
adityapatwardhan
approved these changes
Nov 7, 2019
Member
|
@TravisEz13 I have signed off, sorry for the delay. |
Collaborator
|
@vdamewood Thanks for your contribution! |
|
🎉 Handy links: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
Fix #5555
Fix #9769
This PR adds a -SkipHttpErrorCheck flag to Invoke-WebRequest and Invoke-RestMethod, and adds a -ResponseStatusVariable option to Invoke-RestMethod. The -SkipHttpErrorCheck flag causes the cmdlets to ignore HTTP error statuses and continue to process the responses and write to the pipeline as if these had been successful. The -ResponseStatusVariable assigns the integer value of the status code to the variable named. It can be used with or without -SkipHttpErrorCheck.
PR Context
These cmdlets as they are currently written will throw an exception when the HTTP status is not considered a success. The error handling code will extract the body of the response and modify its contents to assign to the exception, but will leave the original body contents inaccessible. This isn't feasible with web APIs and other sites that return useful diagnostic messages in the body that would be modified by the error handling code.
PR Checklist
.h,.cpp,.cs,.ps1and.psm1files have the correct copyright headerWIP:or[ WIP ]to the beginning of the title (theWIPbot will keep its status check atPendingwhile the prefix is present) and remove the prefix when the PR is ready.