Fixed cancelToken leakage; Added AbortController support; by DigitalBrainJS · Pull Request #3305 · axios/axios

DigitalBrainJS · 2020-09-28T20:22:36Z

This PR fixes cancelToken and adds an alternative way to cancel Axios request with AbortController.

Reworked cancelToken to fix memory leakage in case of using a persistent token for several requests. This can happen because requests cannot unsubscribe from the token after it completed since cancelToken doesn't provide any methods to do this. Possible this is a fix for CancelToken causes memory leak if re-used for multiple requests #3001 issue, but I'm not sure.
Added AbortController support. I believe that using the existing API makes it easier to use the library.
CancelToken and AbortController can be used simultaneously (to facilitate the transition to the new API)
No breaking changes.

const controller = new AbortController();

axios.get('http://localhost/', {
    signal: controller.signal
}).then(
    response=> console.log('Done:', response.data), 
    err=> console.log('Failed:', err)
);

setTimeout(()=>{
    controller.abort();
}, 1000)

Recently published as axios-lab npm fork
Live demo

Added AbortController support;

…cancel-token-leak

…el-token-leak � Conflicts: � package.json

…sending a request;

Nigui · 2021-04-14T06:54:21Z

Any updates about feature integration in master branch ? It seems to be a very useful feature for me.

DigitalBrainJS · 2021-04-14T12:12:17Z

Just for testing purposes, you can play around with this and some other PRs in this sandbox;

…el-token-leak � Conflicts: � index.d.ts � lib/adapters/xhr.js

…cancel-token-leak

…el-token-leak � Conflicts: � README.md

plandem · 2021-06-10T22:03:31Z

any blockers? It would be nice to have that support without breaking changes.

DigitalBrainJS · 2021-06-11T22:07:24Z

@jasonsaayman Is there any chance that this PR will be reviewed? :)

Ruegen · 2021-06-25T04:04:22Z

@jasonsaayman I would love to see this in too

JamesHarrisonZa · 2021-06-29T00:18:52Z

Im migrating our Web applications api client from fetch to axios and we have consumers passing signal so would love this to be supported.

julesrx · 2021-07-17T22:37:36Z

Would like to see this merged too.
I'm seeing around 40Mb more in memory heap when using a single cancel token with 5k+ requests.

zuzusik · 2021-08-23T18:11:41Z

Would love this one to get in!

…el-token-leak

nickserv · 2021-09-13T19:42:04Z

The proposal for cancelToken has been withdrawn, this should be merged to maintain cancellation support.

… fix/cancel-token-leak

…cancel-token-leak

DigitalBrainJS · 2021-09-15T13:54:54Z

@jasonsaayman rebased this on 0.22.0 just in case ;)

