Skip to content

Commit d568600

Browse files
rluvatonRafaelGSS
authored andcommitted
events: remove weak listener for event target
Fixes: #48951 PR-URL: #48952 Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
1 parent dca8678 commit d568600

File tree

3 files changed

+56
-8
lines changed

3 files changed

+56
-8
lines changed

lib/internal/event_target.js

+34-5
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ const kWeakHandler = Symbol('kWeak');
6262
const kResistStopPropagation = Symbol('kResistStopPropagation');
6363

6464
const kHybridDispatch = SymbolFor('nodejs.internal.kHybridDispatch');
65+
const kRemoveWeakListenerHelper = Symbol('nodejs.internal.removeWeakListenerHelper');
6566
const kCreateEvent = Symbol('kCreateEvent');
6667
const kNewListener = Symbol('kNewListener');
6768
const kRemoveListener = Symbol('kRemoveListener');
@@ -410,7 +411,7 @@ let weakListenersState = null;
410411
let objectToWeakListenerMap = null;
411412
function weakListeners() {
412413
weakListenersState ??= new SafeFinalizationRegistry(
413-
(listener) => listener.remove(),
414+
({ eventTarget, listener, eventType }) => eventTarget.deref()?.[kRemoveWeakListenerHelper](eventType, listener),
414415
);
415416
objectToWeakListenerMap ??= new SafeWeakMap();
416417
return { registry: weakListenersState, map: objectToWeakListenerMap };
@@ -432,7 +433,7 @@ const kFlagResistStopPropagation = 1 << 6;
432433
// the linked list makes dispatching faster, even if adding/removing is
433434
// slower.
434435
class Listener {
435-
constructor(previous, listener, once, capture, passive,
436+
constructor(eventTarget, eventType, previous, listener, once, capture, passive,
436437
isNodeStyleListener, weak, resistStopPropagation) {
437438
this.next = undefined;
438439
if (previous !== undefined)
@@ -459,7 +460,13 @@ class Listener {
459460

460461
if (this.weak) {
461462
this.callback = new SafeWeakRef(listener);
462-
weakListeners().registry.register(listener, this, this);
463+
weakListeners().registry.register(listener, {
464+
__proto__: null,
465+
// Weak ref so the listener won't hold the eventTarget alive
466+
eventTarget: new SafeWeakRef(eventTarget),
467+
listener: this,
468+
eventType,
469+
}, this);
463470
// Make the retainer retain the listener in a WeakMap
464471
weakListeners().map.set(weak, listener);
465472
this.listener = this.callback;
@@ -625,7 +632,7 @@ class EventTarget {
625632
if (root === undefined) {
626633
root = { size: 1, next: undefined, resistStopPropagation: Boolean(resistStopPropagation) };
627634
// This is the first handler in our linked list.
628-
new Listener(root, listener, once, capture, passive,
635+
new Listener(this, type, root, listener, once, capture, passive,
629636
isNodeStyleListener, weak, resistStopPropagation);
630637
this[kNewListener](
631638
root.size,
@@ -652,7 +659,7 @@ class EventTarget {
652659
return;
653660
}
654661

655-
new Listener(previous, listener, once, capture, passive,
662+
new Listener(this, type, previous, listener, once, capture, passive,
656663
isNodeStyleListener, weak, resistStopPropagation);
657664
root.size++;
658665
root.resistStopPropagation ||= Boolean(resistStopPropagation);
@@ -695,6 +702,28 @@ class EventTarget {
695702
}
696703
}
697704

705+
[kRemoveWeakListenerHelper](type, listener) {
706+
const root = this[kEvents].get(type);
707+
if (root === undefined || root.next === undefined)
708+
return;
709+
710+
const capture = listener.capture === true;
711+
712+
let handler = root.next;
713+
while (handler !== undefined) {
714+
if (handler === listener) {
715+
handler.remove();
716+
root.size--;
717+
if (root.size === 0)
718+
this[kEvents].delete(type);
719+
// Undefined is passed as the listener as the listener was GCed
720+
this[kRemoveListener](root.size, type, undefined, capture);
721+
break;
722+
}
723+
handler = handler.next;
724+
}
725+
}
726+
698727
/**
699728
* @param {Event} event
700729
*/

test/parallel/test-eventtarget-memoryleakwarning.js

+20-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1-
// Flags: --no-warnings
1+
// Flags: --expose-internals --no-warnings --expose-gc
22
'use strict';
33
const common = require('../common');
44
const {
55
setMaxListeners,
66
EventEmitter,
77
} = require('events');
88
const assert = require('assert');
9+
const { kWeakHandler } = require('internal/event_target');
10+
const { setTimeout } = require('timers/promises');
911

1012
common.expectWarning({
1113
MaxListenersExceededWarning: [
@@ -73,3 +75,20 @@ common.expectWarning({
7375
setMaxListeners(2, ee);
7476
assert.strictEqual(ee.getMaxListeners(), 2);
7577
}
78+
79+
{
80+
(async () => {
81+
// Test that EventTarget listener don't emit MaxListenersExceededWarning for weak listeners that GCed
82+
const et = new EventTarget();
83+
setMaxListeners(2, et);
84+
85+
for (let i = 0; i <= 3; i++) {
86+
et.addEventListener('foo', () => {}, {
87+
[kWeakHandler]: {},
88+
});
89+
90+
await setTimeout(0);
91+
global.gc();
92+
}
93+
})().then(common.mustCall(), common.mustNotCall());
94+
}

test/parallel/test-eventtarget.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ const {
1616

1717
const { once } = require('events');
1818

19-
const { promisify, inspect } = require('util');
20-
const delay = promisify(setTimeout);
19+
const { inspect } = require('util');
20+
const { setTimeout: delay } = require('timers/promises');
2121

2222
// The globals are defined.
2323
ok(Event);

0 commit comments

Comments
 (0)