Unify Flare FocusWithin responder with useFocusWithin (facebook#18636)

trueadm · web-flow · commit f24a9e70980c · 2020-04-16T19:35:41.000+01:00
diff --git a/packages/react-dom/src/client/ReactDOMHostConfig.js b/packages/react-dom/src/client/ReactDOMHostConfig.js
@@ -555,11 +555,10 @@ function dispatchBeforeDetachedBlur(target: HTMLElement): void {
 function dispatchAfterDetachedBlur(target: HTMLElement): void {
   if (enableDeprecatedFlareAPI) {
     DEPRECATED_dispatchEventForResponderEventSystem(
-      'blur',
+      'afterblur',
       null,
       ({
-        isTargetAttached: false,
-        target,
+        relatedTarget: target,
         timeStamp: Date.now(),
       }: any),
       target,
diff --git a/packages/react-interactions/events/src/dom/DeprecatedFocus.js b/packages/react-interactions/events/src/dom/DeprecatedFocus.js
@@ -22,7 +22,7 @@ import {DiscreteEvent} from 'shared/ReactTypes';
  */
 
 type FocusEvent = {|
-  isTargetAttached: boolean,
+  relatedTarget: null | Element | Document,
   target: Element | Document,
   type: FocusEventType | FocusWithinEventType,
   pointerType: PointerType,
@@ -53,6 +53,7 @@ type FocusEventType = 'focus' | 'blur' | 'focuschange' | 'focusvisiblechange';
 type FocusWithinProps = {
   disabled?: boolean,
   onFocusWithin?: (e: FocusEvent) => void,
+  onAfterBlurWithin?: (e: FocusEvent) => void,
   onBeforeBlurWithin?: (e: FocusEvent) => void,
   onBlurWithin?: (e: FocusEvent) => void,
   onFocusWithinChange?: boolean => void,
@@ -65,7 +66,8 @@ type FocusWithinEventType =
   | 'focuswithinchange'
   | 'blurwithin'
   | 'focuswithin'
-  | 'beforeblurwithin';
+  | 'beforeblurwithin'
+  | 'afterblurwithin';
 
 /**
  * Shared between Focus and FocusWithin
@@ -116,8 +118,7 @@ const focusVisibleEvents = hasPointerEvents
 
 const targetEventTypes = ['focus', 'blur', 'beforeblur', ...focusVisibleEvents];
 
-// Used only for the blur "detachedTarget" logic
-const rootEventTypes = ['blur'];
+const rootEventTypes = ['afterblur'];
 
 function addWindowEventListener(types, callback, options) {
   types.forEach(type => {
@@ -192,10 +193,10 @@ function createFocusEvent(
   type: FocusEventType | FocusWithinEventType,
   target: Element | Document,
   pointerType: PointerType,
-  isTargetAttached: boolean,
+  relatedTarget: null | Element | Document,
 ): FocusEvent {
   return {
-    isTargetAttached,
+    relatedTarget,
     target,
     type,
     pointerType,
@@ -297,7 +298,7 @@ function dispatchFocusEvents(
       'focus',
       target,
       pointerType,
-      true,
+      null,
     );
     context.dispatchEvent(syntheticEvent, onFocus, DiscreteEvent);
   }
@@ -321,7 +322,7 @@ function dispatchBlurEvents(
       'blur',
       target,
       pointerType,
-      true,
+      null,
     );
     context.dispatchEvent(syntheticEvent, onBlur, DiscreteEvent);
   }
@@ -346,7 +347,7 @@ function dispatchFocusWithinEvents(
       'focuswithin',
       target,
       pointerType,
-      true,
+      null,
     );
     context.dispatchEvent(syntheticEvent, onFocusWithin, DiscreteEvent);
   }
@@ -361,19 +362,40 @@ function dispatchBlurWithinEvents(
   const pointerType = state.pointerType;
   const target = ((state.focusTarget: any): Element | Document) || event.target;
   const onBlurWithin = (props.onBlurWithin: any);
-  const isTargetAttached = state.detachedTarget === null;
   if (isFunction(onBlurWithin)) {
     const syntheticEvent = createFocusEvent(
       context,
       'blurwithin',
       target,
       pointerType,
-      isTargetAttached,
+      null,
     );
     context.dispatchEvent(syntheticEvent, onBlurWithin, DiscreteEvent);
   }
 }
 
+function dispatchAfterBlurWithinEvents(
+  context: ReactDOMResponderContext,
+  event: ReactDOMResponderEvent,
+  props: FocusWithinProps,
+  state: FocusState,
+) {
+  const pointerType = state.pointerType;
+  const target = ((state.focusTarget: any): Element | Document) || event.target;
+  const onAfterBlurWithin = (props.onAfterBlurWithin: any);
+  const relatedTarget = state.detachedTarget;
+  if (isFunction(onAfterBlurWithin)) {
+    const syntheticEvent = createFocusEvent(
+      context,
+      'afterblurwithin',
+      target,
+      pointerType,
+      relatedTarget,
+    );
+    context.dispatchEvent(syntheticEvent, onAfterBlurWithin, DiscreteEvent);
+  }
+}
+
 function dispatchFocusChange(
   context: ReactDOMResponderContext,
   props: FocusProps,
@@ -616,7 +638,7 @@ const focusWithinResponderImpl = {
             'beforeblurwithin',
             event.target,
             state.pointerType,
-            true,
+            null,
           );
           state.detachedTarget = event.target;
           context.dispatchEvent(
@@ -660,10 +682,10 @@ const focusWithinResponderImpl = {
     props: FocusWithinProps,
     state: FocusState,
   ): void {
-    if (event.type === 'blur') {
+    if (event.type === 'afterblur') {
       const detachedTarget = state.detachedTarget;
       if (detachedTarget !== null && detachedTarget === event.target) {
-        dispatchBlurWithinEvents(context, event, props, state);
+        dispatchAfterBlurWithinEvents(context, event, props, state);
         state.detachedTarget = null;
         if (state.addedRootEvents) {
           state.addedRootEvents = false;
diff --git a/packages/react-interactions/events/src/dom/__tests__/FocusWithin-test.internal.js b/packages/react-interactions/events/src/dom/__tests__/FocusWithin-test.internal.js
@@ -290,11 +290,11 @@ describe.each(table)('FocusWithin responder', hasPointerEvents => {
   });
 
   describe('onBeforeBlurWithin', () => {
-    let onBeforeBlurWithin, onBlurWithin, ref, innerRef, innerRef2;
+    let onBeforeBlurWithin, onAfterBlurWithin, ref, innerRef, innerRef2;
 
     beforeEach(() => {
       onBeforeBlurWithin = jest.fn();
-      onBlurWithin = jest.fn();
+      onAfterBlurWithin = jest.fn();
       ref = React.createRef();
       innerRef = React.createRef();
       innerRef2 = React.createRef();
@@ -305,7 +305,7 @@ describe.each(table)('FocusWithin responder', hasPointerEvents => {
       const Component = ({show}) => {
         const listener = useFocusWithin({
           onBeforeBlurWithin,
-          onBlurWithin,
+          onAfterBlurWithin,
         });
         return (
           <div ref={ref} DEPRECATED_flareListeners={listener}>
@@ -322,12 +322,12 @@ describe.each(table)('FocusWithin responder', hasPointerEvents => {
       target.keydown({key: 'Tab'});
       target.focus();
       expect(onBeforeBlurWithin).toHaveBeenCalledTimes(0);
-      expect(onBlurWithin).toHaveBeenCalledTimes(0);
+      expect(onAfterBlurWithin).toHaveBeenCalledTimes(0);
       ReactDOM.render(<Component show={false} />, container);
       expect(onBeforeBlurWithin).toHaveBeenCalledTimes(1);
-      expect(onBlurWithin).toHaveBeenCalledTimes(1);
-      expect(onBlurWithin).toHaveBeenCalledWith(
-        expect.objectContaining({isTargetAttached: false}),
+      expect(onAfterBlurWithin).toHaveBeenCalledTimes(1);
+      expect(onAfterBlurWithin).toHaveBeenCalledWith(
+        expect.objectContaining({relatedTarget: inner}),
       );
     });
 
@@ -336,7 +336,7 @@ describe.each(table)('FocusWithin responder', hasPointerEvents => {
       const Component = ({show}) => {
         const listener = useFocusWithin({
           onBeforeBlurWithin,
-          onBlurWithin,
+          onAfterBlurWithin,
         });
         return (
           <div ref={ref} DEPRECATED_flareListeners={listener}>
@@ -357,12 +357,12 @@ describe.each(table)('FocusWithin responder', hasPointerEvents => {
       target.keydown({key: 'Tab'});
       target.focus();
       expect(onBeforeBlurWithin).toHaveBeenCalledTimes(0);
-      expect(onBlurWithin).toHaveBeenCalledTimes(0);
+      expect(onAfterBlurWithin).toHaveBeenCalledTimes(0);
       ReactDOM.render(<Component show={false} />, container);
       expect(onBeforeBlurWithin).toHaveBeenCalledTimes(1);
-      expect(onBlurWithin).toHaveBeenCalledTimes(1);
-      expect(onBlurWithin).toHaveBeenCalledWith(
-        expect.objectContaining({isTargetAttached: false}),
+      expect(onAfterBlurWithin).toHaveBeenCalledTimes(1);
+      expect(onAfterBlurWithin).toHaveBeenCalledWith(
+        expect.objectContaining({relatedTarget: inner}),
       );
     });
 
@@ -418,7 +418,7 @@ describe.each(table)('FocusWithin responder', hasPointerEvents => {
       const Component = ({show}) => {
         const listener = useFocusWithin({
           onBeforeBlurWithin,
-          onBlurWithin,
+          onAfterBlurWithin,
         });
 
         return (
@@ -444,7 +444,7 @@ describe.each(table)('FocusWithin responder', hasPointerEvents => {
       target.keydown({key: 'Tab'});
       target.focus();
       expect(onBeforeBlurWithin).toHaveBeenCalledTimes(0);
-      expect(onBlurWithin).toHaveBeenCalledTimes(0);
+      expect(onAfterBlurWithin).toHaveBeenCalledTimes(0);
 
       suspend = true;
       root.render(<Component />);
@@ -454,7 +454,7 @@ describe.each(table)('FocusWithin responder', hasPointerEvents => {
         '<div><input style="display: none;">Loading...</div>',
       );
       expect(onBeforeBlurWithin).toHaveBeenCalledTimes(1);
-      expect(onBlurWithin).toHaveBeenCalledTimes(1);
+      expect(onAfterBlurWithin).toHaveBeenCalledTimes(1);
       resolve();
 
       document.body.removeChild(container2);
