Get uiRuntime directly from react-native-worklets

apps/basic-example/ios/Podfile.lock

@@ -1844,6 +1844,7 @@ PODS:
     - ReactCommon/turbomodule/bridging
     - ReactCommon/turbomodule/core
     - ReactNativeDependencies
+    - RNWorklets (>= 0.8.0)
     - Yoga
   - RNReanimated (4.4.1):
     - hermes-engine
@@ -2307,7 +2308,7 @@ SPEC CHECKSUMS:
   ReactCodegen: 21807c5e7d6d0e334667f755e23063834d581e62
   ReactCommon: d5c1bb4427bf51c443de5926aac332c89ddd9363
   ReactNativeDependencies: fa0a54b3f5319ae0e3b9aff32bfee7a424b88e66
-  RNGestureHandler: f07cf8b0a45a4eee18163629f78413b0a534aece
+  RNGestureHandler: a2f04fb0e854b5280517dbfd0b77170897a44644
   RNReanimated: d6e6865fa9d5ce60863a9e244de45de4f9890e46
   RNWorklets: 04a35c45bd72d24914cbaf24bdfa4e30e1eab2df
   Yoga: fe50ab299e578f397fef753cf309c6703a4db29b

packages/react-native-gesture-handler/RNGestureHandler.podspec

@@ -6,6 +6,8 @@ is_gh_example_app = ENV["GH_EXAMPLE_APP_NAME"] != nil
 compilation_metadata_dir = "CompilationDatabase"
 compilation_metadata_generation_flag = is_gh_example_app ? '-gen-cdb-fragment-path ' + compilation_metadata_dir : ''
 version_flag = "-DREACT_NATIVE_MINOR_VERSION=#{GestureHandlerUtils.get_react_native_minor_version()}"
+use_worklets = GestureHandlerUtils.react_native_worklets_supports_stable_api()
+worklets_flag = use_worklets ? '-DRNGH_USE_WORKLETS=1' : ''
 
 Pod::Spec.new do |s|
   # NPM package specification
@@ -22,11 +24,15 @@ Pod::Spec.new do |s|
   s.requires_arc = true
   s.platforms       = { ios: '11.0', tvos: '11.0', osx: '10.15', visionos: '1.0' }
   s.xcconfig = {
-    "OTHER_CFLAGS" => "$(inherited) #{compilation_metadata_generation_flag} #{version_flag}"
+    "OTHER_CFLAGS" => "$(inherited) #{compilation_metadata_generation_flag} #{version_flag} #{worklets_flag}"
   }
 
   install_modules_dependencies(s);
 
