{"commit":{"revision":"f161ee2eb7e78d6cb3d3878fe1812ac1057fedc6","shortRevision":"f161ee2eb7","authorName":"Brian Vaughn","authorEmail":"brian.david.vaughn@gmail.com","authoredAt":"2019-03-21T14:44:08-07:00","subject":"React.warn() and React.error() (#15170)"},"parents":["78968bb3d9049c65f74d42a1b2f4f9f95d2cba42"],"patch":"diff --git a\/packages\/react\/src\/React.js b\/packages\/react\/src\/React.js\nindex a008fa9637..ba696073f8 100644\n--- a\/packages\/react\/src\/React.js\n+++ b\/packages\/react\/src\/React.js\n@@ -45,6 +45,7 @@ import {\n cloneElementWithValidation,\n } from '.\/ReactElementValidator';\n import ReactSharedInternals from '.\/ReactSharedInternals';\n+import {error, warn} from '.\/withComponentStack';\n import {enableStableConcurrentModeAPIs} from 'shared\/ReactFeatureFlags';\n \n const React = {\n@@ -65,6 +66,9 @@ const React = {\n lazy,\n memo,\n \n+ error,\n+ warn,\n+\n useCallback,\n useContext,\n useEffect,\ndiff --git a\/packages\/react\/src\/__tests__\/withComponentStack-test.js b\/packages\/react\/src\/__tests__\/withComponentStack-test.js\nnew file mode 100644\nindex 0000000000..e46d7f2e54\n--- \/dev\/null\n+++ b\/packages\/react\/src\/__tests__\/withComponentStack-test.js\n@@ -0,0 +1,192 @@\n+\/**\n+ * Copyright (c) Facebook, Inc. and its affiliates.\n+ *\n+ * This source code is licensed under the MIT license found in the\n+ * LICENSE file in the root directory of this source tree.\n+ *\n+ * @emails react-core\n+ *\/\n+\n+'use strict';\n+\n+function normalizeCodeLocInfo(str) {\n+ return str && str.replace(\/at .+?:\\d+\/g, 'at **');\n+}\n+\n+function expectHelper(spy, prefix, ...expectedArgs) {\n+ const expectedStack = expectedArgs.pop();\n+\n+ expect(spy).toHaveBeenCalledTimes(1);\n+\n+ const actualArgs = spy.calls.mostRecent().args;\n+\n+ let actualStack = undefined;\n+ if (expectedStack !== undefined) {\n+ actualStack = actualArgs.pop();\n+ expect(normalizeCodeLocInfo(actualStack)).toBe(expectedStack);\n+ }\n+\n+ expect(actualArgs).toHaveLength(expectedArgs.length);\n+ actualArgs.forEach((actualArg, index) => {\n+ const expectedArg = expectedArgs[index];\n+ expect(actualArg).toBe(\n+ index === 0 ? `${prefix}: ${expectedArg}` : expectedArg,\n+ );\n+ });\n+}\n+\n+function expectMessageAndStack(...expectedArgs) {\n+ expectHelper(console.error, 'error', ...expectedArgs);\n+ expectHelper(console.warn, 'warn', ...expectedArgs);\n+}\n+\n+describe('withComponentStack', () => {\n+ let React = null;\n+ let ReactTestRenderer = null;\n+ let error = null;\n+ let scheduler = null;\n+ let warn = null;\n+\n+ beforeEach(() => {\n+ jest.resetModules();\n+ jest.mock('scheduler', () => require('scheduler\/unstable_mock'));\n+\n+ React = require('react');\n+ ReactTestRenderer = require('react-test-renderer');\n+ scheduler = require('scheduler');\n+\n+ error = React.error;\n+ warn = React.warn;\n+\n+ spyOnDevAndProd(console, 'error');\n+ spyOnDevAndProd(console, 'warn');\n+ });\n+\n+ if (!__DEV__) {\n+ it('does nothing in production mode', () => {\n+ error('error');\n+ warn('warning');\n+\n+ expect(console.error).toHaveBeenCalledTimes(0);\n+ expect(console.warn).toHaveBeenCalledTimes(0);\n+ });\n+ }\n+\n+ if (__DEV__) {\n+ it('does not include component stack when called outside of render', () => {\n+ error('error: logged outside of render');\n+ warn('warn: logged outside of render');\n+ expectMessageAndStack('logged outside of render', undefined);\n+ });\n+\n+ it('should support multiple args', () => {\n+ function Component() {\n+ error('error: number:', 123, 'boolean:', true);\n+ warn('warn: number:', 123, 'boolean:', true);\n+ return null;\n+ }\n+\n+ ReactTestRenderer.create();\n+\n+ expectMessageAndStack(\n+ 'number:',\n+ 123,\n+ 'boolean:',\n+ true,\n+ '\\n in Component (at **)',\n+ );\n+ });\n+\n+ it('includes component stack when called from a render method', () => {\n+ class Parent extends React.Component {\n+ render() {\n+ return ;\n+ }\n+ }\n+\n+ function Child() {\n+ error('error: logged in child render method');\n+ warn('warn: logged in child render method');\n+ return null;\n+ }\n+\n+ ReactTestRenderer.create();\n+\n+ expectMessageAndStack(\n+ 'logged in child render method',\n+ '\\n in Child (at **)' + '\\n in Parent (at **)',\n+ );\n+ });\n+\n+ it('includes component stack when called from a render phase lifecycle method', () => {\n+ function Parent() {\n+ return ;\n+ }\n+\n+ class Child extends React.Component {\n+ UNSAFE_componentWillMount() {\n+ error('error: logged in child cWM lifecycle');\n+ warn('warn: logged in child cWM lifecycle');\n+ }\n+ render() {\n+ return null;\n+ }\n+ }\n+\n+ ReactTestRenderer.create();\n+\n+ expectMessageAndStack(\n+ 'logged in child cWM lifecycle',\n+ '\\n in Child (at **)' + '\\n in Parent (at **)',\n+ );\n+ });\n+\n+ it('includes component stack when called from a commit phase lifecycle method', () => {\n+ function Parent() {\n+ return ;\n+ }\n+\n+ class Child extends React.Component {\n+ componentDidMount() {\n+ error('error: logged in child cDM lifecycle');\n+ warn('warn: logged in child cDM lifecycle');\n+ }\n+ render() {\n+ return null;\n+ }\n+ }\n+\n+ ReactTestRenderer.create();\n+\n+ expectMessageAndStack(\n+ 'logged in child cDM lifecycle',\n+ '\\n in Child (at **)' + '\\n in Parent (at **)',\n+ );\n+ });\n+\n+ it('includes component stack when called from a passive effect handler', () => {\n+ class Parent extends React.Component {\n+ render() {\n+ return ;\n+ }\n+ }\n+\n+ function Child() {\n+ React.useEffect(() => {\n+ error('error: logged in child render method');\n+ warn('warn: logged in child render method');\n+ });\n+ return null;\n+ }\n+\n+ ReactTestRenderer.create();\n+\n+ scheduler.flushAll(); \/\/ Flush passive effects\n+\n+ expectMessageAndStack(\n+ 'logged in child render method',\n+ '\\n in Child (at **)' + '\\n in Parent (at **)',\n+ );\n+ });\n+ }\n+});\ndiff --git a\/packages\/react\/src\/withComponentStack.js b\/packages\/react\/src\/withComponentStack.js\nnew file mode 100644\nindex 0000000000..62aa7ccde2\n--- \/dev\/null\n+++ b\/packages\/react\/src\/withComponentStack.js\n@@ -0,0 +1,48 @@\n+\/**\n+ * Copyright (c) Facebook, Inc. and its affiliates.\n+ *\n+ * This source code is licensed under the MIT license found in the\n+ * LICENSE file in the root directory of this source tree.\n+ *\/\n+\n+import ReactSharedInternals from 'shared\/ReactSharedInternals';\n+\n+function noop() {}\n+\n+let error = noop;\n+let warn = noop;\n+if (__DEV__) {\n+ const ReactDebugCurrentFrame = ReactSharedInternals.ReactDebugCurrentFrame;\n+\n+ error = function() {\n+ const stack = ReactDebugCurrentFrame.getStackAddendum();\n+ if (stack !== '') {\n+ const length = arguments.length;\n+ const args = new Array(length + 1);\n+ for (let i = 0; i < length; i++) {\n+ args[i] = arguments[i];\n+ }\n+ args[length] = stack;\n+ console.error.apply(console, args);\n+ } else {\n+ console.error.apply(console, arguments);\n+ }\n+ };\n+\n+ warn = function() {\n+ const stack = ReactDebugCurrentFrame.getStackAddendum();\n+ if (stack !== '') {\n+ const length = arguments.length;\n+ const args = new Array(length + 1);\n+ for (let i = 0; i < length; i++) {\n+ args[i] = arguments[i];\n+ }\n+ args[length] = stack;\n+ console.warn.apply(console, args);\n+ } else {\n+ console.warn.apply(console, arguments);\n+ }\n+ };\n+}\n+\n+export {error, warn};\n","files":[{"path":"packages\/react\/src\/React.js","status":"M"},{"path":"packages\/react\/src\/__tests__\/withComponentStack-test.js","status":"A"},{"path":"packages\/react\/src\/withComponentStack.js","status":"A"}],"body":""}

dillon1000/react

Files changed