From adadb8169e781ff645c61aa558dc901b1c2c97f4 Mon Sep 17 00:00:00 2001 From: dan Date: Wed, 14 Feb 2024 17:07:33 +0000 Subject: [PATCH] Rewrite tests that depend on propTypes warnings (#28325) In preparation for https://github.com/facebook/react/pull/28207. These tests aren't actually testing propTypes, they just use them to verify we can display a meaningful component name. We've mostly moved away from warnings that display component names directly in favor of component stacks. So let's just replace these with tests asserting the component names show up in stacks. --- .../src/__tests__/ReactMemo-test.js | 155 +++++++------- .../react/src/__tests__/forwardRef-test.js | 202 +++++++----------- 2 files changed, 155 insertions(+), 202 deletions(-) diff --git a/packages/react-reconciler/src/__tests__/ReactMemo-test.js b/packages/react-reconciler/src/__tests__/ReactMemo-test.js index a7b47621d5..8b59d8d104 100644 --- a/packages/react-reconciler/src/__tests__/ReactMemo-test.js +++ b/packages/react-reconciler/src/__tests__/ReactMemo-test.js @@ -657,97 +657,96 @@ describe('memo', () => { }); }); - it('should fall back to showing something meaningful if no displayName or name are present', () => { - const MemoComponent = React.memo(props =>
); - MemoComponent.propTypes = { - required: PropTypes.string.isRequired, - }; - - expect(() => - ReactNoop.render(), - ).toErrorDev( - 'Warning: Failed prop type: The prop `required` is marked as required in ' + - '`Memo`, but its value is `undefined`.', - // There's no component stack in this warning because the inner function is anonymous. - // If we wanted to support this (for the Error frames / source location) - // we could do this by updating ReactComponentStackFrame. - {withoutStack: true}, + it('should skip memo in the stack if neither displayName nor name are present', async () => { + const MemoComponent = React.memo(props => []); + ReactNoop.render( +

+ +

, + ); + await expect(async () => { + await waitForAll([]); + }).toErrorDev( + 'Each child in a list should have a unique "key" prop. See https://reactjs.org/link/warning-keys for more information.\n' + + ' in p (at **)', ); }); - it('should honor a displayName if set on the inner component in warnings', () => { - function Component(props) { - return
; - } - Component.displayName = 'Inner'; - const MemoComponent = React.memo(Component); - MemoComponent.propTypes = { - required: PropTypes.string.isRequired, - }; - - expect(() => - ReactNoop.render(), - ).toErrorDev( - 'Warning: Failed prop type: The prop `required` is marked as required in ' + - '`Inner`, but its value is `undefined`.\n' + - ' in Inner (at **)', + it('should use the inner function name for the stack', async () => { + const MemoComponent = React.memo(function Inner(props, ref) { + return []; + }); + ReactNoop.render( +

+ +

, + ); + await expect(async () => { + await waitForAll([]); + }).toErrorDev( + 'Each child in a list should have a unique "key" prop. See https://reactjs.org/link/warning-keys for more information.\n' + + ' in Inner (at **)\n' + + ' in p (at **)', ); }); - it('should honor a displayName if set on the memo wrapper in warnings', () => { - const MemoComponent = React.memo(function Component(props) { - return
; + it('should use the inner displayName in the stack', async () => { + const fn = (props, ref) => { + return []; + }; + fn.displayName = 'Inner'; + const MemoComponent = React.memo(fn); + ReactNoop.render( +

+ +

, + ); + await expect(async () => { + await waitForAll([]); + }).toErrorDev( + 'Each child in a list should have a unique "key" prop. See https://reactjs.org/link/warning-keys for more information.\n' + + ' in Inner (at **)\n' + + ' in p (at **)', + ); + }); + + it('can use the outer displayName in the stack', async () => { + const MemoComponent = React.memo((props, ref) => { + return []; }); MemoComponent.displayName = 'Outer'; - MemoComponent.propTypes = { - required: PropTypes.string.isRequired, - }; - - expect(() => - ReactNoop.render(), - ).toErrorDev( - 'Warning: Failed prop type: The prop `required` is marked as required in ' + - '`Outer`, but its value is `undefined`.\n' + - ' in Component (at **)', + ReactNoop.render( +

+ +

, + ); + await expect(async () => { + await waitForAll([]); + }).toErrorDev( + 'Each child in a list should have a unique "key" prop. See https://reactjs.org/link/warning-keys for more information.\n' + + ' in Outer (at **)\n' + + ' in p (at **)', ); }); - it('should pass displayName to an anonymous inner component so it shows up in component stacks', () => { - const MemoComponent = React.memo(props => { - return
; - }); - MemoComponent.displayName = 'Memo'; - MemoComponent.propTypes = { - required: PropTypes.string.isRequired, + it('should prefer the inner to the outer displayName in the stack', async () => { + const fn = (props, ref) => { + return []; }; - - expect(() => - ReactNoop.render(), - ).toErrorDev( - 'Warning: Failed prop type: The prop `required` is marked as required in ' + - '`Memo`, but its value is `undefined`.\n' + - ' in Memo (at **)', - ); - }); - - it('should honor a outer displayName when wrapped component and memo component set displayName at the same time.', () => { - function Component(props) { - return
; - } - Component.displayName = 'Inner'; - - const MemoComponent = React.memo(Component); + fn.displayName = 'Inner'; + const MemoComponent = React.memo(fn); MemoComponent.displayName = 'Outer'; - MemoComponent.propTypes = { - required: PropTypes.string.isRequired, - }; - - expect(() => - ReactNoop.render(), - ).toErrorDev( - 'Warning: Failed prop type: The prop `required` is marked as required in ' + - '`Outer`, but its value is `undefined`.\n' + - ' in Inner (at **)', + ReactNoop.render( +

+ +

, + ); + await expect(async () => { + await waitForAll([]); + }).toErrorDev( + 'Each child in a list should have a unique "key" prop. See https://reactjs.org/link/warning-keys for more information.\n' + + ' in Inner (at **)\n' + + ' in p (at **)', ); }); } diff --git a/packages/react/src/__tests__/forwardRef-test.js b/packages/react/src/__tests__/forwardRef-test.js index 0cfa003126..8a02585a97 100644 --- a/packages/react/src/__tests__/forwardRef-test.js +++ b/packages/react/src/__tests__/forwardRef-test.js @@ -204,144 +204,98 @@ describe('forwardRef', () => { ); }); - it('should fall back to showing something meaningful if no displayName or name are present', () => { - const Component = props =>
; - - const RefForwardingComponent = React.forwardRef((props, ref) => ( - - )); - - RefForwardingComponent.propTypes = { - optional: PropTypes.string, - required: PropTypes.string.isRequired, - }; - - RefForwardingComponent.defaultProps = { - optional: 'default', - }; - - const ref = React.createRef(); - - expect(() => - ReactNoop.render(), - ).toErrorDev( - 'Warning: Failed prop type: The prop `required` is marked as required in ' + - '`ForwardRef`, but its value is `undefined`.', - // There's no component stack in this warning because the inner function is anonymous. - // If we wanted to support this (for the Error frames / source location) - // we could do this by updating ReactComponentStackFrame. - {withoutStack: true}, - ); - }); - - it('should honor a displayName if set on the forwardRef wrapper in warnings', () => { - const Component = props =>
; - - const RefForwardingComponent = React.forwardRef(function Inner(props, ref) { - ; + it('should skip forwardRef in the stack if neither displayName nor name are present', async () => { + const RefForwardingComponent = React.forwardRef(function (props, ref) { + return []; }); - RefForwardingComponent.displayName = 'Custom'; - - RefForwardingComponent.propTypes = { - optional: PropTypes.string, - required: PropTypes.string.isRequired, - }; - - RefForwardingComponent.defaultProps = { - optional: 'default', - }; - - const ref = React.createRef(); - - expect(() => - ReactNoop.render(), - ).toErrorDev( - 'Warning: Failed prop type: The prop `required` is marked as required in ' + - '`Custom`, but its value is `undefined`.\n' + - ' in Inner (at **)', + ReactNoop.render( +

+ +

, + ); + await expect(async () => { + await waitForAll([]); + }).toErrorDev( + 'Each child in a list should have a unique "key" prop. See https://reactjs.org/link/warning-keys for more information.\n' + + ' in p (at **)', ); }); - it('should pass displayName to an anonymous inner component so it shows up in component stacks', () => { - const Component = props =>
; - - const RefForwardingComponent = React.forwardRef((props, ref) => ( - - )); - RefForwardingComponent.displayName = 'Custom'; - - RefForwardingComponent.propTypes = { - optional: PropTypes.string, - required: PropTypes.string.isRequired, - }; - - RefForwardingComponent.defaultProps = { - optional: 'default', - }; - - const ref = React.createRef(); - - expect(() => - ReactNoop.render(), - ).toErrorDev( - 'Warning: Failed prop type: The prop `required` is marked as required in ' + - '`Custom`, but its value is `undefined`.\n' + - ' in Custom (at **)', + it('should use the inner function name for the stack', async () => { + const RefForwardingComponent = React.forwardRef(function Inner(props, ref) { + return []; + }); + ReactNoop.render( +

+ +

, + ); + await expect(async () => { + await waitForAll([]); + }).toErrorDev( + 'Each child in a list should have a unique "key" prop. See https://reactjs.org/link/warning-keys for more information.\n' + + ' in Inner (at **)\n' + + ' in p (at **)', ); }); - it('should honor a displayName in stacks if set on the inner function', () => { - const Component = props =>
; - - const inner = (props, ref) => ; - inner.displayName = 'Inner'; - const RefForwardingComponent = React.forwardRef(inner); - - RefForwardingComponent.propTypes = { - optional: PropTypes.string, - required: PropTypes.string.isRequired, + it('should use the inner displayName in the stack', async () => { + const fn = (props, ref) => { + return []; }; - - RefForwardingComponent.defaultProps = { - optional: 'default', - }; - - const ref = React.createRef(); - - expect(() => - ReactNoop.render(), - ).toErrorDev( - 'Warning: Failed prop type: The prop `required` is marked as required in ' + - '`ForwardRef(Inner)`, but its value is `undefined`.\n' + - ' in Inner (at **)', + fn.displayName = 'Inner'; + const RefForwardingComponent = React.forwardRef(fn); + ReactNoop.render( +

+ +

, + ); + await expect(async () => { + await waitForAll([]); + }).toErrorDev( + 'Each child in a list should have a unique "key" prop. See https://reactjs.org/link/warning-keys for more information.\n' + + ' in Inner (at **)\n' + + ' in p (at **)', ); }); - it('should honor a outer displayName when wrapped component and memo component set displayName at the same time.', () => { - const Component = props =>
; - - const inner = (props, ref) => ; - inner.displayName = 'Inner'; - const RefForwardingComponent = React.forwardRef(inner); + it('can use the outer displayName in the stack', async () => { + const RefForwardingComponent = React.forwardRef((props, ref) => { + return []; + }); RefForwardingComponent.displayName = 'Outer'; + ReactNoop.render( +

+ +

, + ); + await expect(async () => { + await waitForAll([]); + }).toErrorDev( + 'Each child in a list should have a unique "key" prop. See https://reactjs.org/link/warning-keys for more information.\n' + + ' in Outer (at **)\n' + + ' in p (at **)', + ); + }); - RefForwardingComponent.propTypes = { - optional: PropTypes.string, - required: PropTypes.string.isRequired, + it('should prefer the inner to the outer displayName in the stack', async () => { + const fn = (props, ref) => { + return []; }; - - RefForwardingComponent.defaultProps = { - optional: 'default', - }; - - const ref = React.createRef(); - - expect(() => - ReactNoop.render(), - ).toErrorDev( - 'Warning: Failed prop type: The prop `required` is marked as required in ' + - '`Outer`, but its value is `undefined`.\n' + - ' in Inner (at **)', + fn.displayName = 'Inner'; + const RefForwardingComponent = React.forwardRef(fn); + RefForwardingComponent.displayName = 'Outer'; + ReactNoop.render( +

+ +

, + ); + await expect(async () => { + await waitForAll([]); + }).toErrorDev( + 'Each child in a list should have a unique "key" prop. See https://reactjs.org/link/warning-keys for more information.\n' + + ' in Inner (at **)\n' + + ' in p (at **)', ); });