From 72ccbb9fbb9c685e12621856893ec3efe9dc4af9 Mon Sep 17 00:00:00 2001
From: apostolidhs <john.apostolidh@gmail.com>
Date: Sun, 23 Jun 2019 14:10:32 +0300
Subject: [PATCH 1/2] Added cleanup method
---
README.md | 11 ++++++++++
cleanup-after-each.js | 1 +
src/index.js | 23 ++++++++++++++------
test/cleanup.test.js | 50 +++++++++++++++++++++++++++++++++++++++++++
typings/index.d.ts | 2 ++
5 files changed, 81 insertions(+), 6 deletions(-)
create mode 100644 cleanup-after-each.js
create mode 100644 test/cleanup.test.js
diff --git a/README.md b/README.md
index be2d6204..bf6b20c7 100644
--- a/README.md
+++ b/README.md
@@ -126,6 +126,17 @@ npm install --save-dev react-test-renderer@^x.y.z
Both of these dependecies must be installed as at least version `16.8.0` to be compatible with
`react-hooks-testing-library`.
+### `cleanup()`
+
+Unmounts any of the Hooks that were mounted with `renderHook`.
+
+Optionally, it is possible to import `cleanup` in a global test file. Using that way, it isn't
+necessary to run `afterEach(cleanup)` on every test script.
+
+```js
+import 'react-hooks-testing-library/cleanup-after-each'
+```
+
## Documentation
There are some [work-in-progress docs here](https://react-hooks-testing-library.com/). Please leave
diff --git a/cleanup-after-each.js b/cleanup-after-each.js
new file mode 100644
index 00000000..bdf5f768
--- /dev/null
+++ b/cleanup-after-each.js
@@ -0,0 +1 @@
+afterEach(require('./src').cleanup)
diff --git a/src/index.js b/src/index.js
index 0245a6c3..dfffb221 100644
--- a/src/index.js
+++ b/src/index.js
@@ -1,6 +1,8 @@
import React, { Suspense } from 'react'
import { act, create } from 'react-test-renderer'
+const unmounts = []
+
function TestHook({ callback, hookProps, onError, children }) {
try {
children(callback(hookProps))
@@ -51,6 +53,11 @@ function resultContainer() {
}
}
+function cleanup() {
+ unmounts.forEach((unmount) => unmount())
+ unmounts.length = 0
+}
+
function renderHook(callback, { initialProps, wrapper } = {}) {
const { result, setValue, setError, addResolver } = resultContainer()
const hookProps = { current: initialProps }
@@ -73,6 +80,14 @@ function renderHook(callback, { initialProps, wrapper } = {}) {
})
const { unmount, update } = testRenderer
+ function unmountHook() {
+ act(() => {
+ unmount()
+ })
+ }
+
+ unmounts.push(unmountHook)
+
return {
result,
waitForNextUpdate: () => new Promise((resolve) => addResolver(resolve)),
@@ -82,12 +97,8 @@ function renderHook(callback, { initialProps, wrapper } = {}) {
update(toRender())
})
},
- unmount: () => {
- act(() => {
- unmount()
- })
- }
+ unmount: unmountHook
}
}
-export { renderHook, act }
+export { renderHook, cleanup, act }
diff --git a/test/cleanup.test.js b/test/cleanup.test.js
new file mode 100644
index 00000000..872b5585
--- /dev/null
+++ b/test/cleanup.test.js
@@ -0,0 +1,50 @@
+import { useEffect } from 'react'
+import { renderHook, cleanup } from 'src'
+
+describe('cleanup tests', () => {
+ let sideEffect = {}
+
+ function useEffectsCounter({ initialProps }) {
+ return renderHook(
+ ({ id }) => {
+ useEffect(() => {
+ sideEffect[id] = 0
+ return () => {
+ sideEffect[id] = sideEffect[id] + 1
+ }
+ }, [id])
+ },
+ { initialProps }
+ )
+ }
+
+ afterEach(() => (sideEffect = {}))
+
+ test('should unmount the tests', () => {
+ useEffectsCounter({ initialProps: { id: 1 } })
+ useEffectsCounter({ initialProps: { id: 10 } })
+ useEffectsCounter({ initialProps: { id: 100 } })
+
+ cleanup()
+
+ expect(sideEffect).toEqual({ 1: 1, 10: 1, 100: 1 })
+ })
+
+ test('should not cleanup a hook that have already unmounted', () => {
+ const { unmount } = useEffectsCounter({ initialProps: { id: 1 } })
+
+ unmount()
+ cleanup()
+
+ expect(sideEffect).toEqual({ 1: 1 })
+ })
+
+ test('should not unmount a hook that have already cleaned up', () => {
+ const { unmount } = useEffectsCounter({ initialProps: { id: 1 } })
+
+ cleanup()
+ unmount()
+
+ expect(sideEffect).toEqual({ 1: 1 })
+ })
+})
diff --git a/typings/index.d.ts b/typings/index.d.ts
index de113325..319e07d1 100644
--- a/typings/index.d.ts
+++ b/typings/index.d.ts
@@ -22,3 +22,5 @@ export function renderHook<P, R>(
callback: (props: P) => R,
options?: RenderHookOptions<P>
): RenderHookResult<P, R>
+
+export function cleanup(): void
From df661401ea34fcc787bbffc85bd88689d1fa3b50 Mon Sep 17 00:00:00 2001
From: apostolidhs <john.apostolidh@gmail.com>
Date: Tue, 25 Jun 2019 00:37:43 +0300
Subject: [PATCH 2/2] Added contribution
---
.all-contributorsrc | 10 ++++++++++
README.md | 20 ++++++++++++++++++--
2 files changed, 28 insertions(+), 2 deletions(-)
diff --git a/.all-contributorsrc b/.all-contributorsrc
index 53aaac86..46813049 100644
--- a/.all-contributorsrc
+++ b/.all-contributorsrc
@@ -111,6 +111,16 @@
"bug",
"code"
]
+ },
+ {
+ "login": "apostolidhs",
+ "name": "John Apostolidis",
+ "avatar_url": "https://avatars3.githubusercontent.com/u/2164902?v=4",
+ "profile": "http://apostolidis.me",
+ "contributions": [
+ "code",
+ "doc"
+ ]
}
],
"commitConvention": "none"
diff --git a/README.md b/README.md
index bf6b20c7..e942d2c0 100644
--- a/README.md
+++ b/README.md
@@ -27,7 +27,7 @@
[](http://www.npmtrends.com/@testing-library/react-hooks)
[](https://github.com/testing-library/react-hooks-testing-library/blob/master/LICENSE.md)
-[](#contributors)
+[](#contributors)
[](http://makeapullrequest.com)
[](https://github.com/testing-library/react-hooks-testing-library/blob/master/CODE_OF_CONDUCT.md)
[](https://app.netlify.com/sites/react-hooks-testing-library/deploys)
@@ -154,7 +154,23 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore -->
-<table><tr><td align="center"><a href="https://github.com/mpeyper"><img src="https://avatars0.githubusercontent.com/u/23029903?v=4" width="100px;" alt="Michael Peyper"/><br /><sub><b>Michael Peyper</b></sub></a><br /><a href="https://github.com/testing-library/react-hooks-testing-library/commits?author=mpeyper" title="Code">💻</a> <a href="#design-mpeyper" title="Design">🎨</a> <a href="https://github.com/testing-library/react-hooks-testing-library/commits?author=mpeyper" title="Documentation">📖</a> <a href="#ideas-mpeyper" title="Ideas, Planning, & Feedback">🤔</a> <a href="#infra-mpeyper" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#platform-mpeyper" title="Packaging/porting to new platform">📦</a> <a href="https://github.com/testing-library/react-hooks-testing-library/commits?author=mpeyper" title="Tests">⚠️</a> <a href="#tool-mpeyper" title="Tools">🔧</a></td><td align="center"><a href="https://github.com/otofu-square"><img src="https://avatars0.githubusercontent.com/u/10118235?v=4" width="100px;" alt="otofu-square"/><br /><sub><b>otofu-square</b></sub></a><br /><a href="https://github.com/testing-library/react-hooks-testing-library/commits?author=otofu-square" title="Code">💻</a></td><td align="center"><a href="https://github.com/ab18556"><img src="https://avatars2.githubusercontent.com/u/988696?v=4" width="100px;" alt="Patrick P. Henley"/><br /><sub><b>Patrick P. Henley</b></sub></a><br /><a href="#ideas-ab18556" title="Ideas, Planning, & Feedback">🤔</a> <a href="#review-ab18556" title="Reviewed Pull Requests">👀</a></td><td align="center"><a href="https://twitter.com/matiosfm"><img src="https://avatars3.githubusercontent.com/u/7120471?v=4" width="100px;" alt="Matheus Marques"/><br /><sub><b>Matheus Marques</b></sub></a><br /><a href="https://github.com/testing-library/react-hooks-testing-library/commits?author=marquesm91" title="Code">💻</a></td><td align="center"><a href="https://ca.linkedin.com/in/dhruvmpatel"><img src="https://avatars1.githubusercontent.com/u/19353311?v=4" width="100px;" alt="Dhruv Patel"/><br /><sub><b>Dhruv Patel</b></sub></a><br /><a href="https://github.com/testing-library/react-hooks-testing-library/issues?q=author%3Adhruv-m-patel" title="Bug reports">🐛</a> <a href="#review-dhruv-m-patel" title="Reviewed Pull Requests">👀</a></td><td align="center"><a href="https://ntucker.true.io"><img src="https://avatars0.githubusercontent.com/u/866147?v=4" width="100px;" alt="Nathaniel Tucker"/><br /><sub><b>Nathaniel Tucker</b></sub></a><br /><a href="https://github.com/testing-library/react-hooks-testing-library/issues?q=author%3Antucker" title="Bug reports">🐛</a> <a href="#review-ntucker" title="Reviewed Pull Requests">👀</a></td><td align="center"><a href="https://github.com/sgrishchenko"><img src="https://avatars3.githubusercontent.com/u/15995890?v=4" width="100px;" alt="Sergei Grishchenko"/><br /><sub><b>Sergei Grishchenko</b></sub></a><br /><a href="https://github.com/testing-library/react-hooks-testing-library/commits?author=sgrishchenko" title="Code">💻</a> <a href="https://github.com/testing-library/react-hooks-testing-library/commits?author=sgrishchenko" title="Documentation">📖</a> <a href="#ideas-sgrishchenko" title="Ideas, Planning, & Feedback">🤔</a></td></tr><tr><td align="center"><a href="https://github.com/josepot"><img src="https://avatars1.githubusercontent.com/u/8620144?v=4" width="100px;" alt="Josep M Sobrepere"/><br /><sub><b>Josep M Sobrepere</b></sub></a><br /><a href="https://github.com/testing-library/react-hooks-testing-library/commits?author=josepot" title="Documentation">📖</a></td><td align="center"><a href="https://github.com/mtinner"><img src="https://avatars0.githubusercontent.com/u/5487448?v=4" width="100px;" alt="Marcel Tinner"/><br /><sub><b>Marcel Tinner</b></sub></a><br /><a href="https://github.com/testing-library/react-hooks-testing-library/commits?author=mtinner" title="Documentation">📖</a></td><td align="center"><a href="https://github.com/FredyC"><img src="https://avatars0.githubusercontent.com/u/1096340?v=4" width="100px;" alt="Daniel K."/><br /><sub><b>Daniel K.</b></sub></a><br /><a href="https://github.com/testing-library/react-hooks-testing-library/issues?q=author%3AFredyC" title="Bug reports">🐛</a> <a href="https://github.com/testing-library/react-hooks-testing-library/commits?author=FredyC" title="Code">💻</a></td></tr></table>
+<table>
+ <tr>
+ <td align="center"><a href="https://github.com/mpeyper"><img src="https://avatars0.githubusercontent.com/u/23029903?v=4" width="100px;" alt="Michael Peyper"/><br /><sub><b>Michael Peyper</b></sub></a><br /><a href="https://github.com/testing-library/react-hooks-testing-library/commits?author=mpeyper" title="Code">💻</a> <a href="#design-mpeyper" title="Design">🎨</a> <a href="https://github.com/testing-library/react-hooks-testing-library/commits?author=mpeyper" title="Documentation">📖</a> <a href="#ideas-mpeyper" title="Ideas, Planning, & Feedback">🤔</a> <a href="#infra-mpeyper" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#platform-mpeyper" title="Packaging/porting to new platform">📦</a> <a href="https://github.com/testing-library/react-hooks-testing-library/commits?author=mpeyper" title="Tests">⚠️</a> <a href="#tool-mpeyper" title="Tools">🔧</a></td>
+ <td align="center"><a href="https://github.com/otofu-square"><img src="https://avatars0.githubusercontent.com/u/10118235?v=4" width="100px;" alt="otofu-square"/><br /><sub><b>otofu-square</b></sub></a><br /><a href="https://github.com/testing-library/react-hooks-testing-library/commits?author=otofu-square" title="Code">💻</a></td>
+ <td align="center"><a href="https://github.com/ab18556"><img src="https://avatars2.githubusercontent.com/u/988696?v=4" width="100px;" alt="Patrick P. Henley"/><br /><sub><b>Patrick P. Henley</b></sub></a><br /><a href="#ideas-ab18556" title="Ideas, Planning, & Feedback">🤔</a> <a href="#review-ab18556" title="Reviewed Pull Requests">👀</a></td>
+ <td align="center"><a href="https://twitter.com/matiosfm"><img src="https://avatars3.githubusercontent.com/u/7120471?v=4" width="100px;" alt="Matheus Marques"/><br /><sub><b>Matheus Marques</b></sub></a><br /><a href="https://github.com/testing-library/react-hooks-testing-library/commits?author=marquesm91" title="Code">💻</a></td>
+ <td align="center"><a href="https://ca.linkedin.com/in/dhruvmpatel"><img src="https://avatars1.githubusercontent.com/u/19353311?v=4" width="100px;" alt="Dhruv Patel"/><br /><sub><b>Dhruv Patel</b></sub></a><br /><a href="https://github.com/testing-library/react-hooks-testing-library/issues?q=author%3Adhruv-m-patel" title="Bug reports">🐛</a> <a href="#review-dhruv-m-patel" title="Reviewed Pull Requests">👀</a></td>
+ <td align="center"><a href="https://ntucker.true.io"><img src="https://avatars0.githubusercontent.com/u/866147?v=4" width="100px;" alt="Nathaniel Tucker"/><br /><sub><b>Nathaniel Tucker</b></sub></a><br /><a href="https://github.com/testing-library/react-hooks-testing-library/issues?q=author%3Antucker" title="Bug reports">🐛</a> <a href="#review-ntucker" title="Reviewed Pull Requests">👀</a></td>
+ <td align="center"><a href="https://github.com/sgrishchenko"><img src="https://avatars3.githubusercontent.com/u/15995890?v=4" width="100px;" alt="Sergei Grishchenko"/><br /><sub><b>Sergei Grishchenko</b></sub></a><br /><a href="https://github.com/testing-library/react-hooks-testing-library/commits?author=sgrishchenko" title="Code">💻</a> <a href="https://github.com/testing-library/react-hooks-testing-library/commits?author=sgrishchenko" title="Documentation">📖</a> <a href="#ideas-sgrishchenko" title="Ideas, Planning, & Feedback">🤔</a></td>
+ </tr>
+ <tr>
+ <td align="center"><a href="https://github.com/josepot"><img src="https://avatars1.githubusercontent.com/u/8620144?v=4" width="100px;" alt="Josep M Sobrepere"/><br /><sub><b>Josep M Sobrepere</b></sub></a><br /><a href="https://github.com/testing-library/react-hooks-testing-library/commits?author=josepot" title="Documentation">📖</a></td>
+ <td align="center"><a href="https://github.com/mtinner"><img src="https://avatars0.githubusercontent.com/u/5487448?v=4" width="100px;" alt="Marcel Tinner"/><br /><sub><b>Marcel Tinner</b></sub></a><br /><a href="https://github.com/testing-library/react-hooks-testing-library/commits?author=mtinner" title="Documentation">📖</a></td>
+ <td align="center"><a href="https://github.com/FredyC"><img src="https://avatars0.githubusercontent.com/u/1096340?v=4" width="100px;" alt="Daniel K."/><br /><sub><b>Daniel K.</b></sub></a><br /><a href="https://github.com/testing-library/react-hooks-testing-library/issues?q=author%3AFredyC" title="Bug reports">🐛</a> <a href="https://github.com/testing-library/react-hooks-testing-library/commits?author=FredyC" title="Code">💻</a></td>
+ <td align="center"><a href="http://apostolidis.me"><img src="https://avatars3.githubusercontent.com/u/2164902?v=4" width="100px;" alt="John Apostolidis"/><br /><sub><b>John Apostolidis</b></sub></a><br /><a href="https://github.com/testing-library/react-hooks-testing-library/commits?author=apostolidhs" title="Code">💻</a> <a href="https://github.com/testing-library/react-hooks-testing-library/commits?author=apostolidhs" title="Documentation">📖</a></td>
+ </tr>
+</table>
<!-- ALL-CONTRIBUTORS-LIST:END -->