JSON improvements: throw if JSON parsing failed; number, boolean can be passed directly as payload for encoding to JSON #2613, #61, #907 #3688

DigitalBrainJS · 2021-03-19T17:22:55Z

Added

support for primitive types to be converted to JSON if the request Content-Type is application/json (under nodejs we get an error) (Post a number as a JSON #2613);
transitional options object;
options validator to assert transitional options;
transitional option silentJSONParsing - throws SyntaxError if JSON parsing failed while responseType is json and transitional.silentJSONParsing is false; (How to handle error from JSON.parse #61). Default: true - keep current behavior.
transitional option forcedJSONParsing to control automatic JSON parsing from the response string. Default true - keep current behavior (responseType=text but json is parsed #2791, responseType: 'text' return Json Object #907)
request transformers now calling in the context of the config object.
automated deprecation warning message depending on the package version
Example:
[Axios v0.21.1] Transitional option 'silentJSONParsing' has been deprecated since v0.19.3 and will be removed in the near future
Update
Added transitional.clarifyTimeoutError to throw ETIMEDOUT error instead of generic ECONNABORTED on request timeout (Uses ECONNABORTED for timeouts instead of ETIMEDOUT #1543);
Added support of onloadend handler if available instead of onreadystatechange;
Added xhr timeout test;
Fixed potential bug of xhr adapter with proper handling timeouts&errors (FakeXMLHTTPRequest failed to handle timeouts);

The API behavior is the same as before, but now we can set the transitional.silentJSONParsing to false for verbose JSON parsing.
Since transient parameters are introduced by the PR, we can support multiple API behaviors at the same time, allowing users to choose the one they want and making it easier to transition between package versions.

When silentJSONParsing is false & responseType is 'json':

await axios.get("https://run.mocky.io/v3/95e6ffc7-ac0c-46c2-aded-7149eeb2ef2d", {
  responseType: "json", 
  transitional: {
    silentJSONParsing: false
  }
});

SyntaxError: Unexpected token b in JSON at position 1
    at JSON.parse (<anonymous>)
    at Object.transformResponse (axios2.js:1023)
    at transform (axios2.js:493)
    at Object.forEach (axios2.js:257)
    at Object.transformData (axios2.js:492)
    at onAdapterResolution (axios2.js:1120)

When silentJSONParsing is true (default value & current behaviour):

await axios.get("https://run.mocky.io/v3/95e6ffc7-ac0c-46c2-aded-7149eeb2ef2d", {
  responseType: "json", 
  transitional: {
    silentJSONParsing: true
  }
});

response= {
  config: {url: "https://run.mocky.io/v3/95e6ffc7-ac0c-46c2-aded-7149eeb2ef2d", method: "get", headers: {…}, transformRequest: Array(1), transformResponse: Array(1), …}
  data: "{badJSON": "123"}"
  headers: {...}
    status: 200
    statusText: "OK"
  }
  ...
}

Recently published as axios-lab npm fork
CodeSandbox demo

…n-primitives � Conflicts: � lib/adapters/xhr.js

…est Content-Type is 'application/json'; Added throwing SyntaxError if JSON parsing failed and responseType is json; Added transitional option object; Added options validator to assert transitional options; Added transitional option `silentJSONParsing= true` for backward compatibility; Updated README.md; Updated typings;

Fixed typo; Added validator.spec.js;

…n-improvements � Conflicts: � lib/defaults.js

… the function context is not specified (for tests compatibility);

…t/json-improvements

…tead of generic ECONNABORTED on request timeouts; Added support of onloadend handler if available instead of onreadystatechange; Added xhr timeout test; Fixed potential bug of xhr adapter with proper handling timeouts&errors (FakeXMLHTTPRequest failed to handle timeouts);

…n-improvements

…t/json-improvements

jasonsaayman

Looks good to me

DigitalBrainJS · 2021-04-19T17:27:17Z

@jasonsaayman Oops. It seems the test failed under IE11 just because it has a different SyntaxError message.
But basically, that is not a necessary assertion, so we can just delete the line:
expect(thrown.message).toContain('JSON');

DigitalBrainJS · 2021-04-19T17:43:11Z

@jasonsaayman Just fixed it in #3763 PR;

rinsuki · 2021-07-26T18:55:31Z

Could you release new version with this changes? I want to use it soon.

kawanet · 2021-09-05T13:54:41Z

@DigitalBrainJS
Did the PR make any breaking changes?
The PR describes it would keep the previous behavior, however.

Default: true - keep current behavior.
The API behavior is the same as before

My app which uses a POST method fails since your commit 5ad6994 merged.
It seems this makes some part of my request header or body broken.

axios release 0.21.1 -> OK
commit d99d5fa -> OK
commit 5ad6994 -> NG
axios release 0.21.2 and 0.21.3 -> NG

burgalon · 2021-09-05T14:05:45Z

@DigitalBrainJS seems to have breaking changes - timemachine3030@5ad6994#diff-b34f2f53ab94368c86775969fb604e8375abe03b6a378bdd09896fd91ac0a0d2R59

kawanet · 2021-09-05T14:46:34Z

I've post a minimum code to reproduce the issue. See 4018 below not 4017 above.

phil-w · 2021-09-06T08:44:44Z

Not sure exactly what's said here, but this just broke my tests.

I had an old axios.post which (a) set the header content type to 'application/json' and passed a JSON.stringify() structure as body. That started to error 400 the latest axios update 0.21.3.

Removing both the header type and the stringification fixed it, so it's all good.

luchaos · 2021-09-07T13:45:56Z

lib/helpers/validator.js

+});
+
+var deprecatedWarnings = {};
+var currentVerArr = pkg.version.split('.');


