Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 34 additions & 9 deletions lib/internal/event_target.js
Original file line number Diff line number Diff line change
Expand Up @@ -461,7 +461,7 @@ const kFlagResistStopPropagation = 1 << 6;
// slower.
class Listener {
constructor(eventTarget, eventType, previous, listener, once, capture, passive,
isNodeStyleListener, weak, resistStopPropagation) {
isNodeStyleListener, weak, resistStopPropagation, signal, onAbort) {
this.next = undefined;
if (previous !== undefined)
previous.next = this;
Expand Down Expand Up @@ -514,6 +514,8 @@ class Listener {
};
this.listener = listener;
}
this.signalRef = signal === undefined ? undefined : new SafeWeakRef(signal);
this.onAbort = onAbort;
}

get once() {
Expand Down Expand Up @@ -556,6 +558,7 @@ class Listener {
if (this.next !== undefined)
this.next.previous = this.previous;
this.flags |= kFlagRemoved;
this.detachSignal();
if ((this.flags & kFlagWeak) !== 0) {
weakListeners().registry.unregister(this);
const weakKey = this.weakKeyRef?.deref();
Expand All @@ -570,6 +573,19 @@ class Listener {
}
}
}

detachSignal() {
const onAbort = this.onAbort;
if (onAbort === undefined)
return;
this.onAbort = undefined;
this.signalRef.deref()?.removeEventListener('abort', onAbort);
}
}

function detachSignals(root) {
for (let handler = root?.next; handler !== undefined; handler = handler.next)
handler.detachSignal();
}

function initEventTarget(self) {
Expand Down Expand Up @@ -646,6 +662,8 @@ class EventTarget {
let isNodeStyleListener = false;
let weak = false;
let resistStopPropagation = false;
let signal;
let onAbort;

// We flatten the options before the validateListener check because the
// spec requires us to hit getters.
Expand All @@ -656,7 +674,7 @@ class EventTarget {
once = Boolean(options.once);
capture = Boolean(options.capture);
passive = Boolean(options.passive);
const signal = options.signal;
signal = options.signal;
weak = options[kWeakHandler];
resistStopPropagation = options[kResistStopPropagation] ?? false;
isNodeStyleListener = Boolean(options[kIsNodeStyleListener]);
Expand All @@ -670,9 +688,11 @@ class EventTarget {
// Capture a copy so that the closure doesn't move `capture` into the
// function context, which slows down the listener lookup below.
const removeCapture = capture;
signal.addEventListener('abort', () => {
onAbort = () => {
this.removeEventListener(type, listener, removeCapture);
}, { __proto__: null, once: true, [kWeakHandler]: this, [kResistStopPropagation]: true });
};
signal.addEventListener('abort', onAbort,
{ __proto__: null, once: true, [kWeakHandler]: this, [kResistStopPropagation]: true });
}
}

Expand All @@ -698,7 +718,7 @@ class EventTarget {
root = { size: 1, next: undefined, resistStopPropagation: Boolean(resistStopPropagation) };
// This is the first handler in our linked list.
new Listener(this, type, root, listener, once, capture, passive,
isNodeStyleListener, weak, resistStopPropagation);
isNodeStyleListener, weak, resistStopPropagation, signal, onAbort);
this[kNewListener](
root.size,
type,
Expand All @@ -725,7 +745,7 @@ class EventTarget {
}

new Listener(this, type, previous, listener, once, capture, passive,
isNodeStyleListener, weak, resistStopPropagation);
isNodeStyleListener, weak, resistStopPropagation, signal, onAbort);
root.size++;
root.resistStopPropagation ||= Boolean(resistStopPropagation);
this[kNewListener](root.size, type, listener, once, capture, passive, weak);
Expand Down Expand Up @@ -1068,10 +1088,15 @@ class NodeEventTarget extends EventTarget {
throw new ERR_INVALID_THIS('NodeEventTarget');
if (this[kEvents] === undefined)
return this;
if (type !== undefined)
this[kEvents].delete(String(type));
else
if (type !== undefined) {
type = String(type);
detachSignals(this[kEvents].get(type));
this[kEvents].delete(type);
} else {
for (const { 1: root } of this[kEvents])
detachSignals(root);
this[kEvents].clear();
}

return this;
}
Expand Down
25 changes: 25 additions & 0 deletions test/parallel/test-eventtarget-signal-listener-cleanup.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
'use strict';
const common = require('../common');
const assert = require('node:assert');
const { getEventListeners } = require('node:events');

const et = new EventTarget();
const controller = new AbortController();
const { signal } = controller;
const abortListeners = () => getEventListeners(signal, 'abort').length;

function handler() {}

et.addEventListener('foo', handler, { signal });
et.removeEventListener('foo', handler);
assert.strictEqual(abortListeners(), 0);

et.addEventListener('foo', common.mustCall(), { signal, once: true });
et.dispatchEvent(new Event('foo'));
assert.strictEqual(abortListeners(), 0);

et.addEventListener('foo', common.mustNotCall(), { signal });
assert.strictEqual(abortListeners(), 1);
controller.abort();
assert.strictEqual(abortListeners(), 0);
et.dispatchEvent(new Event('foo'));
Loading