improve error message for cross-functional component updates (#18316)

* improve error message for cross-functional component updates * correctly use %s by quoting it * use workInProgress and lint * add test assertion * fix test * Improve the error message Co-authored-by: Dan Abramov <dan.abramov@me.com>
facebook · Mar 19, 2020 · 7554ab7 · 7554ab7
1 parent 2186beb
commit 7554ab7
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 10 deletions.
diff --git a/packages/react-reconciler/src/ReactFiberWorkLoop.js b/packages/react-reconciler/src/ReactFiberWorkLoop.js
@@ -2793,17 +2793,36 @@ if (__DEV__ && replayFailedUnitOfWorkWithInvokeGuardedCallback) {
 }
 
 let didWarnAboutUpdateInRender = false;
+let didWarnAboutUpdateInRenderForAnotherComponent;
+if (__DEV__) {
+  didWarnAboutUpdateInRenderForAnotherComponent = new Set();
+}
+
 function warnAboutRenderPhaseUpdatesInDEV(fiber) {
   if (__DEV__) {
     if ((executionContext & RenderContext) !== NoContext) {
       switch (fiber.tag) {
         case FunctionComponent:
         case ForwardRef:
         case SimpleMemoComponent: {
-          console.error(
-            'Cannot update a component from inside the function body of a ' +
-              'different component.',
-          );
+          const renderingComponentName =
+            (workInProgress && getComponentName(workInProgress.type)) ||
+            'Unknown';
+          const setStateComponentName =
+            getComponentName(fiber.type) || 'Unknown';
+          const dedupeKey =
+            renderingComponentName + ' ' + setStateComponentName;
+          if (!didWarnAboutUpdateInRenderForAnotherComponent.has(dedupeKey)) {
+            didWarnAboutUpdateInRenderForAnotherComponent.add(dedupeKey);
+            console.error(
+              'Cannot update a component (`%s`) from inside the function body of a ' +
+                'different component (`%s`). To locate the bad setState() call inside `%s`, ' +
+                'follow the stack trace as described in https://fb.me/setstate-in-render',
+              setStateComponentName,
+              renderingComponentName,
+              renderingComponentName,
+            );
+          }
           break;
         }
         case ClassComponent: {

diff --git a/packages/react-reconciler/src/__tests__/ReactHooks-test.internal.js b/packages/react-reconciler/src/__tests__/ReactHooks-test.internal.js
@@ -1087,7 +1087,7 @@ describe('ReactHooks', () => {
       ),
     ).toErrorDev([
       'Context can only be read while React is rendering',
-      'Cannot update a component from inside the function body of a different component.',
+      'Cannot update a component (`Fn`) from inside the function body of a different component (`Cls`).',
     ]);
   });
 
@@ -1783,8 +1783,8 @@ describe('ReactHooks', () => {
     if (__DEV__) {
       expect(console.error).toHaveBeenCalledTimes(2);
       expect(console.error.calls.argsFor(0)[0]).toContain(
-        'Warning: Cannot update a component from inside the function body ' +
-          'of a different component.%s',
+        'Warning: Cannot update a component (`%s`) from inside the function body ' +
+          'of a different component (`%s`).',
       );
     }
   });

diff --git a/packages/react-reconciler/src/__tests__/ReactHooksWithNoopRenderer-test.internal.js b/packages/react-reconciler/src/__tests__/ReactHooksWithNoopRenderer-test.internal.js
@@ -430,7 +430,7 @@ function loadModules({
 
           function Bar({triggerUpdate}) {
             if (triggerUpdate) {
-              setStep(1);
+              setStep(x => x + 1);
             }
             return <Text text="Bar" />;
           }
@@ -458,10 +458,21 @@ function loadModules({
             expect(() =>
               expect(Scheduler).toFlushAndYield(['Foo [0]', 'Bar', 'Foo [1]']),
             ).toErrorDev([
-              'Cannot update a component from inside the function body of a ' +
-                'different component.',
+              'Cannot update a component (`Foo`) from inside the function body of a ' +
+                'different component (`Bar`). To locate the bad setState() call inside `Bar`',
             ]);
           });
+
+          // It should not warn again (deduplication).
+          await ReactNoop.act(async () => {
+            root.render(
+              <>
+                <Foo />
+                <Bar triggerUpdate={true} />
+              </>,
+            );
+            expect(Scheduler).toFlushAndYield(['Foo [1]', 'Bar', 'Foo [2]']);
+          });
         });
 
         it('keeps restarting until there are no more new updates', () => {