IT博客汇 | 关于Promise内存泄漏的问题

关于Promise内存泄漏的问题

TAT.云中飞扬发表于 2015-05-30 12:57:25

Promise

Promise是ES6的新特性，在ES6之前各大浏览器、各种polyfill和各种js执行环境都针对Promise进行了自己的实现，不过实现上大同小异。

V8 Promise内存泄漏

不过V8对Promise的实现存在内存泄漏问题，当一个promise无法resolve也无法reject的时候，就会发生内存泄漏。

一个很容易造成Promise内存泄漏的场景便是递归Promise或者嵌套Promise。

为方便观察内存使用情况，下面是一段在Nodejs里面运行的代码

(function() {
    // 记录Promise链的长度
    var i = 0;
    function run() {
        return new Promise(function(resolve) {
            // 每增加10000个Promise打印一次内存使用情况
            if (i % 10000 === 0) console.log(i);
            i++;
            // 模拟一个异步操作
            setTimeout(function() {
                // 100000个Promise之后退出
                if(i === 10000 * 10) return resolve();
                // 如果resolve的参数是一个Promise，外层Promise将接管这个Promise的状态，构成嵌套Promise
                resolve(run());
            }, 0);
        }).then(function() {});
    }
    run();
})();

在我的电脑上输出：

{ rss: 18649088, heapTotal: 12359168, heapUsed: 5261784 }
{ rss: 47480832, heapTotal: 54668544, heapUsed: 23838080 }
{ rss: 78712832, heapTotal: 69115648, heapUsed: 38977672 }
{ rss: 96018432, heapTotal: 84594688, heapUsed: 56701128 }
{ rss: 112631808, heapTotal: 101105664, heapUsed: 72469704 }
{ rss: 129875968, heapTotal: 118648576, heapUsed: 88569232 }
{ rss: 147075072, heapTotal: 135159552, heapUsed: 104614336 }
{ rss: 164286464, heapTotal: 151670528, heapUsed: 120667096 }
{ rss: 181628928, heapTotal: 169213440, heapUsed: 136718144 }
{ rss: 193110016, heapTotal: 180564736, heapUsed: 157979448 }

关键代码就是这一行

// 如果resolve的参数是一个Promise，外层Promise将接管这个Promise的状态，构成嵌套Promise
resolve(run());

嵌套的Prosise形成了一个Promise状态链，外层Promise等待内层Promise调用resolve或者reject，因为V8原生的Promise实现存在缺陷，这样使用之后会积累一大坨Promise，无法被释放，所以就造成了内存泄漏。

有趣的是，将代码稍作修改，将第5行的return去掉，却不会出现内存泄漏的问题

(function() {
    // 记录Promise链的长度
    var i = 0;
    function run() {
        // 去掉return
        new Promise(function(resolve) {
            // 每增加10000个Promise打印一次内存使用情况
            if (i % 10000 === 0) console.log(process.memoryUsage());
            i++;
            // 模拟一个异步操作
            setImmediate(function() {
                // 100000个Promise之后退出
                if(i === 10000 * 10) return resolve();
                // 如果resolve的参数是一个Promise，外层Promise将接管这个Promise的状态，构成嵌套Promise
                resolve(run());
            });
        }).then(function() {});
    }
    run();
})();

输出：

{ rss: 18636800, heapTotal: 12359168, heapUsed: 5261760 }
{ rss: 26435584, heapTotal: 18550784, heapUsed: 8178720 }
{ rss: 26472448, heapTotal: 18550784, heapUsed: 6725168 }
{ rss: 26472448, heapTotal: 18550784, heapUsed: 9352496 }
{ rss: 26472448, heapTotal: 18550784, heapUsed: 7852088 }
{ rss: 26472448, heapTotal: 18550784, heapUsed: 6351640 }
{ rss: 26472448, heapTotal: 18550784, heapUsed: 8977488 }
{ rss: 26472448, heapTotal: 18550784, heapUsed: 7477072 }
{ rss: 26472448, heapTotal: 18550784, heapUsed: 5976560 }
{ rss: 26476544, heapTotal: 18550784, heapUsed: 8602336 }

究其原因是没构成嵌套Promise，run返回了undefined，不是一个Promise。

为了证明V8的实现确实存在问题，我们来看看bluebird的实现，bluebird是众多Promise polyfill中的一个。

使用bluebird来解决这个问题非常简单，只用将Promise替换成bluebird的实现，同时为每个Promise调用done，关于为什么Prosime需要done，请看这里

var Promise = require('bluebird');
(function() {
    // 记录Promise链的长度
    var i = 0;
    function run() {
        return new Promise(function(resolve) {
            // 每增加10000个Promise打印一次内存使用情况
            if (i % 10000 === 0) console.log(process.memoryUsage());
            i++;
            // 模拟一个异步操作
            setImmediate(function() {
                // 100000个Promise之后退出
                if(i === 10000 * 10) return resolve();
                // 如果resolve的参数是一个Promise，外层Promise将接管这个Promise的状态，构成嵌套Promise
                resolve(run());
            });
        }).then(function() {}).done();
    }
    run();
})();

{ rss: 22421504, heapTotal: 14423040, heapUsed: 6167664 }
{ rss: 27738112, heapTotal: 18550784, heapUsed: 8497792 }
{ rss: 27770880, heapTotal: 18550784, heapUsed: 7449536 }
{ rss: 27774976, heapTotal: 18550784, heapUsed: 10486392 }
{ rss: 27774976, heapTotal: 18550784, heapUsed: 9395416 }
{ rss: 27774976, heapTotal: 18550784, heapUsed: 8304040 }
{ rss: 27779072, heapTotal: 18550784, heapUsed: 7212688 }
{ rss: 27779072, heapTotal: 18550784, heapUsed: 10247776 }
{ rss: 27787264, heapTotal: 18550784, heapUsed: 9177776 }
{ rss: 27803648, heapTotal: 18550784, heapUsed: 8088968 }

done的作用是告诉引擎没有任何地方需要等Promise resolve或者reject了，可以gc掉了，因为状态已转移到内层Promise去了，只用保留最内层Promise即可。

到目前为止V8引擎还没实现原生的Promise.done。

总结一下

随着ES6/ES7的快速发展，Promise显得日益重要，今后将会有大量基于Promise的API出现
嵌套Promise应该属于反模式了吧，尽量避免写出这种代码
确保每一个Promise都会调用done，引擎不存在这种缺陷的情况除外
相信Promise会越来越好用，各个js引擎也会对Promise进行优化

以上纯属基于简单技术模型的研究，实际中遇到Promise内存泄漏往往很不好排查问题，如发现文章中有不足之处还望在留言中指出。