issue#2609 | Sasha | predictable axios requests #2702

SashaKoro · 2020-01-30T15:35:25Z

axios requests are not delayed by pre-emptive promise creation by default
add options to interceptors api ("synchronous" and "runWhen"
add documentation and unit tests

SashaKoro · 2020-01-30T15:36:06Z

Issue for context: #2609

SashaKoro · 2020-01-30T15:50:40Z

@chinesedfan Let me know if anything is unclear or needs some extra work. Happy to make changes. 😃

chinesedfan

@SashaKoro Really thanks for your work. Left some comments to discuss.

Shall we consider the response interceptors someday? How about call as synchronousRequest and requestWhen?
In fact, runWhen can be achieved by adding a conditional return statement in the beginning of interceptors. I want to make axios as simple as possible.
No need to update dist files, because we will update them together before releasing.

README.md

lib/core/Axios.js

test/specs/adapter.spec.js

test/specs/interceptors.spec.js

SashaKoro · 2020-01-31T15:44:13Z

@chinesedfan Thanks for the feedback! I will be working through the comments, responding and updating the MR over the next couple of days.

To answer the question of:

"How about call as synchronousRequest and requestWhen?"

I explicitly did not use request in the naming because the interceptors do not always fire requests inside of themselves. Sometimes they are just updating the configuration object, doing logging or updating UI state.

chinesedfan · 2020-02-01T04:41:55Z

I explicitly did not use request in the naming because the interceptors do not always fire requests inside of themselves. Sometimes they are just updating the configuration object, doing logging or updating UI state.

@SashaKoro My fault. axios.interceptors.request/response are both instances of InterceptorManager. And I have replied to other questions for you.

SashaKoro · 2020-02-05T16:27:29Z

To answer:

"In fact, runWhen can be achieved by adding a conditional return statement in the beginning of interceptors."

I put runWhen as a separate config option because axios needs to know if the interceptor will run before its executed. This is in the case where asynchronous interceptors that do not need to run can be filtered out prior to going into sync or async flows.

SashaKoro · 2020-02-05T16:31:31Z

To answer:

Shall we consider the response interceptors someday?

Yeah, that's a good call. Do you mind if I look at that as part of a separate MR? Just to wrap this one up (because that story could have its own unknowns).

- axios requests are not delayed by pre-emptive promise creation by default - add options to interceptors api ("synchronous" and "runWhen") - add documentation and unit tests

SashaKoro · 2020-02-05T18:39:55Z

@chinesedfan I've updated the pull request with the changes requested.

chinesedfan

@SashaKoro Resolved or replied old conversations. And left new comments for your updates.

Do you mind if I look at that as part of a separate MR? Just to wrap this one up (because that story could have its own unknowns).

Sure. I think less people care about that.

README.md

lib/core/Axios.js

test/specs/interceptors.spec.js

test/specs/adapter.spec.js

SashaKoro · 2020-02-07T15:15:46Z

@chinesedfan Pull request updated with requested changes

SashaKoro · 2020-02-13T19:11:04Z

@chinesedfan I will address your latest comments soon. This week has been pretty busy.

SashaKoro · 2020-02-14T22:24:57Z

@chinesedfan Pull request updated with requested changes.

- remove check for requestCancelled

SashaKoro · 2020-02-18T21:17:47Z

@chinesedfan Pull request updated with the new unit tests and the removed requestCancelled check.

chinesedfan

@SashaKoro No other reviewers now. After days, I checked this pull request again and found 2 new points.

chinesedfan · 2020-03-06T14:15:43Z

lib/core/Axios.js

-    chain.unshift(interceptor.fulfilled, interceptor.rejected);
+    if (typeof interceptor.runWhen === 'function' && interceptor.runWhen(config) === false) {
+      return;
+    }


As runWhen is executed immediately, we need to try/catch of it.

I'm a bit confused on this one. What do we want to do in the catch if the runWhen function fails? The function is provided by the consumer so we don't know what kind of errors it might throw. I would think we just want the program to fail at that point.

The axios configuration accepts other consumer provided functions such as validateStatus and paramsSerializer. Calls to those functions are not wrapped in try/catch blocks.

chinesedfan · 2020-03-06T14:18:29Z

lib/core/Axios.js

+    try {
+      newConfig = onFulfilled(newConfig);
+    } catch (error) {
+      onRejected(error);


If onRejected had solved the error, we should continue the loop. If not, should drop to the next onRejected.

Hmm, this would make the functionality different from the asynchronous behavior then.

When we have async interceptors we do a promise chain:

promise = promise.then(chain.shift(), chain.shift());

When any interceptor throws in a chained promise, the whole thing errors out.

@SashaKoro Sorry for my long long latency. I mean,

var f = function(name) { return function(...args) { console.log(name, args) } } Promise.reject('bad') .then(f('f1'), f('f2')) .then(f('f3'), f('f4')) // outputs f2 [ 'bad' ] f3 [ undefined ]

Even though the chain has an error, but f2 can resolve it and make the loop go on.

SashaKoro · 2020-03-20T22:22:04Z

@chinesedfan Hey! I will try to address the requested changes as soon as I can. Been pretty busy.

SashaKoro · 2020-04-11T15:02:28Z

@chinesedfan Hey, just replied to your comments. Sorry for the long delay. Things are pretty hectic.

SashaKoro · 2020-05-25T13:41:17Z

@chinesedfan Checking in on the status of this merge request.

BruceHubbard · 2020-06-19T13:20:17Z

@chinesedfan Did you see @SashaKoro's comments? We're still running on a fork of this library for now until this MR gets merged in.

briganti · 2021-01-10T22:28:23Z

@chinesedfan @yasuf any plan on merging this PR?

SashaKoro · 2021-02-23T02:18:28Z

@chinesedfan @yasuf @jasonsaayman

It's been a while and this cropped back up on my radar again.

Look, I know this is a big change but its also a valuable change. This merge request is already up to 75 comments and I've come back around and updated things several times. My last comments from 10 months did not receive a response. What is preventing this merge request from getting merged? (Besides getting the branch up to date)

jasonsaayman · 2021-02-23T05:55:48Z

@SashaKoro I will look at this in the evening my time and see if we can merge it. Can you tell me if this is up to date with the latest Axios version? Also, are we breaking any backward compatibility here? I have updated the branch so let's see if that comes out successful.

SashaKoro · 2021-02-23T15:00:52Z

@jasonsaayman

Hey Jay. Thanks for the quick reply. I'm gonna get myself up to speed with the latest axios version + backward compatibility this evening / tomorrow and get back to you.

SashaKoro · 2021-02-25T15:45:26Z

@jasonsaayman

I've done a thorough look through the axios commits to master since the original merge request timeline and did not find any potential issues. The merge request should break no backward capabilities.

This reverts commit 62d6256.

Since axios/axios#2702 (in axios 0.21.2) it is possible to avoid delay in requests. Interceptors set up by vue-auth are global, and are delaying every other callers.

Updates Typescript definition file to include types for the interceptor options that were added in axios#2702 so that Typescript users are able to safely consume this feature.

Axios recently added an option to specify whether a request interceptor is synchronous. See axios/axios#2702.

guyskk · 2021-12-25T14:17:05Z

lib/core/Axios.js

+    var chain = [dispatchRequest, undefined];
+
+    Array.prototype.unshift.apply(chain, requestInterceptorChain);
+    chain.concat(responseInterceptorChain);


@chinesedfan @SashaKoro Here is the bug of issue #4036! The concat method does not change the existing arrays, but instead returns a new array. It cause response interceptors not append into chain!

Yes, but it has been fixed in #4013 and released in v0.21.3.

* issue#2609 | Sasha | predictable axios requests - axios requests are not delayed by pre-emptive promise creation by default - add options to interceptors api ("synchronous" and "runWhen") - add documentation and unit tests * issue#2609 | Sasha | pull request feedback changes * issue#2609 | Sasha | additional feedback changes * issue#2609 | Sasha | put back try/catch * issue#2609 | Sasha | add 2 adapter unit tests - remove check for requestCancelled Co-authored-by: ak71845 <alexandre.korotkov@kroger.com> Co-authored-by: Xianming Zhong <chinesedfan@qq.com> Co-authored-by: Jay <jasonsaayman@gmail.com>

SashaKoro force-pushed the issue#2609 branch from 6885ac5 to 952426e Compare January 30, 2020 15:39

SashaKoro requested a review from chinesedfan January 30, 2020 15:49

chinesedfan suggested changes Jan 31, 2020

View reviewed changes

chinesedfan requested a review from yasuf January 31, 2020 09:00

issue#2609 | Sasha | predictable axios requests

1e4352a

- axios requests are not delayed by pre-emptive promise creation by default - add options to interceptors api ("synchronous" and "runWhen") - add documentation and unit tests

SashaKoro force-pushed the issue#2609 branch from 952426e to 1e4352a Compare February 5, 2020 18:37

chinesedfan suggested changes Feb 6, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

lib/core/Axios.js Outdated Show resolved Hide resolved

test/specs/interceptors.spec.js Outdated Show resolved Hide resolved

test/specs/adapter.spec.js Show resolved Hide resolved

issue#2609 | Sasha | pull request feedback changes

4be5d6d

issue#2609 | Sasha | additional feedback changes

29d13dd

SashaKoro added 2 commits February 17, 2020 10:44

issue#2609 | Sasha | put back try/catch

e1c2fb0

issue#2609 | Sasha | add 2 adapter unit tests

cfb8d6e

- remove check for requestCancelled

chinesedfan added the type:feature label Feb 19, 2020

chinesedfan approved these changes Feb 19, 2020

View reviewed changes

Merge branch 'master' into issue#2609

d73ff66

chinesedfan suggested changes Mar 6, 2020

View reviewed changes

jasonsaayman removed the type:feature label May 21, 2020

jasonsaayman added the status:work in progress label Jun 22, 2020

chinesedfan removed the status:work in progress label Aug 29, 2020

Merge branch 'master' into issue#2609

703bb26

jasonsaayman self-assigned this Mar 1, 2021

jasonsaayman added this to the v0.22.0 milestone Mar 1, 2021

jasonsaayman merged commit 62d6256 into axios:master Mar 1, 2021

jasonsaayman added this to Done in v0.22.0 Mar 17, 2021

jeremyxu2010 pushed a commit to jeremyxu2010/axios that referenced this pull request Jul 2, 2021

Revert "issue#2609 | Sasha | predictable axios requests (axios#2702)"

8264cd0

This reverts commit 62d6256.

Glandos mentioned this pull request Sep 8, 2021

Requests unexpectedly delayed due to an axios internal promise #2609

Closed

Glandos mentioned this pull request Sep 8, 2021

Use synchronous interceptors d0whc3r/vue-auth-plugin#351

Open

gfortaine mentioned this pull request Sep 9, 2021

Since 0.21.2, nock-based tests of client that uses axios fail #4036

Closed

jeffberry mentioned this pull request Oct 16, 2021

Update types to include newly added Interceptor Options #4195

Closed

yepitschunked added a commit to yepitschunked/axios-retry that referenced this pull request Nov 4, 2021

Mark request interceptor as synchronous

37a64fd

Axios recently added an option to specify whether a request interceptor is synchronous. See axios/axios#2702.

yepitschunked mentioned this pull request Nov 4, 2021

Mark request interceptor as synchronous softonic/axios-retry#188

Closed

guyskk reviewed Dec 25, 2021

View reviewed changes

iomariani mentioned this pull request Feb 4, 2022

Enhance + Types for AxiosInterceptorOptions #4444

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

issue#2609 | Sasha | predictable axios requests #2702

issue#2609 | Sasha | predictable axios requests #2702

SashaKoro commented Jan 30, 2020

SashaKoro commented Jan 30, 2020

SashaKoro commented Jan 30, 2020

chinesedfan left a comment

SashaKoro commented Jan 31, 2020 •

edited

chinesedfan commented Feb 1, 2020

SashaKoro commented Feb 5, 2020

SashaKoro commented Feb 5, 2020

SashaKoro commented Feb 5, 2020

chinesedfan left a comment

SashaKoro commented Feb 7, 2020

SashaKoro commented Feb 13, 2020

SashaKoro commented Feb 14, 2020

SashaKoro commented Feb 18, 2020

chinesedfan left a comment

chinesedfan Mar 6, 2020

SashaKoro Apr 11, 2020

chinesedfan Mar 6, 2020

SashaKoro Apr 11, 2020

chinesedfan Mar 1, 2021

SashaKoro commented Mar 20, 2020

SashaKoro commented Apr 11, 2020

SashaKoro commented May 25, 2020

BruceHubbard commented Jun 19, 2020

briganti commented Jan 10, 2021

SashaKoro commented Feb 23, 2021 •

edited

jasonsaayman commented Feb 23, 2021

SashaKoro commented Feb 23, 2021 •

edited

SashaKoro commented Feb 25, 2021 •

edited

guyskk Dec 25, 2021

chinesedfan Dec 28, 2021

issue#2609 | Sasha | predictable axios requests #2702

issue#2609 | Sasha | predictable axios requests #2702

Conversation

SashaKoro commented Jan 30, 2020

SashaKoro commented Jan 30, 2020

SashaKoro commented Jan 30, 2020

chinesedfan left a comment

Choose a reason for hiding this comment

SashaKoro commented Jan 31, 2020 • edited

chinesedfan commented Feb 1, 2020

SashaKoro commented Feb 5, 2020

SashaKoro commented Feb 5, 2020

SashaKoro commented Feb 5, 2020

chinesedfan left a comment

Choose a reason for hiding this comment

SashaKoro commented Feb 7, 2020

SashaKoro commented Feb 13, 2020

SashaKoro commented Feb 14, 2020

SashaKoro commented Feb 18, 2020

chinesedfan left a comment

Choose a reason for hiding this comment

chinesedfan Mar 6, 2020

Choose a reason for hiding this comment

SashaKoro Apr 11, 2020

Choose a reason for hiding this comment

chinesedfan Mar 6, 2020

Choose a reason for hiding this comment

SashaKoro Apr 11, 2020

Choose a reason for hiding this comment

chinesedfan Mar 1, 2021

Choose a reason for hiding this comment

SashaKoro commented Mar 20, 2020

SashaKoro commented Apr 11, 2020

SashaKoro commented May 25, 2020

BruceHubbard commented Jun 19, 2020

briganti commented Jan 10, 2021

SashaKoro commented Feb 23, 2021 • edited

jasonsaayman commented Feb 23, 2021

SashaKoro commented Feb 23, 2021 • edited

SashaKoro commented Feb 25, 2021 • edited

guyskk Dec 25, 2021

Choose a reason for hiding this comment

chinesedfan Dec 28, 2021

Choose a reason for hiding this comment

SashaKoro commented Jan 31, 2020 •

edited

SashaKoro commented Feb 23, 2021 •

edited

SashaKoro commented Feb 23, 2021 •

edited

SashaKoro commented Feb 25, 2021 •

edited