NODE JS утечка памяти Event Listener

2022-02-02 18:13 Блог разработчика

Куда вечно утекает память?

(node) warning: possible EventEmitter memory leak detected.

Ошибка, которая будоражит умы многих разработчиков. Я тут поседел еще больше пока решал как её обойти.[spoiler]

Что такое утечка памяти интересно и подробно рассказано тут.

Я рассмотрю конкретный кейс.

Задача: есть некий хост - сервер. К нему я подключаюсь по net socket используя адрес и порт.

Время от времени порт закрывается и подключение пропадает. Нужно ждать когда порт откроется и подключиться снова.

var net = require('net');
const client = new net.Socket();
let _connect_ = function () {
client.connect(port, host, function (err) {
if (err) {
console.log("error");
console.log(err);
}
console.log("connected");
});
}
client.on('error', function () {
console.log("connection error");
setTimeout(function(){_connect_();}, 1000);
});

Если сервер доступен то подключение произойдет. А если нет - увидим ошибку. Но не беда, через секунду попробуем снова.

Тут то мы и получаем утечку памяти. Т.к. подобная схема плодит бесконечное количество подписок на события client.on 'error'. А если мы добавим еще обработчиков событий (client.on 'data', например), то их количество увеличиться кратно.

Добрые люди советуют указать такую строку в начале:

process.setMaxListeners(0);

Это не решает проблему, только убирает сообщения об утечках. Как говориться, если я ничего не вижу то и меня никто не видит.

Правильно решать такую проблему нужно удалением не нужных прослушивателей. Для этого есть команда:

client.removeAllListeners();

Она очищает подписки на события для этого эмиттера. Всё что нам нужно это заново их потом создать. Можно не удалять все подписки, а только конкретную. Подробнее описано тут.

Итак финальный вариант примерно такой:

var net = require('net');
const client = new net.Socket();
let _connect_ = function () {
client.connect(port_one, host_one, function (err) {
if (err) {
console.log("error");
console.log(err);
}
console.log("connected");
});
}
client.on('error', function () {
console.log("connection error");
reconnect ();
});

function reconnect () {
client.removeAllListeners();
client.on('error', function () {
console.log("connection error");
});
setTimeout(function(){_connect_();}, 1000);
}