Read hover callbacks from the live Pressability config at invocation (#59363)

Summary:
Pull Request resolved: #59363

`Pressability._createEventHandlers` destructured `onHoverIn`/`onHoverOut` out of
`this._config` once, and `getEventHandlers` memoises the handler object for the
life of the instance. `configure` replaces the config on every update, but the
W3C-pointer hover closures kept calling the callbacks captured when the handlers
were first created, so a hover callback that closes over component state observed
that state as it was at mount, for the life of the view, however many times the
component re-rendered.

Every other handler in `_createEventHandlers` already reads `this._config` inside
its own body, and so does the legacy mouse branch below. This makes the W3C
pointer branch do the same. It also restores `reset`'s documented guarantee for
hover: after `reset` freezes `this._config`, a late `onPointerEnter` no longer
calls a configured callback.

Whether to attach `onPointerEnter`/`onPointerLeave` at all is still decided once,
from the config present when the handlers are created, because that presence is
what makes the host view listen for pointer enter/leave. A view that mounts
without a hover callback and is given one later still does not begin listening.
That behaviour is unchanged by this diff.

Only the branch behind `shouldPressibilityUseW3CPointerEventsForHover` is
touched. With that flag at its default the generated handlers are byte-identical
to before.

Changelog:
[General][Fixed] - `Pressability` now invokes the current `onHoverIn`/`onHoverOut` rather than the ones captured when its event handlers were created

Reviewed By: christophpurrer

Differential Revision: D126767220

fbshipit-source-id: 6bc1d2f663d503797c9c0762a79b6d35c7311fdf

Author: rozele

packages/react-native/Libraries/Pressability/Pressability.js

@@ -563,11 +563,16 @@ export default class Pressability {
         onPointerEnter: undefined as void | (PointerEvent => void),
         onPointerLeave: undefined as void | (PointerEvent => void),
       };
-      const {onHoverIn, onHoverOut} = this._config;
-      if (onHoverIn != null) {
+      // Whether to attach these at all is necessarily decided once: their
+      // presence is what makes the host view listen for pointer enter/leave.
+      // The callbacks themselves are read from `this._config` at invocation,
+      // as every other handler here does, so that `configure` is observed.
+      const configAtCreation = this._config;
+      if (configAtCreation.onHoverIn != null) {
         hoverPointerEvents.onPointerEnter = (event: PointerEvent) => {
           this._isHovered = true;
           this._cancelHoverOutDelayTimeout();
+          const {onHoverIn} = this._config;
           if (onHoverIn != null) {
             const delayHoverIn = normalizeDelay(this._config.delayHoverIn);
             if (delayHoverIn > 0) {
@@ -581,11 +586,12 @@ export default class Pressability {
           }
         };
       }
-      if (onHoverOut != null) {
+      if (configAtCreation.onHoverOut != null) {
         hoverPointerEvents.onPointerLeave = (event: PointerEvent) => {
           if (this._isHovered) {
             this._isHovered = false;
             this._cancelHoverInDelayTimeout();
+            const {onHoverOut} = this._config;
             if (onHoverOut != null) {
               const delayHoverOut = normalizeDelay(this._config.delayHoverOut);
               if (delayHoverOut > 0) {

packages/react-native/Libraries/Pressability/__tests__/Pressability-test.js

@@ -8,8 +8,11 @@
  * @format
  */
 
-import type {GestureResponderEvent} from '../../Types/CoreEventTypes';
-import type {PressabilityConfig} from '../Pressability';
+import type {
+  GestureResponderEvent,
+  PointerEvent,
+} from '../../Types/CoreEventTypes';
+import type {EventHandlers, PressabilityConfig} from '../Pressability';
 
 const UIManager = require('../../ReactNative/UIManager').default;
 const Platform = require('../../Utilities/Platform').default;
@@ -164,6 +167,60 @@ const createMockMouseEvent = (registrationName: string) => {
   };
 };
 
+const createMockPointerEvent = (registrationName: string): PointerEvent => {
+  const nativeEvent = {
+    altKey: false,
+    button: 0,
+    buttons: 0,
+    clientX: 0,
+    clientY: 0,
+    ctrlKey: false,
+    detail: 0,
+    height: 1,
+    isPrimary: true,
+    metaKey: false,
+    offsetX: 0,
+    offsetY: 0,
+    pageX: 0,
+    pageY: 0,
+    pointerId: 1,
+    pointerType: 'mouse',
+    pressure: 0,
+    relatedTarget: null,
+    screenX: 0,
+    screenY: 0,
+    shiftKey: false,
+    tangentialPressure: 0,
+    tiltX: 0,
+    tiltY: 0,
+    twist: 0,
+    width: 1,
+    x: 0,
+    y: 0,
+  };
+
+  return {
+    bubbles: null,
+    cancelable: null,
+    currentTarget: 42,
+    defaultPrevented: null,
+    dispatchConfig: {
+      registrationName,
+    },
+    eventPhase: null,
+    preventDefault: jest.fn(() => undefined),
+    isDefaultPrevented: jest.fn(() => false),
+    stopPropagation: jest.fn(() => undefined),
+    isPropagationStopped: jest.fn(() => false),
+    isTrusted: null,
+    nativeEvent,
+    persist: jest.fn(),
+    target: null,
+    timeStamp: 1075881600000,
+    type: null,
+  };
+};
+
 const createMockPressEvent = (
   nameOrOverrides:
     | string
@@ -983,6 +1040,144 @@ describe('Pressability', () => {
     });
   });
 
+  // The host view is given the handler object `getEventHandlers` built at
+  // mount; `configure` then replaces the config on every subsequent render.
+  // A handler that closes over its callback instead of reading `this._config`
+  // therefore keeps calling the mount-time closure for the life of the view,
+  // which on Android is the only path hover can take.
+  describe('hover with W3C pointer events', () => {
+    function requirePressabilityWithW3CHover() {
+      jest.doMock(
+        '../../../src/private/featureflags/specs/NativeReactNativeFeatureFlags',
+        () => ({
+          __esModule: true,
+          default: {
+            shouldPressibilityUseW3CPointerEventsForHover: () => true,
+          },
+        }),
+      );
+      return require('../Pressability').default;
+    }
+
+    // Mirrors a React render closure: each render produces a new callback
+    // that has captured that render's state value.
+    function configForRender(
+      isReady: boolean,
+      observed: Array<boolean>,
+    ): PressabilityConfig {
+      return {
+        onHoverIn: () => {
+          observed.push(isReady);
+        },
+        onHoverOut: () => {
+          observed.push(isReady);
+        },
+      };
+    }
+
+    // `onPointerEnter`/`onPointerLeave` are optional on `EventHandlers`.
+    function dispatchPointerEnter(handlers: EventHandlers): void {
+      const {onPointerEnter} = handlers;
+      invariant(
+        typeof onPointerEnter === 'function',
+        'Expected to find "onPointerEnter" function',
+      );
+      onPointerEnter(createMockPointerEvent('onPointerEnter'));
+    }
+
+    function dispatchPointerLeave(handlers: EventHandlers): void {
+      const {onPointerLeave} = handlers;
+      invariant(
+        typeof onPointerLeave === 'function',
+        'Expected to find "onPointerLeave" function',
+      );
+      onPointerLeave(createMockPointerEvent('onPointerLeave'));
+    }
+
+    it('gives the host view the same handlers across reconfigures', () => {
+      const PressabilityWithW3CHover = requirePressabilityWithW3CHover();
+      const observed: Array<boolean> = [];
+      const pressability = new PressabilityWithW3CHover(
+        configForRender(false, observed),
+      );
+      const mountHandlers = pressability.getEventHandlers();
+
+      pressability.configure(configForRender(true, observed));
+
+      expect(pressability.getEventHandlers().onPointerEnter).toBe(
+        mountHandlers.onPointerEnter,
+      );
+      expect(pressability.getEventHandlers().onPointerLeave).toBe(
+        mountHandlers.onPointerLeave,
+      );
+    });
+
+    it('calls the current `onHoverIn`, not the one captured at mount', () => {
+      const PressabilityWithW3CHover = requirePressabilityWithW3CHover();
+      const observed: Array<boolean> = [];
+      const pressability = new PressabilityWithW3CHover(
+        configForRender(false, observed),
+      );
+      const mountHandlers = pressability.getEventHandlers();
+
+      pressability.configure(configForRender(true, observed));
+      dispatchPointerEnter(mountHandlers);
+
+      expect(observed).toEqual([true]);
+    });
+
+    it('calls the current `onHoverOut`, not the one captured at mount', () => {
+      const PressabilityWithW3CHover = requirePressabilityWithW3CHover();
+      const observed: Array<boolean> = [];
+      const pressability = new PressabilityWithW3CHover(
+        configForRender(false, observed),
+      );
+      const mountHandlers = pressability.getEventHandlers();
+
+      dispatchPointerEnter(mountHandlers);
+      observed.length = 0;
+
+      pressability.configure(configForRender(true, observed));
+      dispatchPointerLeave(mountHandlers);
+
+      expect(observed).toEqual([true]);
+    });
+
+    it('calls the current `onHoverIn` after `delayHoverIn`', () => {
+      const PressabilityWithW3CHover = requirePressabilityWithW3CHover();
+      const observed: Array<boolean> = [];
+      const pressability = new PressabilityWithW3CHover({
+        ...configForRender(false, observed),
+        delayHoverIn: 100,
+      });
+      const mountHandlers = pressability.getEventHandlers();
+
+      pressability.configure({
+        ...configForRender(true, observed),
+        delayHoverIn: 100,
+      });
+      dispatchPointerEnter(mountHandlers);
+      jest.advanceTimersByTime(100);
+
+      expect(observed).toEqual([true]);
+    });
+
+    it('calls nothing after `reset`', () => {
+      const PressabilityWithW3CHover = requirePressabilityWithW3CHover();
+      const observed: Array<boolean> = [];
+      const pressability = new PressabilityWithW3CHover(
+        configForRender(false, observed),
+      );
+      const mountHandlers = pressability.getEventHandlers();
+
+      pressability.reset();
+      dispatchPointerEnter(mountHandlers);
+      dispatchPointerLeave(mountHandlers);
+
+      expect(observed).toEqual([]);
+    });
+  });
+
   afterEach(() => {
     jest.useRealTimers();
   });