Fail on console.error in tests with failOnConsole (github#25600)

* Install jest-fail-on-console

* Setup and use failOnConsole

* Add intentional 'unique key' error

* Revert "Add intentional 'unique key' error"

This reverts commit 5f75f069d80df36ce632421ae7ad26e98ac17ad3.

* Comment about why use this package

jest.config.js

@@ -29,7 +29,7 @@ module.exports = {
   },
   reporters,
   modulePathIgnorePatterns: ['assets/'],
-  setupFilesAfterEnv: ['@alex_neo/jest-expect-message'],
+  setupFilesAfterEnv: ['./jest.setup.js', '@alex_neo/jest-expect-message'],
   ...(isBrowser ? {} : { testEnvironment: 'node' }),
   testPathIgnorePatterns: [
     'node_modules/',

jest.setup.js

@@ -0,0 +1,12 @@
+import failOnConsole from 'jest-fail-on-console'
+
+// Jest tests don't fail in some cases where we would see an error in DevTools
+// Console when running locally and we would also see the error in the test
+// output.  This includes the React `Each child in a list should have a unique
+// "key" prop` error example.
+//
+// To catch this and fail tests in cases like this, we use `jest-fail-on-console`
+// to fail on calls to `console.error()`.
+failOnConsole({
+  shouldFailOnWarn: false,
+})

package.json

@@ -140,6 +140,7 @@
     "japanese-characters": "^1.1.0",
     "javascript-stringify": "^2.1.0",
     "jest": "^27.4.7",
+    "jest-fail-on-console": "^2.2.3",
     "jest-github-actions-reporter": "^1.0.3",
     "jest-slow-test-reporter": "^1.0.0",
     "linkinator": "^3.0.3",