feat(Worklets): Create a stub of Worklets Module (software-mansion#6539)

This pull request is one of many which replace

- software-mansion#6378

since that PR is extensive and too difficult to review.

## Summary

Adding a second Native Module for Worklets.

It's initial responsibility for now is forwarding `valueUnpackerCode` to
Reanimated Module. While it seems silly, it's a good start since it sets
up the whole pipeline of:

```tree
typescript
├── android
│   └── cpp
└── ios
    └── cpp
```
(I was too lazy to use mermaid, long live `mkdir -p`)

Follow up PRs will move more and more responsibilities from Reanimated
to Worklets.

Requires:

- software-mansion#6556
- software-mansion#6557 

## Test plan

- [x] All GitHub Actions pass
- [x] Compatibility Github Action passes
- [x] debug Android works
- [x] release Android works
- [x] debug iOS works
- [x] release iOS works

Author: tjzel

Common/cpp/reanimated/NativeModules/NativeReanimatedModule.cpp

@@ -52,29 +52,30 @@ using namespace facebook;
 namespace reanimated {
 
 NativeReanimatedModule::NativeReanimatedModule(
+    const std::shared_ptr<NativeWorkletsModule> &nativeWorkletsModule,
     jsi::Runtime &rnRuntime,
     const std::shared_ptr<JSScheduler> &jsScheduler,
     const std::shared_ptr<MessageQueueThread> &jsQueue,
     const std::shared_ptr<UIScheduler> &uiScheduler,
     const PlatformDepMethodsHolder &platformDepMethodsHolder,
-    const std::string &valueUnpackerCode,
     const bool isBridgeless,
     const bool isReducedMotion)
     : NativeReanimatedModuleSpec(
           isBridgeless ? nullptr : jsScheduler->getJSCallInvoker()),
       isBridgeless_(isBridgeless),
       isReducedMotion_(isReducedMotion),
       jsQueue_(jsQueue),
+      nativeWorkletsModule_(nativeWorkletsModule),
       jsScheduler_(jsScheduler),
       uiScheduler_(uiScheduler),
+      valueUnpackerCode_(nativeWorkletsModule->getValueUnpackerCode()),
       uiWorkletRuntime_(std::make_shared<WorkletRuntime>(
           rnRuntime,
           jsQueue,
           jsScheduler_,
           "Reanimated UI runtime",
           true /* supportsLocking */,
-          valueUnpackerCode)),
-      valueUnpackerCode_(valueUnpackerCode),
+          valueUnpackerCode_)),
       eventHandlerRegistry_(std::make_unique<EventHandlerRegistry>()),
       requestRender_(platformDepMethodsHolder.requestRender),
       onRenderCallback_([this](const double timestampMs) {

Common/cpp/reanimated/NativeModules/NativeReanimatedModule.h

@@ -13,6 +13,7 @@
 #include <reanimated/LayoutAnimations/LayoutAnimationsProxy.h>
 #endif // RCT_NEW_ARCH_ENABLED
 
+#include <worklets/NativeModules/NativeWorkletsModule.h>
 #include <worklets/Registries/EventHandlerRegistry.h>
 #include <worklets/Tools/JSScheduler.h>
 #include <worklets/Tools/UIScheduler.h>
@@ -32,12 +33,12 @@ namespace reanimated {
 class NativeReanimatedModule : public NativeReanimatedModuleSpec {
  public:
   NativeReanimatedModule(
+      const std::shared_ptr<NativeWorkletsModule> &nativeWorkletsModule,
       jsi::Runtime &rnRuntime,
       const std::shared_ptr<JSScheduler> &jsScheduler,
       const std::shared_ptr<MessageQueueThread> &jsQueue,
       const std::shared_ptr<UIScheduler> &uiScheduler,
       const PlatformDepMethodsHolder &platformDepMethodsHolder,
-      const std::string &valueUnpackerCode,
       const bool isBridgeless,
       const bool isReducedMotion);
 
@@ -168,18 +169,23 @@ class NativeReanimatedModule : public NativeReanimatedModuleSpec {
     return *layoutAnimationsManager_;
   }
 
-  inline jsi::Runtime &getUIRuntime() const {
+  [[nodiscard]] inline jsi::Runtime &getUIRuntime() const {
     return uiWorkletRuntime_->getJSIRuntime();
   }
 
-  inline bool isBridgeless() const {
+  [[nodiscard]] inline bool isBridgeless() const {
     return isBridgeless_;
   }
 
-  inline bool isReducedMotion() const {
+  [[nodiscard]] inline bool isReducedMotion() const {
     return isReducedMotion_;
   }
 
+  [[nodiscard]] inline std::shared_ptr<NativeWorkletsModule>
+  getNativeWorkletsModule() const {
+    return nativeWorkletsModule_;
+  }
+
  private:
   void commonInit(const PlatformDepMethodsHolder &platformDepMethodsHolder);
 
@@ -195,10 +201,11 @@ class NativeReanimatedModule : public NativeReanimatedModuleSpec {
   const bool isBridgeless_;
   const bool isReducedMotion_;
   const std::shared_ptr<MessageQueueThread> jsQueue_;
+  const std::shared_ptr<NativeWorkletsModule> nativeWorkletsModule_;
   const std::shared_ptr<JSScheduler> jsScheduler_;
   const std::shared_ptr<UIScheduler> uiScheduler_;
+  const std::string valueUnpackerCode_;
   std::shared_ptr<WorkletRuntime> uiWorkletRuntime_;
-  std::string valueUnpackerCode_;
 
   std::unique_ptr<EventHandlerRegistry> eventHandlerRegistry_;
   const RequestRenderFunction requestRender_;

Common/cpp/worklets/NativeModules/NativeWorkletsModule.cpp

@@ -0,0 +1,25 @@
+#include <string>
+
+#ifdef RCT_NEW_ARCH_ENABLED
+#include <react/renderer/uimanager/UIManagerBinding.h>
+#include <react/renderer/uimanager/primitives.h>
+#endif // RCT_NEW_ARCH_ENABLED
+
+#include <worklets/NativeModules/NativeWorkletsModule.h>
+
+#ifdef __ANDROID__
+#include <fbjni/fbjni.h>
+#endif // __ANDROID__
+
+#include <jsi/jsi.h>
+
+using namespace facebook;
+
+namespace worklets {
+
+NativeWorkletsModule::NativeWorkletsModule(const std::string &valueUnpackerCode)
+    : NativeWorkletsModuleSpec(nullptr),
+      valueUnpackerCode_(valueUnpackerCode) {}
+
+NativeWorkletsModule::~NativeWorkletsModule() {}
+} // namespace worklets

Common/cpp/worklets/NativeModules/NativeWorkletsModule.h

@@ -0,0 +1,23 @@
+#pragma once
+
+#include <cxxreact/MessageQueueThread.h>
+#include <worklets/NativeModules/NativeWorkletsModuleSpec.h>
+#include <string>
+
+namespace worklets {
+
+class NativeWorkletsModule : public NativeWorkletsModuleSpec {
+ public:
+  explicit NativeWorkletsModule(const std::string &valueUnpackerCode);
+
+  ~NativeWorkletsModule();
+
+  [[nodiscard]] inline std::string getValueUnpackerCode() const {
+    return valueUnpackerCode_;
+  }
+
+ private:
+  const std::string valueUnpackerCode_;
+};
+
+} // namespace worklets

Common/cpp/worklets/NativeModules/NativeWorkletsModuleSpec.cpp

@@ -0,0 +1,9 @@
+#include <worklets/NativeModules/NativeWorkletsModuleSpec.h>
+
+namespace worklets {
+
+NativeWorkletsModuleSpec::NativeWorkletsModuleSpec(
+    const std::shared_ptr<CallInvoker> jsInvoker)
+    : TurboModule("NativeWorklets", jsInvoker) {}
+
+} // namespace worklets

Common/cpp/worklets/NativeModules/NativeWorkletsModuleSpec.h

@@ -0,0 +1,18 @@
+#pragma once
+
+#include <ReactCommon/CallInvoker.h>
+#include <ReactCommon/TurboModule.h>
+#include <memory>
+
+using namespace facebook;
+using namespace react;
+
+namespace worklets {
+
+class JSI_EXPORT NativeWorkletsModuleSpec : public TurboModule {
+ protected:
+  explicit NativeWorkletsModuleSpec(
+      const std::shared_ptr<CallInvoker> jsInvoker);
+};
+
+} // namespace worklets

Common/cpp/worklets/WorkletRuntime/RNRuntimeWorkletDecorator.cpp

@@ -0,0 +1,14 @@
+#include <worklets/WorkletRuntime/RNRuntimeWorkletDecorator.h>
+
+namespace worklets {
+
+void RNRuntimeWorkletDecorator::decorate(
+    jsi::Runtime &rnRuntime,
+    const std::shared_ptr<NativeWorkletsModule> &nativeWorkletsModule) {
+  rnRuntime.global().setProperty(
+      rnRuntime,
+      "__workletsModuleProxy",
+      jsi::Object::createFromHostObject(rnRuntime, nativeWorkletsModule));
+}
+
+} // namespace worklets

Common/cpp/worklets/WorkletRuntime/RNRuntimeWorkletDecorator.h

@@ -0,0 +1,19 @@
+#pragma once
+
+#include <jsi/jsi.h>
+#include <worklets/NativeModules/NativeWorkletsModule.h>
+#include <memory>
+
+using namespace facebook;
+
+namespace worklets {
+
+class RNRuntimeWorkletDecorator {
+  // TODO: Rename to `RNRuntimeWorkletsDecorator` or something more suitable.
+ public:
+  static void decorate(
+      jsi::Runtime &rnRuntime,
+      const std::shared_ptr<NativeWorkletsModule> &nativeWorkletsModule);
+};
+
+} // namespace worklets

RNReanimated.podspec

@@ -78,6 +78,21 @@ Pod::Spec.new do |s|
   s.platforms    = { :ios => ios_min_version, :tvos => "9.0", :osx => "10.14", :visionos => "1.0" }
   s.source       = { :git => "https://github.com/software-mansion/react-native-reanimated.git", :tag => "#{s.version}" }
 
+  s.subspec "worklets" do |ss|
+    ss.source_files = "Common/cpp/worklets/**/*.{cpp,h}"
+    ss.header_dir = "worklets"
+    ss.header_mappings_dir = "Common/cpp/worklets"
+
+    ss.subspec "apple" do |sss|
+      # Please be careful with the snakes.
+      # 🐍🐍🐍
+      # Thank you for your understanding.
+      sss.source_files = "apple/worklets/**/*.{mm,h,m}"
+      sss.header_dir = "worklets"
+      sss.header_mappings_dir = "apple/worklets"
+    end
+  end
+
   s.subspec "reanimated" do |ss|
     ss.source_files = "Common/cpp/reanimated/**/*.{cpp,h}"
     ss.header_dir = "reanimated"
@@ -90,12 +105,6 @@ Pod::Spec.new do |s|
     end
   end
 
-  s.subspec "worklets" do |ss|
-    ss.source_files = "Common/cpp/worklets/**/*.{cpp,h}"
-    ss.header_dir = "worklets"
-    ss.header_mappings_dir = "Common/cpp/worklets"
-  end
-
   gcc_debug_definitions = "$(inherited)"
   if !is_release
     gcc_debug_definitions << " HERMES_ENABLE_DEBUGGER=1"

android/build.gradle

@@ -461,8 +461,8 @@ task createNativeDepsDirectories() {
 
 task packageNdkLibs(type: Copy) {
     from("$buildDir/reanimated-ndk/all")
-    include("**/libreanimated.so")
     include("**/libworklets.so")
+    include("**/libreanimated.so")
     into("$projectDir/src/main/jniLibs")
 }