Memory leaks due to unmounting components with alive promises
まだ誰も着手していません。
- 主要言語
- JavaScript
- スター
- 11.8k
- フォーク
- 7.9k
- 平均マージ
- 1日 11時間
- マージ済み PR(30日)
- 11
説明
I just came to isMounted is an Antipattern article . I'm afraid that the solution using a cancelable promise you suggest here does not solve the potential memory leak, but hides it basically the same way as using isMounted would do.
Why?
The problem is that when a component starts some asynchronous operation (i.e. XHR) and passes a callback which should update component's state to a Promise or Promise-like interface, the callback holds a reference to the component so until the callback object exists, the component cannot be fully removed from memory.
When the cancelable promise you introduce here is canceled, no references are broken, just a boolean flag is set. Therefore the component stays in memory along with the promise.
In other words, it would be easy to un-cancel such promise by setting hasCancelled_ back to false, therefore the reference to the object have to still exist. The only thing this cancellable promise does (not) is skipping the call to resolve(val), but from the memory management view it is the same approach as asking for isMounted inside the component.
My opinion is that the only proper solution would be to abort async operations inside the promise (clear timeouts, abort XHRs) and delete the promise itself.
Update: I managed to prove my assumption using two test scripts:
// 1. create and cancel many promises, consumes all memory and crashes after a while
setInterval(()=>process.stdout.write(Math.round(process.memoryUsage().heapUsed / 1024) + " KiB \r"), 100);
const makeCancelable = (promise) => {
let hasCanceled_ = false;
const wrappedPromise = new Promise((resolve, reject) => {
promise.then(
val => hasCanceled_ ? reject({isCanceled: true}) : resolve(val),
error => hasCanceled_ ? reject({isCanceled: true}) : reject(error)
);
});
return {
promise: wrappedPromise,
cancel() {
hasCanceled_ = true;
},
};
};
const makeBigStuff = size => new Array(size);
const makeLongPromise = () => new Promise((resolve, reject) => {setTimeout(resolve, 60000);});
let promised;
setInterval(function() {
if (promised) {
promised.cancel();
}
const bigStuff = makeBigStuff(100000);
promised = makeCancelable(makeLongPromise());
promised.promise.then(function() {
bigStuff.noop && bigStuff.noop(); // just touch bigStuff somehow
});
}, 10);
// 2. destroy the reference to cancel running the callback,
// also disposing resources held by the callback to be garbage collected.
// No out of memory crashes occur.
setInterval(()=>process.stdout.write(Math.round(process.memoryUsage().heapUsed / 1024) + " KiB \r"), 100);
const weak = (callback) => {
weakfn = function () {
return callback && callback(...arguments);
};
weakfn.destroy = () => {
callback = undefined;
};
return weakfn;
};
const makeBigStuff = size => new Array(size);
const makeLongPromise = () => new Promise((resolve, reject) => {setTimeout(resolve, 60000);});
let weakCallback;
setInterval(function() {
if (weakCallback) {
weakCallback.destroy();
}
const bigStuff = makeBigStuff(100000);
promised = makeLongPromise();
weakCallback = weak(function() {
bigStuff.noop && bigStuff.noop(); // just touch bigStuff somehow
});
promised.then(weakCallback);
}, 10);
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
isMounted Antipattern の記事と、issue で参照されている cancelable-promise のガイダンスから始めます。提供された 2 つの JavaScript メモリテストを実行または調査し、キャンセルされた promise と、参照が破棄されたコールバックを比較します。文書化されたアプローチに報告された保持動作があるかどうかを判断し、それに応じてガイダンスを更新できれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- javascript, react
- 領域
- documentation
- issue の種類
- バグ
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 25/100