Skip to content

Commit

Permalink
Roll out TurboModule Promise Async Dispatch
Browse files Browse the repository at this point in the history 
Summary:
## Context
The legacy NativeModule infra implements promise methods using [async NativeModule method calls](https://fburl.com/diffusion/tpkff6vg). In the TurboModule infra, promise methods [treat as sync methods](https://fburl.com/diffusion/yde7xw71), and executed directly on the JavaScript thread. This experiment makes TurboModule promise methods async, and dispatches them to the NativeModules thread, when they're executed from JavaScript.

Reviewed By: fkgozali

Differential Revision: D25623192

fbshipit-source-id: 2b50d771c5272af3b6edf150054bb3e80cab0040
  • Loading branch information
@RSNara @facebook-github-bot
RSNara authored and facebook-github-bot committed Dec 18, 2020
1 parent 40115d8 commit 5c4f145
Show file tree
Hide file tree
Showing 5 changed files with 45 additions and 81 deletions.
2 changes: 0 additions & 2 deletions ReactAndroid/src/main/java/com/facebook/react/turbomodule/core/TurboModuleManager.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,6 @@ public TurboModuleManager(
(CallInvokerHolderImpl) jsCallInvokerHolder,
(CallInvokerHolderImpl) nativeCallInvokerHolder,
delegate,
ReactFeatureFlags.enableTurboModulePromiseAsyncDispatch,
ReactFeatureFlags.useTurboModuleJSCodegen);
installJSIBindings();

Expand Down Expand Up @@ -295,7 +294,6 @@ private native HybridData initHybrid(
CallInvokerHolderImpl jsCallInvokerHolder,
CallInvokerHolderImpl nativeCallInvokerHolder,
TurboModuleManagerDelegate tmmDelegate,
boolean enablePromiseAsyncDispatch,
boolean enableTurboModuleJSCodegen);

private native void installJSIBindings();
Expand Down
3 changes: 0 additions & 3 deletions .../src/main/java/com/facebook/react/turbomodule/core/jni/ReactCommon/TurboModuleManager.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,10 @@ jni::local_ref<TurboModuleManager::jhybriddata> TurboModuleManager::initHybrid(
jni::alias_ref<CallInvokerHolder::javaobject> jsCallInvokerHolder,
jni::alias_ref<CallInvokerHolder::javaobject> nativeCallInvokerHolder,
jni::alias_ref<TurboModuleManagerDelegate::javaobject> delegate,
bool enablePromiseAsyncDispatch,
bool enableJSCodegen) {
auto jsCallInvoker = jsCallInvokerHolder->cthis()->getCallInvoker();
auto nativeCallInvoker = nativeCallInvokerHolder->cthis()->getCallInvoker();

JavaTurboModule::enablePromiseAsyncDispatch(enablePromiseAsyncDispatch);

return makeCxxInstance(
jThis,
runtimeExecutor->cthis()->get(),
Expand Down
1 change: 0 additions & 1 deletion ...id/src/main/java/com/facebook/react/turbomodule/core/jni/ReactCommon/TurboModuleManager.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ class TurboModuleManager : public jni::HybridClass<TurboModuleManager> {
jni::alias_ref<CallInvokerHolder::javaobject> jsCallInvokerHolder,
jni::alias_ref<CallInvokerHolder::javaobject> nativeCallInvokerHolder,
jni::alias_ref<TurboModuleManagerDelegate::javaobject> delegate,
bool enablePromiseAsyncDispatch,
bool enableJSCodegen);
static void registerNatives();

Expand Down
114 changes: 45 additions & 69 deletions ReactCommon/react/nativemodule/core/platform/android/ReactCommon/JavaTurboModule.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,6 @@ JavaTurboModule::~JavaTurboModule() {
});
}

bool JavaTurboModule::isPromiseAsyncDispatchEnabled_ = false;
void JavaTurboModule::enablePromiseAsyncDispatch(bool enable) {
isPromiseAsyncDispatchEnabled_ = enable;
}

JavaTurboModule::JavaTurboModule(
const InitParams &params,
TurboModuleSchema &&schema)
Expand Down Expand Up @@ -322,8 +317,7 @@ JNIArgs JavaTurboModule::convertJSIArgsToJNIArgs(

auto makeGlobalIfNecessary =
[&globalRefs, env, valueKind](jobject obj) -> jobject {
if (valueKind == VoidKind ||
(valueKind == PromiseKind && isPromiseAsyncDispatchEnabled_)) {
if (valueKind == VoidKind || valueKind == PromiseKind) {
jobject globalObj = env->NewGlobalRef(obj);
globalRefs.push_back(globalObj);
env->DeleteLocalRef(obj);
Expand Down Expand Up @@ -491,9 +485,7 @@ jsi::Value JavaTurboModule::invokeJavaMethod(
const char *methodName = methodNameStr.c_str();
const char *moduleName = name_.c_str();

bool isMethodSync =
!(valueKind == VoidKind ||
(valueKind == PromiseKind && isPromiseAsyncDispatchEnabled_));
bool isMethodSync = !(valueKind == VoidKind || valueKind == PromiseKind);

if (isMethodSync) {
TMPL::syncMethodCallStart(moduleName, methodName);
Expand Down Expand Up @@ -834,60 +826,48 @@ jsi::Value JavaTurboModule::invokeJavaMethod(
const char *moduleName = moduleNameStr.c_str();
const char *methodName = methodNameStr.c_str();

if (isPromiseAsyncDispatchEnabled_) {
jobject globalPromise = env->NewGlobalRef(promise);

globalRefs.push_back(globalPromise);
env->DeleteLocalRef(promise);

jargs[argCount].l = globalPromise;
TMPL::asyncMethodCallArgConversionEnd(moduleName, methodName);
TMPL::asyncMethodCallDispatch(moduleName, methodName);

nativeInvoker_->invokeAsync(
[jargs,
globalRefs,
methodID,
instance_ = instance_,
moduleNameStr,
methodNameStr,
id = getUniqueId()]() mutable -> void {
/**
* TODO(ramanpreet): Why do we have to require the
* environment again? Why does JNI crash when we use the env
* from the upper scope?
*/
JNIEnv *env = jni::Environment::current();
const char *moduleName = moduleNameStr.c_str();
const char *methodName = methodNameStr.c_str();

TMPL::asyncMethodCallExecutionStart(
moduleName, methodName, id);
env->CallVoidMethodA(
instance_.get(), methodID, jargs.data());
try {
FACEBOOK_JNI_THROW_PENDING_EXCEPTION();
} catch (...) {
TMPL::asyncMethodCallExecutionFail(
moduleName, methodName, id);
throw;
}

for (auto globalRef : globalRefs) {
env->DeleteGlobalRef(globalRef);
}
TMPL::asyncMethodCallExecutionEnd(
jobject globalPromise = env->NewGlobalRef(promise);

globalRefs.push_back(globalPromise);
env->DeleteLocalRef(promise);

jargs[argCount].l = globalPromise;
TMPL::asyncMethodCallArgConversionEnd(moduleName, methodName);
TMPL::asyncMethodCallDispatch(moduleName, methodName);

nativeInvoker_->invokeAsync(
[jargs,
globalRefs,
methodID,
instance_ = instance_,
moduleNameStr,
methodNameStr,
id = getUniqueId()]() mutable -> void {
/**
* TODO(ramanpreet): Why do we have to require the
* environment again? Why does JNI crash when we use the env
* from the upper scope?
*/
JNIEnv *env = jni::Environment::current();
const char *moduleName = moduleNameStr.c_str();
const char *methodName = methodNameStr.c_str();

TMPL::asyncMethodCallExecutionStart(
moduleName, methodName, id);
env->CallVoidMethodA(instance_.get(), methodID, jargs.data());
try {
FACEBOOK_JNI_THROW_PENDING_EXCEPTION();
} catch (...) {
TMPL::asyncMethodCallExecutionFail(
moduleName, methodName, id);
});

} else {
jargs[argCount].l = promise;
TMPL::syncMethodCallArgConversionEnd(moduleName, methodName);
TMPL::syncMethodCallExecutionStart(moduleName, methodName);
env->CallVoidMethodA(instance_.get(), methodID, jargs.data());
TMPL::syncMethodCallExecutionEnd(moduleName, methodName);
TMPL::syncMethodCallReturnConversionStart(moduleName, methodName);
}
throw;
}

for (auto globalRef : globalRefs) {
env->DeleteGlobalRef(globalRef);
}
TMPL::asyncMethodCallExecutionEnd(moduleName, methodName, id);
});

return jsi::Value::undefined();
});
Expand All @@ -896,12 +876,8 @@ jsi::Value JavaTurboModule::invokeJavaMethod(
Promise.callAsConstructor(runtime, promiseConstructorArg);
checkJNIErrorForMethodCall();

if (isPromiseAsyncDispatchEnabled_) {
TMPL::asyncMethodCallEnd(moduleName, methodName);
} else {
TMPL::syncMethodCallReturnConversionEnd(moduleName, methodName);
TMPL::syncMethodCallEnd(moduleName, methodName);
}
TMPL::asyncMethodCallEnd(moduleName, methodName);

return promise;
}
default:
Expand Down
6 changes: 0 additions & 6 deletions ReactCommon/react/nativemodule/core/platform/android/ReactCommon/JavaTurboModule.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@ class JSI_EXPORT JavaTurboModule : public TurboModule {
const jsi::Value *args,
size_t argCount);

static void enablePromiseAsyncDispatch(bool enable);
jsi::Value get(jsi::Runtime &runtime, const jsi::PropNameID &propName)
override;

Expand All @@ -64,11 +63,6 @@ class JSI_EXPORT JavaTurboModule : public TurboModule {
std::shared_ptr<CallInvoker> nativeInvoker_;
folly::Optional<TurboModuleSchema> turboModuleSchema_;

/**
* Experiments
*/
static bool isPromiseAsyncDispatchEnabled_;

JNIArgs convertJSIArgsToJNIArgs(
JNIEnv *env,
jsi::Runtime &rt,
Expand Down

0 comments on commit 5c4f145

Please sign in to comment.