feat: add asyncWrapper config (#236)

Author: Kent C. Dodds

src/config.js

@@ -3,6 +3,14 @@
 // './queries' are query functions.
 let config = {
   testIdAttribute: 'data-testid',
+  // this is to support React's async `act` function.
+  // forcing react-testing-library to wrap all async functions would've been
+  // a total nightmare (consider wrapping every findBy* query and then also
+  // updating `within` so those would be wrapped too. Total nightmare).
+  // so we have this config option that's really only intended for
+  // react-testing-library to use. For that reason, this feature will remain
+  // undocumented.
+  asyncWrapper: cb => cb(),
 }
 
 export function configure(newConfig) {

src/wait-for-dom-change.js

@@ -1,4 +1,5 @@
 import {newMutationObserver, getDocument, getSetImmediate} from './helpers'
+import {getConfig} from './config'
 
 function waitForDomChange({
   container = getDocument(),
@@ -36,4 +37,8 @@ function waitForDomChange({
   })
 }
 
-export {waitForDomChange}
+function waitForDomChangeWrapper(...args) {
+  return getConfig().asyncWrapper(() => waitForDomChange(...args))
+}
+
+export {waitForDomChangeWrapper as waitForDomChange}

src/wait-for-element-to-be-removed.js

@@ -1,4 +1,5 @@
 import {getDocument, getSetImmediate, newMutationObserver} from './helpers'
+import {getConfig} from './config'
 
 function waitForElementToBeRemoved(
   callback,
@@ -69,4 +70,8 @@ function waitForElementToBeRemoved(
   })
 }
 
-export {waitForElementToBeRemoved}
+function waitForElementToBeRemovedWrapper(...args) {
+  return getConfig().asyncWrapper(() => waitForElementToBeRemoved(...args))
+}
+
+export {waitForElementToBeRemovedWrapper as waitForElementToBeRemoved}

src/wait-for-element.js

@@ -1,4 +1,5 @@
 import {newMutationObserver, getDocument, getSetImmediate} from './helpers'
+import {getConfig} from './config'
 
 function waitForElement(
   callback,
@@ -54,4 +55,8 @@ function waitForElement(
   })
 }
 
-export {waitForElement}
+function waitForElementWrapper(...args) {
+  return getConfig().asyncWrapper(() => waitForElement(...args))
+}
+
+export {waitForElementWrapper as waitForElement}

src/wait.js

@@ -1,7 +1,12 @@
 import waitForExpect from 'wait-for-expect'
+import {getConfig} from './config'
 
 function wait(callback = () => {}, {timeout = 4500, interval = 50} = {}) {
   return waitForExpect(callback, timeout, interval)
 }
 
-export {wait}
+function waitWrapper(...args) {
+  return getConfig().asyncWrapper(() => wait(...args))
+}
+
+export {waitWrapper as wait}

typings/config.d.ts

@@ -1,5 +1,6 @@
 export interface IConfig {
   testIdAttribute: string
+  asyncWrapper<T>(cb: Function): Promise<T>
 }
 
 export interface IConfigFn {