var pkg = require('./../../package.json'); tries to load my project's package.json which has no version key set, causing the application to fail on boot in the browser.
what's the purpose of this validator and why does it need my project's package.json and a potentially non-existing version? (it was brought to my attention that that's the culprit after all - for the version is a required package.json field https://docs.npmjs.com/creating-a-package-json-file#required-name-and-version-fields)
it's a vue3/webpack project.
edit: seems to be related? #3499

Will have a look as to why this is happening

it's an edge case, really - people do the weirdest things in their project's package.json (as my own example showed). the fix is simple enough, the package.json just has to be valid and meet the minimum requirements (the version should be there at all times, technically - til).

yet, this issue might highlight a completely different problem. relying on the validity of / bundling the package.json might not be the best solution to use a version for negotiation (as seen in this PR) nor to be used for the user agent (as seen in the linked issue above where it is imported in the http adapter).

is this actually a path/loader issue and the version to be read is the one from axios' own package.json, not the project's? looking at the http adapter code it looks like it wants axios' version (headers['User-Agent'] = 'axios/' + pkg.version;)
if that's the case then i'd assume that axios is potentially sending the wrong version (the project's it's used in) in the user agent header, too?

I meet the same question here, so do you know how to solve it?

I meet the same question here, so do you know how to solve it?

For me the solution was to add a version to package.json. "version": "0.0.0" works just fine.

landerson-gc · 2021-09-11T02:15:39Z

lib/adapters/xhr.js

+        }
+        // readystate handler is calling before onerror or ontimeout handlers,
+        // so we should call onloadend on the next 'tick'
+        setTimeout(onloadend);


this setTimeout appears to be causing test failures for me when using sinon/nise FakeServer with FakeTimers in Jest. And possibly with nock.
replacing this line with onloadend() causes my tests to pass again.

Same for me. Thx for pointing it out. :)
Will this be fixed in a new release, because this bug appears since v0.21.2. Is it already planned? :)

For one project we ended up putting flushPromises and await sandbox.clock.tickAsync() / sandbox.clock.tick in the appropriate places in our custom wrappers for sinon FakeServer and requests to workaround this change so that we could use the latest version of axios in the project.

Thanks for the response :) ... the await clock.tickAsync(); worked for me. Thanks a lot!