+  if use_worklets
+    s.dependency "RNWorklets", ">= 0.8.0"
+  end
+
   if ENV['USE_FRAMEWORKS'] != nil
     add_dependency(s, "React-FabricComponents", :additional_framework_paths => [
       "react/renderer/textlayoutmanager/platform/ios",

packages/react-native-gesture-handler/android/build.gradle

@@ -74,8 +74,9 @@ def getExternalLibVersion(project){
 
     // Handle cases where version is a pre-release one, e.g. "2.3.0-alpha.1"
     def patchVersion = patch.find(/(\d+)/) ? patch.find(/(\d+)/) : "0"
+    def isPrerelease = libVerision.contains('-')
 
-    return [Integer.parseInt(major), Integer.parseInt(minor), Integer.parseInt(patchVersion)]
+    return [Integer.parseInt(major), Integer.parseInt(minor), Integer.parseInt(patchVersion), isPrerelease]
 }
 
 // Check whether Reanimated 2.3 or higher is installed alongside Gesture Handler
@@ -107,6 +108,22 @@ def shouldUseCommonInterfaceFromRNSVG() {
             major > 15
 }
 
+def shouldUseRuntimeFromWorklets() {
+    def worklets = rootProject.subprojects.find { it.name == 'react-native-worklets' }
+
+    if (worklets == null) {
+        return false
+    }
+
+    def (major, minor, patch, isPrerelease) = getExternalLibVersion(worklets)
+
+    if (isPrerelease) {
+        return false
+    }
+
+    return major > 0 || (major == 0 && minor >= 8)
+}
+
 def reactNativeArchitectures() {
     def value = project.getProperties().get("reactNativeArchitectures")
     return value ? value.split(",") : ["armeabi-v7a", "x86", "x86_64", "arm64-v8a"]
@@ -152,6 +169,7 @@ android {
                 cppFlags "-O2", "-frtti", "-fexceptions", "-Wall", "-Werror", "-std=c++20", "-DANDROID"
                 arguments "-DREACT_NATIVE_DIR=${REACT_NATIVE_DIR}",
                         "-DREACT_NATIVE_MINOR_VERSION=${REACT_NATIVE_MINOR_VERSION}",
+                        "-DRNGH_USE_WORKLETS=${shouldUseRuntimeFromWorklets()}",
                         "-DANDROID_STL=c++_shared",
                         "-DANDROID_SUPPORT_FLEXIBLE_PAGE_SIZES=ON"
                 abiFilters(*reactNativeArchitectures())
@@ -226,6 +244,13 @@ dependencies {
         }
     }
 
+    if (shouldUseRuntimeFromWorklets()) {
+        implementation(rootProject.subprojects.find { it.name == 'react-native-worklets' }) {
+            // resolves "Duplicate class com.facebook.jni.CppException"
+            exclude group: 'com.facebook.fbjni'
+        }
+    }
+
     if (shouldUseCommonInterfaceFromRNSVG()) {
         implementation rootProject.subprojects.find { it.name == 'react-native-svg' }
     }

packages/react-native-gesture-handler/android/src/main/java/com/swmansion/gesturehandler/react/RNGestureHandlerModule.kt

@@ -120,7 +120,7 @@ class RNGestureHandlerModule(reactContext: ReactApplicationContext?) :
   @ReactMethod
   override fun installUIRuntimeBindings(): Boolean {
     if (!uiRuntimeDecorated) {
-      uiRuntimeDecorated = decorateUIRuntime()
+      uiRuntimeDecorated = installUIRuntimeBindingsNative()
     }
 
     return uiRuntimeDecorated
@@ -162,7 +162,7 @@ class RNGestureHandlerModule(reactContext: ReactApplicationContext?) :
 
   private external fun initHybrid(): HybridData
   private external fun getBindingsInstallerCxx(): BindingsInstallerHolder
-  private external fun decorateUIRuntime(): Boolean
+  private external fun installUIRuntimeBindingsNative(): Boolean
   private external fun invalidateNative(): Unit
 
   override fun getBindingsInstaller() = getBindingsInstallerCxx()

packages/react-native-gesture-handler/android/src/main/jni/CMakeLists.txt

@@ -51,3 +51,9 @@ target_link_libraries(
   ReactAndroid::jsi
   fbjni::fbjni
 )
+
+if(RNGH_USE_WORKLETS)
+  find_package(react-native-worklets REQUIRED CONFIG)
+  target_compile_definitions(${PACKAGE_NAME} PRIVATE RNGH_USE_WORKLETS=1)
+  target_link_libraries(${PACKAGE_NAME} react-native-worklets::worklets)
+endif()

packages/react-native-gesture-handler/android/src/main/jni/RNGestureHandlerModule.cpp

@@ -20,7 +20,8 @@ void RNGestureHandlerModule::registerNatives() {
            "getBindingsInstallerCxx",
            RNGestureHandlerModule::getBindingsInstallerCxx),
        makeNativeMethod(
-           "decorateUIRuntime", RNGestureHandlerModule::decorateUIRuntime),
+           "installUIRuntimeBindingsNative",
+           RNGestureHandlerModule::installUIRuntimeBindings),
        makeNativeMethod(
            "invalidateNative", RNGestureHandlerModule::invalidateNative)});
 }
@@ -51,11 +52,19 @@ void RNGestureHandlerModule::setGestureState(
   method(this->javaPart_, handlerTag, state);
 }
 
