feat!: Support Axios v1 #46
Merged
+25
−4
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
BREAKING CHANGE: CreateAxiosRequestTransformer now must return AxiosRequestTransformer instead of AxiosResponseTransformer.
axios [1.0.0, 2.0.0) are now supported. < 1.0.0 versions are also supported, but it will be deleted in the next major release. To run jest testing on axios v1, I also added babel-jest to transform ES modules that axios exports because jest only supports CommonJS without enabling experimental ESM support implicitly.
mpyw
approved these changes
Oct 11, 2022
Comment on lines
+4
to
+7
| // HACK: Axios exports their module in both CommonJS style and ESM style. | ||
| // However, jest does prefer the ESM one that occurs a runtime error. | ||
| // So in this resolver the main module of axios package is replaced to CommonJS one. | ||
| // This only applies to tests. |
| @@ -78,7 +78,7 @@ export interface CreateAxiosInterceptor { | |||
| (options?: AxiosCaseMiddlewareOptions): AxiosInterceptor; | |||
| } | |||
| export interface CreateAxiosRequestTransformer { | |||
| (options?: AxiosCaseMiddlewareOptions): AxiosResponseTransformer; | |||
| (options?: AxiosCaseMiddlewareOptions): AxiosRequestTransformer; | |||
mpyw
reviewed
Oct 11, 2022
test/integration/basic.ts
Outdated
| @@ -94,7 +94,7 @@ test('it should be converted on success', (done) => { | |||
| }) | |||
| .then((response) => { | |||
| expect(JSON.stringify(response.data)).toBe(JSON.stringify(camelData)); | |||
| expect(response.headers.contentType).toBe('application/json'); | |||
| expect(response.headers.contentType || response.headers['Content-Type']).toBe('application/json'); | |||
There was a problem hiding this comment.
What's the purpose of these changes?
There was a problem hiding this comment.
@mpyw response.headers.contentType is no longer available in axios >= 1.0, so I added response.headers['Content-Type'] which actually exists. To keep backward compatibility, I left the previous one with logical OR. This means the tests can be run even with axios < 1.0.
There was a problem hiding this comment.
Was headers.contentType really generated by axios, not by axios-case-converter? I suspect that the camelCase conversion no longer works for latest axios.
There was a problem hiding this comment.
|
@mpyw Could you please approve to run CI workflow for confirming the tests pass? |
mpyw
added a commit
that referenced
this pull request
Oct 11, 2022
mpyw
added a commit
that referenced
this pull request
Oct 11, 2022
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.
Closes #45
axios [1.0.0, 2.0.0) are now supported.
< 1.0.0 versions are also supported, but it will be deleted in the next major release.
To run jest testing on axios v1, I also added babel-jest to transform ES modules that axios exports because jest only supports CommonJS without enabling experimental ESM support implicitly.