Skip to content

Fix RCTInstance self-deadlock during invalidate #59145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zeyap wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix RCTInstance self-deadlock during invalidate #59145

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 27 additions & 0 deletions packages/react-native/ReactCommon/react/runtime/iostests/RCTInstanceTests.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
#import <React/RCTBridgeModule.h>
#import <React/RCTBundleManager.h>
#import <React/RCTJavaScriptLoader.h>
#import <React/RCTSurfacePresenter.h>
#import <ReactCommon/RCTHermesInstance.h>
#import <ReactCommon/RCTInstance.h>
#import <ReactCommon/RCTTurboModule.h>
Expand Down Expand Up @@ -241,4 +242,30 @@ - (void)testBundleLoadAwaitsMainQueueModuleSetup
@"FakeEagerModule -init must have fully returned before the JS bundle finishes loading");
}

- (void)testInvalidateDoesNotDeadlockWhenSuspendCallsIntoJS
{
OCMStub([_mockDelegate unstableModulesRequiringMainQueueSetup]).andReturn(@[]);

RCTInstance *instance = [self makeInstance];
__weak RCTInstance *weakInstance = instance;

// Stands in for a surface observer that calls into JS while suspend stops surfaces.
id presenterMock = OCMPartialMock(instance.surfacePresenter);
OCMStub([(RCTSurfacePresenter *)presenterMock suspend]).andDo(^(NSInvocation *invocation) {
[weakInstance callFunctionOnJSModule:@"RCTLog" method:@"logIfNoNativeHook" args:@[]];
BOOL result = YES;
[invocation setReturnValue:&result];
});

// Invalidate off-main so a deadlock fails the wait instead of hanging the test runner.
XCTestExpectation *invalidated = [self expectationWithDescription:@"invalidate returned"];
dispatch_async(dispatch_get_global_queue(QOS_CLASS_USER_INITIATED, 0), ^{
[instance invalidate];
[invalidated fulfill];
});
[self waitForExpectations:@[ invalidated ] timeout:5.0];

[presenterMock stopMocking];
}

@end
12 changes: 8 additions & 4 deletions packages/react-native/ReactCommon/react/runtime/platform/ios/ReactCommon/RCTInstance.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,11 +183,15 @@ - (void)callFunctionOnJSModule:(NSString *)moduleName method:(NSString *)method

- (void)invalidate
{
std::lock_guard<std::mutex> lock(_invalidationMutex);
_valid = false;
if (_reactInstance) {
_reactInstance->unregisterFromInspector();
{
std::lock_guard<std::mutex> lock(_invalidationMutex);
_valid = false;
if (_reactInstance) {
_reactInstance->unregisterFromInspector();
}
}
// suspend shouldn't be called under _invalidationMutex: it notifies surface observers,
// which can call callFunctionOnJSModule and deadlock on the same mutex.
[_surfacePresenter suspend];
[_jsThreadManager dispatchToJSThread:^{
/**
Expand Down
Loading