fix: Improve legacyRoot error message

testing-library · Apr 11, 2024 · 725ae27 · 725ae27
1 parent 1645d21
commit 725ae27
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 5 deletions.
diff --git a/src/__tests__/render.js b/src/__tests__/render.js
@@ -234,7 +234,7 @@ describe('render API', () => {
     expect(() => {
       render(<div />, {legacyRoot: true})
     }).toThrowErrorMatchingInlineSnapshot(
-      `\`legacyRoot: true\` is not supported in this version of React. Please use React 18 instead.`,
+      `\`legacyRoot: true\` is not supported in this version of React. If your app runs React 19 or later, you should remove this flag. If your app runs React 18 or earlier, and you need help with upgrading your app, visit https://react.dev/blog/2022/03/08/react-18-upgrade-guide.`,
     )
   })
 
@@ -259,7 +259,7 @@ describe('render API', () => {
     expect(() => {
       render(ui, {container, hydrate: true, legacyRoot: true})
     }).toThrowErrorMatchingInlineSnapshot(
-      `\`legacyRoot: true\` is not supported in this version of React. Please use React 18 instead.`,
+      `\`legacyRoot: true\` is not supported in this version of React. If your app runs React 19 or later, you should remove this flag. If your app runs React 18 or earlier, and you need help with upgrading your app, visit https://react.dev/blog/2022/03/08/react-18-upgrade-guide.`,
     )
   })
 })
diff --git a/src/__tests__/renderHook.js b/src/__tests__/renderHook.js
@@ -108,6 +108,6 @@ testGateReact19('legacyRoot throws', () => {
       },
     ).result
   }).toThrowErrorMatchingInlineSnapshot(
-    `\`legacyRoot: true\` is not supported in this version of React. Please use React 18 instead.`,
+    `\`legacyRoot: true\` is not supported in this version of React. If your app runs React 19 or later, you should remove this flag. If your app runs React 18 or earlier, and you need help with upgrading your app, visit https://react.dev/blog/2022/03/08/react-18-upgrade-guide.`,
   )
 })
diff --git a/src/pure.js b/src/pure.js
@@ -209,7 +209,9 @@ function render(
 ) {
   if (legacyRoot && typeof ReactDOM.render !== 'function') {
     const error = new Error(
-      '`legacyRoot: true` is not supported in this version of React. Please use React 18 instead.',
+      '`legacyRoot: true` is not supported in this version of React. ' +
+        'If your app runs React 19 or later, you should remove this flag. ' +
+        'If your app runs React 18 or earlier, and you need help with upgrading your app, visit https://react.dev/blog/2022/03/08/react-18-upgrade-guide.',
     )
     Error.captureStackTrace(error, render)
     throw error
@@ -274,7 +276,9 @@ function renderHook(renderCallback, options = {}) {
 
   if (renderOptions.legacyRoot && typeof ReactDOM.render !== 'function') {
     const error = new Error(
-      '`legacyRoot: true` is not supported in this version of React. Please use React 18 instead.',
+      '`legacyRoot: true` is not supported in this version of React. ' +
+        'If your app runs React 19 or later, you should remove this flag. ' +
+        'If your app runs React 18 or earlier, and you need help with upgrading your app, visit https://react.dev/blog/2022/03/08/react-18-upgrade-guide.',
     )
     Error.captureStackTrace(error, renderHook)
     throw error