Move the event logic to ReanimatedNativeDetector add fallback

Author: j-piasecki

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

@@ -29,6 +29,16 @@ export type ReanimatedHandler<THandlerData> = {
   context: ReanimatedContext<THandlerData>;
 };
 
+export type NativeEventsManager = new (component: {
+  props: Record<string, unknown>;
+  _componentRef: React.Ref<unknown>;
+  getComponentViewTag: () => number;
+}) => {
+  attachEvents: () => void;
+  detachEvents: () => void;
+  updateEvents: (prevProps: Record<string, unknown>) => void;
+};
+
 let Reanimated:
   | {
       default: {
@@ -38,6 +48,7 @@ let Reanimated:
           options?: unknown
         ): ComponentClass<P>;
       };
+      NativeEventsManager: NativeEventsManager;
       useHandler: <THandlerData>(
         handlers: GestureCallbacks<THandlerData>
       ) => ReanimatedHandler<THandlerData>;

packages/react-native-gesture-handler/src/v3/detectors/HostGestureDetector.tsx

@@ -1,3 +1,4 @@
 import RNGestureHandlerDetectorNativeComponent from '../../specs/RNGestureHandlerDetectorNativeComponent';
+export { NativeProps as RNGestureHandlerDetectorNativeComponentProps } from '../../specs/RNGestureHandlerDetectorNativeComponent';
 const HostGestureDetector = RNGestureHandlerDetectorNativeComponent;
 export default HostGestureDetector;

packages/react-native-gesture-handler/src/v3/detectors/NativeDetector.tsx

@@ -7,30 +7,27 @@ import {
   NativeDetectorProps,
   nativeDetectorStyles,
 } from './common';
