Add unit test for RuntimeExecutor post-shutdown safety#56995
Closed
javache wants to merge 2 commits into
Closed
Conversation
Summary: Add `ReactContext.getRuntimeExecutor()` so callers can obtain the `RuntimeExecutor` without reaching into `CatalystInstance`. The bridge subclass forwards to `CatalystInstance.getRuntimeExecutor()`; the bridgeless subclass forwards to `ReactHost.runtimeExecutor`; `ThemedReactContext` proxies to its wrapped `ReactApplicationContext`. Previously, callers that needed the runtime executor had to reach through `catalystInstance.getRuntimeExecutor()`, which is bridge-only and required a `NoGetCatalystInstance` lint suppression. The new accessor works uniformly in both bridged and bridgeless modes. Changelog: [Android][Added] - Add `ReactContext.getRuntimeExecutor()` Differential Revision: D106647233
Summary: The `RuntimeExecutor` returned by `ReactInstance::getBufferedRuntimeExecutor()` is designed to be safe to hold past the lifetime of the `ReactInstance` itself — callers may schedule work on it after shutdown without crashing, and any pending callbacks must be dropped rather than surfaced on the JS queue. This contract relies on `weak_ptr` captures inside the executor closure and inside the base closure in the `ReactInstance` constructor. Today nothing tests it directly — coverage is incidental through `ReactInstanceTest` happy-path cases — so a future refactor that swaps a `weak_ptr` capture for a `shared_ptr` (keeping the runtime alive) or a raw pointer (introducing UAF) could silently regress. Adds three focused regression tests covering: - Calling the held executor after `ReactInstance` destruction drops the callback (no queuing, no execution). - Repeated post-shutdown invocations remain memory-safe. - Work buffered in `BufferedRuntimeExecutor` before shutdown is dropped, never surfaced on the JS queue. The new test file lands under the existing `tests` target's `glob(["tests/**/*.cpp"])`, so no BUCK changes are needed. Note: this test deliberately targets the buffered API only. `getUnbufferedRuntimeExecutor()` captures `runtimeScheduler_.get()` as a raw pointer and is not safe to hold past shutdown by design — a separate concern, out of scope here. Changelog: [Internal] Differential Revision: D106783789
meta-cla
Bot
added
the
CLA Signed
|
@javache has exported this pull request. If you are a Meta employee, you can view the originating Diff in D106783789. |
Collaborator
|
This pull request was successfully merged by @javache in b043c27 When will my fix make it into a release? | How to file a pick request? |
|
This pull request has been merged in b043c27. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary:
The
RuntimeExecutorreturned byReactInstance::getBufferedRuntimeExecutor()is designed to be safe to hold past the lifetime of theReactInstanceitself — callers may schedule work on it after shutdown without crashing, and any pending callbacks must be dropped rather than surfaced on the JS queue.This contract relies on
weak_ptrcaptures inside the executor closure and inside the base closure in theReactInstanceconstructor. Today nothing tests it directly — coverage is incidental throughReactInstanceTesthappy-path cases — so a future refactor that swaps aweak_ptrcapture for ashared_ptr(keeping the runtime alive) or a raw pointer (introducing UAF) could silently regress.Adds three focused regression tests covering:
ReactInstancedestruction drops the callback (no queuing, no execution).BufferedRuntimeExecutorbefore shutdown is dropped, never surfaced on the JS queue.The new test file lands under the existing
teststarget'sglob(["tests/**/*.cpp"]), so no BUCK changes are needed.Note: this test deliberately targets the buffered API only.
getUnbufferedRuntimeExecutor()capturesruntimeScheduler_.get()as a raw pointer and is not safe to hold past shutdown by design — a separate concern, out of scope here.Changelog:
[Internal]
Differential Revision: D106783789