Repository navigation
Commit d2669f4
Android: make the batched-event-dispatch Choreographer frame callback one-shot (behind feature flag) (#58376)
Summary:
# Make the batched-event-dispatch Choreographer frame callback one-shot (Android)
Part of #58367. Split from #58368 per review feedback (one PR per pump, each behind a feature flag).
`FabricEventDispatcher.ScheduleDispatchFrameCallback.doFrame` calls `dispatchBatchedEvents()` at the end of every frame — which (despite the name) only **re-posts the same frame callback**. Events themselves are dispatched synchronously as they are emitted, so once this callback is posted it keeps the `TIMERS_EVENTS` Choreographer armed at vsync rate forever, doing no work each frame beyond re-posting itself and firing the batch-dispatched listeners.
This PR makes the callback one-shot, behind `ReactNativeFeatureFlags.disableIdleEventDispatchFrameCallbackRearmAndroid` (default **false** = current behavior; `ossReleaseStage: 'experimental'`):
- With the flag on, `doFrame` clears `isFrameCallbackDispatchScheduled` and does not re-post.
- Re-arming is already demand-driven in the existing code: `dispatchEvent` → `scheduleDispatchOfBatchedEvents` → `maybeDispatchBatchedEvents` posts the callback whenever new events arrive while it is not scheduled, and `onHostResume` re-posts.
## Foregrounding / backgrounding
`onHostPause` / `onHostDestroy` → `cancelDispatchOfBatchedEvents()` and `onHostResume` → `scheduleDispatchOfBatchedEvents()` + `currentFrameCallback.resume()` are untouched. On the paused (`shouldStop`) frame the batch-dispatched listeners still fire, exactly as on `main`.
## Rollout
Flag: `disableIdleEventDispatchFrameCallbackRearmAndroid` — `defaultValue: false`, `expectedReleaseValue: true`, `ossReleaseStage: 'experimental'`. With the flag off, behavior is identical to current `main`.
Changelog: [Internal]
Pull Request resolved: #58376
Test Plan:
- [x] Flag off (`defaultValue`): branch structure is identical to `main` (the legacy `shouldStop`/re-post path is taken verbatim).
- [x] Compiles: `./gradlew :packages:react-native:ReactAndroid:compileReleaseKotlin`.
- [ ] Flag on, real app on device (OnePlus 3T, Android 9): idle `adb shell atrace` shows the event-dispatch `doFrame` stops firing between event bursts; touch/scroll event delivery unchanged; pause/resume keeps events flowing after foreground return.
- [ ] Flag on: RNTester event integration tests pass.
## Changelog:
[Android] [Fixed] - Make the batched-event-dispatch Choreographer frame callback one-shot instead of re-posting itself every frame (behind `disableIdleEventDispatchFrameCallbackRearmAndroid`)
## Prior art
Same one-shot mechanism as #41658 (November 2023, removed by #43044 with the rest of `enableOnDemandReactChoreographer`). Comparison and analysis: #58367.
Reviewed By: christophpurrer
Differential Revision: D124365969
Pulled By: javache
fbshipit-source-id: 553e6679c5f13b4f4cb8f1d1ac5aaac1759a22c31 parent c389859 commit d2669f4
23 files changed
Lines changed: 243 additions & 111 deletions
File tree
- packages/react-native
- ReactAndroid/src/main
- java/com/facebook/react
- internal/featureflags
- uimanager/events
- jni/react/featureflags
- ReactCommon/react
- featureflags
- nativemodule/featureflags
- scripts/featureflags
- src/private/featureflags
- specs
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | | - | |
| 7 | + | |
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
| |||
60 | 60 | | |
61 | 61 | | |
62 | 62 | | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
63 | 69 | | |
64 | 70 | | |
65 | 71 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | | - | |
| 7 | + | |
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
| |||
25 | 25 | | |
26 | 26 | | |
27 | 27 | | |
| 28 | + | |
28 | 29 | | |
29 | 30 | | |
30 | 31 | | |
| |||
157 | 158 | | |
158 | 159 | | |
159 | 160 | | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
160 | 170 | | |
161 | 171 | | |
162 | 172 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | | - | |
| 7 | + | |
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
| |||
38 | 38 | | |
39 | 39 | | |
40 | 40 | | |
| 41 | + | |
| 42 | + | |
41 | 43 | | |
42 | 44 | | |
43 | 45 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | | - | |
| 7 | + | |
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
| |||
33 | 33 | | |
34 | 34 | | |
35 | 35 | | |
| 36 | + | |
| 37 | + | |
36 | 38 | | |
37 | 39 | | |
38 | 40 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | | - | |
| 7 | + | |
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
| |||
29 | 29 | | |
30 | 30 | | |
31 | 31 | | |
| 32 | + | |
32 | 33 | | |
33 | 34 | | |
34 | 35 | | |
| |||
166 | 167 | | |
167 | 168 | | |
168 | 169 | | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
169 | 180 | | |
170 | 181 | | |
171 | 182 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | | - | |
| 7 | + | |
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
| |||
23 | 23 | | |
24 | 24 | | |
25 | 25 | | |
| 26 | + | |
| 27 | + | |
26 | 28 | | |
27 | 29 | | |
28 | 30 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | | - | |
| 7 | + | |
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
| |||
33 | 33 | | |
34 | 34 | | |
35 | 35 | | |
| 36 | + | |
| 37 | + | |
36 | 38 | | |
37 | 39 | | |
38 | 40 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
| 16 | + | |
16 | 17 | | |
17 | 18 | | |
18 | 19 | | |
| |||
147 | 148 | | |
148 | 149 | | |
149 | 150 | | |
150 | | - | |
151 | | - | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
152 | 157 | | |
153 | | - | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
154 | 163 | | |
155 | 164 | | |
156 | 165 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | | - | |
| 7 | + | |
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
| |||
69 | 69 | | |
70 | 70 | | |
71 | 71 | | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
72 | 78 | | |
73 | 79 | | |
74 | 80 | | |
| |||
614 | 620 | | |
615 | 621 | | |
616 | 622 | | |
| 623 | + | |
| 624 | + | |
| 625 | + | |
| 626 | + | |
| 627 | + | |
617 | 628 | | |
618 | 629 | | |
619 | 630 | | |
| |||
1090 | 1101 | | |
1091 | 1102 | | |
1092 | 1103 | | |
| 1104 | + | |
| 1105 | + | |
| 1106 | + | |
1093 | 1107 | | |
1094 | 1108 | | |
1095 | 1109 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | | - | |
| 7 | + | |
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
| |||
45 | 45 | | |
46 | 46 | | |
47 | 47 | | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
48 | 51 | | |
49 | 52 | | |
50 | 53 | | |
| |||
0 commit comments