Rename UseEvent too

facebook · Dec 13, 2022 · 2d97961 · 2d97961
1 parent a1466f0
commit 2d97961
Show file tree

Hide file tree

Showing 16 changed files with 55 additions and 52 deletions.
diff --git a/packages/eslint-plugin-react-hooks/src/ExhaustiveDeps.js b/packages/eslint-plugin-react-hooks/src/ExhaustiveDeps.js
@@ -226,7 +226,10 @@ export default {
         if (name === 'useRef' && id.type === 'Identifier') {
           // useRef() return value is stable.
           return true;
-        } else if (isUseEventIdentifier(callee) && id.type === 'Identifier') {
+        } else if (
+          isUseEffectEventIdentifier(callee) &&
+          id.type === 'Identifier'
+        ) {
           for (const ref of resolved.references) {
             if (ref !== id) {
               useEffectEventVariables.add(ref.identifier);
@@ -1851,7 +1854,7 @@ function isAncestorNodeOf(a, b) {
   return a.range[0] <= b.range[0] && a.range[1] >= b.range[1];
 }
 
-function isUseEventIdentifier(node) {
+function isUseEffectEventIdentifier(node) {
   if (__EXPERIMENTAL__) {
     return node.type === 'Identifier' && node.name === 'useEffectEvent';
   }

diff --git a/packages/eslint-plugin-react-hooks/src/RulesOfHooks.js b/packages/eslint-plugin-react-hooks/src/RulesOfHooks.js
@@ -103,7 +103,7 @@ function isInsideComponentOrHook(node) {
   return false;
 }
 
-function isUseEventIdentifier(node) {
+function isUseEffectEventIdentifier(node) {
   if (__EXPERIMENTAL__) {
     return node.type === 'Identifier' && node.name === 'useEffectEvent';
   }
@@ -135,15 +135,15 @@ export default {
     // For a given scope, iterate through the references and add all useEffectEvent definitions. We can
     // do this in non-Program nodes because we can rely on the assumption that useEffectEvent functions
     // can only be declared within a component or hook at its top level.
-    function recordAllUseEventFunctions(scope) {
+    function recordAllUseEffectEventFunctions(scope) {
       for (const reference of scope.references) {
         const parent = reference.identifier.parent;
         if (
           parent.type === 'VariableDeclarator' &&
           parent.init &&
           parent.init.type === 'CallExpression' &&
           parent.init.callee &&
-          isUseEventIdentifier(parent.init.callee)
+          isUseEffectEventIdentifier(parent.init.callee)
         ) {
           for (const ref of reference.resolved.references) {
             if (ref !== reference) {
@@ -576,7 +576,7 @@ export default {
         if (
           node.callee.type === 'Identifier' &&
           (node.callee.name === 'useEffect' ||
-            isUseEventIdentifier(node.callee)) &&
+            isUseEffectEventIdentifier(node.callee)) &&
           node.arguments.length > 0
         ) {
           // Denote that we have traversed into a useEffect call, and stash the CallExpr for
@@ -613,14 +613,14 @@ export default {
       FunctionDeclaration(node) {
         // function MyComponent() { const onClick = useEffectEvent(...) }
         if (isInsideComponentOrHook(node)) {
-          recordAllUseEventFunctions(context.getScope());
+          recordAllUseEffectEventFunctions(context.getScope());
         }
       },
 
       ArrowFunctionExpression(node) {
         // const MyComponent = () => { const onClick = useEffectEvent(...) }
         if (isInsideComponentOrHook(node)) {
-          recordAllUseEventFunctions(context.getScope());
+          recordAllUseEffectEventFunctions(context.getScope());
         }
       },
     };

diff --git a/packages/react-dom/src/__tests__/ReactDOMFizzServer-test.js b/packages/react-dom/src/__tests__/ReactDOMFizzServer-test.js
@@ -5460,7 +5460,7 @@ describe('ReactDOMFizzServer', () => {
   });
 
   describe('useEffectEvent', () => {
-    // @gate enableUseEventHook
+    // @gate enableUseEffectEventHook
     it('can server render a component with useEffectEvent', async () => {
       const ref = React.createRef();
       function App() {
@@ -5491,7 +5491,7 @@ describe('ReactDOMFizzServer', () => {
       expect(getVisibleChildren(container)).toEqual(<button>1</button>);
     });
 
-    // @gate enableUseEventHook
+    // @gate enableUseEffectEventHook
     it('throws if useEffectEvent is called during a server render', async () => {
       const logs = [];
       function App() {
@@ -5523,7 +5523,7 @@ describe('ReactDOMFizzServer', () => {
       expect(reportedServerErrors).toEqual([caughtError]);
     });
 
-    // @gate enableUseEventHook
+    // @gate enableUseEffectEventHook
     it('does not guarantee useEffectEvent return values during server rendering are distinct', async () => {
       function App() {
         const onClick1 = React.experimental_useEffectEvent(() => {});

diff --git a/packages/react-reconciler/src/ReactFiberCommitWork.js b/packages/react-reconciler/src/ReactFiberCommitWork.js
@@ -50,7 +50,7 @@ import {
   enableUpdaterTracking,
   enableCache,
   enableTransitionTracing,
-  enableUseEventHook,
+  enableUseEffectEventHook,
   enableFloat,
   enableLegacyHidden,
   enableHostSingletons,
@@ -454,9 +454,9 @@ function commitBeforeMutationEffectsOnFiber(finishedWork: Fiber) {
 
   switch (finishedWork.tag) {
     case FunctionComponent: {
-      if (enableUseEventHook) {
+      if (enableUseEffectEventHook) {
         if ((flags & Update) !== NoFlags) {
-          commitUseEventMount(finishedWork);
+          commitUseEffectEventMount(finishedWork);
         }
       }
       break;
@@ -706,7 +706,7 @@ function commitHookEffectListMount(flags: HookFlags, finishedWork: Fiber) {
   }
 }
 
-function commitUseEventMount(finishedWork: Fiber) {
+function commitUseEffectEventMount(finishedWork: Fiber) {
   const updateQueue: FunctionComponentUpdateQueue | null = (finishedWork.updateQueue: any);
   const eventPayloads = updateQueue !== null ? updateQueue.events : null;
   if (eventPayloads !== null) {

diff --git a/packages/react-reconciler/src/ReactFiberHooks.js b/packages/react-reconciler/src/ReactFiberHooks.js
@@ -38,7 +38,7 @@ import {
   enableTransitionTracing,
   enableUseHook,
   enableUseMemoCacheHook,
-  enableUseEventHook,
+  enableUseEffectEventHook,
   enableLegacyCache,
   debugRenderPhaseSideEffectsForStrictMode,
 } from 'shared/ReactFeatureFlags';
@@ -2780,7 +2780,7 @@ if (enableUseHook) {
 if (enableUseMemoCacheHook) {
   (ContextOnlyDispatcher: Dispatcher).useMemoCache = throwInvalidHookError;
 }
-if (enableUseEventHook) {
+if (enableUseEffectEventHook) {
   (ContextOnlyDispatcher: Dispatcher).useEffectEvent = throwInvalidHookError;
 }
 
@@ -2814,7 +2814,7 @@ if (enableUseHook) {
 if (enableUseMemoCacheHook) {
   (HooksDispatcherOnMount: Dispatcher).useMemoCache = useMemoCache;
 }
-if (enableUseEventHook) {
+if (enableUseEffectEventHook) {
   (HooksDispatcherOnMount: Dispatcher).useEffectEvent = mountEvent;
 }
 const HooksDispatcherOnUpdate: Dispatcher = {
@@ -2846,7 +2846,7 @@ if (enableUseMemoCacheHook) {
 if (enableUseHook) {
   (HooksDispatcherOnUpdate: Dispatcher).use = use;
 }
-if (enableUseEventHook) {
+if (enableUseEffectEventHook) {
   (HooksDispatcherOnUpdate: Dispatcher).useEffectEvent = updateEvent;
 }
 
@@ -2879,7 +2879,7 @@ if (enableUseHook) {
 if (enableUseMemoCacheHook) {
   (HooksDispatcherOnRerender: Dispatcher).useMemoCache = useMemoCache;
 }
-if (enableUseEventHook) {
+if (enableUseEffectEventHook) {
   (HooksDispatcherOnRerender: Dispatcher).useEffectEvent = updateEvent;
 }
 
@@ -3059,7 +3059,7 @@ if (__DEV__) {
   if (enableUseMemoCacheHook) {
     (HooksDispatcherOnMountInDEV: Dispatcher).useMemoCache = useMemoCache;
   }
-  if (enableUseEventHook) {
+  if (enableUseEffectEventHook) {
     (HooksDispatcherOnMountInDEV: Dispatcher).useEffectEvent = function useEffectEvent<
       Args,
       Return,
@@ -3214,7 +3214,7 @@ if (__DEV__) {
   if (enableUseMemoCacheHook) {
     (HooksDispatcherOnMountWithHookTypesInDEV: Dispatcher).useMemoCache = useMemoCache;
   }
-  if (enableUseEventHook) {
+  if (enableUseEffectEventHook) {
     (HooksDispatcherOnMountWithHookTypesInDEV: Dispatcher).useEffectEvent = function useEffectEvent<
       Args,
       Return,
@@ -3369,7 +3369,7 @@ if (__DEV__) {
   if (enableUseMemoCacheHook) {
     (HooksDispatcherOnUpdateInDEV: Dispatcher).useMemoCache = useMemoCache;
   }
-  if (enableUseEventHook) {
+  if (enableUseEffectEventHook) {
     (HooksDispatcherOnUpdateInDEV: Dispatcher).useEffectEvent = function useEffectEvent<
       Args,
       Return,
@@ -3525,7 +3525,7 @@ if (__DEV__) {
   if (enableUseMemoCacheHook) {
     (HooksDispatcherOnRerenderInDEV: Dispatcher).useMemoCache = useMemoCache;
   }
-  if (enableUseEventHook) {
+  if (enableUseEffectEventHook) {
     (HooksDispatcherOnRerenderInDEV: Dispatcher).useEffectEvent = function useEffectEvent<
       Args,
       Return,
@@ -3707,7 +3707,7 @@ if (__DEV__) {
       return useMemoCache(size);
     };
   }
-  if (enableUseEventHook) {
+  if (enableUseEffectEventHook) {
     (InvalidNestedHooksDispatcherOnMountInDEV: Dispatcher).useEffectEvent = function useEffectEvent<
       Args,
       Return,
@@ -3890,7 +3890,7 @@ if (__DEV__) {
       return useMemoCache(size);
     };
   }
-  if (enableUseEventHook) {
+  if (enableUseEffectEventHook) {
     (InvalidNestedHooksDispatcherOnUpdateInDEV: Dispatcher).useEffectEvent = function useEffectEvent<
       Args,
       Return,
@@ -4074,7 +4074,7 @@ if (__DEV__) {
       return useMemoCache(size);
     };
   }
-  if (enableUseEventHook) {
+  if (enableUseEffectEventHook) {
     (InvalidNestedHooksDispatcherOnRerenderInDEV: Dispatcher).useEffectEvent = function useEffectEvent<
       Args,
       Return,

diff --git a/packages/react-reconciler/src/__tests__/useEffectEvent-test.js b/packages/react-reconciler/src/__tests__/useEffectEvent-test.js
@@ -51,7 +51,7 @@ describe('useEffectEvent', () => {
     return <span prop={props.text} />;
   }
 
-  // @gate enableUseEventHook
+  // @gate enableUseEffectEventHook
   it('memoizes basic case correctly', () => {
     class IncrementButton extends React.PureComponent {
       increment = () => {
@@ -117,7 +117,7 @@ describe('useEffectEvent', () => {
     ]);
   });
 
-  // @gate enableUseEventHook
+  // @gate enableUseEffectEventHook
   it('can be defined more than once', () => {
     class IncrementButton extends React.PureComponent {
       increment = () => {
@@ -173,7 +173,7 @@ describe('useEffectEvent', () => {
     ]);
   });
 
-  // @gate enableUseEventHook
+  // @gate enableUseEffectEventHook
   it('does not preserve `this` in event functions', () => {
     class GreetButton extends React.PureComponent {
       greet = () => {
@@ -222,7 +222,7 @@ describe('useEffectEvent', () => {
     ]);
   });
 
-  // @gate enableUseEventHook
+  // @gate enableUseEffectEventHook
   it('throws when called in render', () => {
     class IncrementButton extends React.PureComponent {
       increment = () => {
@@ -259,7 +259,7 @@ describe('useEffectEvent', () => {
     expect(Scheduler).toHaveYielded(['Count: 0', 'Count: 0']);
   });
 
-  // @gate enableUseEventHook
+  // @gate enableUseEffectEventHook
   it("useLayoutEffect shouldn't re-fire when event handlers change", () => {
     class IncrementButton extends React.PureComponent {
       increment = () => {
@@ -349,7 +349,7 @@ describe('useEffectEvent', () => {
     ]);
   });
 
-  // @gate enableUseEventHook
+  // @gate enableUseEffectEventHook
   it("useEffect shouldn't re-fire when event handlers change", () => {
     class IncrementButton extends React.PureComponent {
       increment = () => {
@@ -438,7 +438,7 @@ describe('useEffectEvent', () => {
     ]);
   });
 
-  // @gate enableUseEventHook
+  // @gate enableUseEffectEventHook
   it('is stable in a custom hook', () => {
     class IncrementButton extends React.PureComponent {
       increment = () => {
@@ -533,7 +533,7 @@ describe('useEffectEvent', () => {
     ]);
   });
 
-  // @gate enableUseEventHook
+  // @gate enableUseEffectEventHook
   it('is mutated before all other effects', () => {
     function Counter({value}) {
       useInsertionEffect(() => {
@@ -557,7 +557,7 @@ describe('useEffectEvent', () => {
     expect(Scheduler).toHaveYielded(['Effect value: 2', 'Event value: 2']);
   });
 
-  // @gate enableUseEventHook
+  // @gate enableUseEffectEventHook
   it("doesn't provide a stable identity", () => {
     function Counter({shouldRender, value}) {
       const onClick = useEffectEvent(() => {
@@ -596,7 +596,7 @@ describe('useEffectEvent', () => {
     ]);
   });
 
-  // @gate enableUseEventHook
+  // @gate enableUseEffectEventHook
   it('event handlers always see the latest committed value', async () => {
     let committedEventHandler = null;
 
@@ -646,7 +646,7 @@ describe('useEffectEvent', () => {
     expect(committedEventHandler()).toBe('Value seen by useEffectEvent: 2');
   });
 
-  // @gate enableUseEventHook
+  // @gate enableUseEffectEventHook
   it('integration: implements docs chat room example', () => {
     function createConnection() {
       let connectedCallback;
@@ -735,7 +735,7 @@ describe('useEffectEvent', () => {
     expect(Scheduler).toHaveYielded(['Connected! theme: dark']);
   });
 
-  // @gate enableUseEventHook
+  // @gate enableUseEffectEventHook
   it('integration: implements the docs logVisit example', () => {
     class AddToCartButton extends React.PureComponent {
       addToCart = () => {

diff --git a/packages/react-server/src/ReactFizzHooks.js b/packages/react-server/src/ReactFizzHooks.js
@@ -32,7 +32,7 @@ import {makeId} from './ReactServerFormatConfig';
 import {
   enableCache,
   enableUseHook,
-  enableUseEventHook,
+  enableUseEffectEventHook,
   enableUseMemoCacheHook,
 } from 'shared/ReactFeatureFlags';
 import is from 'shared/objectIs';
@@ -507,7 +507,7 @@ export function useCallback<T>(
   return useMemo(() => callback, deps);
 }
 
-function throwOnUseEventCall() {
+function throwOnUseEffectEventCall() {
   throw new Error(
     "A function wrapped in useEffectEvent can't be called during rendering.",
   );
@@ -517,7 +517,7 @@ export function useEffectEvent<Args, Return, F: (...Array<Args>) => Return>(
   callback: F,
 ): F {
   // $FlowIgnore[incompatible-return]
-  return throwOnUseEventCall;
+  return throwOnUseEffectEventCall;
 }
 
 // TODO Decide on how to implement this hook for server rendering.
@@ -651,7 +651,7 @@ export const HooksDispatcher: Dispatcher = {
 if (enableCache) {
   HooksDispatcher.useCacheRefresh = useCacheRefresh;
 }
-if (enableUseEventHook) {
+if (enableUseEffectEventHook) {
   HooksDispatcher.useEffectEvent = useEffectEvent;
 }
 if (enableUseMemoCacheHook) {

diff --git a/packages/shared/ReactFeatureFlags.js b/packages/shared/ReactFeatureFlags.js
@@ -121,7 +121,7 @@ export const enableUseHook = true;
 // auto-memoization.
 export const enableUseMemoCacheHook = __EXPERIMENTAL__;
 
-export const enableUseEventHook = __EXPERIMENTAL__;
+export const enableUseEffectEventHook = __EXPERIMENTAL__;
 
 // Test in www before enabling in open source.
 // Enables DOM-server to stream its instruction set as data-attributes