-import { useReanimatedEventsManager } from './useReanimatedEventsManager';
+import { ReanimatedNativeDetector } from './ReanimatedNativeDetector';
 
 export function NativeDetector<THandlerData, TConfig>({
   gesture,
   children,
 }: NativeDetectorProps<THandlerData, TConfig>) {
-  // TODO: is it possible with useReanimatedEventsManager to handle both Animated and Reanimated at the same time?
-
   const NativeDetectorComponent = gesture.config.dispatchesAnimatedEvents
     ? AnimatedNativeDetector
-    : HostGestureDetector;
+    : gesture.config.shouldUseReanimatedDetector
+      ? ReanimatedNativeDetector
+      : HostGestureDetector;
 
   ensureNativeDetectorComponent(NativeDetectorComponent);
   configureRelations(gesture);
 
-  // TODO: call useReanimatedEventsManager only when using Reanimated
-  const viewRef = useReanimatedEventsManager(gesture);
   const handlerTags = useMemo(() => {
     return isComposedGesture(gesture) ? gesture.tags : [gesture.tag];
   }, [gesture]);
 
   return (
     <NativeDetectorComponent
-      ref={viewRef}
       pointerEvents={'box-none'}
       // @ts-ignore This is a type mismatch between RNGH types and RN Codegen types
       onGestureHandlerStateChange={
@@ -43,6 +40,18 @@ export function NativeDetector<THandlerData, TConfig>({
         gesture.detectorCallbacks.onGestureHandlerTouchEvent
       }
       // @ts-ignore This is a type mismatch between RNGH types and RN Codegen types
+      onGestureHandlerReanimatedStateChange={
+        gesture.detectorCallbacks.onReanimatedStateChange
+      }
+      // @ts-ignore This is a type mismatch between RNGH types and RN Codegen types
+      onGestureHandlerReanimatedEvent={
+        gesture.detectorCallbacks.onReanimatedUpdateEvent
+      }
+      // @ts-ignore This is a type mismatch between RNGH types and RN Codegen types
+      onGestureHandlerReanimatedTouchEvent={
+        gesture.detectorCallbacks.onReanimatedTouchEvent
+      }
+      // @ts-ignore This is a type mismatch between RNGH types and RN Codegen types
       onGestureHandlerAnimatedEvent={
         gesture.detectorCallbacks.onGestureHandlerAnimatedEvent
       }

packages/react-native-gesture-handler/src/v3/detectors/ReanimatedNativeDetector.tsx

@@ -0,0 +1,93 @@
+import { useEffect, useMemo, useRef } from 'react';
+import {
+  NativeEventsManager,
+  Reanimated,
+} from '../../handlers/gestures/reanimatedWrapper';
+import HostGestureDetector, {
+  type RNGestureHandlerDetectorNativeComponentProps,
+} from './HostGestureDetector';
+import { findNodeHandle } from 'react-native';
+
+let NativeEventsManagerImpl = Reanimated?.NativeEventsManager;
+
+if (!NativeEventsManagerImpl) {
+  // Fallback to empty object when Reanimated or NativeEventsManager is not available
+  try {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+    NativeEventsManagerImpl =
+      // eslint-disable-next-line @typescript-eslint/no-var-requires, @typescript-eslint/no-unsafe-member-access
+      require('react-native-reanimated/src/createAnimatedComponent/NativeEventsManager').NativeEventsManager;
+  } catch {
+    // fail silently
+  }
+}
+
+type WorkletProps = Pick<
+  RNGestureHandlerDetectorNativeComponentProps,
+  | 'onGestureHandlerReanimatedStateChange'
+  | 'onGestureHandlerReanimatedEvent'
+  | 'onGestureHandlerReanimatedTouchEvent'
+>;
+
+function LeanReanimatedNativeDetector(
+  props: RNGestureHandlerDetectorNativeComponentProps
+) {
+  const prevProps = useRef<WorkletProps>(null);
+  const eventManager = useRef<InstanceType<NativeEventsManager> | null>(null);
+  const viewRef = useRef<any>(null);
+
+  const {
+    onGestureHandlerReanimatedStateChange,
+    onGestureHandlerReanimatedEvent,
+    onGestureHandlerReanimatedTouchEvent,
+    ...restProps
+  } = props;
+
+  const reaProps: WorkletProps = useMemo(
+    () => ({
+      onGestureHandlerReanimatedStateChange,
+      // @ts-ignore This is a type mismatch between RNGH types and RN Codegen types
+      onGestureHandlerReanimatedEvent,
+      // @ts-ignore This is a type mismatch between RNGH types and RN Codegen types
+      onGestureHandlerReanimatedTouchEvent,
+    }),
+    [
+      onGestureHandlerReanimatedEvent,
+      onGestureHandlerReanimatedStateChange,
+      onGestureHandlerReanimatedTouchEvent,
+    ]
+  );
+
+  useEffect(() => {
+    const nativeTag = findNodeHandle(viewRef.current) ?? -1;
+    // @ts-expect-error Reanimated expects __nativeTag to be present on the ref
+    viewRef.__nativeTag = nativeTag;
+    // @ts-expect-error NativeEventsManager should be defined here, if it isn't, we should
+    // go the fallback way and use Reanimated's createAnimatedComponent
+    eventManager.current = new NativeEventsManagerImpl({
+      props: reaProps,
+      _componentRef: viewRef,
+      getComponentViewTag: () => {
+        return nativeTag;
+      },
+    });
+    eventManager.current.attachEvents();
+
+    return () => {
+      eventManager.current?.detachEvents();
+    };
+  }, []);
+
+  useEffect(() => {
+    if (prevProps.current) {
+      eventManager.current?.updateEvents(prevProps.current);
+    }
+    prevProps.current = reaProps;
+  }, [reaProps]);
+
+  return <HostGestureDetector ref={viewRef} {...restProps} />;
+}
+
+export const ReanimatedNativeDetector = NativeEventsManagerImpl
+  ? LeanReanimatedNativeDetector
+  : Reanimated?.default.createAnimatedComponent(HostGestureDetector);

packages/react-native-gesture-handler/src/v3/detectors/ReanimatedNativeDetector.web.tsx

@@ -0,0 +1,5 @@
+import { Reanimated } from '../../handlers/gestures/reanimatedWrapper';
+import HostGestureDetector from './HostGestureDetector';
+
+export const ReanimatedNativeDetector =
+  Reanimated?.default.createAnimatedComponent(HostGestureDetector);

packages/react-native-gesture-handler/src/v3/detectors/VirtualDetector/InterceptingGestureDetector.tsx

@@ -17,10 +17,10 @@ import {
   AnimatedNativeDetector,
   InterceptingGestureDetectorProps,
   nativeDetectorStyles,
-  ReanimatedNativeDetector,
 } from '../common';
 import { tagMessage } from '../../../utils';
 import { useEnsureGestureHandlerRootView } from '../useEnsureGestureHandlerRootView';
+import { ReanimatedNativeDetector } from '../ReanimatedNativeDetector';
 
 interface VirtualChildrenForNative {
   viewTag: number;

packages/react-native-gesture-handler/src/v3/detectors/common.ts

@@ -1,6 +1,5 @@
 import React from 'react';
 import { Gesture } from '../types';
-import { Reanimated } from '../../handlers/gestures/reanimatedWrapper';
 import { Animated, StyleSheet } from 'react-native';
 import HostGestureDetector from './HostGestureDetector';
 import { GestureDetectorProps as LegacyDetectorProps } from '../../handlers/gestures/GestureDetector';
@@ -23,9 +22,6 @@ export type GestureDetectorProps<THandlerData, TConfig> =
 export const AnimatedNativeDetector =
   Animated.createAnimatedComponent(HostGestureDetector);
 
-export const ReanimatedNativeDetector =
-  Reanimated?.default.createAnimatedComponent(HostGestureDetector);
-
 export const nativeDetectorStyles = StyleSheet.create({
   detector: {
     display: 'contents',