feat: Flush microtasks in cleanup (#519)

Author: Kent C. Dodds

Diff for: src/__tests__/cleanup.js

@@ -1,7 +1,7 @@
 import React from 'react'
 import {render, cleanup} from '../'
 
-test('cleans up the document', () => {
+test('cleans up the document', async () => {
   const spy = jest.fn()
   const divId = 'my-div'
 
@@ -17,12 +17,12 @@ test('cleans up the document', () => {
   }
 
   render(<Test />)
-  cleanup()
+  await cleanup()
   expect(document.body.innerHTML).toBe('')
   expect(spy).toHaveBeenCalledTimes(1)
 })
 
-test('cleanup does not error when an element is not a child', () => {
+test('cleanup does not error when an element is not a child', async () => {
   render(<div />, {container: document.createElement('div')})
-  cleanup()
+  await cleanup()
 })

Diff for: src/index.js

@@ -1,4 +1,3 @@
-import flush from './flush-microtasks'
 import {cleanup} from './pure'
 
 // if we're running in a test runner that supports afterEach
@@ -8,8 +7,7 @@ import {cleanup} from './pure'
 // or set the RTL_SKIP_AUTO_CLEANUP env variable to 'true'.
 if (typeof afterEach === 'function' && !process.env.RTL_SKIP_AUTO_CLEANUP) {
   afterEach(async () => {
-    await flush()
-    cleanup()
+    await cleanup()
   })
 }
 

Diff for: src/pure.js

@@ -7,6 +7,7 @@ import {
   configure as configureDTL,
 } from '@testing-library/dom'
 import act, {asyncAct} from './act-compat'
+import flush from './flush-microtasks'
 
 configureDTL({
   asyncWrapper: async cb => {
@@ -88,7 +89,8 @@ function render(
   }
 }
 
-function cleanup() {
+async function cleanup() {
+  await flush();
   mountedContainers.forEach(cleanupAtContainer)
 }