Commit fd55d3c
lib: clean up persisted signals when they are settled
PR-URL: #56001
Refs: #55328
Fixes: #55328
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
Reviewed-By: Jason Zhang <xzha4350@gmail.com>
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>1 parent 84f98e0 commit fd55d3c
2 files changed
Lines changed: 77 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -96,8 +96,21 @@ const dependantSignalsCleanupRegistry = new SafeFinalizationRegistry((signalWeak | |||
| 96 | 96 | } | |
| 97 | 97 | }); | |
| 98 | 98 | }); | |
| 99 | + | ||
| 99 | 100 | const gcPersistentSignals = new SafeSet(); | |
| 100 | 101 | ||
| 102 | + const sourceSignalsCleanupRegistry = new SafeFinalizationRegistry(({ sourceSignalRef, composedSignalRef }) => { | ||
| 103 | + const composedSignal = composedSignalRef.deref(); | ||
| 104 | + if (composedSignal !== undefined) { | ||
| 105 | + composedSignal[kSourceSignals].delete(sourceSignalRef); | ||
| 106 | + | ||
| 107 | + if (composedSignal[kSourceSignals].size === 0) { | ||
| 108 | + // This signal will no longer abort. There's no need to keep it in the gcPersistentSignals set. | ||
| 109 | + gcPersistentSignals.delete(composedSignal); | ||
| 110 | + } | ||
| 111 | + } | ||
| 112 | + }); | ||
| 113 | + | ||
| 101 | 114 | const kAborted = Symbol('kAborted'); | |
| 102 | 115 | const kReason = Symbol('kReason'); | |
| 103 | 116 | const kCloneData = Symbol('kCloneData'); | |
@@ -260,6 +273,10 @@ class AbortSignal extends EventTarget { | |||
| 260 | 273 | resultSignal[kSourceSignals].add(signalWeakRef); | |
| 261 | 274 | signal[kDependantSignals].add(resultSignalWeakRef); | |
| 262 | 275 | dependantSignalsCleanupRegistry.register(resultSignal, signalWeakRef); | |
| 276 | + sourceSignalsCleanupRegistry.register(signal, { | ||
| 277 | + sourceSignalRef: signalWeakRef, | ||
| 278 | + composedSignalRef: resultSignalWeakRef, | ||
| 279 | + }); | ||
| 263 | 280 | } else if (!signal[kSourceSignals]) { | |
| 264 | 281 | continue; | |
| 265 | 282 | } else { | |
@@ -277,6 +294,10 @@ class AbortSignal extends EventTarget { | |||
| 277 | 294 | resultSignal[kSourceSignals].add(sourceSignalWeakRef); | |
| 278 | 295 | sourceSignal[kDependantSignals].add(resultSignalWeakRef); | |
| 279 | 296 | dependantSignalsCleanupRegistry.register(resultSignal, sourceSignalWeakRef); | |
| 297 | + sourceSignalsCleanupRegistry.register(signal, { | ||
| 298 | + sourceSignalRef: sourceSignalWeakRef, | ||
| 299 | + composedSignalRef: resultSignalWeakRef, | ||
| 300 | + }); | ||
| 280 | 301 | } | |
| 281 | 302 | } | |
| 282 | 303 | } | |
@@ -436,6 +457,7 @@ class AbortController { | |||
| 436 | 457 | */ | |
| 437 | 458 | get signal() { | |
| 438 | 459 | this.#signal ??= new AbortSignal(kDontThrowSymbol); | |
| 460 | + | ||
| 439 | 461 | return this.#signal; | |
| 440 | 462 | } | |
| 441 | 463 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -64,6 +64,41 @@ function runShortLivedSourceSignal(limit, done) { | |||
| 64 | 64 | run(1); | |
| 65 | 65 | }; | |
| 66 | 66 | ||
| 67 | + function runWithOrphanListeners(limit, done) { | ||
| 68 | + let composedSignalRef; | ||
| 69 | + const composedSignalRefs = []; | ||
| 70 | + const handler = () => { }; | ||
| 71 | + | ||
| 72 | + function run(iteration) { | ||
| 73 | + const ac = new AbortController(); | ||
| 74 | + if (iteration > limit) { | ||
| 75 | + setImmediate(() => { | ||
| 76 | + global.gc(); | ||
| 77 | + setImmediate(() => { | ||
| 78 | + global.gc(); | ||
| 79 | + | ||
| 80 | + done(composedSignalRefs); | ||
| 81 | + }); | ||
| 82 | + }); | ||
| 83 | + return; | ||
| 84 | + } | ||
| 85 | + | ||
| 86 | + composedSignalRef = new WeakRef(AbortSignal.any([ac.signal])); | ||
| 87 | + composedSignalRef.deref().addEventListener('abort', handler); | ||
| 88 | + | ||
| 89 | + const otherComposedSignalRef = new WeakRef(AbortSignal.any([composedSignalRef.deref()])); | ||
| 90 | + otherComposedSignalRef.deref().addEventListener('abort', handler); | ||
| 91 | + | ||
| 92 | + composedSignalRefs.push(composedSignalRef, otherComposedSignalRef); | ||
| 93 | + | ||
| 94 | + setImmediate(() => { | ||
| 95 | + run(iteration + 1); | ||
| 96 | + }); | ||
| 97 | + } | ||
| 98 | + | ||
| 99 | + run(1); | ||
| 100 | + } | ||
| 101 | + | ||
| 67 | 102 | const limit = 10_000; | |
| 68 | 103 | ||
| 69 | 104 | describe('when there is a long-lived signal', () => { | |
@@ -120,3 +155,23 @@ it('drops settled dependant signals when signal is composite', (t, done) => { | |||
| 120 | 155 | }); | |
| 121 | 156 | }); | |
| 122 | 157 | }); | |
| 158 | + | ||
| 159 | + it('drops settled signals even when there are listeners', (t, done) => { | ||
| 160 | + runWithOrphanListeners(limit, (signalRefs) => { | ||
| 161 | + setImmediate(() => { | ||
| 162 | + global.gc(); | ||
| 163 | + setImmediate(() => { | ||
| 164 | + global.gc(); // One more call needed to clean up the deeper composed signals | ||
| 165 | + setImmediate(() => { | ||
| 166 | + global.gc(); // One more call needed to clean up the deeper composed signals | ||
| 167 | + | ||
| 168 | + const unGCedSignals = [...signalRefs].filter((ref) => ref.deref()); | ||
| 169 | + | ||
| 170 | + t.assert.strictEqual(unGCedSignals.length, 0); | ||
| 171 | + | ||
| 172 | + done(); | ||
| 173 | + }); | ||
| 174 | + }); | ||
| 175 | + }); | ||
| 176 | + }); | ||
| 177 | + }); | ||
0 commit comments