-
Notifications
You must be signed in to change notification settings - Fork 546
Replace axios with fetch to reduce bundle size and allow custom HTTP clients #1120
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.
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
Draft
Copilot
wants to merge
4
commits into
main
Choose a base branch
from
copilot/fix-898
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
bc02c62
Initial plan
Copilot 2cc8738
Replace axios with fetch in RequestClient - core implementation complete
Copilot 66df225
Add comprehensive fetch tests and examples - implementation complete
Copilot d00ffa4
Update changelog and finalize fetch implementation documentation
Copilot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| # Bringing Your Own Fetch Implementation | ||
|
|
||
| With the new fetch-based Twilio Node Helper Library, you can significantly reduce bundle size by providing your own fetch implementation. This is particularly useful for: | ||
|
|
||
| - Edge environments that have built-in fetch | ||
| - Node.js applications that want to use undici or other optimized HTTP clients | ||
| - Lambda functions where bundle size matters | ||
|
|
||
| ## Using Built-in Fetch (Node.js 18+) | ||
|
|
||
| ```js | ||
| const twilio = require('twilio'); | ||
|
|
||
| // No additional configuration needed - uses global fetch | ||
| const client = twilio(accountSid, authToken); | ||
|
|
||
| client.messages.create({ | ||
| to: '+15555555555', | ||
| from: '+15555555551', | ||
| body: 'Using built-in fetch!' | ||
| }); | ||
| ``` | ||
|
|
||
| ## Using Undici for Better Performance | ||
|
|
||
| ```js | ||
| const twilio = require('twilio'); | ||
| const { fetch } = require('undici'); | ||
|
|
||
| const client = twilio(accountSid, authToken, { | ||
| httpClient: new twilio.RequestClient({ fetch }) | ||
| }); | ||
|
|
||
| client.messages.create({ | ||
| to: '+15555555555', | ||
| from: '+15555555551', | ||
| body: 'Using undici for better performance!' | ||
| }); | ||
| ``` | ||
|
|
||
| ## Using node-fetch for Compatibility | ||
|
|
||
| ```js | ||
| const twilio = require('twilio'); | ||
| const fetch = require('node-fetch'); | ||
|
|
||
| const client = twilio(accountSid, authToken, { | ||
| httpClient: new twilio.RequestClient({ fetch }) | ||
| }); | ||
| ``` | ||
|
|
||
| ## Custom Fetch with Additional Features | ||
|
|
||
| ```js | ||
| const twilio = require('twilio'); | ||
|
|
||
| // Custom fetch wrapper with logging | ||
| const customFetch = async (url, options) => { | ||
| console.log(`Making request to: ${url}`); | ||
| const response = await fetch(url, options); | ||
| console.log(`Response status: ${response.status}`); | ||
| return response; | ||
| }; | ||
|
|
||
| const client = twilio(accountSid, authToken, { | ||
| httpClient: new twilio.RequestClient({ | ||
| fetch: customFetch, | ||
| autoRetry: true, | ||
| maxRetries: 5 | ||
| }) | ||
| }); | ||
| ``` | ||
|
|
||
| ## Benefits | ||
|
|
||
| - **Reduced Bundle Size**: No axios dependency (~100KB+ saved) | ||
| - **Better Performance**: Use optimized HTTP clients like undici | ||
| - **Environment Flexibility**: Works in Edge, Node.js, and browser environments | ||
| - **Future-Proof**: Uses web standards instead of library-specific APIs |
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You may want to drop support for older versions of NodeJS with this PR. I think Node 18 was the first version that at some point had stable support for fetch. Node 18 is in EoL now thou, so >=20 for the engine might be a better change. This change is going to be a breaking change regardless, since Node14 wouldn't be able to handle fetch.
"engines": {
"node": ">=20.0"