feat: adding a new harIsAlreadyEncoded option
#46
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
erunion
commented
Sep 8, 2021
| const fetch = require('node-fetch'); | ||
|
|
||
| const url = 'http://mockbin.com/har'; | ||
| const options = {method: 'POST', headers: {cookie: 'foo=bar; bar=baz; '}}; |
Member
Author
There was a problem hiding this comment.
Cool side effect of this work is now cookies for node-fetch won't have an unnecessary space at the end.
gratcliff
approved these changes
Sep 8, 2021
| if (Object.keys(source.headersObj).length) { | ||
| reqOpts.headers = source.headersObj | ||
| if (Object.keys(source.allHeaders).length) { | ||
| reqOpts.headers = source.allHeaders |
There was a problem hiding this comment.
What are the implications of consuming allHeaders instead of headersObj?
Member
Author
There was a problem hiding this comment.
allHeaders contains the cookie header if it's present, headersObj is a k/v store of headers from the HAR excluding cookie because that's dynamically generated from the cookies array in the HAR.
Member
Author
There was a problem hiding this comment.
And by changing this to allHeaders this target no longer needs to combine its own cookie data into a cookie header because that's already been done in src/index.js.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
With the work done in readmeio/oas-to-har#17 to ensure that query parameters are always properly encoded it was discovered that cookie parameters were being double encoded: once in
oas-to-harand again here. Since this is obviously bad, I've refactored our existing customescapeQueryStringsoption to beharIsAlreadyEncoded(defaulting to false) so that we can now control both query string and cookie encoding behavior.In the process of doing this I've slightly refactored a couple targets to no longer do their own cookie encoding as it's already being done in the
HTTPSnippetconstructor when it builds up a list ofallHeaders. This refactor also allows us to not have to pass an option toHTTPSnippetand also to the target itself to control encoding handling because the rootHTTPSnippetclass does not currently have any way of passing down options to targets.