Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Added cleanup and autocleanup functionality
  • Loading branch information
mpeyper committed Oct 13, 2019
1 parent eb400b1 commit 183c3ce
Show file tree
Hide file tree
Showing 5 changed files with 148 additions and 6 deletions.
33 changes: 27 additions & 6 deletions src/index.js
@@ -1,6 +1,8 @@
import React, { Suspense } from 'react'
import { act, create } from 'react-test-renderer'

let cleanupCallbacks = []

function TestHook({ callback, hookProps, onError, children }) {
try {
children(callback(hookProps))
Expand Down Expand Up @@ -73,6 +75,15 @@ function renderHook(callback, { initialProps, wrapper } = {}) {
})
const { unmount, update } = testRenderer

function unmountHook() {
act(() => {
cleanupCallbacks = cleanupCallbacks.filter((cb) => cb !== unmountHook)
unmount()
})
}

cleanupCallbacks.push(unmountHook)

let waitingForNextUpdate = null
const resolveOnNextUpdate = (resolve) => {
addResolver((...args) => {
Expand All @@ -93,12 +104,22 @@ function renderHook(callback, { initialProps, wrapper } = {}) {
update(toRender())
})
},
unmount: () => {
act(() => {
unmount()
})
}
unmount: unmountHook
}
}

export { renderHook, act }
async function cleanup() {
await act(async () => {
await act(async () => {})
cleanupCallbacks.forEach((cb) => cb())
cleanupCallbacks = []
})
}

if (typeof afterEach === 'function' && !process.env.RHTL_SKIP_AUTO_CLEANUP) {
afterEach(async () => {
await cleanup()
})
}

export { renderHook, cleanup, act }
28 changes: 28 additions & 0 deletions test/autoCleanup.disabled.test.js
@@ -0,0 +1,28 @@
import { useEffect } from 'react'

// This verifies that if RHTL_SKIP_AUTO_CLEANUP is set
// then we DON'T auto-wire up the afterEach for folks
describe('skip auto cleanup (disabled) tests', () => {
let cleanupCalled = false
let renderHook

beforeAll(() => {
process.env.RHTL_SKIP_AUTO_CLEANUP = 'true'
renderHook = require('src').renderHook
})

test('first', () => {
const hookWithCleanup = () => {
useEffect(() => {
return () => {
cleanupCalled = true
}
})
}
renderHook(() => hookWithCleanup())
})

test('second', () => {
expect(cleanupCalled).toBe(false)
})
})
28 changes: 28 additions & 0 deletions test/autoCleanup.noAfterEach.test.js
@@ -0,0 +1,28 @@
import { useEffect } from 'react'

// This verifies that if RHTL_SKIP_AUTO_CLEANUP is set
// then we DON'T auto-wire up the afterEach for folks
describe('skip auto cleanup (no afterEach) tests', () => {
let cleanupCalled = false
let renderHook

beforeAll(() => {
afterEach = false
renderHook = require('src').renderHook
})

test('first', () => {
const hookWithCleanup = () => {
useEffect(() => {
return () => {
cleanupCalled = true
}
})
}
renderHook(() => hookWithCleanup())
})

test('second', () => {
expect(cleanupCalled).toBe(false)
})
})
24 changes: 24 additions & 0 deletions test/autoCleanup.test.js
@@ -0,0 +1,24 @@
import { useEffect } from 'react'
import { renderHook } from 'src'

// This verifies that by importing RHTL in an
// environment which supports afterEach (like jest)
// we'll get automatic cleanup between tests.
describe('auto cleanup tests', () => {
let cleanupCalled = false

test('first', () => {
const hookWithCleanup = () => {
useEffect(() => {
return () => {
cleanupCalled = true
}
})
}
renderHook(() => hookWithCleanup())
})

test('second', () => {
expect(cleanupCalled).toBe(true)
})
})
41 changes: 41 additions & 0 deletions test/cleanup.test.js
@@ -0,0 +1,41 @@
import { useEffect } from 'react'
import { renderHook, cleanup } from 'src'

describe('cleanup tests', () => {
test('should flush effects on cleanup', async () => {
let cleanupCalled = false

const hookWithCleanup = () => {
useEffect(() => {
return () => {
cleanupCalled = true
}
})
}

renderHook(() => hookWithCleanup())

await cleanup()

expect(cleanupCalled).toBe(true)
})

test('should cleanup all rendered hooks', async () => {
let cleanupCalled = []
const hookWithCleanup = (id) => {
useEffect(() => {
return () => {
cleanupCalled[id] = true
}
})
}

renderHook(() => hookWithCleanup(1))
renderHook(() => hookWithCleanup(2))

await cleanup()

expect(cleanupCalled[1]).toBe(true)
expect(cleanupCalled[2]).toBe(true)
})
})

0 comments on commit 183c3ce

Please sign in to comment.