ReactDOM.useEvent: more scaffolding changes (facebook#18282)

Author: trueadm

packages/legacy-events/PluginModuleType.js

@@ -29,7 +29,7 @@ export type PluginModule<NativeEvent> = {
     nativeTarget: NativeEvent,
     nativeEventTarget: null | EventTarget,
     eventSystemFlags: EventSystemFlags,
-    container?: Document | Element,
+    container?: EventTarget,
   ) => ?ReactSyntheticEvent,
   tapMoveThreshold?: number,
 };

packages/legacy-events/ReactSyntheticEventType.js

@@ -34,4 +34,5 @@ export type ReactSyntheticEvent = {|
   _dispatchInstances: null | Array<Fiber>,
   _dispatchListeners: null | Array<Function>,
   _targetInst: null | Fiber,
+  type: string,
 |};

packages/react-art/src/ReactARTHostConfig.js

@@ -469,3 +469,15 @@ export function getInstanceFromNode(node) {
 export function beforeRemoveInstance(instance) {
   // noop
 }
+
+export function mountEventListener(listener: any) {
+  throw new Error('Not yet implemented.');
+}
+
+export function unmountEventListener(listener: any) {
+  throw new Error('Not yet implemented.');
+}
+
+export function validateEventListenerTarget(target: any, listener: any) {
+  throw new Error('Not yet implemented.');
+}

packages/react-debug-tools/src/ReactDebugHooks.js

@@ -44,7 +44,7 @@ type HookLogEntry = {
 
 type ReactDebugListenerMap = {|
   clear: () => void,
-  setListener: (instance: EventTarget, callback: ?(Event) => void) => void,
+  setListener: (target: EventTarget, callback: ?(Event) => void) => void,
 |};
 
 let hookLog: Array<HookLogEntry> = [];

packages/react-dom/src/client/ReactDOMHostConfig.js

@@ -66,12 +66,17 @@ import {
   enableSuspenseServerRenderer,
   enableDeprecatedFlareAPI,
   enableFundamentalAPI,
+  enableUseEventAPI,
 } from 'shared/ReactFeatureFlags';
 import {HostComponent} from 'shared/ReactWorkTags';
 import {
   RESPONDER_EVENT_SYSTEM,
   IS_PASSIVE,
 } from 'legacy-events/EventSystemFlags';
+import {
+  attachElementListener,
+  detachElementListener,
+} from '../events/DOMModernPluginEventSystem';
 
 export type ReactListenerEvent = ReactDOMListenerEvent;
 export type ReactListenerMap = ReactDOMListenerMap;
@@ -1075,3 +1080,63 @@ export function unmountFundamentalComponent(
 export function getInstanceFromNode(node: HTMLElement): null | Object {
   return getClosestInstanceFromNode(node) || null;
 }
+
+export function mountEventListener(listener: ReactDOMListener): void {
+  if (enableUseEventAPI) {
+    const {target} = listener;
+    if (target === window) {
+      // TODO (useEvent)
+    } else {
+      attachElementListener(listener);
+    }
+  }
+}
+
+export function unmountEventListener(listener: ReactDOMListener): void {
+  if (enableUseEventAPI) {
+    const {target} = listener;
+    if (target === window) {
+      // TODO (useEvent)
+    } else {
+      detachElementListener(listener);
+    }
+  }
+}
+
+export function validateEventListenerTarget(
+  target: EventTarget,
+  listener: ?(Event) => void,
+): boolean {
+  if (enableUseEventAPI) {
+    if (
+      target &&
+      (target === window || getClosestInstanceFromNode(((target: any): Node)))
+    ) {
+      if (listener == null || typeof listener === 'function') {
+        return true;
+      }
+      if (__DEV__) {
+        console.warn(
+          'Event listener method setListener() from useEvent() hook requires the second argument' +
+            ' to be either a valid function callback or null/undefined.',
+        );
+      }
+    }
+    if (__DEV__) {
+      if (target && (target: any).nodeType === DOCUMENT_NODE) {
+        console.warn(
+          'Event listener method setListener() from useEvent() hook requires the first argument to be a valid' +
+            ' DOM node that was rendered and managed by React or a "window" object. It looks like' +
+            ' you supplied a "document" node, instead use the "window" object.',
+        );
+      } else {
+        console.warn(
+          'Event listener method setListener() from useEvent() hook requires the first argument to be a valid' +
+            ' DOM node that was rendered and managed by React or a "window" object. If this is' +
+            ' from a ref, ensure the ref value has been set before attaching.',
+        );
+      }
+    }
+  }
+  return false;
+}

packages/react-dom/src/events/DOMEventListenerMap.js

@@ -16,18 +16,15 @@ const PossiblyWeakMap = typeof WeakMap === 'function' ? WeakMap : Map;
 const elementListenerMap:
   // $FlowFixMe Work around Flow bug
   | WeakMap
-  | Map<
-      Document | Element | Node,
-      Map<DOMTopLevelEventType | string, null | (any => void)>,
-    > = new PossiblyWeakMap();
+  | Map<EventTarget, Map<DOMTopLevelEventType | string, null | (any => void)>> = new PossiblyWeakMap();
 
 export function getListenerMapForElement(
-  element: Document | Element | Node,
+  target: EventTarget,
 ): Map<DOMTopLevelEventType | string, null | (any => void)> {
-  let listenerMap = elementListenerMap.get(element);
+  let listenerMap = elementListenerMap.get(target);
   if (listenerMap === undefined) {
     listenerMap = new Map();
-    elementListenerMap.set(element, listenerMap);
+    elementListenerMap.set(target, listenerMap);
   }
   return listenerMap;
 }

packages/react-dom/src/events/DOMModernPluginEventSystem.js

@@ -108,7 +108,7 @@ function dispatchEventsForPlugins(
   eventSystemFlags: EventSystemFlags,
   nativeEvent: AnyNativeEvent,
   targetInst: null | Fiber,
-  rootContainer: Element | Document,
+  rootContainer: EventTarget,
 ): void {
   const nativeEventTarget = getEventTarget(nativeEvent);
   const syntheticEvents: Array<ReactSyntheticEvent> = [];
@@ -209,7 +209,7 @@ function willDeferLaterForFBLegacyPrimer(nativeEvent: any): boolean {
 
 function isMatchingRootContainer(
   grandContainer: Element,
-  rootContainer: Document | Element,
+  rootContainer: EventTarget,
 ): boolean {
   return (
     grandContainer === rootContainer ||
@@ -223,10 +223,19 @@ export function dispatchEventForPluginEventSystem(
   eventSystemFlags: EventSystemFlags,
   nativeEvent: AnyNativeEvent,
   targetInst: null | Fiber,
-  rootContainer: Document | Element,
+  rootContainer: EventTarget,
 ): void {
   let ancestorInst = targetInst;
-  if (rootContainer.nodeType !== DOCUMENT_NODE) {
+  // Given the rootContainer can be any EventTarget, if the
+  // target is that of a DOM node (other than the document)
+  // then we'll attempt to find the correct ancestor root.
+  // Note: the rootContainer can be other things like
+  // "window" or other valid EventTarget objects.
+  const possibleContainerNodeType = ((rootContainer: any): Node).nodeType;
+  if (
+    possibleContainerNodeType !== undefined &&
+    possibleContainerNodeType !== DOCUMENT_NODE
+  ) {
     // If we detect the FB legacy primer system, we
     // defer the event to the "document" with a one
     // time event listener so we can defer the event.

packages/react-dom/src/events/EventListener.js

@@ -8,29 +8,40 @@
  */
 
 export function addEventBubbleListener(
-  element: Document | Element | Node,
+  target: EventTarget,
   eventType: string,
   listener: Function,
 ): void {
-  element.addEventListener(eventType, listener, false);
+  target.addEventListener(eventType, listener, false);
 }
 
 export function addEventCaptureListener(
-  element: Document | Element | Node,
+  target: EventTarget,
   eventType: string,
   listener: Function,
 ): void {
-  element.addEventListener(eventType, listener, true);
+  target.addEventListener(eventType, listener, true);
 }
 
 export function addEventCaptureListenerWithPassiveFlag(
-  element: Document | Element | Node,
+  target: EventTarget,
   eventType: string,
   listener: Function,
   passive: boolean,
 ): void {
-  element.addEventListener(eventType, listener, {
+  target.addEventListener(eventType, listener, {
     capture: true,
     passive,
   });
 }
+
+export function addEventBubbleListenerWithPassiveFlag(
+  target: EventTarget,
+  eventType: string,
+  listener: Function,
+  passive: boolean,
+): void {
+  target.addEventListener(eventType, listener, {
+    passive,
+  });
+}

packages/react-dom/src/events/ReactDOMEventListener.js

@@ -130,7 +130,7 @@ export function addResponderEventSystemEvent(
 }
 
 export function addTrappedEventListener(
-  container: Document | Element,
+  targetContainer: EventTarget,
   topLevelType: DOMTopLevelEventType,
   capture: boolean,
   legacyFBSupport?: boolean,
@@ -153,7 +153,7 @@ export function addTrappedEventListener(
     null,
     topLevelType,
     PLUGIN_EVENT_SYSTEM,
-    container,
+    targetContainer,
   );
 
   const rawEventName = getRawEventName(topLevelType);
@@ -179,7 +179,7 @@ export function addTrappedEventListener(
         if (fbListener) {
           fbListener.remove();
         } else {
-          container.removeEventListener(
+          targetContainer.removeEventListener(
             ((rawEventName: any): string),
             (listener: any),
           );
@@ -188,9 +188,17 @@ export function addTrappedEventListener(
     };
   }
   if (capture) {
-    fbListener = addEventCaptureListener(container, rawEventName, listener);
+    fbListener = addEventCaptureListener(
+      targetContainer,
+      rawEventName,
+      listener,
+    );
   } else {
-    fbListener = addEventBubbleListener(container, rawEventName, listener);
+    fbListener = addEventBubbleListener(
+      targetContainer,
+      rawEventName,
+      listener,
+    );
   }
   // If we have an fbListener, then use that.
   // We'll only have one if we use the forked
@@ -199,20 +207,20 @@ export function addTrappedEventListener(
 }
 
 export function removeTrappedPassiveEventListener(
-  document: Document,
+  targetContainer: EventTarget,
   topLevelType: string,
   listener: any => void,
 ) {
   if (listener.remove != null) {
     listener.remove();
   } else {
     if (passiveBrowserEventsSupported) {
-      document.removeEventListener(topLevelType, listener, {
+      targetContainer.removeEventListener(topLevelType, listener, {
         capture: true,
         passive: true,
       });
     } else {
-      document.removeEventListener(topLevelType, listener, true);
+      targetContainer.removeEventListener(topLevelType, listener, true);
     }
   }
 }
@@ -254,7 +262,7 @@ function dispatchUserBlockingUpdate(
 export function dispatchEvent(
   topLevelType: DOMTopLevelEventType,
   eventSystemFlags: EventSystemFlags,
-  container: Document | Element,
+  container: EventTarget,
   nativeEvent: AnyNativeEvent,
 ): void {
   if (!_enabled) {
@@ -370,7 +378,7 @@ export function dispatchEvent(
 export function attemptToDispatchEvent(
   topLevelType: DOMTopLevelEventType,
   eventSystemFlags: EventSystemFlags,
-  container: Document | Element,
+  container: EventTarget,
   nativeEvent: AnyNativeEvent,
 ): null | Container | SuspenseInstance {
   // TODO: Warn if _enabled is false.

packages/react-dom/src/events/ReactDOMEventReplaying.js

@@ -126,7 +126,7 @@ type QueuedReplayableEvent = {|
   topLevelType: DOMTopLevelEventType,
   eventSystemFlags: EventSystemFlags,
   nativeEvent: AnyNativeEvent,
-  container: Document | Element,
+  container: EventTarget,
 |};
 
 let hasScheduledReplayAttempt = false;
@@ -285,7 +285,7 @@ function createQueuedReplayableEvent(
   blockedOn: null | Container | SuspenseInstance,
   topLevelType: DOMTopLevelEventType,
   eventSystemFlags: EventSystemFlags,
-  container: Document | Element,
+  container: EventTarget,
   nativeEvent: AnyNativeEvent,
 ): QueuedReplayableEvent {
   return {
@@ -301,7 +301,7 @@ export function queueDiscreteEvent(
   blockedOn: null | Container | SuspenseInstance,
   topLevelType: DOMTopLevelEventType,
   eventSystemFlags: EventSystemFlags,
-  container: Document | Element,
+  container: EventTarget,
   nativeEvent: AnyNativeEvent,
 ): void {
   const queuedEvent = createQueuedReplayableEvent(
@@ -376,7 +376,7 @@ function accumulateOrCreateContinuousQueuedReplayableEvent(
   blockedOn: null | Container | SuspenseInstance,
   topLevelType: DOMTopLevelEventType,
   eventSystemFlags: EventSystemFlags,
-  container: Document | Element,
+  container: EventTarget,
   nativeEvent: AnyNativeEvent,
 ): QueuedReplayableEvent {
   if (
@@ -411,7 +411,7 @@ export function queueIfContinuousEvent(
   blockedOn: null | Container | SuspenseInstance,
   topLevelType: DOMTopLevelEventType,
   eventSystemFlags: EventSystemFlags,
-  container: Document | Element,
+  container: EventTarget,
   nativeEvent: AnyNativeEvent,
 ): boolean {
   // These set relatedTarget to null because the replayed event will be treated as if we