Convert tests to react-testing-library, remove enzyme and test-renderer #996
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,22 +5,28 @@ import PropTypes from 'prop-types' | |
| import semver from 'semver' | ||
| import { createStore } from 'redux' | ||
| import { Provider, createProvider, connect } from '../../src/index.js' | ||
| import * as rtl from 'react-testing-library' | ||
| import 'jest-dom/extend-expect' | ||
|
There was a problem hiding this comment. This should probably be in our test setup file. (Do we have one? We should, if not.) There was a problem hiding this comment. although... we only use these files in 2 of 5 test files. so maybe not? |
||
|
|
||
| describe('React', () => { | ||
| describe('Provider', () => { | ||
| afterEach(() => rtl.cleanup()) | ||
| const createChild = (storeKey = 'store') => { | ||
| class Child extends Component { | ||
| render() { | ||
| return ( | ||
| <div data-testid="store"> | ||
| {storeKey} - {this.context[storeKey] && this.context[storeKey].mine ? this.context[storeKey].mine : ''} | ||
| </div> | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| Child.contextTypes = { | ||
| [storeKey]: PropTypes.object.isRequired | ||
| } | ||
|
|
||
| return Child | ||
| } | ||
| const Child = createChild(); | ||
|
|
||
|
|
@@ -34,33 +40,33 @@ describe('React', () => { | |
| const spy = jest.spyOn(console, 'error').mockImplementation(() => {}) | ||
|
|
||
| try { | ||
| expect(() => rtl.render( | ||
| <Provider store={store}> | ||
| <div /> | ||
| </Provider> | ||
| )).not.toThrow() | ||
|
|
||
| if (semver.lt(React.version, '15.0.0')) { | ||
| expect(() => rtl.render( | ||
| <Provider store={store}> | ||
| </Provider> | ||
| )).toThrow(/children with exactly one child/) | ||
| } else { | ||
| expect(() => rtl.render( | ||
| <Provider store={store}> | ||
| </Provider> | ||
| )).toThrow(/a single React element child/) | ||
| } | ||
|
|
||
| if (semver.lt(React.version, '15.0.0')) { | ||
| expect(() => rtl.render( | ||
| <Provider store={store}> | ||
| <div /> | ||
| <div /> | ||
| </Provider> | ||
| )).toThrow(/children with exactly one child/) | ||
| } else { | ||
| expect(() => rtl.render( | ||
| <Provider store={store}> | ||
| <div /> | ||
| <div /> | ||
|
|
@@ -75,47 +81,52 @@ describe('React', () => { | |
|
|
||
| it('should add the store to the child context', () => { | ||
| const store = createStore(() => ({})) | ||
| store.mine = 'hi' | ||
|
There was a problem hiding this comment. I'm not sure this is the best approach for identifying a store. It would be better to provide canary values in the initialState for each store. Setting arbitrary properties is technically possible, but it's not idiomatic Redux and might be confusing to those working with these tests in the future. There was a problem hiding this comment. I'm fixing this in the 16.x PR I'm making. Fully agree, and an easy fix There was a problem hiding this comment. I already took care of this in the #998 branch - I put some canary values in the store as suggested. |
||
|
|
||
| const spy = jest.spyOn(console, 'error').mockImplementation(() => {}) | ||
| const tester = rtl.render( | ||
| <Provider store={store}> | ||
| <Child /> | ||
| </Provider> | ||
| ) | ||
| expect(spy).toHaveBeenCalledTimes(0) | ||
| spy.mockRestore() | ||
|
|
||
| expect(tester.getByTestId('store')).toHaveTextContent('store - hi') | ||
| }) | ||
|
|
||
| it('should add the store to the child context using a custom store key', () => { | ||
| const store = createStore(() => ({})) | ||
| store.mine = 'hi' | ||
| const CustomProvider = createProvider('customStoreKey'); | ||
| const CustomChild = createChild('customStoreKey'); | ||
|
|
||
| const spy = jest.spyOn(console, 'error').mockImplementation(() => {}); | ||
| const tester = rtl.render( | ||
| <CustomProvider store={store}> | ||
| <CustomChild /> | ||
| </CustomProvider> | ||
| ) | ||
| expect(spy).toHaveBeenCalledTimes(0) | ||
| spy.mockRestore() | ||
|
|
||
| expect(tester.getByTestId('store')).toHaveTextContent('customStoreKey - hi') | ||
| }) | ||
|
|
||
| it('should warn once when receiving a new store in props', () => { | ||
| const store1 = createStore((state = 10) => state + 1) | ||
| store1.mine = '1' | ||
| const store2 = createStore((state = 10) => state * 2) | ||
| store2.mine = '2' | ||
| const store3 = createStore((state = 10) => state * state) | ||
| store3.mine = '3' | ||
|
|
||
| let externalSetState | ||
| class ProviderContainer extends Component { | ||
| constructor() { | ||
| super() | ||
| this.state = { store: store1 } | ||
| externalSetState = this.setState.bind(this) | ||
| } | ||
| render() { | ||
| return ( | ||
|
|
@@ -126,14 +137,13 @@ describe('React', () => { | |
| } | ||
| } | ||
|
|
||
| const tester = rtl.render(<ProviderContainer />) | ||
| expect(tester.getByTestId('store')).toHaveTextContent('store - 1') | ||
|
|
||
| let spy = jest.spyOn(console, 'error').mockImplementation(() => {}) | ||
| externalSetState({ store: store2 }) | ||
|
|
||
| expect(tester.getByTestId('store')).toHaveTextContent('store - 1') | ||
| expect(spy).toHaveBeenCalledTimes(1) | ||
| expect(spy.mock.calls[0][0]).toBe( | ||
| '<Provider> does not support changing `store` on the fly. ' + | ||
|
|
@@ -145,9 +155,9 @@ describe('React', () => { | |
| spy.mockRestore() | ||
|
|
||
| spy = jest.spyOn(console, 'error').mockImplementation(() => {}) | ||
| externalSetState({ store: store3 }) | ||
|
|
||
| expect(tester.getByTestId('store')).toHaveTextContent('store - 1') | ||
| expect(spy).toHaveBeenCalledTimes(0) | ||
| spy.mockRestore() | ||
| }) | ||
|
|
@@ -168,7 +178,7 @@ describe('React', () => { | |
| render() { return <Provider store={innerStore}><Inner /></Provider> } | ||
| } | ||
|
|
||
| rtl.render(<Provider store={outerStore}><Outer /></Provider>) | ||
| expect(innerMapStateToProps).toHaveBeenCalledTimes(1) | ||
|
|
||
| innerStore.dispatch({ type: 'INC'}) | ||
|
|
@@ -216,7 +226,7 @@ describe('React', () => { | |
| } | ||
| } | ||
|
|
||
| const tester = rtl.render( | ||
| <Provider store={store}> | ||
| <Container /> | ||
| </Provider> | ||
|
|
@@ -229,8 +239,8 @@ describe('React', () => { | |
| expect(childMapStateInvokes).toBe(2) | ||
|
|
||
| // setState calls DOM handlers are batched | ||
| const button = tester.getByText('change') | ||
| rtl.fireEvent.click(button) | ||
| expect(childMapStateInvokes).toBe(3) | ||
|
|
||
| // Provider uses unstable_batchedUpdates() under the hood | ||
|
|
@@ -245,7 +255,7 @@ describe('React', () => { | |
| const spy = jest.spyOn(console, 'error').mockImplementation(() => {}) | ||
| const store = createStore(() => ({})) | ||
|
|
||
| rtl.render( | ||
| <React.StrictMode> | ||
| <Provider store={store}> | ||
| <div /> | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we have explicit imports here (
import { render, fireEvent })? I tend to dislikeimport * as foosyntax out of both habit and as a very implicit signal that this is TS code (as it's a standard over there, I've noticed; a minor nit pick, for sure). Obviously it doesn't matter at all in the testing context, but it's mainly about enforcing good patterns for others in future PRs. Folks tend to copy what you do in their code.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tend to disagree about this, not in principle, just on whether it's a good pattern. I like to do explicit imports for things that have fewer than 5 items. More than that, it gets confusing (I'm looking at you, redux-saga/effects) as to whether an imported thing is from one place or another (for example, delay is from redux-saga, the effects are not).
For react-testing-library, it is even more confusing, because
renderandcleanupand a few others are from the main library, but the queries likegetByTextIdcome from the return value ofrenderMaking this clear is difficult, and I think it will reduce the learning curve for new contributors to use the*import. But I'll leave the call to you two. If you still feel it's an issue after reading my perspective, I'll change it.