Skip to content
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

WIP: Fetch Adapter v2 #5

Draft
wants to merge 69 commits into
base: v1.x
Choose a base branch
from
Draft

WIP: Fetch Adapter v2 #5

wants to merge 69 commits into from

Conversation

sgammon
Copy link
Owner

@sgammon sgammon commented Sep 14, 2023

Coming soon, filed here for CI

sgammon and others added 30 commits September 13, 2023 18:49
This changeset adds a `fetch`-based adapter implementation to
`axios`, powered by `cross-fetch`[1]. The implementation may thus
be used on either Node or in browser environments.

Changes enclosed:
- Add `fetch` adapter implementation
- Add `fetch` to standard built-in adapters
- Add initial Node-side tests for `fetch`
- Slight refactor to tests to use common setup / teardown code

Still pending:
- Upload/download progress events
- Browser-side testing

Fixes and closes axios#1219, and supersedes axios#2891.
- Add support for `axios(URL(...))` and `axios({url: URL(...)})`
- Add config support for `fetcher`, `fetchOptions` and `parsedUrl`
- Translate `config.url = URL(...)` to string
- Implement override for `config.fetcher`
- Mock fetch implementation for testing
- Spawn fetch adapter configs for testing
- Test for expected instance/static props related to fetch adapter
- Add initial browser tests for fetch adapter
- Test for acceptance of `URL`
- Add pure JS Node polyfill deps
- Add new `generic` dist target for Workers, Deno, etc.
- Move to typealiases in `lib/platform/...` rather than direct use
- Adapt tests for new alias imports
- Drop `cross-fetch`, any need for Node polyfills in pure JS envs
- Implement abstract testsuite structure for fetch
- Move browser fetch tests to new implementation + API
- Implement pure-JS test for Deno, based on new API
- Add test command for Deno (`npm run test:deno`)
- Add alias test command for Node (`npm run test:node`)
- Add alias to run all tests (`npm run test:all`)
- Add basic fetch overhead benchmark
- Add example using new `generic` output
- Define `knownAdapters` for each platform type
- Import `knownAdapters` for library defaults
- Alias XHR adapter to `#xhrAdapter`, only include in browser libs
- Add `.generic.d.*ts` type entries which omit XHR adapter
Temporary: will probably drop before merge
- Setup baseline default and platform-specific `fetchOption`s
- Avoids issue with some environments not supporting `cache`
- Allows shipping bundles with reasonable defaults for each env
sgammon and others added 25 commits September 14, 2023 03:15
- Tweak treeshaking to be more aggressive on modern platforms
- Move license comment to bottom of output targets
- Structured type for `FetchOptions`
- Better type export for `Fetcher`
- Better type export for `AxiosFetchAdapter`
- Add support for `beforeEach`/`afterEach`
- Add full typings for abstract test types
- Prep to extend abstract test suite to Node
- Skip checking config for handler type if no `responseType` param
  is present
- Only resolve handler from `Content-Type` if header is available
  in response
- Move properties around to avoid stray changes in diffs
- Move `cross-fetch` to optional deps
- Instead of failing, bypass URL parsing, and pass the URL verbatim
  to the underlying fetch implementation
- Move abstract fetch testsuite tests into basic test spec file
@sgammon sgammon self-assigned this Sep 14, 2023
Copy link

@accesslint accesslint bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are accessibility issues in these changes.

<div>
<h3>User</h3>
<div class="row">
<img id="useravatar" src="" class="col-md-1"/>
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This image is missing a text alternative. This is a problem for people using screen readers.

Copy link
Owner Author

@sgammon sgammon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

review round 1

Comment on lines +27 to +29
- engine: bun
version: 0.3.0
mode: labs
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

test task missing for bun

Comment on lines +24 to +26
- engine: node
version: 19.x
mode: labs
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

timeout bug on node 19

Comment on lines +1 to +4
# axios + fetch

This directory provides sample code for using Axios with the [Fetch API][1]. As of version `1.2.1`, Axios has a built-in
adapter for using `fetch` in environments that support it, and additionally supports use with Fetch API objects like
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe drop examples for another PR?

Comment on lines +11 to +13
interface CommonHeaders {
common: AxiosHeaders;
}
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shouldn't be added

Comment on lines +16 to +19
interface CommonHeaders {
common: AxiosHeaders;
}

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto

@sgammon
Copy link
Owner Author

sgammon commented Sep 14, 2023

  • Needs updated examples
  • Needs updated docs
  • Needs testing with optionalDependencies
  • Separate PR boundaries
    • Fetch core
    • Fetch examples + docs

Copy link

@github-advanced-security github-advanced-security bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CodeQL found more than 10 potential problems in the proposed changes. Check the Files changed tab for more details.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant