Skip to content

Commit

Permalink
introduce native api to access RuntimeExecutor (facebook#42758)
Browse files Browse the repository at this point in the history
Summary:

Changelog: [iOS][Added] - introduce native api to access RuntimeExecutor

The goal of this API is to provide a safe way to access the `jsi::runtime` in bridgeless mode. The decision to limit access to the runtime in bridgeless was a conscious one - the runtime pointer is not thread-safe and its lifecycle must be managed correctly by owners.

However, interacting with the runtime is an advanced use case we would want to support. Our recommended ways to access the runtime in bridgeless mode is either 1) via the RuntimeExecutor, or 2) via a C++ TurboModule.

This diff introduces the API that would allow for 1). The integration consists of these parts:
- wrapper object for RuntimeExecutor access, `RCTRuntimeExecutor`. The NSObject wrapper is necessary so we can make it the property of a swift module
- new protocol API,`RCTRuntimeExecutionModule`, for modules to access the RuntimeExecutor block
- integration within the bridgeless infrastructure

Reviewed By: javache

Differential Revision: D53256188
  • Loading branch information
philIip authored and facebook-github-bot committed Feb 5, 2024
1 parent e4342f5 commit 8566e31
Show file tree
Hide file tree
Showing 6 changed files with 115 additions and 2 deletions.
18 changes: 18 additions & 0 deletions packages/react-native/React/Base/RCTRuntimeExecutorModule.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

@class RCTRuntimeExecutor;

/**
* Have your module conform to this protocol to access the RuntimeExecutor.
* Only available in the bridgeless runtime.
*/
@protocol RCTRuntimeExecutorModule <NSObject>

@property (nonatomic, nullable, readwrite) RCTRuntimeExecutor *runtimeExecutor;

@end
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

#import <ReactCommon/RuntimeExecutor.h>
#import <jsi/jsi.h>

NS_ASSUME_NONNULL_BEGIN

typedef void (^RCTJSIRuntimeHandlingBlock)(facebook::jsi::Runtime &runtime);

@interface RCTRuntimeExecutor : NSObject

- (instancetype)init NS_UNAVAILABLE;

/**
Initializes an object that wraps ways to access the RuntimeExecutor.
@param runtimeExecutor The instance of RuntimeExecutor.
*/
- (instancetype)initWithRuntimeExecutor:(facebook::react::RuntimeExecutor)runtimeExecutor NS_DESIGNATED_INITIALIZER;

- (void)execute:(RCTJSIRuntimeHandlingBlock)block;

@end

NS_ASSUME_NONNULL_END
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

#import "RCTRuntimeExecutor.h"

@implementation RCTRuntimeExecutor {
facebook::react::RuntimeExecutor _runtimeExecutor;
}

#pragma mark - Initializer

- (instancetype)initWithRuntimeExecutor:(facebook::react::RuntimeExecutor)runtimeExecutor
{
if (self = [super init]) {
_runtimeExecutor = runtimeExecutor;
}

return self;
}

#pragma mark - Public API

- (void)execute:(RCTJSIRuntimeHandlingBlock)block
{
if (_runtimeExecutor) {
_runtimeExecutor([=](facebook::jsi::Runtime &runtime) { block(runtime); });
}
}

@end
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,11 @@
#import <React/RCTTurboModuleRegistry.h>
#import <ReactCommon/RuntimeExecutor.h>
#import <ReactCommon/TurboModuleBinding.h>

#import "RCTTurboModule.h"

@class RCTTurboModuleManager;

@protocol RCTTurboModuleManagerDelegate <NSObject>

/**
Expand Down Expand Up @@ -52,6 +55,12 @@

@end

@protocol RCTTurboModuleManagerRuntimeHandler <NSObject>

- (facebook::react::RuntimeExecutor)runtimeExecutorForTurboModuleManager:(RCTTurboModuleManager *)turboModuleManager;

@end

@interface RCTTurboModuleManager : NSObject <RCTTurboModuleRegistry>

- (instancetype)initWithBridge:(RCTBridge *)bridge
Expand All @@ -67,4 +76,6 @@

- (void)invalidate;

@property (nonatomic, weak, readwrite) id<RCTTurboModuleManagerRuntimeHandler> runtimeHandler;

@end
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

#import "RCTTurboModuleManager.h"
#import "RCTInteropTurboModule.h"
#import "RCTRuntimeExecutor.h"

#import <atomic>
#import <cassert>
Expand All @@ -24,8 +25,8 @@
#import <React/RCTLog.h>
#import <React/RCTModuleData.h>
#import <React/RCTPerformanceLogger.h>
#import <React/RCTRuntimeExecutorModule.h>
#import <React/RCTUtils.h>
#import <ReactCommon/RuntimeExecutor.h>
#import <ReactCommon/TurboCxxModule.h>
#import <ReactCommon/TurboModulePerfLogger.h>
#import <ReactCommon/TurboModuleUtils.h>
Expand Down Expand Up @@ -676,6 +677,13 @@ - (BOOL)_shouldCreateObjCModule:(Class)moduleClass
}
}

// This is a more performant alternative for conformsToProtocol:@protocol(RCTRuntimeExecutorModule)
if ([module respondsToSelector:@selector(setRuntimeExecutor:)]) {
RCTRuntimeExecutor *runtimeExecutor = [[RCTRuntimeExecutor alloc]
initWithRuntimeExecutor:[_runtimeHandler runtimeExecutorForTurboModuleManager:self]];
[(id<RCTRuntimeExecutorModule>)module setRuntimeExecutor:runtimeExecutor];
}

/**
* Some modules need their own queues, but don't provide any, so we need to create it for them.
* These modules typically have the following:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ void RCTInstanceSetRuntimeDiagnosticFlags(NSString *flags)
sRuntimeDiagnosticFlags = [flags copy];
}

@interface RCTInstance () <RCTTurboModuleManagerDelegate>
@interface RCTInstance () <RCTTurboModuleManagerDelegate, RCTTurboModuleManagerRuntimeHandler>
@end

@implementation RCTInstance {
Expand Down Expand Up @@ -208,6 +208,17 @@ - (Class)getModuleClassFromName:(const char *)name
return nullptr;
}

#pragma mark - RCTTurboModuleManagerRuntimeHandler

- (RuntimeExecutor)runtimeExecutorForTurboModuleManager:(RCTTurboModuleManager *)turboModuleManager
{
if (_valid) {
return _reactInstance->getBufferedRuntimeExecutor();
}

return nullptr;
}

#pragma mark - Private

- (void)_start
Expand Down Expand Up @@ -259,6 +270,7 @@ - (void)_start
bridgeModuleDecorator:_bridgeModuleDecorator
delegate:self
jsInvoker:std::make_shared<BridgelessJSCallInvoker>(bufferedRuntimeExecutor)];
_turboModuleManager.runtimeHandler = self;

#if RCT_DEV
/**
Expand Down

0 comments on commit 8566e31

Please sign in to comment.