Skip to content

Commit ed69f9f

Browse files
committed
Preserve AbortSignal.any cancellation before source listeners run
1 parent 7fc911a commit ed69f9f

3 files changed

Lines changed: 159 additions & 18 deletions

File tree

‎packages/react-native/src/private/webapis/dom/abort-api/AbortSignal.js‎

Lines changed: 69 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,12 @@ import {AbortController} from './AbortController';
4444
const ABORTED_KEY: symbol = Symbol('aborted');
4545
const REASON_KEY: symbol = Symbol('reason');
4646

47+
const dependentSignals: WeakMap<AbortSignal, Set<AbortSignal>> = new WeakMap();
48+
const sourceSignalRefs: WeakMap<
49+
AbortSignal,
50+
ReadonlyArray<WeakRef<AbortSignal>>,
51+
> = new WeakMap();
52+
4753
/**
4854
* The signal class.
4955
* @see https://dom.spec.whatwg.org/#abortsignal
@@ -113,22 +119,37 @@ export class AbortSignal extends EventTarget {
113119
}
114120
}
115121

116-
// Third pass: none of the signals is aborted, so subscribe to all of them
117-
// and abort the resulting signal when any of them aborts.
118-
const controller = new AbortController();
119-
const listeners = [];
120-
const cleanup = () => listeners.forEach(unsubscribe => unsubscribe());
122+
const resultSignal = createAbortSignal();
123+
const resultSources: Set<AbortSignal> = new Set();
121124

122125
for (let i = 0; i < signals.length; i++) {
123126
const signal = signals[i];
124-
const onAbort = () => {
125-
controller.abort(signal.reason);
126-
cleanup();
127-
};
128-
signal.addEventListener('abort', onAbort);
129-
listeners.push(() => signal.removeEventListener('abort', onAbort));
127+
const sourceRefs = sourceSignalRefs.get(signal);
128+
if (sourceRefs == null) {
129+
resultSources.add(signal);
130+
} else {
131+
for (const sourceRef of sourceRefs) {
132+
const sourceSignal = sourceRef.deref();
133+
if (sourceSignal != null) {
134+
resultSources.add(sourceSignal);
135+
}
136+
}
137+
}
130138
}
131-
return controller.signal;
139+
140+
const resultSourceRefs: Array<WeakRef<AbortSignal>> = [];
141+
for (const sourceSignal of resultSources) {
142+
let dependents = dependentSignals.get(sourceSignal);
143+
if (dependents == null) {
144+
dependents = new Set();
145+
dependentSignals.set(sourceSignal, dependents);
146+
}
147+
dependents.add(resultSignal);
148+
resultSourceRefs.push(new WeakRef(sourceSignal));
149+
}
150+
sourceSignalRefs.set(resultSignal, resultSourceRefs);
151+
152+
return resultSignal;
132153
}
133154

134155
// $FlowExpectedError[unsupported-syntax]
@@ -201,7 +222,43 @@ export function abortSignal(
201222
signal[ABORTED_KEY] = true;
202223
// $FlowExpectedError[prop-missing]
203224
signal[REASON_KEY] = reason;
225+
226+
const dependentSignalsToAbort: Array<AbortSignal> = [];
227+
const dependents = dependentSignals.get(signal);
228+
if (dependents != null) {
229+
dependentSignals.delete(signal);
230+
for (const dependentSignal of dependents) {
231+
// $FlowExpectedError[invalid-compare]
232+
// $FlowExpectedError[prop-missing]
233+
if (dependentSignal[ABORTED_KEY] === false) {
234+
// $FlowExpectedError[prop-missing]
235+
dependentSignal[ABORTED_KEY] = true;
236+
// $FlowExpectedError[prop-missing]
237+
dependentSignal[REASON_KEY] = reason;
238+
unregisterDependentSignal(dependentSignal);
239+
dependentSignalsToAbort.push(dependentSignal);
240+
}
241+
}
242+
}
243+
204244
dispatchTrustedEvent(signal, new Event('abort'));
245+
for (const dependentSignal of dependentSignalsToAbort) {
246+
dispatchTrustedEvent(dependentSignal, new Event('abort'));
247+
}
248+
}
249+
250+
function unregisterDependentSignal(dependentSignal: AbortSignal): void {
251+
const sourceRefs = sourceSignalRefs.get(dependentSignal);
252+
if (sourceRefs == null) {
253+
return;
254+
}
255+
sourceSignalRefs.delete(dependentSignal);
256+
for (const sourceRef of sourceRefs) {
257+
const sourceSignal = sourceRef.deref();
258+
if (sourceSignal != null) {
259+
dependentSignals.get(sourceSignal)?.delete(dependentSignal);
260+
}
261+
}
205262
}
206263

207264
// Properties should be enumerable.

‎packages/react-native/src/private/webapis/dom/abort-api/__tests__/AbortController-itest.js‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -349,15 +349,17 @@ describe('AbortController', () => {
349349
const second = new AbortController();
350350
const reason = new Error('stop');
351351

352-
const signal = AbortSignal.any([first.signal, second.signal]);
352+
Fantom.runTask(() => {
353+
const signal = AbortSignal.any([first.signal, second.signal]);
353354

354-
expect(signal).toBeInstanceOf(AbortSignal);
355-
expect(signal.aborted).toBe(false);
355+
expect(signal).toBeInstanceOf(AbortSignal);
356+
expect(signal.aborted).toBe(false);
356357

357-
second.abort(reason);
358+
second.abort(reason);
358359

359-
expect(signal.aborted).toBe(true);
360-
expect(signal.reason).toBe(reason);
360+
expect(signal.aborted).toBe(true);
361+
expect(signal.reason).toBe(reason);
362+
});
361363
});
362364

363365
it('should abort immediately if one of the provided signals is already aborted', () => {
Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
/**
2+
* Copyright (c) Meta Platforms, Inc. and affiliates.
3+
*
4+
* This source code is licensed under the MIT license found in the
5+
* LICENSE file in the root directory of this source tree.
6+
*
7+
* @flow strict-local
8+
* @format
9+
*/
10+
11+
import {AbortController} from '../AbortController';
12+
import {AbortSignal} from '../AbortSignal';
13+
14+
describe('AbortSignal.any', () => {
15+
it('aborts the dependent signal even if a source listener stops propagation', () => {
16+
const source = new AbortController();
17+
source.signal.addEventListener('abort', event => {
18+
event.stopImmediatePropagation();
19+
});
20+
const signal = AbortSignal.any([source.signal]);
21+
22+
source.abort('cancelled');
23+
24+
expect(signal.aborted).toBe(true);
25+
expect(signal.reason).toBe('cancelled');
26+
});
27+
28+
it('marks dependent signals as aborted before dispatching to the source', () => {
29+
const source = new AbortController();
30+
let observed;
31+
source.signal.addEventListener('abort', () => {
32+
observed = [signal.aborted, signal.reason];
33+
});
34+
const signal = AbortSignal.any([source.signal]);
35+
36+
source.abort('reason');
37+
38+
expect(observed).toEqual([true, 'reason']);
39+
});
40+
41+
it('dispatches to the source and then to its dependents in creation order', () => {
42+
const first = new AbortController();
43+
const second = new AbortController();
44+
const inner = AbortSignal.any([first.signal, second.signal]);
45+
const outer = AbortSignal.any([inner, inner, first.signal]);
46+
const unrelated = AbortSignal.any([second.signal]);
47+
const events: Array<string> = [];
48+
first.signal.addEventListener('abort', () => {
49+
events.push('first');
50+
});
51+
inner.addEventListener('abort', () => {
52+
events.push('inner');
53+
});
54+
outer.addEventListener('abort', () => {
55+
events.push('outer');
56+
});
57+
unrelated.addEventListener('abort', () => {
58+
events.push('unrelated');
59+
});
60+
61+
first.abort('first reason');
62+
second.abort('second reason');
63+
64+
expect(events).toEqual(['first', 'inner', 'outer', 'unrelated']);
65+
expect(outer.reason).toBe('first reason');
66+
expect(unrelated.reason).toBe('second reason');
67+
});
68+
69+
it('keeps the first reason when a source listener aborts another source', () => {
70+
const first = new AbortController();
71+
const second = new AbortController();
72+
first.signal.addEventListener('abort', () => second.abort('second'));
73+
const signal = AbortSignal.any([first.signal, second.signal]);
74+
const listener = jest.fn();
75+
signal.addEventListener('abort', listener);
76+
77+
first.abort('first');
78+
79+
expect(signal.reason).toBe('first');
80+
expect(listener).toHaveBeenCalledTimes(1);
81+
});
82+
});

0 commit comments

Comments
 (0)