-bool RNGestureHandlerModule::decorateUIRuntime() {
-  return RNGHRuntimeDecorator::installUIRuntimeBindings(
-      *rnRuntime_, getModuleId(), [&](int handlerTag, int state) {
+bool RNGestureHandlerModule::installUIRuntimeBindings() {
+  const auto resolved = RNGHRuntimeDecorator::tryFindUIRuntime(*rnRuntime_);
+
+  if (resolved.runtime == nullptr) {
+    return false;
+  }
+
+  RNGHRuntimeDecorator::installUIRuntimeBindings(
+      *resolved.runtime, [&](int handlerTag, int state) {
         this->setGestureState(handlerTag, state);
       });
+
+  return true;
 }
 
 void RNGestureHandlerModule::invalidateNative() {

packages/react-native-gesture-handler/android/src/main/jni/RNGestureHandlerModule.h

@@ -27,7 +27,7 @@ class RNGestureHandlerModule : public jni::HybridClass<RNGestureHandlerModule> {
   jni::local_ref<BindingsInstallerHolder::javaobject> getBindingsInstallerCxx();
 
   void setGestureState(const int handlerTag, const int state);
-  bool decorateUIRuntime();
+  bool installUIRuntimeBindings();
   void invalidateNative();
   int getModuleId();
 };

packages/react-native-gesture-handler/apple/RNGestureHandlerModule.mm

@@ -104,16 +104,23 @@ - (void)initialize
   _operations = [NSMutableArray new];
 }
 
-- (bool)decorateUIRuntime
+- (bool)tryInstallUIRuntimeBindings
 {
   __weak RNGestureHandlerModule *weakSelf = self;
+  const auto resolved = RNGHRuntimeDecorator::tryFindUIRuntime(*_rnRuntime);
 
-  return RNGHRuntimeDecorator::installUIRuntimeBindings(*_rnRuntime, _moduleId, [weakSelf](int handlerTag, int state) {
+  if (resolved.runtime == nullptr) {
+    return false;
+  }
+
+  RNGHRuntimeDecorator::installUIRuntimeBindings(*resolved.runtime, [weakSelf](int handlerTag, int state) {
     RNGestureHandlerModule *strongSelf = weakSelf;
     if (strongSelf != nil) {
       [strongSelf setGestureState:state forHandler:handlerTag];
     }
   });
+
+  return true;
 }
 
 - (void)createGestureHandler:(NSString *)handlerName handlerTag:(double)handlerTag config:(NSDictionary *)config
@@ -185,7 +192,7 @@ - (void)flushOperations
 - (nonnull NSNumber *)installUIRuntimeBindings
 {
   if (!_uiRuntimeDecorated) {
-    _uiRuntimeDecorated = [self decorateUIRuntime];
+    _uiRuntimeDecorated = [self tryInstallUIRuntimeBindings];
   }
 
   return _uiRuntimeDecorated ? @1 : @0;

packages/react-native-gesture-handler/scripts/gesture_handler_utils.rb

@@ -1,6 +1,10 @@
+require 'rubygems'
+
 module GestureHandlerUtils
     module_function
 
+    MIN_REACT_NATIVE_WORKLETS_VERSION = Gem::Version.new('0.8.0')
+
     def try_to_parse_react_native_package_json(react_native_dir)
         react_native_package_json_path = File.join(react_native_dir, 'package.json')
 
@@ -28,4 +32,37 @@ def get_react_native_minor_version()
 
         return react_native_json['version'].split('.')[1].to_i
     end
+
+    def node_package_dir(package_name)
+        package_json_path = `cd "#{Pod::Config.instance.installation_root.to_s}" && node --print "require.resolve('#{package_name}/package.json')" 2>/dev/null`.strip
+
+        if !$?.success? || package_json_path.empty?
+            return nil
+        end
+
+        return File.dirname(package_json_path)
+    end
+
+    def react_native_worklets_package_dir()
+        return node_package_dir('react-native-worklets')
+    end
+
+    def react_native_worklets_supports_stable_api()
+        package_dir = react_native_worklets_package_dir()
+
+        if package_dir == nil || !File.exist?(File.join(package_dir, 'RNWorklets.podspec'))
+            return false
+        end
+
+        package_json = JSON.parse(File.read(File.join(package_dir, 'package.json')))
+        version_string = package_json['version']
+
+        return false if version_string.include?('-')
+
+        version = Gem::Version.new(version_string)
+
+        return version >= MIN_REACT_NATIVE_WORKLETS_VERSION
+    rescue JSON::ParserError, ArgumentError, TypeError, Errno::ENOENT
+        return false
+    end
 end

packages/react-native-gesture-handler/shared/runtime/RNGHRuntimeDecorator.cpp

@@ -7,6 +7,10 @@
 
 #include "RNGHRuntimeDecorator.h"
 
+#if RNGH_USE_WORKLETS
+#include <worklets/Compat/StableApi.h>
+#endif
+
 namespace gesturehandler {
 
 using namespace facebook;
@@ -89,25 +93,9 @@ void RNGHRuntimeDecorator::installRNRuntimeBindings(
       rnRuntime, "_RNGH_MODULE_ID", std::move(moduleIdValue));
 }
 
-bool RNGHRuntimeDecorator::installUIRuntimeBindings(
-    jsi::Runtime &rnRuntime,
-    int moduleId,
+void RNGHRuntimeDecorator::installUIRuntimeBindings(
+    jsi::Runtime &uiRuntime,
     std::function<void(int, int)> &&setGestureState) {
-  const auto runtimeHolder =
-      rnRuntime.global().getProperty(rnRuntime, "_WORKLET_RUNTIME");
-
-  if (runtimeHolder.isUndefined()) {
-    return false;
-  }
-
-  const auto arrayBufferValue =
-      runtimeHolder.getObject(rnRuntime).getArrayBuffer(rnRuntime).data(
-          rnRuntime);
-  const auto uiRuntimeAddress =
-      reinterpret_cast<uintptr_t *>(&arrayBufferValue[0]);
-  jsi::Runtime &uiRuntime =
-      *reinterpret_cast<jsi::Runtime *>(*uiRuntimeAddress);
-
   auto setGestureStateSync = jsi::Function::createFromHostFunction(
       uiRuntime,
       jsi::PropNameID::forAscii(uiRuntime, "_setGestureStateSync"),
@@ -128,12 +116,39 @@ bool RNGHRuntimeDecorator::installUIRuntimeBindings(
 
   uiRuntime.global().setProperty(
       uiRuntime, "_setGestureStateSync", std::move(setGestureStateSync));
+}
 
-  auto moduleIdValue = jsi::Value(moduleId);
-  rnRuntime.global().setProperty(
-      rnRuntime, "_RNGH_MODULE_ID", std::move(moduleIdValue));
+ResolvedUIRuntime RNGHRuntimeDecorator::tryFindUIRuntime(
+    jsi::Runtime &rnRuntime) {
+#if RNGH_USE_WORKLETS
+  const auto workletsRuntimeHolder = rnRuntime.global().getProperty(
+      rnRuntime, "__RNGH_UI_WORKLET_RUNTIME_HOLDER");
+
+  if (workletsRuntimeHolder.isObject()) {
+    const auto uiWorkletRuntime = worklets::getWorkletRuntimeFromHolder(
+        rnRuntime, workletsRuntimeHolder.asObject(rnRuntime));
+
+    if (uiWorkletRuntime) {
+      return {
+          &worklets::getJSIRuntimeFromWorkletRuntime(uiWorkletRuntime),
+          uiWorkletRuntime};
+    }
+  }
+#endif
+
+  const auto runtimeHolder =
+      rnRuntime.global().getProperty(rnRuntime, "_WORKLET_RUNTIME");
 
-  return true;
+  if (runtimeHolder.isUndefined()) {
+    return {};
+  }
+
+  const auto arrayBufferValue =
+      runtimeHolder.getObject(rnRuntime).getArrayBuffer(rnRuntime).data(
+          rnRuntime);
+  const auto uiRuntimeAddress =
+      reinterpret_cast<uintptr_t *>(&arrayBufferValue[0]);
+  return {reinterpret_cast<jsi::Runtime *>(*uiRuntimeAddress), nullptr};
 }
 
 } // namespace gesturehandler

packages/react-native-gesture-handler/shared/runtime/RNGHRuntimeDecorator.h

@@ -1,19 +1,28 @@
 #pragma once
 #include <jsi/jsi.h>
 
+#include <memory>
+
 namespace gesturehandler {
 using namespace facebook;
 
+struct ResolvedUIRuntime {
+  jsi::Runtime *runtime = nullptr;
+  // Keeps the runtime owner alive for as long as `runtime` is used. Empty
+  // when the runtime is owned externally.
+  std::shared_ptr<void> retainer;
+};
+
 class RNGHRuntimeDecorator {
  public:
   static void installRNRuntimeBindings(
       jsi::Runtime &rnRuntime,
       int moduleId,
       std::function<void(int, int)> &&setGestureState);
-  static bool installUIRuntimeBindings(
-      jsi::Runtime &rnRuntime,
-      int moduleId,
+  static void installUIRuntimeBindings(
+      jsi::Runtime &uiRuntime,
       std::function<void(int, int)> &&setGestureState);
+  static ResolvedUIRuntime tryFindUIRuntime(jsi::Runtime &rnRuntime);
 };
 
 } // namespace gesturehandler