@testing-library/react-native 7.1.0 → 8.0.0

package/build/render.js.flow

@@ -3,10 +3,10 @@ import * as React from 'react';
 import TestRenderer, { type ReactTestRenderer } from 'react-test-renderer'; // eslint-disable-line import/no-extraneous-dependencies
 import act from './act';
 import { addToCleanupQueue } from './cleanup';
-import { getByAPI } from './helpers/getByAPI';
-import { queryByAPI } from './helpers/queryByAPI';
-import { findByAPI } from './helpers/findByAPI';
-import a11yAPI from './helpers/a11yAPI';
+import { getByAPI, type GetByAPI } from './helpers/getByAPI';
+import { queryByAPI, type QueryByAPI } from './helpers/queryByAPI';
+import { findByAPI, type FindByAPI } from './helpers/findByAPI';
+import { a11yAPI, type A11yAPI } from './helpers/a11yAPI';
 import debugShallow from './helpers/debugShallow';
 import debugDeep from './helpers/debugDeep';
 
@@ -25,7 +25,18 @@ type TestRendererOptions = {
 export default function render<T>(
   component: React.Element<T>,
   { wrapper: Wrapper, createNodeMock }: Options = {}
-) {
+): {
+  ...FindByAPI,
+  ...QueryByAPI,
+  ...GetByAPI,
+  ...A11yAPI,
+  update: (component: React.Element<any>) => void,
+  container: ReactTestInstance,
+  rerender: (component: React.Element<any>) => void,
+  unmount: (nextElement?: React.Element<any>) => void,
+  toJSON: () => null | ReactTestRendererJSON,
+  debug: DebugFunction,
+} {
   const wrap = (innerElement: React.Element<any>) =>
     Wrapper ? <Wrapper>{innerElement}</Wrapper> : innerElement;
 
@@ -35,8 +46,13 @@ export default function render<T>(
   );
   const update = updateWithAct(renderer, wrap);
   const instance = renderer.root;
+  const unmount = () => {
+    act(() => {
+      renderer.unmount();
+    });
+  };
 
-  addToCleanupQueue(renderer.unmount);
+  addToCleanupQueue(unmount);
 
   return {
     ...getByAPI(instance),
@@ -44,9 +60,9 @@ export default function render<T>(
     ...findByAPI(instance),
     ...a11yAPI(instance),
     update,
+    unmount,
     container: instance,
     rerender: update, // alias for `update`
-    unmount: renderer.unmount,
     toJSON: renderer.toJSON,
     debug: debug(instance, renderer),
   };
@@ -76,7 +92,15 @@ function updateWithAct(
   };
 }
 
-function debug(instance: ReactTestInstance, renderer) {
+interface DebugFunction {
+  (message?: string): void;
+  shallow: (message?: string) => void;
+}
+
+function debug(
+  instance: ReactTestInstance,
+  renderer: ReactTestRenderer
+): DebugFunction {
   function debugImpl(message?: string) {
     return debugDeep(renderer.toJSON(), message);
   }

package/build/shallow.js.flow

@@ -8,7 +8,7 @@ import { throwRemovedFunctionError } from './helpers/errors';
  */
 export function shallowInternal(
   instance: ReactTestInstance | React.Element<any>
-) {
+): {| output: any |} {
   const renderer = new ShallowRenderer();
 
   renderer.render(React.createElement(instance.type, instance.props));

package/build/types.flow.js.flow

@@ -1,5 +1,9 @@
 // @flow
 
+export type Thenable = {
+  then(resolve: () => mixed, reject?: () => mixed): mixed,
+};
+
 export type A11yRole =
   | 'none'
   | 'button'

package/build/waitFor.js

@@ -12,13 +12,16 @@ var _act = _interopRequireDefault(require("./act"));
 
 var _errors = require("./helpers/errors");
 
+var _timers = require("./helpers/timers");
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
 
 function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 
-const DEFAULT_TIMEOUT = 4500;
+/* globals jest */
+const DEFAULT_TIMEOUT = 1000;
 const DEFAULT_INTERVAL = 50;
 
 function checkReactVersionAtLeast(major, minor) {
@@ -27,44 +30,170 @@ function checkReactVersionAtLeast(major, minor) {
   return actualMajor > major || actualMajor === major && actualMinor >= minor;
 }
 
-function waitForInternal(expectation, options) {
-  var _options$timeout, _options$interval;
+function waitForInternal(expectation, {
+  timeout = DEFAULT_TIMEOUT,
+  interval = DEFAULT_INTERVAL,
+  stackTraceError
+}) {
+  if (typeof expectation !== 'function') {
+    throw new TypeError('Received `expectation` arg must be a function');
+  } // eslint-disable-next-line no-async-promise-executor
+
+
+  return new Promise(async (resolve, reject) => {
+    let lastError, intervalId;
+    let finished = false;
+    let promiseStatus = 'idle';
+    const overallTimeoutTimer = (0, _timers.setTimeout)(handleTimeout, timeout);
+    const usingFakeTimers = (0, _timers.jestFakeTimersAreEnabled)();
+
+    if (usingFakeTimers) {
+      checkExpectation(); // this is a dangerous rule to disable because it could lead to an
+      // infinite loop. However, eslint isn't smart enough to know that we're
+      // setting finished inside `onDone` which will be called when we're done
+      // waiting or when we've timed out.
+      // eslint-disable-next-line no-unmodified-loop-condition
+
+      let fakeTimeRemaining = timeout;
+
+      while (!finished) {
+        if (!(0, _timers.jestFakeTimersAreEnabled)()) {
+          const error = new Error(`Changed from using fake timers to real timers while using waitFor. This is not allowed and will result in very strange behavior. Please ensure you're awaiting all async things your test is doing before changing to real timers. For more info, please go to https://github.com/testing-library/dom-testing-library/issues/830`);
+
+          if (stackTraceError) {
+            (0, _errors.copyStackTrace)(error, stackTraceError);
+          }
+
+          reject(error);
+          return;
+        } // when fake timers are used we want to simulate the interval time passing
+
+
+        if (fakeTimeRemaining <= 0) {
+          return;
+        } else {
+          fakeTimeRemaining -= interval;
+        } // we *could* (maybe should?) use `advanceTimersToNextTimer` but it's
+        // possible that could make this loop go on forever if someone is using
+        // third party code that's setting up recursive timers so rapidly that
+        // the user's timer's don't get a chance to resolve. So we'll advance
+        // by an interval instead. (We have a test for this case).
+
+
+        jest.advanceTimersByTime(interval); // It's really important that checkExpectation is run *before* we flush
+        // in-flight promises. To be honest, I'm not sure why, and I can't quite
+        // think of a way to reproduce the problem in a test, but I spent
+        // an entire day banging my head against a wall on this.
+
+        checkExpectation(); // In this rare case, we *need* to wait for in-flight promises
+        // to resolve before continuing. We don't need to take advantage
+        // of parallelization so we're fine.
+        // https://stackoverflow.com/a/59243586/971592
+        // eslint-disable-next-line no-await-in-loop
+
+        await new Promise(resolve => (0, _timers.setImmediate)(resolve));
+      }
+    } else {
+      intervalId = setInterval(checkRealTimersCallback, interval);
+      checkExpectation();
+    }
+
+    function onDone(error, result) {
+      finished = true;
+      (0, _timers.clearTimeout)(overallTimeoutTimer);
+
+      if (!usingFakeTimers) {
+        clearInterval(intervalId);
+      }
 
-  const timeout = (_options$timeout = options === null || options === void 0 ? void 0 : options.timeout) !== null && _options$timeout !== void 0 ? _options$timeout : DEFAULT_TIMEOUT;
-  const interval = (_options$interval = options === null || options === void 0 ? void 0 : options.interval) !== null && _options$interval !== void 0 ? _options$interval : DEFAULT_INTERVAL;
-  const startTime = Date.now();
-  return new Promise((resolve, reject) => {
-    const rejectOrRerun = error => {
-      if (Date.now() - startTime >= timeout) {
+      if (error) {
         reject(error);
-        return;
+      } else {
+        // $FlowIgnore[incompatible-return] error and result are mutually exclusive
+        resolve(result);
+      }
+    }
+
+    function checkRealTimersCallback() {
+      if ((0, _timers.jestFakeTimersAreEnabled)()) {
+        const error = new Error(`Changed from using real timers to fake timers while using waitFor. This is not allowed and will result in very strange behavior. Please ensure you're awaiting all async things your test is doing before changing to fake timers. For more info, please go to https://github.com/testing-library/dom-testing-library/issues/830`);
+
+        if (stackTraceError) {
+          (0, _errors.copyStackTrace)(error, stackTraceError);
+        }
+
+        return reject(error);
+      } else {
+        return checkExpectation();
       }
+    }
 
-      setTimeout(runExpectation, interval);
-    };
+    function checkExpectation() {
+      if (promiseStatus === 'pending') return;
 
-    function runExpectation() {
       try {
-        const result = expectation();
-        resolve(result);
+        const result = expectation(); // $FlowIgnore[incompatible-type]
+
+        if (typeof (result === null || result === void 0 ? void 0 : result.then) === 'function') {
+          promiseStatus = 'pending'; // eslint-disable-next-line promise/catch-or-return
+
+          result.then(resolvedValue => {
+            promiseStatus = 'resolved';
+            onDone(null, resolvedValue);
+            return;
+          }, rejectedValue => {
+            promiseStatus = 'rejected';
+            lastError = rejectedValue;
+            return;
+          });
+        } else {
+          onDone(null, result);
+        } // If `callback` throws, wait for the next mutation, interval, or timeout.
+
       } catch (error) {
-        rejectOrRerun(error);
+        // Save the most recent callback error to reject the promise with it in the event of a timeout
+        lastError = error;
       }
     }
 
-    setTimeout(runExpectation, 0);
+    function handleTimeout() {
+      let error;
+
+      if (lastError) {
+        error = lastError;
+
+        if (stackTraceError) {
+          (0, _errors.copyStackTrace)(error, stackTraceError);
+        }
+      } else {
+        error = new Error('Timed out in waitFor.');
+
+        if (stackTraceError) {
+          (0, _errors.copyStackTrace)(error, stackTraceError);
+        }
+      }
+
+      onDone(error, null);
+    }
   });
 }
 
 async function waitFor(expectation, options) {
+  // Being able to display a useful stack trace requires generating it before doing anything async
+  const stackTraceError = new _errors.ErrorWithStack('STACK_TRACE_ERROR', waitFor);
+  const optionsWithStackTrace = {
+    stackTraceError,
+    ...options
+  };
+
   if (!checkReactVersionAtLeast(16, 9)) {
-    return waitForInternal(expectation, options);
+    return waitForInternal(expectation, optionsWithStackTrace);
   }
 
   let result; //$FlowFixMe: `act` has incorrect flow typing
 
   await (0, _act.default)(async () => {
-    result = await waitForInternal(expectation, options);
+    result = await waitForInternal(expectation, optionsWithStackTrace);
   }); //$FlowFixMe: either we have result or `waitFor` threw error
 
   return result;

package/build/waitFor.js.flow

@@ -1,10 +1,21 @@
 // @flow
+/* globals jest */
 
 import * as React from 'react';
 import act from './act';
-import { throwRemovedFunctionError } from './helpers/errors';
+import {
+  ErrorWithStack,
+  throwRemovedFunctionError,
+  copyStackTrace,
+} from './helpers/errors';
+import {
+  setTimeout,
+  clearTimeout,
+  setImmediate,
+  jestFakeTimersAreEnabled,
+} from './helpers/timers';
 
-const DEFAULT_TIMEOUT = 4500;
+const DEFAULT_TIMEOUT = 1000;
 const DEFAULT_INTERVAL = 50;
 
 function checkReactVersionAtLeast(major: number, minor: number): boolean {
@@ -17,33 +28,159 @@ function checkReactVersionAtLeast(major: number, minor: number): boolean {
 export type WaitForOptions = {
   timeout?: number,
   interval?: number,
+  stackTraceError?: ErrorWithStack,
 };
 
 function waitForInternal<T>(
   expectation: () => T,
-  options?: WaitForOptions
+  {
+    timeout = DEFAULT_TIMEOUT,
+    interval = DEFAULT_INTERVAL,
+    stackTraceError,
+  }: WaitForOptions
 ): Promise<T> {
-  const timeout = options?.timeout ?? DEFAULT_TIMEOUT;
-  const interval = options?.interval ?? DEFAULT_INTERVAL;
-  const startTime = Date.now();
+  if (typeof expectation !== 'function') {
+    throw new TypeError('Received `expectation` arg must be a function');
+  }
+
+  // eslint-disable-next-line no-async-promise-executor
+  return new Promise(async (resolve, reject) => {
+    let lastError, intervalId;
+    let finished = false;
+    let promiseStatus = 'idle';
+
+    const overallTimeoutTimer = setTimeout(handleTimeout, timeout);
+
+    const usingFakeTimers = jestFakeTimersAreEnabled();
+
+    if (usingFakeTimers) {
+      checkExpectation();
+      // this is a dangerous rule to disable because it could lead to an
+      // infinite loop. However, eslint isn't smart enough to know that we're
+      // setting finished inside `onDone` which will be called when we're done
+      // waiting or when we've timed out.
+      // eslint-disable-next-line no-unmodified-loop-condition
+      let fakeTimeRemaining = timeout;
+      while (!finished) {
+        if (!jestFakeTimersAreEnabled()) {
+          const error = new Error(
+            `Changed from using fake timers to real timers while using waitFor. This is not allowed and will result in very strange behavior. Please ensure you're awaiting all async things your test is doing before changing to real timers. For more info, please go to https://github.com/testing-library/dom-testing-library/issues/830`
+          );
+          if (stackTraceError) {
+            copyStackTrace(error, stackTraceError);
+          }
+          reject(error);
+          return;
+        }
+
+        // when fake timers are used we want to simulate the interval time passing
+        if (fakeTimeRemaining <= 0) {
+          return;
+        } else {
+          fakeTimeRemaining -= interval;
+        }
 
-  return new Promise((resolve, reject) => {
-    const rejectOrRerun = (error) => {
-      if (Date.now() - startTime >= timeout) {
+        // we *could* (maybe should?) use `advanceTimersToNextTimer` but it's
+        // possible that could make this loop go on forever if someone is using
+        // third party code that's setting up recursive timers so rapidly that
+        // the user's timer's don't get a chance to resolve. So we'll advance
+        // by an interval instead. (We have a test for this case).
+        jest.advanceTimersByTime(interval);
+
+        // It's really important that checkExpectation is run *before* we flush
+        // in-flight promises. To be honest, I'm not sure why, and I can't quite
+        // think of a way to reproduce the problem in a test, but I spent
+        // an entire day banging my head against a wall on this.
+        checkExpectation();
+
+        // In this rare case, we *need* to wait for in-flight promises
+        // to resolve before continuing. We don't need to take advantage
+        // of parallelization so we're fine.
+        // https://stackoverflow.com/a/59243586/971592
+        // eslint-disable-next-line no-await-in-loop
+        await new Promise((resolve) => setImmediate(resolve));
+      }
+    } else {
+      intervalId = setInterval(checkRealTimersCallback, interval);
+      checkExpectation();
+    }
+
+    function onDone(error, result) {
+      finished = true;
+      clearTimeout(overallTimeoutTimer);
+
+      if (!usingFakeTimers) {
+        clearInterval(intervalId);
+      }
+
+      if (error) {
         reject(error);
-        return;
+      } else {
+        // $FlowIgnore[incompatible-return] error and result are mutually exclusive
+        resolve(result);
       }
-      setTimeout(runExpectation, interval);
-    };
-    function runExpectation() {
+    }
+
+    function checkRealTimersCallback() {
+      if (jestFakeTimersAreEnabled()) {
+        const error = new Error(
+          `Changed from using real timers to fake timers while using waitFor. This is not allowed and will result in very strange behavior. Please ensure you're awaiting all async things your test is doing before changing to fake timers. For more info, please go to https://github.com/testing-library/dom-testing-library/issues/830`
+        );
+        if (stackTraceError) {
+          copyStackTrace(error, stackTraceError);
+        }
+        return reject(error);
+      } else {
+        return checkExpectation();
+      }
+    }
+
+    function checkExpectation() {
+      if (promiseStatus === 'pending') return;
       try {
         const result = expectation();
-        resolve(result);
+
+        // $FlowIgnore[incompatible-type]
+        if (typeof result?.then === 'function') {
+          promiseStatus = 'pending';
+          // eslint-disable-next-line promise/catch-or-return
+          result.then(
+            (resolvedValue) => {
+              promiseStatus = 'resolved';
+              onDone(null, resolvedValue);
+              return;
+            },
+            (rejectedValue) => {
+              promiseStatus = 'rejected';
+              lastError = rejectedValue;
+              return;
+            }
+          );
+        } else {
+          onDone(null, result);
+        }
+        // If `callback` throws, wait for the next mutation, interval, or timeout.
       } catch (error) {
-        rejectOrRerun(error);
+        // Save the most recent callback error to reject the promise with it in the event of a timeout
+        lastError = error;
+      }
+    }
+
+    function handleTimeout() {
+      let error;
+      if (lastError) {
+        error = lastError;
+        if (stackTraceError) {
+          copyStackTrace(error, stackTraceError);
+        }
+      } else {
+        error = new Error('Timed out in waitFor.');
+        if (stackTraceError) {
+          copyStackTrace(error, stackTraceError);
+        }
       }
+      onDone(error, null);
     }
-    setTimeout(runExpectation, 0);
   });
 }
 
@@ -51,15 +188,19 @@ export default async function waitFor<T>(
   expectation: () => T,
   options?: WaitForOptions
 ): Promise<T> {
+  // Being able to display a useful stack trace requires generating it before doing anything async
+  const stackTraceError = new ErrorWithStack('STACK_TRACE_ERROR', waitFor);
+  const optionsWithStackTrace = { stackTraceError, ...options };
+
   if (!checkReactVersionAtLeast(16, 9)) {
-    return waitForInternal(expectation, options);
+    return waitForInternal(expectation, optionsWithStackTrace);
   }
 
   let result: T;
 
   //$FlowFixMe: `act` has incorrect flow typing
   await act(async () => {
-    result = await waitForInternal(expectation, options);
+    result = await waitForInternal(expectation, optionsWithStackTrace);
   });
 
   //$FlowFixMe: either we have result or `waitFor` threw error

package/build/waitForElementToBeRemoved.js

@@ -11,7 +11,9 @@ var _errors = require("./helpers/errors");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-const isRemoved = result => !result || Array.isArray(result) && !result.length;
+function isRemoved(result) {
+  return !result || Array.isArray(result) && !result.length;
+}
 
 async function waitForElementToBeRemoved(expectation, options) {
   // Created here so we get a nice stacktrace

package/build/waitForElementToBeRemoved.js.flow

@@ -2,8 +2,9 @@
 import waitFor, { type WaitForOptions } from './waitFor';
 import { ErrorWithStack } from './helpers/errors';
 
-const isRemoved = (result) =>
-  !result || (Array.isArray(result) && !result.length);
+function isRemoved<T>(result: T): boolean {
+  return !result || (Array.isArray(result) && !result.length);
+}
 
 export default async function waitForElementToBeRemoved<T>(
   expectation: () => T,

package/build/within.js

@@ -12,15 +12,13 @@ var _queryByAPI = require("./helpers/queryByAPI");
 
 var _findByAPI = require("./helpers/findByAPI");
 
-var _a11yAPI = _interopRequireDefault(require("./helpers/a11yAPI"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+var _a11yAPI = require("./helpers/a11yAPI");
 
 function within(instance) {
   return { ...(0, _getByAPI.getByAPI)(instance),
     ...(0, _queryByAPI.queryByAPI)(instance),
     ...(0, _findByAPI.findByAPI)(instance),
-    ...(0, _a11yAPI.default)(instance)
+    ...(0, _a11yAPI.a11yAPI)(instance)
   };
 }
 

package/build/within.js.flow

@@ -1,10 +1,12 @@
 // @flow
-import { getByAPI } from './helpers/getByAPI';
-import { queryByAPI } from './helpers/queryByAPI';
-import { findByAPI } from './helpers/findByAPI';
-import a11yAPI from './helpers/a11yAPI';
+import { getByAPI, type GetByAPI } from './helpers/getByAPI';
+import { queryByAPI, type QueryByAPI } from './helpers/queryByAPI';
+import { findByAPI, type FindByAPI } from './helpers/findByAPI';
+import { a11yAPI, type A11yAPI } from './helpers/a11yAPI';
 
-export function within(instance: ReactTestInstance) {
+export function within(
+  instance: ReactTestInstance
+): { ...FindByAPI, ...QueryByAPI, ...GetByAPI, ...A11yAPI } {
   return {
     ...getByAPI(instance),
     ...queryByAPI(instance),

package/jest-preset/index.js

@@ -0,0 +1,10 @@
+const reactNativePreset = require('react-native/jest-preset');
+
+module.exports = {
+  ...reactNativePreset,
+  // this is needed to make modern fake timers work
+  // because the react-native preset overrides global.Promise
+  setupFiles: [require.resolve('./save-promise.js')]
+    .concat(reactNativePreset.setupFiles)
+    .concat([require.resolve('./restore-promise.js')]),
+};

package/jest-preset/restore-promise.js

@@ -0,0 +1 @@
+global.Promise = global.RNTL_ORIGINAL_PROMISE;

package/jest-preset/save-promise.js

@@ -0,0 +1 @@
+global.RNTL_ORIGINAL_PROMISE = Promise;