…be passed directly as payload for encoding to JSON axios#2613, axios#61, axios#907 (axios#3688) * Draft * Added support for primitive types to be converted to JSON if the request Content-Type is 'application/json'; Added throwing SyntaxError if JSON parsing failed and responseType is json; Added transitional option object; Added options validator to assert transitional options; Added transitional option `silentJSONParsing= true` for backward compatibility; Updated README.md; Updated typings; * Fixed isOlderVersion helper; Fixed typo; Added validator.spec.js; * Added forcedJSONParsing transitional option axios#2791 * `transformData` is now called in the default configuration context if the function context is not specified (for tests compatibility); * Added `transitional.clarifyTimeoutError` to throw ETIMEDOUT error instead of generic ECONNABORTED on request timeouts; Added support of onloadend handler if available instead of onreadystatechange; Added xhr timeout test; Fixed potential bug of xhr adapter with proper handling timeouts&errors (FakeXMLHTTPRequest failed to handle timeouts);

DigitalBrainJS added 4 commits March 18, 2021 22:04

Draft

c26b1b5

Merge branch 'master' of https://github.com/axios/axios into feat/jso…

4d06575

…n-primitives � Conflicts: � lib/adapters/xhr.js

Fixed isOlderVersion helper;

5112ba3

Fixed typo; Added validator.spec.js;

DigitalBrainJS changed the title ~~Feat/JSON improvements #2613, #61, #907~~ JSON improvements #2613, #61, #907 Mar 19, 2021

DigitalBrainJS changed the title ~~JSON improvements #2613, #61, #907~~ JSON improvements: throw if JSON parsing failed; number, boolean can be passed directly as payload for encoding to JSON #2613, #61, #907 Mar 19, 2021

DigitalBrainJS added 7 commits March 19, 2021 22:20

Added forcedJSONParsing transitional option axios#2791

aa63605

Merge branch 'master' into feat/json-improvements

b30a737

Merge branch 'master' of https://github.com/axios/axios into feat/jso…

7cdfb90

…n-improvements � Conflicts: � lib/defaults.js

transformData is now called in the default configuration context if…

ba6d2bc

… the function context is not specified (for tests compatibility);

Merge remote-tracking branch 'origin/feat/json-improvements' into fea…

07441a6

…t/json-improvements

Merge branch 'master' into feat/json-improvements

bb5b761

Merge branch 'master' into feat/json-improvements

b8bd73c

Rose2161 approved these changes Apr 3, 2021

View reviewed changes

DigitalBrainJS added 3 commits April 5, 2021 19:38

Merge branch 'master' of https://github.com/axios/axios into feat/jso…

f2dd788

…n-improvements

Merge remote-tracking branch 'origin/feat/json-improvements' into fea…

d7f938b

…t/json-improvements

jasonsaayman self-requested a review April 13, 2021 09:00

jasonsaayman self-assigned this Apr 13, 2021

jasonsaayman reviewed Apr 19, 2021

View reviewed changes

jasonsaayman merged commit 5ad6994 into axios:master Apr 19, 2021

DigitalBrainJS mentioned this pull request Apr 19, 2021

Feat/json improvements #3763

Merged

This was referenced May 6, 2021

e.sent.data.forEach is not a function when getting invalid JSON response #3675

Closed

How to handle error from JSON.parse #61

Closed

This was referenced May 16, 2021

Post a number as a JSON #2613

Closed

responseType=text but json is parsed #2791

Closed

kawanet mentioned this pull request Sep 5, 2021

0.21.2 has a breaking change with pre-stringified JSON request body #4017

Closed

kawanet mentioned this pull request Sep 5, 2021

0.21.2 has a breaking change with pre-stringified JSON request body #4018

Closed

gfortaine mentioned this pull request Sep 5, 2021

fix json transform when data is pre-stringified #4020

Merged

luchaos reviewed Sep 7, 2021

View reviewed changes

sync-by-unito bot mentioned this pull request Sep 9, 2021

Bump axios from 0.21.1 to 0.21.4 in /packages/health-check SkynetLabs/skynet-webportal#1161

Merged

