Update how Gesture Handler exposes `setGestureState` to the Reanimated UI runtime #3207

j-piasecki · 2024-11-12T16:22:46Z

Description

Changes how setGestureState is exposed to the UI runtime. Instead of the weird conditionally adding Reanimated as a dependency on Android and the weird cast on iOS it uses _WORKLET_RUNTIME const injected by Reanimated into the JS runtime. This allows Gesture Handler to decorate the UI runtime without direct dependencies between the libraries.

The new approach relies on two methods being added to the global object:

_setGestureStateAsync on the JS runtime
_setGestureStateSync on the UI runtime

which allows for state manipulation also from the JS thread.

The basic example has been modified to easily test the new functionality.

Caution

This works only on the New Architecture (and breaks the old one)

Test plan

Test the expo example app and the modified basic example app

FabricExample/package.json

src/handlers/gestures/gestureStateManager.ts

src/RNGestureHandlerModule.ts

android/src/main/jni/RNGestureHandlerModule.cpp

tomekzaw · 2025-04-17T14:00:37Z

Additionally, I'd like to rename NativeMethods.h to GestureHandler.h or SetGestureState.h in react-native-reanimated, is that okay?

https://github.com/software-mansion/react-native-reanimated/blob/main/packages/react-native-reanimated/apple/reanimated/apple/native/NativeMethods.h

android/src/main/jni/RNGestureHandlerModule.h

tjzel

Very nice work overall, I like the removals 😎

android/src/main/jni/RNGestureHandlerModule.h

apple/RNGestureHandlerModule.mm

src/RNGestureHandlerModule.ts

src/handlers/gestures/gestureStateManager.ts

apple/RNGestureHandlerModule.mm

...e-handler/android/src/main/java/com/swmansion/gesturehandler/react/RNGestureHandlerModule.kt

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

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

packages/react-native-gesture-handler/shared/RuntimeDecorator.cpp

packages/react-native-gesture-handler/shared/RuntimeDecorator.h

packages/react-native-gesture-handler/src/handlers/gestures/gestureStateManager.ts

- `setGestureState` -> `setGestureState_DEPRECATED` (JSI injected name stays the same for compatibility) - `_setGestureStateNew` -> `_setGestureStateModern`

m-bert · 2025-07-03T07:33:17Z

scripts/format-cpp.js

Do we need this? We have format-apple script, the only difference is path passed to glob. Maybe it would be better to rename this script and pass path as argument?

Unified the scripts in da123f7. Let me know what you think.

.lintstagedrc.json

...e-handler/android/src/main/java/com/swmansion/gesturehandler/react/RNGestureHandlerModule.kt

...droid/paper/src/main/java/com/swmansion/gesturehandler/NativeRNGestureHandlerModuleSpec.java

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

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

packages/react-native-gesture-handler/package.json

packages/react-native-gesture-handler/src/handlers/gestures/gestureStateManager.ts

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

...e-handler/android/src/main/java/com/swmansion/gesturehandler/react/RNGestureHandlerModule.kt

latekvo · 2025-07-03T13:35:26Z

...e-handler/android/src/main/java/com/swmansion/gesturehandler/react/RNGestureHandlerModule.kt

@@ -49,10 +58,16 @@ class RNGestureHandlerModule(reactContext: ReactApplicationContext?) :
  }

  @ReactMethod