* fix/Avoid package.json import; (#4041) * Added auto-generated config module `env/data.js` for importing package environment vars without importing the whole `package.json`; Refactored `http.js` to use `env/data.js` instead of package.json; * Added `env/data.js`; Added `env/README.md`; * Feat/export package version constant (#4065) * Added auto-generated config module `env/data.js` for importing package environment vars without importing the whole `package.json`; Refactored `http.js` to use `env/data.js` instead of package.json; * Added `env/data.js`; Added `env/README.md`; * Export package version constant; * Fixed cancelToken leakage; Added AbortController support; (#3305) * Fixed cancelToken leakage; Added AbortController support; * Fixed typings; * Documented `signal` option; * Added processing of early cancellation using AbortController without sending a request; Co-authored-by: Jay <jasonsaayman@gmail.com> * Updating CI to run on release branches * Fixed default transitional config for custom Axios instance; (#4052) Refactored `/core/mergeConfig`; Co-authored-by: Jay <jasonsaayman@gmail.com> * Prepping v0.22.0 for release * Updated date Co-authored-by: Dmitriy Mozgovoy <robotshara@gmail.com>

* fix/Avoid package.json import; (axios#4041) * Added auto-generated config module `env/data.js` for importing package environment vars without importing the whole `package.json`; Refactored `http.js` to use `env/data.js` instead of package.json; * Added `env/data.js`; Added `env/README.md`; * Feat/export package version constant (axios#4065) * Added auto-generated config module `env/data.js` for importing package environment vars without importing the whole `package.json`; Refactored `http.js` to use `env/data.js` instead of package.json; * Added `env/data.js`; Added `env/README.md`; * Export package version constant; * Fixed cancelToken leakage; Added AbortController support; (axios#3305) * Fixed cancelToken leakage; Added AbortController support; * Fixed typings; * Documented `signal` option; * Added processing of early cancellation using AbortController without sending a request; Co-authored-by: Jay <jasonsaayman@gmail.com> * Updating CI to run on release branches * Fixed default transitional config for custom Axios instance; (axios#4052) Refactored `/core/mergeConfig`; Co-authored-by: Jay <jasonsaayman@gmail.com> * Prepping v0.22.0 for release * Updated date Co-authored-by: Dmitriy Mozgovoy <robotshara@gmail.com>

CodeJuggernaut · 2022-07-28T21:59:25Z

error TS2739: Type 'AbortSignal' is missing the following properties from type 'AbortSignal': reason, throwIfAborted
error TS2322: Type 'import("/node_modules/node-abort-controller/index").AbortSignal' is not assignable to type 'AbortSignal'.

The type signatures don't match on axios@0.27.2 and node-abort-controller@3.0.1, also doesn't match on abort-controller@3.0.0

The workaround is to cast it as any which is not good, but works until a better solution is found.

          {
            signal: options.signal as any
          }

Hitotsubashi · 2022-08-17T13:11:54Z

+  this.promise.then = function(onfulfilled) {
+    var _resolve;
+    // eslint-disable-next-line func-names
+    var promise = new Promise(function(resolve) {
+      token.subscribe(resolve);
+      _resolve = resolve;
+    }).then(onfulfilled);
+
+    promise.cancel = function reject() {
+      token.unsubscribe(_resolve);
+    };
+
+    return promise;
+  };
+


Since you had removed code "config.cancelToken.promise.then(function onCanceled(cancel) " from the file named "adapter/xhr.js" in this commit, I think lines 38~52 are no longer needed.

I try to remove lines 38~52 here and then run the script "npm run test", finally find out that all tests are passed.

Yes, but CancelToken is a public interface, so we can't be sure that user code is somehow not relying on its thenable/promise interface. IMHO, this should be kept as long as the CancelToken exists in the codebase.

DigitalBrainJS added 2 commits September 28, 2020 22:51

Fixed cancelToken leakage;

37873c7

Added AbortController support;

Merge branch 'master' into fix/cancel-token-leak

ee8d079

chinesedfan added the type:future proposal label Oct 17, 2020

chinesedfan mentioned this pull request Oct 17, 2020

An alternative way to cancel requests using promise.cancel method #3295

Closed

Merge branch 'master' into fix/cancel-token-leak

3e16235

DigitalBrainJS mentioned this pull request Dec 29, 2020

Support AbortSignal for aborting requests #3506

Closed

r3c mentioned this pull request Feb 8, 2021

CancelToken causes memory leak if re-used for multiple requests #3001

Closed

DigitalBrainJS added 9 commits February 9, 2021 14:36

Fixed typings;

4791ec8

Documented signal option;

322ab08

Merge remote-tracking branch 'origin/fix/cancel-token-leak' into fix/…

bb4f877

…cancel-token-leak

Merge branch 'master' of https://github.com/axios/axios into fix/canc…

d8818f5

…el-token-leak � Conflicts: � package.json

Added processing of early cancellation using AbortController without …

64862c5

…sending a request;

Merge branch 'master' into fix/cancel-token-leak

1ad25f1

Merge branch 'master' into fix/cancel-token-leak

1cd76e2

Merge branch 'master' into fix/cancel-token-leak

67eed20

Merge branch 'master' into fix/cancel-token-leak

b55281d

DigitalBrainJS added 2 commits April 21, 2021 18:26

Merge branch 'master' of https://github.com/axios/axios into fix/canc…

45d4797

…el-token-leak � Conflicts: � index.d.ts � lib/adapters/xhr.js

Merge remote-tracking branch 'origin/fix/cancel-token-leak' into fix/…

1e151f7

…cancel-token-leak

DigitalBrainJS mentioned this pull request Apr 23, 2021

Increased response time after too much cancelled request #3766

Closed

Merge branch 'master' of https://github.com/axios/axios into fix/canc…

f16938b

…el-token-leak � Conflicts: � README.md

ziruihao mentioned this pull request Aug 1, 2021

Abort requests via FetchInit signal abort lifeomic/axios-fetch#81

Open

Merge branch 'master' into fix/cancel-token-leak

c2bb331

DigitalBrainJS added 2 commits September 5, 2021 14:45

Merge branch 'master' of https://github.com/axios/axios into fix/canc…

1fb1364

…el-token-leak

Merge branch 'master' into fix/cancel-token-leak

f4fb0ad

DigitalBrainJS mentioned this pull request Sep 10, 2021

Axios race condition with cancel token? #4043

Closed

DigitalBrainJS added 2 commits September 15, 2021 16:32

Merge branch 'release/v0.22.0' of https://github.com/axios/axios into…

11bd6f7

… fix/cancel-token-leak

Merge remote-tracking branch 'origin/fix/cancel-token-leak' into fix/…

f43e9c9

…cancel-token-leak

DigitalBrainJS changed the base branch from master to release/v0.22.0 September 15, 2021 13:36

jasonsaayman merged commit 9bcff10 into axios:release/v0.22.0 Sep 16, 2021

jasonsaayman mentioned this pull request Oct 1, 2021

Release/v0.22.0 #4107

Merged

GulajavaMinistudio mentioned this pull request Oct 1, 2021

Choose two branches to see what’s javascript-indonesias/axios#105

Merged

Jujulego mentioned this pull request Oct 1, 2021

Use AbortController to cancel axios request Jujulego/alma#42

Closed

redpeacock78 mentioned this pull request Oct 2, 2021

Update axios to the latest version redpeacock78/line-sticker-downloder#15

Merged

19shubham11 mentioned this pull request Nov 26, 2021

Update docs regarding cancellation axios/axios-docs#57

Closed

sync-by-unito bot mentioned this pull request Jan 6, 2022

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

Closed

This was referenced Feb 22, 2022

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

Closed

[Snyk] Upgrade axios from 0.21.4 to 0.25.0 dfds/blaster#234

Closed

RobertBoes mentioned this pull request Mar 8, 2022

Update axios version inertiajs/inertia#1116

Merged

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

Hitotsubashi reviewed Aug 17, 2022

View reviewed changes

shaneomatz mentioned this pull request Nov 18, 2022

[Snyk] Upgrade axios from 0.21.1 to 0.27.2 shaneomatz/opensupports#2

Open

kiki-zjq mentioned this pull request May 22, 2023

Axios 源码解析 kiki-zjq/Blog#1

Open

This was referenced Oct 27, 2025

Bump axios from 0.16.2 to 1.13.0 Pouria-FOSSA/dependabot-metadata-test#74

Closed

Bump axios from 0.16.2 to 1.13.1 Pouria-FOSSA/dependabot-metadata-test#75

Open

Uh oh!

Conversation

DigitalBrainJS commented Sep 28, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Nigui commented Apr 14, 2021

Uh oh!

DigitalBrainJS commented Apr 14, 2021

Uh oh!

plandem commented Jun 10, 2021

Uh oh!

DigitalBrainJS commented Jun 11, 2021

Uh oh!

Ruegen commented Jun 25, 2021

Uh oh!

JamesHarrisonZa commented Jun 29, 2021

Uh oh!

julesrx commented Jul 17, 2021

Uh oh!

zuzusik commented Aug 23, 2021

Uh oh!

nickserv commented Sep 13, 2021

Uh oh!

DigitalBrainJS commented Sep 15, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

CodeJuggernaut commented Jul 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Hitotsubashi Aug 17, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DigitalBrainJS Sep 14, 2022

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

12 participants

DigitalBrainJS commented Sep 28, 2020 •

edited

Loading

DigitalBrainJS commented Sep 15, 2021 •

edited

Loading

CodeJuggernaut commented Jul 28, 2022 •

edited

Loading

Hitotsubashi Aug 17, 2022 •

edited

Loading