landerson-gc reviewed Sep 11, 2021

View reviewed changes

This was referenced Sep 12, 2021

Bump axios from 0.19.2 to 0.21.2 in /amplify/backend/function/jcUpdateMainUserGroup/src jesus-collective/mobile#905

Closed

Bump axios from 0.21.1 to 0.21.4 in /amplify/backend/function/jcmobilePostConfirmation/src jesus-collective/mobile#904

Closed

jhpedemonte mentioned this pull request Sep 28, 2021

0.21.4 incorrectly stringifies null data #4099

Closed

DigitalBrainJS mentioned this pull request Oct 7, 2021

Fixed TransitionalOptions typings #4147

Merged

chinesedfan mentioned this pull request Oct 27, 2021

Axios breaking changes in simple requests beginning with 0.21.2 and up coming from v0.21.1 #4129

Closed

snyk-bot mentioned this pull request Feb 22, 2022

[Snyk] Upgrade axios from 0.19.2 to 0.25.0 dfds/micro-frontend-poc#8

Closed

snyk-bot mentioned this pull request Mar 16, 2022

[Snyk] Upgrade axios from 0.19.2 to 0.26.0 dfds/micro-frontend-poc#16

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

JSON improvements: throw if JSON parsing failed; number, boolean can be passed directly as payload for encoding to JSON #2613, #61, #907 #3688

JSON improvements: throw if JSON parsing failed; number, boolean can be passed directly as payload for encoding to JSON #2613, #61, #907 #3688

DigitalBrainJS commented Mar 19, 2021 •

edited

jasonsaayman left a comment

DigitalBrainJS commented Apr 19, 2021

DigitalBrainJS commented Apr 19, 2021

rinsuki commented Jul 26, 2021

kawanet commented Sep 5, 2021

burgalon commented Sep 5, 2021

kawanet commented Sep 5, 2021 •

edited

phil-w commented Sep 6, 2021

luchaos Sep 7, 2021 •

edited

jasonsaayman Sep 7, 2021

luchaos Sep 7, 2021 •

edited

fireairforce Sep 22, 2021

luchaos Sep 23, 2021

landerson-gc Sep 11, 2021

Fezi32 Dec 8, 2021

landerson-gc Dec 8, 2021

Fezi32 Dec 9, 2021

JSON improvements: throw if JSON parsing failed; number, boolean can be passed directly as payload for encoding to JSON #2613, #61, #907 #3688

JSON improvements: throw if JSON parsing failed; number, boolean can be passed directly as payload for encoding to JSON #2613, #61, #907 #3688

Conversation

DigitalBrainJS commented Mar 19, 2021 • edited

When silentJSONParsing is false & responseType is 'json':

When silentJSONParsing is true (default value & current behaviour):

jasonsaayman left a comment

Choose a reason for hiding this comment

DigitalBrainJS commented Apr 19, 2021

DigitalBrainJS commented Apr 19, 2021

rinsuki commented Jul 26, 2021

kawanet commented Sep 5, 2021

burgalon commented Sep 5, 2021

kawanet commented Sep 5, 2021 • edited

phil-w commented Sep 6, 2021

luchaos Sep 7, 2021 • edited

Choose a reason for hiding this comment

jasonsaayman Sep 7, 2021

Choose a reason for hiding this comment

luchaos Sep 7, 2021 • edited

Choose a reason for hiding this comment

fireairforce Sep 22, 2021

Choose a reason for hiding this comment

luchaos Sep 23, 2021

Choose a reason for hiding this comment

landerson-gc Sep 11, 2021

Choose a reason for hiding this comment

Fezi32 Dec 8, 2021

Choose a reason for hiding this comment

landerson-gc Dec 8, 2021

Choose a reason for hiding this comment

Fezi32 Dec 9, 2021

Choose a reason for hiding this comment

DigitalBrainJS commented Mar 19, 2021 •

edited

kawanet commented Sep 5, 2021 •

edited

luchaos Sep 7, 2021 •

edited

luchaos Sep 7, 2021 •

edited