-  override fun createGestureHandler(handlerName: String, handlerTagDouble: Double, config: ReadableMap) {
+  override fun createGestureHandler(handlerName: String, handlerTagDouble: Double, config: ReadableMap): Boolean {


The createGestureHandler seems to only ever return true/1.
Is this the case, or am I missing something?
If it is the case, can we get away with returning void instead?

When a method returns any value in the codegen spec, the generated method is synchronous. I don't think there's a way to force codegen to generate a synchronous method that returns void.

m-bert

LGTM (let's see what @tomekzaw thinks) 🎉

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

tomekzaw

LGTM, thanks for all the changes!

WoLewicki

Some comments

WoLewicki · 2025-07-04T13:00:33Z

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

+    jsi::Runtime &rnRuntime,
+    std::function<void(int, int)> &&setGestureState) {
+  const auto runtimeHolder =
+      rnRuntime.global().getProperty(rnRuntime, "_WORKLET_RUNTIME");


Do I get it correctly that this is added to rnRuntime by Reanimated? From which version of lib is it there? Also, can't we have some race conditions that it is not yet there when you call this method or something like that? Btw, is it safe to have some kind of pointer from one runtime to another?

Do I get it correctly that this is added to rnRuntime by Reanimated

Yes

From which version of lib is it there

Pretty sure it was added in 2.x

Also, can't we have some race conditions that it is not yet there when you call this method or something like that

Yes - when you don't render an Animated.View, the Reanimated native module will not be initialized, and this field will not exist. This is handled on the JS side which will throw an exception about this.

is it safe to have some kind of pointer from one runtime to another

I believe so

Just for the context, _WORKLET_RUNTIME was added a few years ago to support integration of Reanimated with Expo GL. The latter could be used from the Reanimated UI runtime so it would inject some JSI bindings into the Reanimated UI runtime.

WoLewicki · 2025-07-04T13:01:53Z

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

+          rnRuntime);
+  const auto uiRuntimeAddress =
+      reinterpret_cast<uintptr_t *>(&arrayBufferValue[0]);
+  jsi::Runtime &uiRuntime =


Oh ok, so the above is just a bool specifying that there will be a buffer with a pointer to memory with uiRuntime allocated there?

I'm not sure what you mean by "the above".

runtimeHolder is a jsi value holding an array buffer. arrayBufferValue is the data held inside the buffer (the 8 bytes of the pointer to the ui runtime). uiRuntimeAddress is a pointer to the first byte of the buffer value, casted to uintptr_t which is an integer the size of a pointer. uiRuntime is a reference to the ui runtime which we get by casting the uiRuntimeAddress to jsi::Runtime * and dereferencing it.

Ok got it, thanks

For the context, this is because we can't represent a 64-bit pointer as a number so we need to use ArrayBuffer for that.

j-piasecki requested a review from tomekzaw November 12, 2024 16:24

j-piasecki force-pushed the @jpiasecki/update-reanimated-integration branch from 4b6cb29 to 039e228 Compare April 17, 2025 13:19

tomekzaw requested changes Apr 17, 2025

View reviewed changes

tomekzaw changed the title ~~Update how gesture handler exposes setGestureState to the ui runtime~~ Update how Gesture Handler exposes setGestureState to the Reanimated UI runtime Apr 17, 2025

tomekzaw reviewed Apr 17, 2025

View reviewed changes

android/src/main/jni/RNGestureHandlerModule.h Outdated Show resolved Hide resolved

tjzel reviewed Apr 18, 2025

View reviewed changes

tomekzaw reviewed May 13, 2025

View reviewed changes

apple/RNGestureHandlerModule.mm Outdated Show resolved Hide resolved

j-piasecki force-pushed the @jpiasecki/update-reanimated-integration branch from 08271fd to 12c9f11 Compare May 27, 2025 12:21

j-piasecki force-pushed the @jpiasecki/update-reanimated-integration branch from 296b706 to d5d7233 Compare June 30, 2025 05:43

tomekzaw requested changes Jun 30, 2025

View reviewed changes

j-piasecki force-pushed the @jpiasecki/update-reanimated-integration branch from 2e996c8 to eeafcc9 Compare July 2, 2025 11:55

j-piasecki added 18 commits July 3, 2025 07:25

Bump Reanimated

b8f9632

Update ios

583b499

Update android

4a506bf

Use Reanimated 4 beta

fb5543a

Renames:

17c6ce1

- `setGestureState` -> `setGestureState_DEPRECATED` (JSI injected name stays the same for compatibility) - `_setGestureStateNew` -> `_setGestureStateModern`

Decorate UI runtime lazily

96be8a7

Use non-deprecated method

fde59ee

Rename to _setGestureStateSync

126943a

Extract runtime decoration to shared code

90877be

Prefix with underscore

366dcdc

Handle calling setGestureState from other threads

e40e4e0

Expose _setGestureStateAsync to JS runtime

9fe3f60

Make state manager work also on JS

105e6f8

Add cpp format script

d10ddec

Format c++

38a0c20

Don't format build folders

5bd5f46

Fix header

53a79f0

Remove some gates

d835f7a

j-piasecki added 8 commits July 3, 2025 07:25

Android changes from review

a5ea8e4

iOS changes after review

4306217

Changes to shared

b1653e2

Throw error when no methods available

71f3699

Release javaPart on module invalidate

c6a87ac

Mark tagMessage as worklet

fdaccf5

Increase memory for basic-example build

0454c96

Continuously check whether ui runtime was decorated

801acd8

j-piasecki force-pushed the @jpiasecki/update-reanimated-integration branch from eeafcc9 to 801acd8 Compare July 3, 2025 05:25

j-piasecki changed the base branch from main to next July 3, 2025 05:26

j-piasecki requested review from m-bert and latekvo July 3, 2025 05:26

j-piasecki marked this pull request as ready for review July 3, 2025 05:26

Make createGestureHandler synchronous and run on the JS thread

2b43704

m-bert reviewed Jul 3, 2025

View reviewed changes

latekvo reviewed Jul 3, 2025

View reviewed changes

...e-handler/android/src/main/java/com/swmansion/gesturehandler/react/RNGestureHandlerModule.kt Show resolved Hide resolved

latekvo reviewed Jul 3, 2025

View reviewed changes

j-piasecki added 8 commits July 4, 2025 07:54

Add comment about createGestureHandler returning a bool

d4606a0

Remove todo

d1af5ad

Make comment start uppercase

843b069

Rename method

77ac470

Rename fields

4d51da1

Unify format apple and format cpp scripts

da123f7

Remove log

91a3bf3

Rename count -> argumentCount

2e3215e

m-bert approved these changes Jul 4, 2025

View reviewed changes

packages/react-native-gesture-handler/shared/RNGHRuntimeDecorator.cpp Outdated Show resolved Hide resolved

tomekzaw approved these changes Jul 4, 2025

View reviewed changes

WoLewicki reviewed Jul 4, 2025

View reviewed changes

j-piasecki merged commit 8a8b506 into next Jul 7, 2025
10 checks passed

j-piasecki deleted the @jpiasecki/update-reanimated-integration branch July 7, 2025 07:40

Uh oh!

Update how Gesture Handler exposes setGestureState to the Reanimated UI runtime #3207

Update how Gesture Handler exposes setGestureState to the Reanimated UI runtime #3207

Uh oh!

Conversation

j-piasecki commented Nov 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Test plan

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tomekzaw commented Apr 17, 2025

Uh oh!

Uh oh!

tjzel left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

latekvo Jul 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

m-bert left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

tomekzaw left a comment

Choose a reason for hiding this comment

Uh oh!

WoLewicki left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tomekzaw Jul 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Update how Gesture Handler exposes `setGestureState` to the Reanimated UI runtime #3207

Update how Gesture Handler exposes `setGestureState` to the Reanimated UI runtime #3207

j-piasecki commented Nov 12, 2024 •

edited

Loading

latekvo Jul 3, 2025 •

edited

Loading

tomekzaw Jul 4, 2025 •

edited

Loading