Add node-fetch custom agent support #51
Closed
Conversation
This file contains 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
|
Is there a way to retrigger travis, seems stuck to me. |
|
@mutaphysis sorry for not responding for so long. We switched from TravisCI to GitHub Actions and all the tests are now passing. Can you re-base your PR up to the latest code? Also, it would be awesome if you could update the docs as well. |
Adds a new `agent` property to the options object that allows configuring the node fetch agent. This can be used for adding proxy support, doing custom dns resolving and other advanced use cases. See https://nodejs.org/api/http.html#http_new_agent_options for more information on http agents.
mutaphysis
force-pushed
the
feat/http-agent-support
branch
from
7e57f0d
to
4683302
Compare
shazron
requested changes
Mar 9, 2022
| @@ -13,6 +13,8 @@ governing permissions and limitations under the License. | |||
| // Type definitions for @adobe/jwt-auth 0.3 | |||
| // Project: https://github.com/adobe/jwt-auth#readme | |||
|
|
|||
| import { Agent } from 'http' | |||
| @@ -101,7 +102,8 @@ async function authorize(options) { | |||
| const postOptions = { | |||
| method: 'POST', | |||
| body: form, | |||
| headers: form.getHeaders() | |||
| headers: form.getHeaders(), | |||
| agent | |||
There was a problem hiding this comment.
technically node-fetch custom agent can take in a function as well (see node-fetch docs)
Documentation is missing in README.md regarding the agent option.
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.
Add node-fetch custom agent support
Description
Adds a new
agentproperty to the options object thatallows configuring the node fetch agent. This can be used
for adding proxy support, doing custom dns resolving and
other advanced use cases.
See https://nodejs.org/api/http.html#http_new_agent_options for
more information on http agents.
Related Issue
#50
Motivation and Context
Will working on a project we had a problem that the back-end we deployed was only allowed network access through a proxy. For our own use of node-fetch this was easily fixed by using a configured https://www.npmjs.com/package/https-proxy-agent but this behaviour was not exposed through the APIs of @adobe/jwt-auth. Thus a simple fix, expose the node-fetch agent property in the API and pass the value through..
How Has This Been Tested?
Tested with a custom proxy aware agent against mitmproxy & a proprietary company proxy. Test cases have not been changed, test coverage is still at 100%, but there is no real test that the agent is actually passed. Typescript types have been extended.
Types of changes
Checklist: