@testing-library/react-native 12.1.1 → 12.1.3

package/build/waitFor.js.map

@@ -1 +1 @@
-{"version":3,"file":"waitFor.js","names":["_act","_interopRequireWildcard","require","_config","_flushMicroTasks","_errors","_timers","_reactVersions","_getRequireWildcardCache","nodeInterop","WeakMap","cacheBabelInterop","cacheNodeInterop","obj","__esModule","default","cache","has","get","newObj","hasPropertyDescriptor","Object","defineProperty","getOwnPropertyDescriptor","key","prototype","hasOwnProperty","call","desc","set","DEFAULT_INTERVAL","waitForInternal","expectation","timeout","getConfig","asyncUtilTimeout","interval","stackTraceError","onTimeout","TypeError","Promise","resolve","reject","lastError","intervalId","finished","promiseStatus","overallTimeoutTimer","usingFakeTimers","jestFakeTimersAreEnabled","checkExpectation","fakeTimeRemaining","error","Error","copyStackTrace","handleTimeout","jest","advanceTimersByTime","setImmediate","setTimeout","setInterval","checkRealTimersCallback","onDone","done","clearTimeout","clearInterval","type","result","then","promiseResult","resolvedValue","rejectedValue","String","waitFor","options","ErrorWithStack","optionsWithStackTrace","checkReactVersionAtLeast","previousActEnvironment","getIsReactActEnvironment","setReactActEnvironment","flushMicroTasks","act"],"sources":["../src/waitFor.ts"],"sourcesContent":["/* globals jest */\nimport act, { setReactActEnvironment, getIsReactActEnvironment } from './act';\nimport { getConfig } from './config';\nimport { flushMicroTasks } from './flushMicroTasks';\nimport { ErrorWithStack, copyStackTrace } from './helpers/errors';\nimport {\n  setTimeout,\n  clearTimeout,\n  setImmediate,\n  jestFakeTimersAreEnabled,\n} from './helpers/timers';\nimport { checkReactVersionAtLeast } from './react-versions';\n\nconst DEFAULT_INTERVAL = 50;\n\nexport type WaitForOptions = {\n  timeout?: number;\n  interval?: number;\n  stackTraceError?: ErrorWithStack;\n  onTimeout?: (error: Error) => Error;\n};\n\nfunction waitForInternal<T>(\n  expectation: () => T,\n  {\n    timeout = getConfig().asyncUtilTimeout,\n    interval = DEFAULT_INTERVAL,\n    stackTraceError,\n    onTimeout,\n  }: WaitForOptions\n): Promise<T> {\n  if (typeof expectation !== 'function') {\n    throw new TypeError('Received `expectation` arg must be a function');\n  }\n\n  // eslint-disable-next-line no-async-promise-executor\n  return new Promise(async (resolve, reject) => {\n    let lastError: unknown, intervalId: ReturnType<typeof setTimeout>;\n    let finished = false;\n    let promiseStatus = 'idle';\n\n    let overallTimeoutTimer: NodeJS.Timeout | null = null;\n\n    const usingFakeTimers = jestFakeTimersAreEnabled();\n\n    if (usingFakeTimers) {\n      checkExpectation();\n      // this is a dangerous rule to disable because it could lead to an\n      // infinite loop. However, eslint isn't smart enough to know that we're\n      // setting finished inside `onDone` which will be called when we're done\n      // waiting or when we've timed out.\n      // eslint-disable-next-line no-unmodified-loop-condition\n      let fakeTimeRemaining = timeout;\n      while (!finished) {\n        if (!jestFakeTimersAreEnabled()) {\n          const error = new Error(\n            `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`\n          );\n          if (stackTraceError) {\n            copyStackTrace(error, stackTraceError);\n          }\n          reject(error);\n          return;\n        }\n\n        // when fake timers are used we want to simulate the interval time passing\n        if (fakeTimeRemaining <= 0) {\n          handleTimeout();\n          return;\n        } else {\n          fakeTimeRemaining -= interval;\n        }\n\n        // we *could* (maybe should?) use `advanceTimersToNextTimer` but it's\n        // possible that could make this loop go on forever if someone is using\n        // third party code that's setting up recursive timers so rapidly that\n        // the user's timer's don't get a chance to resolve. So we'll advance\n        // by an interval instead. (We have a test for this case).\n        jest.advanceTimersByTime(interval);\n\n        // It's really important that checkExpectation is run *before* we flush\n        // in-flight promises. To be honest, I'm not sure why, and I can't quite\n        // think of a way to reproduce the problem in a test, but I spent\n        // an entire day banging my head against a wall on this.\n        checkExpectation();\n\n        // In this rare case, we *need* to wait for in-flight promises\n        // to resolve before continuing. We don't need to take advantage\n        // of parallelization so we're fine.\n        // https://stackoverflow.com/a/59243586/971592\n        // eslint-disable-next-line no-await-in-loop\n        await new Promise((resolve) => setImmediate(resolve));\n      }\n    } else {\n      overallTimeoutTimer = setTimeout(handleTimeout, timeout);\n      intervalId = setInterval(checkRealTimersCallback, interval);\n      checkExpectation();\n    }\n\n    function onDone(\n      done: { type: 'result'; result: T } | { type: 'error'; error: unknown }\n    ) {\n      finished = true;\n      if (overallTimeoutTimer) {\n        clearTimeout(overallTimeoutTimer);\n      }\n\n      if (!usingFakeTimers) {\n        clearInterval(intervalId);\n      }\n\n      if (done.type === 'error') {\n        reject(done.error);\n      } else {\n        resolve(done.result);\n      }\n    }\n\n    function checkRealTimersCallback() {\n      if (jestFakeTimersAreEnabled()) {\n        const error = new Error(\n          `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`\n        );\n        if (stackTraceError) {\n          copyStackTrace(error, stackTraceError);\n        }\n        return reject(error);\n      } else {\n        return checkExpectation();\n      }\n    }\n\n    function checkExpectation() {\n      if (promiseStatus === 'pending') return;\n      try {\n        const result = expectation();\n\n        // @ts-ignore result can be a promise\n        // eslint-disable-next-line promise/prefer-await-to-then\n        if (typeof result?.then === 'function') {\n          const promiseResult: Promise<T> = result as any;\n          promiseStatus = 'pending';\n          // eslint-disable-next-line promise/catch-or-return, promise/prefer-await-to-then\n          promiseResult.then(\n            (resolvedValue) => {\n              promiseStatus = 'resolved';\n              onDone({ type: 'result', result: resolvedValue });\n              return;\n            },\n            (rejectedValue) => {\n              promiseStatus = 'rejected';\n              lastError = rejectedValue;\n              return;\n            }\n          );\n        } else {\n          onDone({ type: 'result', result: result });\n        }\n        // If `callback` throws, wait for the next mutation, interval, or timeout.\n      } catch (error) {\n        // Save the most recent callback error to reject the promise with it in the event of a timeout\n        lastError = error;\n      }\n    }\n\n    function handleTimeout() {\n      let error: Error;\n      if (lastError) {\n        if (lastError instanceof Error) {\n          error = lastError;\n        } else {\n          error = new Error(String(lastError));\n        }\n\n        if (stackTraceError) {\n          copyStackTrace(error, stackTraceError);\n        }\n      } else {\n        error = new Error('Timed out in waitFor.');\n        if (stackTraceError) {\n          copyStackTrace(error, stackTraceError);\n        }\n      }\n      if (typeof onTimeout === 'function') {\n        const result = onTimeout(error);\n        if (result) {\n          error = result;\n        }\n      }\n      onDone({ type: 'error', error });\n    }\n  });\n}\n\nexport default async function waitFor<T>(\n  expectation: () => T,\n  options?: WaitForOptions\n): Promise<T> {\n  // Being able to display a useful stack trace requires generating it before doing anything async\n  const stackTraceError = new ErrorWithStack('STACK_TRACE_ERROR', waitFor);\n  const optionsWithStackTrace = { stackTraceError, ...options };\n\n  if (checkReactVersionAtLeast(18, 0)) {\n    const previousActEnvironment = getIsReactActEnvironment();\n    setReactActEnvironment(false);\n\n    try {\n      const result = await waitForInternal(expectation, optionsWithStackTrace);\n      // Flush the microtask queue before restoring the `act` environment\n      await flushMicroTasks();\n      return result;\n    } finally {\n      setReactActEnvironment(previousActEnvironment);\n    }\n  }\n\n  if (!checkReactVersionAtLeast(16, 9)) {\n    return waitForInternal(expectation, optionsWithStackTrace);\n  }\n\n  let result: T;\n\n  await act(async () => {\n    result = await waitForInternal(expectation, optionsWithStackTrace);\n  });\n\n  // Either we have result or `waitFor` threw error\n  return result!;\n}\n"],"mappings":";;;;;;AACA,IAAAA,IAAA,GAAAC,uBAAA,CAAAC,OAAA;AACA,IAAAC,OAAA,GAAAD,OAAA;AACA,IAAAE,gBAAA,GAAAF,OAAA;AACA,IAAAG,OAAA,GAAAH,OAAA;AACA,IAAAI,OAAA,GAAAJ,OAAA;AAMA,IAAAK,cAAA,GAAAL,OAAA;AAA4D,SAAAM,yBAAAC,WAAA,eAAAC,OAAA,kCAAAC,iBAAA,OAAAD,OAAA,QAAAE,gBAAA,OAAAF,OAAA,YAAAF,wBAAA,YAAAA,CAAAC,WAAA,WAAAA,WAAA,GAAAG,gBAAA,GAAAD,iBAAA,KAAAF,WAAA;AAAA,SAAAR,wBAAAY,GAAA,EAAAJ,WAAA,SAAAA,WAAA,IAAAI,GAAA,IAAAA,GAAA,CAAAC,UAAA,WAAAD,GAAA,QAAAA,GAAA,oBAAAA,GAAA,wBAAAA,GAAA,4BAAAE,OAAA,EAAAF,GAAA,UAAAG,KAAA,GAAAR,wBAAA,CAAAC,WAAA,OAAAO,KAAA,IAAAA,KAAA,CAAAC,GAAA,CAAAJ,GAAA,YAAAG,KAAA,CAAAE,GAAA,CAAAL,GAAA,SAAAM,MAAA,WAAAC,qBAAA,GAAAC,MAAA,CAAAC,cAAA,IAAAD,MAAA,CAAAE,wBAAA,WAAAC,GAAA,IAAAX,GAAA,QAAAW,GAAA,kBAAAH,MAAA,CAAAI,SAAA,CAAAC,cAAA,CAAAC,IAAA,CAAAd,GAAA,EAAAW,GAAA,SAAAI,IAAA,GAAAR,qBAAA,GAAAC,MAAA,CAAAE,wBAAA,CAAAV,GAAA,EAAAW,GAAA,cAAAI,IAAA,KAAAA,IAAA,CAAAV,GAAA,IAAAU,IAAA,CAAAC,GAAA,KAAAR,MAAA,CAAAC,cAAA,CAAAH,MAAA,EAAAK,GAAA,EAAAI,IAAA,YAAAT,MAAA,CAAAK,GAAA,IAAAX,GAAA,CAAAW,GAAA,SAAAL,MAAA,CAAAJ,OAAA,GAAAF,GAAA,MAAAG,KAAA,IAAAA,KAAA,CAAAa,GAAA,CAAAhB,GAAA,EAAAM,MAAA,YAAAA,MAAA;AAX5D;;AAaA,MAAMW,gBAAgB,GAAG,EAAE;AAS3B,SAASC,eAAeA,CACtBC,WAAoB,EACpB;EACEC,OAAO,GAAG,IAAAC,iBAAS,GAAE,CAACC,gBAAgB;EACtCC,QAAQ,GAAGN,gBAAgB;EAC3BO,eAAe;EACfC;AACc,CAAC,EACL;EACZ,IAAI,OAAON,WAAW,KAAK,UAAU,EAAE;IACrC,MAAM,IAAIO,SAAS,CAAC,+CAA+C,CAAC;EACtE;;EAEA;EACA,OAAO,IAAIC,OAAO,CAAC,OAAOC,OAAO,EAAEC,MAAM,KAAK;IAC5C,IAAIC,SAAkB,EAAEC,UAAyC;IACjE,IAAIC,QAAQ,GAAG,KAAK;IACpB,IAAIC,aAAa,GAAG,MAAM;IAE1B,IAAIC,mBAA0C,GAAG,IAAI;IAErD,MAAMC,eAAe,GAAG,IAAAC,gCAAwB,GAAE;IAElD,IAAID,eAAe,EAAE;MACnBE,gBAAgB,EAAE;MAClB;MACA;MACA;MACA;MACA;MACA,IAAIC,iBAAiB,GAAGlB,OAAO;MAC/B,OAAO,CAACY,QAAQ,EAAE;QAChB,IAAI,CAAC,IAAAI,gCAAwB,GAAE,EAAE;UAC/B,MAAMG,KAAK,GAAG,IAAIC,KAAK,CACpB,kUAAiU,CACnU;UACD,IAAIhB,eAAe,EAAE;YACnB,IAAAiB,sBAAc,EAACF,KAAK,EAAEf,eAAe,CAAC;UACxC;UACAK,MAAM,CAACU,KAAK,CAAC;UACb;QACF;;QAEA;QACA,IAAID,iBAAiB,IAAI,CAAC,EAAE;UAC1BI,aAAa,EAAE;UACf;QACF,CAAC,MAAM;UACLJ,iBAAiB,IAAIf,QAAQ;QAC/B;;QAEA;QACA;QACA;QACA;QACA;QACAoB,IAAI,CAACC,mBAAmB,CAACrB,QAAQ,CAAC;;QAElC;QACA;QACA;QACA;QACAc,gBAAgB,EAAE;;QAElB;QACA;QACA;QACA;QACA;QACA,MAAM,IAAIV,OAAO,CAAEC,OAAO,IAAK,IAAAiB,oBAAY,EAACjB,OAAO,CAAC,CAAC;MACvD;IACF,CAAC,MAAM;MACLM,mBAAmB,GAAG,IAAAY,kBAAU,EAACJ,aAAa,EAAEtB,OAAO,CAAC;MACxDW,UAAU,GAAGgB,WAAW,CAACC,uBAAuB,EAAEzB,QAAQ,CAAC;MAC3Dc,gBAAgB,EAAE;IACpB;IAEA,SAASY,MAAMA,CACbC,IAAuE,EACvE;MACAlB,QAAQ,GAAG,IAAI;MACf,IAAIE,mBAAmB,EAAE;QACvB,IAAAiB,oBAAY,EAACjB,mBAAmB,CAAC;MACnC;MAEA,IAAI,CAACC,eAAe,EAAE;QACpBiB,aAAa,CAACrB,UAAU,CAAC;MAC3B;MAEA,IAAImB,IAAI,CAACG,IAAI,KAAK,OAAO,EAAE;QACzBxB,MAAM,CAACqB,IAAI,CAACX,KAAK,CAAC;MACpB,CAAC,MAAM;QACLX,OAAO,CAACsB,IAAI,CAACI,MAAM,CAAC;MACtB;IACF;IAEA,SAASN,uBAAuBA,CAAA,EAAG;MACjC,IAAI,IAAAZ,gCAAwB,GAAE,EAAE;QAC9B,MAAMG,KAAK,GAAG,IAAIC,KAAK,CACpB,kUAAiU,CACnU;QACD,IAAIhB,eAAe,EAAE;UACnB,IAAAiB,sBAAc,EAACF,KAAK,EAAEf,eAAe,CAAC;QACxC;QACA,OAAOK,MAAM,CAACU,KAAK,CAAC;MACtB,CAAC,MAAM;QACL,OAAOF,gBAAgB,EAAE;MAC3B;IACF;IAEA,SAASA,gBAAgBA,CAAA,EAAG;MAC1B,IAAIJ,aAAa,KAAK,SAAS,EAAE;MACjC,IAAI;QACF,MAAMqB,MAAM,GAAGnC,WAAW,EAAE;;QAE5B;QACA;QACA,IAAI,OAAOmC,MAAM,EAAEC,IAAI,KAAK,UAAU,EAAE;UACtC,MAAMC,aAAyB,GAAGF,MAAa;UAC/CrB,aAAa,GAAG,SAAS;UACzB;UACAuB,aAAa,CAACD,IAAI,CACfE,aAAa,IAAK;YACjBxB,aAAa,GAAG,UAAU;YAC1BgB,MAAM,CAAC;cAAEI,IAAI,EAAE,QAAQ;cAAEC,MAAM,EAAEG;YAAc,CAAC,CAAC;YACjD;UACF,CAAC,EACAC,aAAa,IAAK;YACjBzB,aAAa,GAAG,UAAU;YAC1BH,SAAS,GAAG4B,aAAa;YACzB;UACF,CAAC,CACF;QACH,CAAC,MAAM;UACLT,MAAM,CAAC;YAAEI,IAAI,EAAE,QAAQ;YAAEC,MAAM,EAAEA;UAAO,CAAC,CAAC;QAC5C;QACA;MACF,CAAC,CAAC,OAAOf,KAAK,EAAE;QACd;QACAT,SAAS,GAAGS,KAAK;MACnB;IACF;IAEA,SAASG,aAAaA,CAAA,EAAG;MACvB,IAAIH,KAAY;MAChB,IAAIT,SAAS,EAAE;QACb,IAAIA,SAAS,YAAYU,KAAK,EAAE;UAC9BD,KAAK,GAAGT,SAAS;QACnB,CAAC,MAAM;UACLS,KAAK,GAAG,IAAIC,KAAK,CAACmB,MAAM,CAAC7B,SAAS,CAAC,CAAC;QACtC;QAEA,IAAIN,eAAe,EAAE;UACnB,IAAAiB,sBAAc,EAACF,KAAK,EAAEf,eAAe,CAAC;QACxC;MACF,CAAC,MAAM;QACLe,KAAK,GAAG,IAAIC,KAAK,CAAC,uBAAuB,CAAC;QAC1C,IAAIhB,eAAe,EAAE;UACnB,IAAAiB,sBAAc,EAACF,KAAK,EAAEf,eAAe,CAAC;QACxC;MACF;MACA,IAAI,OAAOC,SAAS,KAAK,UAAU,EAAE;QACnC,MAAM6B,MAAM,GAAG7B,SAAS,CAACc,KAAK,CAAC;QAC/B,IAAIe,MAAM,EAAE;UACVf,KAAK,GAAGe,MAAM;QAChB;MACF;MACAL,MAAM,CAAC;QAAEI,IAAI,EAAE,OAAO;QAAEd;MAAM,CAAC,CAAC;IAClC;EACF,CAAC,CAAC;AACJ;AAEe,eAAeqB,OAAOA,CACnCzC,WAAoB,EACpB0C,OAAwB,EACZ;EACZ;EACA,MAAMrC,eAAe,GAAG,IAAIsC,sBAAc,CAAC,mBAAmB,EAAEF,OAAO,CAAC;EACxE,MAAMG,qBAAqB,GAAG;IAAEvC,eAAe;IAAE,GAAGqC;EAAQ,CAAC;EAE7D,IAAI,IAAAG,uCAAwB,EAAC,EAAE,EAAE,CAAC,CAAC,EAAE;IACnC,MAAMC,sBAAsB,GAAG,IAAAC,6BAAwB,GAAE;IACzD,IAAAC,2BAAsB,EAAC,KAAK,CAAC;IAE7B,IAAI;MACF,MAAMb,MAAM,GAAG,MAAMpC,eAAe,CAACC,WAAW,EAAE4C,qBAAqB,CAAC;MACxE;MACA,MAAM,IAAAK,gCAAe,GAAE;MACvB,OAAOd,MAAM;IACf,CAAC,SAAS;MACR,IAAAa,2BAAsB,EAACF,sBAAsB,CAAC;IAChD;EACF;EAEA,IAAI,CAAC,IAAAD,uCAAwB,EAAC,EAAE,EAAE,CAAC,CAAC,EAAE;IACpC,OAAO9C,eAAe,CAACC,WAAW,EAAE4C,qBAAqB,CAAC;EAC5D;EAEA,IAAIT,MAAS;EAEb,MAAM,IAAAe,YAAG,EAAC,YAAY;IACpBf,MAAM,GAAG,MAAMpC,eAAe,CAACC,WAAW,EAAE4C,qBAAqB,CAAC;EACpE,CAAC,CAAC;;EAEF;EACA,OAAOT,MAAM;AACf"}
+{"version":3,"file":"waitFor.js","names":["_act","_interopRequireWildcard","require","_config","_flushMicroTasks","_errors","_timers","_reactVersions","_getRequireWildcardCache","nodeInterop","WeakMap","cacheBabelInterop","cacheNodeInterop","obj","__esModule","default","cache","has","get","newObj","hasPropertyDescriptor","Object","defineProperty","getOwnPropertyDescriptor","key","prototype","hasOwnProperty","call","desc","set","DEFAULT_INTERVAL","waitForInternal","expectation","timeout","getConfig","asyncUtilTimeout","interval","stackTraceError","onTimeout","TypeError","Promise","resolve","reject","lastError","intervalId","finished","promiseStatus","overallTimeoutTimer","usingFakeTimers","jestFakeTimersAreEnabled","checkExpectation","fakeTimeRemaining","error","Error","copyStackTrace","handleTimeout","jest","advanceTimersByTime","flushMicroTasks","setTimeout","setInterval","checkRealTimersCallback","onDone","done","clearTimeout","clearInterval","type","result","then","promiseResult","resolvedValue","rejectedValue","String","waitFor","options","ErrorWithStack","optionsWithStackTrace","checkReactVersionAtLeast","previousActEnvironment","getIsReactActEnvironment","setReactActEnvironment","flushMicroTasksLegacy","act"],"sources":["../src/waitFor.ts"],"sourcesContent":["/* globals jest */\nimport act, { setReactActEnvironment, getIsReactActEnvironment } from './act';\nimport { getConfig } from './config';\nimport { flushMicroTasks, flushMicroTasksLegacy } from './flush-micro-tasks';\nimport { ErrorWithStack, copyStackTrace } from './helpers/errors';\nimport {\n  setTimeout,\n  clearTimeout,\n  jestFakeTimersAreEnabled,\n} from './helpers/timers';\nimport { checkReactVersionAtLeast } from './react-versions';\n\nconst DEFAULT_INTERVAL = 50;\n\nexport type WaitForOptions = {\n  timeout?: number;\n  interval?: number;\n  stackTraceError?: ErrorWithStack;\n  onTimeout?: (error: Error) => Error;\n};\n\nfunction waitForInternal<T>(\n  expectation: () => T,\n  {\n    timeout = getConfig().asyncUtilTimeout,\n    interval = DEFAULT_INTERVAL,\n    stackTraceError,\n    onTimeout,\n  }: WaitForOptions\n): Promise<T> {\n  if (typeof expectation !== 'function') {\n    throw new TypeError('Received `expectation` arg must be a function');\n  }\n\n  // eslint-disable-next-line no-async-promise-executor\n  return new Promise(async (resolve, reject) => {\n    let lastError: unknown, intervalId: ReturnType<typeof setTimeout>;\n    let finished = false;\n    let promiseStatus = 'idle';\n\n    let overallTimeoutTimer: NodeJS.Timeout | null = null;\n\n    const usingFakeTimers = jestFakeTimersAreEnabled();\n\n    if (usingFakeTimers) {\n      checkExpectation();\n      // this is a dangerous rule to disable because it could lead to an\n      // infinite loop. However, eslint isn't smart enough to know that we're\n      // setting finished inside `onDone` which will be called when we're done\n      // waiting or when we've timed out.\n      // eslint-disable-next-line no-unmodified-loop-condition\n      let fakeTimeRemaining = timeout;\n      while (!finished) {\n        if (!jestFakeTimersAreEnabled()) {\n          const error = new Error(\n            `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`\n          );\n          if (stackTraceError) {\n            copyStackTrace(error, stackTraceError);\n          }\n          reject(error);\n          return;\n        }\n\n        // when fake timers are used we want to simulate the interval time passing\n        if (fakeTimeRemaining <= 0) {\n          handleTimeout();\n          return;\n        } else {\n          fakeTimeRemaining -= interval;\n        }\n\n        // we *could* (maybe should?) use `advanceTimersToNextTimer` but it's\n        // possible that could make this loop go on forever if someone is using\n        // third party code that's setting up recursive timers so rapidly that\n        // the user's timer's don't get a chance to resolve. So we'll advance\n        // by an interval instead. (We have a test for this case).\n        jest.advanceTimersByTime(interval);\n\n        // It's really important that checkExpectation is run *before* we flush\n        // in-flight promises. To be honest, I'm not sure why, and I can't quite\n        // think of a way to reproduce the problem in a test, but I spent\n        // an entire day banging my head against a wall on this.\n        checkExpectation();\n\n        // In this rare case, we *need* to wait for in-flight promises\n        // to resolve before continuing. We don't need to take advantage\n        // of parallelization so we're fine.\n        // https://stackoverflow.com/a/59243586/971592\n        // eslint-disable-next-line no-await-in-loop\n        await flushMicroTasks();\n      }\n    } else {\n      overallTimeoutTimer = setTimeout(handleTimeout, timeout);\n      intervalId = setInterval(checkRealTimersCallback, interval);\n      checkExpectation();\n    }\n\n    function onDone(\n      done: { type: 'result'; result: T } | { type: 'error'; error: unknown }\n    ) {\n      finished = true;\n      if (overallTimeoutTimer) {\n        clearTimeout(overallTimeoutTimer);\n      }\n\n      if (!usingFakeTimers) {\n        clearInterval(intervalId);\n      }\n\n      if (done.type === 'error') {\n        reject(done.error);\n      } else {\n        resolve(done.result);\n      }\n    }\n\n    function checkRealTimersCallback() {\n      if (jestFakeTimersAreEnabled()) {\n        const error = new Error(\n          `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`\n        );\n        if (stackTraceError) {\n          copyStackTrace(error, stackTraceError);\n        }\n        return reject(error);\n      } else {\n        return checkExpectation();\n      }\n    }\n\n    function checkExpectation() {\n      if (promiseStatus === 'pending') return;\n      try {\n        const result = expectation();\n\n        // @ts-ignore result can be a promise\n        // eslint-disable-next-line promise/prefer-await-to-then\n        if (typeof result?.then === 'function') {\n          const promiseResult: Promise<T> = result as any;\n          promiseStatus = 'pending';\n          // eslint-disable-next-line promise/catch-or-return, promise/prefer-await-to-then\n          promiseResult.then(\n            (resolvedValue) => {\n              promiseStatus = 'resolved';\n              onDone({ type: 'result', result: resolvedValue });\n              return;\n            },\n            (rejectedValue) => {\n              promiseStatus = 'rejected';\n              lastError = rejectedValue;\n              return;\n            }\n          );\n        } else {\n          onDone({ type: 'result', result: result });\n        }\n        // If `callback` throws, wait for the next mutation, interval, or timeout.\n      } catch (error) {\n        // Save the most recent callback error to reject the promise with it in the event of a timeout\n        lastError = error;\n      }\n    }\n\n    function handleTimeout() {\n      let error: Error;\n      if (lastError) {\n        if (lastError instanceof Error) {\n          error = lastError;\n        } else {\n          error = new Error(String(lastError));\n        }\n\n        if (stackTraceError) {\n          copyStackTrace(error, stackTraceError);\n        }\n      } else {\n        error = new Error('Timed out in waitFor.');\n        if (stackTraceError) {\n          copyStackTrace(error, stackTraceError);\n        }\n      }\n      if (typeof onTimeout === 'function') {\n        const result = onTimeout(error);\n        if (result) {\n          error = result;\n        }\n      }\n      onDone({ type: 'error', error });\n    }\n  });\n}\n\nexport default async function waitFor<T>(\n  expectation: () => T,\n  options?: WaitForOptions\n): Promise<T> {\n  // Being able to display a useful stack trace requires generating it before doing anything async\n  const stackTraceError = new ErrorWithStack('STACK_TRACE_ERROR', waitFor);\n  const optionsWithStackTrace = { stackTraceError, ...options };\n\n  if (checkReactVersionAtLeast(18, 0)) {\n    const previousActEnvironment = getIsReactActEnvironment();\n    setReactActEnvironment(false);\n\n    try {\n      const result = await waitForInternal(expectation, optionsWithStackTrace);\n      // Flush the microtask queue before restoring the `act` environment\n      await flushMicroTasksLegacy();\n      return result;\n    } finally {\n      setReactActEnvironment(previousActEnvironment);\n    }\n  }\n\n  if (!checkReactVersionAtLeast(16, 9)) {\n    return waitForInternal(expectation, optionsWithStackTrace);\n  }\n\n  let result: T;\n\n  await act(async () => {\n    result = await waitForInternal(expectation, optionsWithStackTrace);\n  });\n\n  // Either we have result or `waitFor` threw error\n  return result!;\n}\n"],"mappings":";;;;;;AACA,IAAAA,IAAA,GAAAC,uBAAA,CAAAC,OAAA;AACA,IAAAC,OAAA,GAAAD,OAAA;AACA,IAAAE,gBAAA,GAAAF,OAAA;AACA,IAAAG,OAAA,GAAAH,OAAA;AACA,IAAAI,OAAA,GAAAJ,OAAA;AAKA,IAAAK,cAAA,GAAAL,OAAA;AAA4D,SAAAM,yBAAAC,WAAA,eAAAC,OAAA,kCAAAC,iBAAA,OAAAD,OAAA,QAAAE,gBAAA,OAAAF,OAAA,YAAAF,wBAAA,YAAAA,CAAAC,WAAA,WAAAA,WAAA,GAAAG,gBAAA,GAAAD,iBAAA,KAAAF,WAAA;AAAA,SAAAR,wBAAAY,GAAA,EAAAJ,WAAA,SAAAA,WAAA,IAAAI,GAAA,IAAAA,GAAA,CAAAC,UAAA,WAAAD,GAAA,QAAAA,GAAA,oBAAAA,GAAA,wBAAAA,GAAA,4BAAAE,OAAA,EAAAF,GAAA,UAAAG,KAAA,GAAAR,wBAAA,CAAAC,WAAA,OAAAO,KAAA,IAAAA,KAAA,CAAAC,GAAA,CAAAJ,GAAA,YAAAG,KAAA,CAAAE,GAAA,CAAAL,GAAA,SAAAM,MAAA,WAAAC,qBAAA,GAAAC,MAAA,CAAAC,cAAA,IAAAD,MAAA,CAAAE,wBAAA,WAAAC,GAAA,IAAAX,GAAA,QAAAW,GAAA,kBAAAH,MAAA,CAAAI,SAAA,CAAAC,cAAA,CAAAC,IAAA,CAAAd,GAAA,EAAAW,GAAA,SAAAI,IAAA,GAAAR,qBAAA,GAAAC,MAAA,CAAAE,wBAAA,CAAAV,GAAA,EAAAW,GAAA,cAAAI,IAAA,KAAAA,IAAA,CAAAV,GAAA,IAAAU,IAAA,CAAAC,GAAA,KAAAR,MAAA,CAAAC,cAAA,CAAAH,MAAA,EAAAK,GAAA,EAAAI,IAAA,YAAAT,MAAA,CAAAK,GAAA,IAAAX,GAAA,CAAAW,GAAA,SAAAL,MAAA,CAAAJ,OAAA,GAAAF,GAAA,MAAAG,KAAA,IAAAA,KAAA,CAAAa,GAAA,CAAAhB,GAAA,EAAAM,MAAA,YAAAA,MAAA;AAV5D;;AAYA,MAAMW,gBAAgB,GAAG,EAAE;AAS3B,SAASC,eAAeA,CACtBC,WAAoB,EACpB;EACEC,OAAO,GAAG,IAAAC,iBAAS,EAAC,CAAC,CAACC,gBAAgB;EACtCC,QAAQ,GAAGN,gBAAgB;EAC3BO,eAAe;EACfC;AACc,CAAC,EACL;EACZ,IAAI,OAAON,WAAW,KAAK,UAAU,EAAE;IACrC,MAAM,IAAIO,SAAS,CAAC,+CAA+C,CAAC;EACtE;;EAEA;EACA,OAAO,IAAIC,OAAO,CAAC,OAAOC,OAAO,EAAEC,MAAM,KAAK;IAC5C,IAAIC,SAAkB,EAAEC,UAAyC;IACjE,IAAIC,QAAQ,GAAG,KAAK;IACpB,IAAIC,aAAa,GAAG,MAAM;IAE1B,IAAIC,mBAA0C,GAAG,IAAI;IAErD,MAAMC,eAAe,GAAG,IAAAC,gCAAwB,EAAC,CAAC;IAElD,IAAID,eAAe,EAAE;MACnBE,gBAAgB,CAAC,CAAC;MAClB;MACA;MACA;MACA;MACA;MACA,IAAIC,iBAAiB,GAAGlB,OAAO;MAC/B,OAAO,CAACY,QAAQ,EAAE;QAChB,IAAI,CAAC,IAAAI,gCAAwB,EAAC,CAAC,EAAE;UAC/B,MAAMG,KAAK,GAAG,IAAIC,KAAK,CACpB,kUACH,CAAC;UACD,IAAIhB,eAAe,EAAE;YACnB,IAAAiB,sBAAc,EAACF,KAAK,EAAEf,eAAe,CAAC;UACxC;UACAK,MAAM,CAACU,KAAK,CAAC;UACb;QACF;;QAEA;QACA,IAAID,iBAAiB,IAAI,CAAC,EAAE;UAC1BI,aAAa,CAAC,CAAC;UACf;QACF,CAAC,MAAM;UACLJ,iBAAiB,IAAIf,QAAQ;QAC/B;;QAEA;QACA;QACA;QACA;QACA;QACAoB,IAAI,CAACC,mBAAmB,CAACrB,QAAQ,CAAC;;QAElC;QACA;QACA;QACA;QACAc,gBAAgB,CAAC,CAAC;;QAElB;QACA;QACA;QACA;QACA;QACA,MAAM,IAAAQ,gCAAe,EAAC,CAAC;MACzB;IACF,CAAC,MAAM;MACLX,mBAAmB,GAAG,IAAAY,kBAAU,EAACJ,aAAa,EAAEtB,OAAO,CAAC;MACxDW,UAAU,GAAGgB,WAAW,CAACC,uBAAuB,EAAEzB,QAAQ,CAAC;MAC3Dc,gBAAgB,CAAC,CAAC;IACpB;IAEA,SAASY,MAAMA,CACbC,IAAuE,EACvE;MACAlB,QAAQ,GAAG,IAAI;MACf,IAAIE,mBAAmB,EAAE;QACvB,IAAAiB,oBAAY,EAACjB,mBAAmB,CAAC;MACnC;MAEA,IAAI,CAACC,eAAe,EAAE;QACpBiB,aAAa,CAACrB,UAAU,CAAC;MAC3B;MAEA,IAAImB,IAAI,CAACG,IAAI,KAAK,OAAO,EAAE;QACzBxB,MAAM,CAACqB,IAAI,CAACX,KAAK,CAAC;MACpB,CAAC,MAAM;QACLX,OAAO,CAACsB,IAAI,CAACI,MAAM,CAAC;MACtB;IACF;IAEA,SAASN,uBAAuBA,CAAA,EAAG;MACjC,IAAI,IAAAZ,gCAAwB,EAAC,CAAC,EAAE;QAC9B,MAAMG,KAAK,GAAG,IAAIC,KAAK,CACpB,kUACH,CAAC;QACD,IAAIhB,eAAe,EAAE;UACnB,IAAAiB,sBAAc,EAACF,KAAK,EAAEf,eAAe,CAAC;QACxC;QACA,OAAOK,MAAM,CAACU,KAAK,CAAC;MACtB,CAAC,MAAM;QACL,OAAOF,gBAAgB,CAAC,CAAC;MAC3B;IACF;IAEA,SAASA,gBAAgBA,CAAA,EAAG;MAC1B,IAAIJ,aAAa,KAAK,SAAS,EAAE;MACjC,IAAI;QACF,MAAMqB,MAAM,GAAGnC,WAAW,CAAC,CAAC;;QAE5B;QACA;QACA,IAAI,OAAOmC,MAAM,EAAEC,IAAI,KAAK,UAAU,EAAE;UACtC,MAAMC,aAAyB,GAAGF,MAAa;UAC/CrB,aAAa,GAAG,SAAS;UACzB;UACAuB,aAAa,CAACD,IAAI,CACfE,aAAa,IAAK;YACjBxB,aAAa,GAAG,UAAU;YAC1BgB,MAAM,CAAC;cAAEI,IAAI,EAAE,QAAQ;cAAEC,MAAM,EAAEG;YAAc,CAAC,CAAC;YACjD;UACF,CAAC,EACAC,aAAa,IAAK;YACjBzB,aAAa,GAAG,UAAU;YAC1BH,SAAS,GAAG4B,aAAa;YACzB;UACF,CACF,CAAC;QACH,CAAC,MAAM;UACLT,MAAM,CAAC;YAAEI,IAAI,EAAE,QAAQ;YAAEC,MAAM,EAAEA;UAAO,CAAC,CAAC;QAC5C;QACA;MACF,CAAC,CAAC,OAAOf,KAAK,EAAE;QACd;QACAT,SAAS,GAAGS,KAAK;MACnB;IACF;IAEA,SAASG,aAAaA,CAAA,EAAG;MACvB,IAAIH,KAAY;MAChB,IAAIT,SAAS,EAAE;QACb,IAAIA,SAAS,YAAYU,KAAK,EAAE;UAC9BD,KAAK,GAAGT,SAAS;QACnB,CAAC,MAAM;UACLS,KAAK,GAAG,IAAIC,KAAK,CAACmB,MAAM,CAAC7B,SAAS,CAAC,CAAC;QACtC;QAEA,IAAIN,eAAe,EAAE;UACnB,IAAAiB,sBAAc,EAACF,KAAK,EAAEf,eAAe,CAAC;QACxC;MACF,CAAC,MAAM;QACLe,KAAK,GAAG,IAAIC,KAAK,CAAC,uBAAuB,CAAC;QAC1C,IAAIhB,eAAe,EAAE;UACnB,IAAAiB,sBAAc,EAACF,KAAK,EAAEf,eAAe,CAAC;QACxC;MACF;MACA,IAAI,OAAOC,SAAS,KAAK,UAAU,EAAE;QACnC,MAAM6B,MAAM,GAAG7B,SAAS,CAACc,KAAK,CAAC;QAC/B,IAAIe,MAAM,EAAE;UACVf,KAAK,GAAGe,MAAM;QAChB;MACF;MACAL,MAAM,CAAC;QAAEI,IAAI,EAAE,OAAO;QAAEd;MAAM,CAAC,CAAC;IAClC;EACF,CAAC,CAAC;AACJ;AAEe,eAAeqB,OAAOA,CACnCzC,WAAoB,EACpB0C,OAAwB,EACZ;EACZ;EACA,MAAMrC,eAAe,GAAG,IAAIsC,sBAAc,CAAC,mBAAmB,EAAEF,OAAO,CAAC;EACxE,MAAMG,qBAAqB,GAAG;IAAEvC,eAAe;IAAE,GAAGqC;EAAQ,CAAC;EAE7D,IAAI,IAAAG,uCAAwB,EAAC,EAAE,EAAE,CAAC,CAAC,EAAE;IACnC,MAAMC,sBAAsB,GAAG,IAAAC,6BAAwB,EAAC,CAAC;IACzD,IAAAC,2BAAsB,EAAC,KAAK,CAAC;IAE7B,IAAI;MACF,MAAMb,MAAM,GAAG,MAAMpC,eAAe,CAACC,WAAW,EAAE4C,qBAAqB,CAAC;MACxE;MACA,MAAM,IAAAK,sCAAqB,EAAC,CAAC;MAC7B,OAAOd,MAAM;IACf,CAAC,SAAS;MACR,IAAAa,2BAAsB,EAACF,sBAAsB,CAAC;IAChD;EACF;EAEA,IAAI,CAAC,IAAAD,uCAAwB,EAAC,EAAE,EAAE,CAAC,CAAC,EAAE;IACpC,OAAO9C,eAAe,CAACC,WAAW,EAAE4C,qBAAqB,CAAC;EAC5D;EAEA,IAAIT,MAAS;EAEb,MAAM,IAAAe,YAAG,EAAC,YAAY;IACpBf,MAAM,GAAG,MAAMpC,eAAe,CAACC,WAAW,EAAE4C,qBAAqB,CAAC;EACpE,CAAC,CAAC;;EAEF;EACA,OAAOT,MAAM;AACf"}

package/build/waitForElementToBeRemoved.js.map

@@ -1 +1 @@
-{"version":3,"file":"waitForElementToBeRemoved.js","names":["_waitFor","_interopRequireDefault","require","_errors","obj","__esModule","default","isRemoved","result","Array","isArray","length","waitForElementToBeRemoved","expectation","options","timeoutError","ErrorWithStack","initialElements","waitFor","error"],"sources":["../src/waitForElementToBeRemoved.ts"],"sourcesContent":["import waitFor from './waitFor';\nimport type { WaitForOptions } from './waitFor';\nimport { ErrorWithStack } from './helpers/errors';\n\nfunction isRemoved<T>(result: T): boolean {\n  return !result || (Array.isArray(result) && !result.length);\n}\n\nexport default async function waitForElementToBeRemoved<T>(\n  expectation: () => T,\n  options?: WaitForOptions\n): Promise<T> {\n  // Created here so we get a nice stacktrace\n  const timeoutError = new ErrorWithStack(\n    'Timed out in waitForElementToBeRemoved.',\n    waitForElementToBeRemoved\n  );\n\n  // Elements have to be present initally and then removed.\n  const initialElements = expectation();\n  if (isRemoved(initialElements)) {\n    throw new ErrorWithStack(\n      'The element(s) given to waitForElementToBeRemoved are already removed. waitForElementToBeRemoved requires that the element(s) exist(s) before waiting for removal.',\n      waitForElementToBeRemoved\n    );\n  }\n\n  return waitFor(() => {\n    let result;\n    try {\n      result = expectation();\n    } catch (error) {\n      return initialElements;\n    }\n\n    if (!isRemoved(result)) {\n      throw timeoutError;\n    }\n\n    return initialElements;\n  }, options);\n}\n"],"mappings":";;;;;;AAAA,IAAAA,QAAA,GAAAC,sBAAA,CAAAC,OAAA;AAEA,IAAAC,OAAA,GAAAD,OAAA;AAAkD,SAAAD,uBAAAG,GAAA,WAAAA,GAAA,IAAAA,GAAA,CAAAC,UAAA,GAAAD,GAAA,KAAAE,OAAA,EAAAF,GAAA;AAElD,SAASG,SAASA,CAAIC,MAAS,EAAW;EACxC,OAAO,CAACA,MAAM,IAAKC,KAAK,CAACC,OAAO,CAACF,MAAM,CAAC,IAAI,CAACA,MAAM,CAACG,MAAO;AAC7D;AAEe,eAAeC,yBAAyBA,CACrDC,WAAoB,EACpBC,OAAwB,EACZ;EACZ;EACA,MAAMC,YAAY,GAAG,IAAIC,sBAAc,CACrC,yCAAyC,EACzCJ,yBAAyB,CAC1B;;EAED;EACA,MAAMK,eAAe,GAAGJ,WAAW,EAAE;EACrC,IAAIN,SAAS,CAACU,eAAe,CAAC,EAAE;IAC9B,MAAM,IAAID,sBAAc,CACtB,oKAAoK,EACpKJ,yBAAyB,CAC1B;EACH;EAEA,OAAO,IAAAM,gBAAO,EAAC,MAAM;IACnB,IAAIV,MAAM;IACV,IAAI;MACFA,MAAM,GAAGK,WAAW,EAAE;IACxB,CAAC,CAAC,OAAOM,KAAK,EAAE;MACd,OAAOF,eAAe;IACxB;IAEA,IAAI,CAACV,SAAS,CAACC,MAAM,CAAC,EAAE;MACtB,MAAMO,YAAY;IACpB;IAEA,OAAOE,eAAe;EACxB,CAAC,EAAEH,OAAO,CAAC;AACb"}
+{"version":3,"file":"waitForElementToBeRemoved.js","names":["_waitFor","_interopRequireDefault","require","_errors","obj","__esModule","default","isRemoved","result","Array","isArray","length","waitForElementToBeRemoved","expectation","options","timeoutError","ErrorWithStack","initialElements","waitFor","error"],"sources":["../src/waitForElementToBeRemoved.ts"],"sourcesContent":["import waitFor from './waitFor';\nimport type { WaitForOptions } from './waitFor';\nimport { ErrorWithStack } from './helpers/errors';\n\nfunction isRemoved<T>(result: T): boolean {\n  return !result || (Array.isArray(result) && !result.length);\n}\n\nexport default async function waitForElementToBeRemoved<T>(\n  expectation: () => T,\n  options?: WaitForOptions\n): Promise<T> {\n  // Created here so we get a nice stacktrace\n  const timeoutError = new ErrorWithStack(\n    'Timed out in waitForElementToBeRemoved.',\n    waitForElementToBeRemoved\n  );\n\n  // Elements have to be present initally and then removed.\n  const initialElements = expectation();\n  if (isRemoved(initialElements)) {\n    throw new ErrorWithStack(\n      'The element(s) given to waitForElementToBeRemoved are already removed. waitForElementToBeRemoved requires that the element(s) exist(s) before waiting for removal.',\n      waitForElementToBeRemoved\n    );\n  }\n\n  return waitFor(() => {\n    let result;\n    try {\n      result = expectation();\n    } catch (error) {\n      return initialElements;\n    }\n\n    if (!isRemoved(result)) {\n      throw timeoutError;\n    }\n\n    return initialElements;\n  }, options);\n}\n"],"mappings":";;;;;;AAAA,IAAAA,QAAA,GAAAC,sBAAA,CAAAC,OAAA;AAEA,IAAAC,OAAA,GAAAD,OAAA;AAAkD,SAAAD,uBAAAG,GAAA,WAAAA,GAAA,IAAAA,GAAA,CAAAC,UAAA,GAAAD,GAAA,KAAAE,OAAA,EAAAF,GAAA;AAElD,SAASG,SAASA,CAAIC,MAAS,EAAW;EACxC,OAAO,CAACA,MAAM,IAAKC,KAAK,CAACC,OAAO,CAACF,MAAM,CAAC,IAAI,CAACA,MAAM,CAACG,MAAO;AAC7D;AAEe,eAAeC,yBAAyBA,CACrDC,WAAoB,EACpBC,OAAwB,EACZ;EACZ;EACA,MAAMC,YAAY,GAAG,IAAIC,sBAAc,CACrC,yCAAyC,EACzCJ,yBACF,CAAC;;EAED;EACA,MAAMK,eAAe,GAAGJ,WAAW,CAAC,CAAC;EACrC,IAAIN,SAAS,CAACU,eAAe,CAAC,EAAE;IAC9B,MAAM,IAAID,sBAAc,CACtB,oKAAoK,EACpKJ,yBACF,CAAC;EACH;EAEA,OAAO,IAAAM,gBAAO,EAAC,MAAM;IACnB,IAAIV,MAAM;IACV,IAAI;MACFA,MAAM,GAAGK,WAAW,CAAC,CAAC;IACxB,CAAC,CAAC,OAAOM,KAAK,EAAE;MACd,OAAOF,eAAe;IACxB;IAEA,IAAI,CAACV,SAAS,CAACC,MAAM,CAAC,EAAE;MACtB,MAAMO,YAAY;IACpB;IAEA,OAAOE,eAAe;EACxB,CAAC,EAAEH,OAAO,CAAC;AACb"}

package/examples/basic/.expo-shared/assets.json

@@ -0,0 +1,4 @@
+{
+  "12bb71342c6255bbf50437ec8f4441c083f47cdb74bd89160c15e4f43e52a1cb": true,
+  "40b842e832070c58deac6aa9e08fa459302ee3f9da492c7e77d93d2fbf4a56fd": true
+}

package/examples/basic/.gitignore

@@ -0,0 +1,14 @@
+node_modules/
+.expo/
+dist/
+npm-debug.*
+*.jks
+*.p8
+*.p12
+*.key
+*.mobileprovision
+*.orig.*
+web-build/
+
+# macOS
+.DS_Store

package/examples/basic/App.tsx

@@ -0,0 +1,20 @@
+import * as React from 'react';
+import { SafeAreaView } from 'react-native';
+import { LoginForm } from './components/LoginForm';
+import { Home } from './components/Home';
+
+const App = () => {
+  const [user, setUser] = React.useState<string | null>(null);
+
+  return (
+    <SafeAreaView>
+      {user == null ? (
+        <LoginForm onLoginSuccess={setUser} />
+      ) : (
+        <Home user={user} />
+      )}
+    </SafeAreaView>
+  );
+};
+
+export default App;

package/examples/basic/README.md

@@ -0,0 +1,11 @@
+# Basic RNTL setup
+
+This example is shows a basic modern React Native Testing Library setup in a template Expo app.
+
+The app and related tests written in TypeScript, and it uses recommended practices like:
+
+- testing large pieces of application instead of small components
+- using `screen`-based queries
+- using recommended query types, e.g. `*ByText`, `*ByLabelText`, `*ByPlaceholderText` over `byTestId`
+
+You also use this repository as a reference when having issues in your RNTL configuration, as it contains the recommended Jest setup.

package/examples/basic/__tests__/App.test.tsx

@@ -0,0 +1,119 @@
+import * as React from 'react';
+import { render, screen, fireEvent } from '@testing-library/react-native';
+import App from '../App';
+
+/**
+ * A good place to start is having a tests that your component renders correctly.
+ */
+test('renders correctly', () => {
+  // Idiom: no need to capture render output, as we will use `screen` for queries.
+  render(<App />);
+
+  // Idiom: `getBy*` queries are predicates by themselves, but we will use it with `expect().toBeOnTheScreen()`
+  // to clarify our intent.
+  expect(
+    screen.getByRole('header', { name: 'Sign in to Example App' })
+  ).toBeOnTheScreen();
+});
+
+/**
+ * Hint: It's best when your tests are similar to what a manual test scenarions would look like,
+ * i.e. a series of actions taken by the user, followed by a series of assertions verified from
+ * his point of view.
+ */
+test('User can sign in successully with correct credentials', async () => {
+  // Idiom: no need to capture render output, as we will use `screen` for queries.
+  render(<App />);
+
+  // Idiom: `getBy*` queries are predicates by themselves, but we will use it with `expect().toBeOnTheScreen()`
+  // to clarify our intent.
+  expect(
+    screen.getByRole('header', { name: 'Sign in to Example App' })
+  ).toBeOnTheScreen();
+
+  // Hint: we can use `getByLabelText` to find our text inputs using their labels.
+  fireEvent.changeText(screen.getByLabelText('Username'), 'admin');
+  fireEvent.changeText(screen.getByLabelText('Password'), 'admin1');
+
+  // Hint: we can use `getByRole` to find our button with given text.
+  fireEvent.press(screen.getByRole('button', { name: 'Sign In' }));
+
+  // Idiom: since pressing button triggers async operation we need to use `findBy*` query to wait
+  // for the action to complete.
+  // Hint: subsequent queries do not need to use `findBy*`, because they are used after the async action
+  // already finished
+  expect(
+    await screen.findByRole('header', { name: 'Welcome admin!' })
+  ).toBeOnTheScreen();
+
+  // Idiom: use `queryBy*` with `expect().not.toBeOnTheScreen()` to assess that element is not present.
+  expect(
+    screen.queryByRole('header', { name: 'Sign in to Example App' })
+  ).not.toBeOnTheScreen();
+  expect(screen.queryByLabelText('Username')).not.toBeOnTheScreen();
+  expect(screen.queryByLabelText('Password')).not.toBeOnTheScreen();
+});
+
+/**
+ * Another test case based on manual test scenario.
+ *
+ * Hint: Try to tests what a user would see and do, instead of assering internal component state
+ * that is not directly reflected in the UI.
+ *
+ * For this reason prefer quries that correspond to things directly observable by the user like:
+ * `getByRole`, `getByText`, `getByLabelText`, `getByPlaceholderText, `getByDisplayValue`, etc.
+ * over `getByTestId` which is not directly observable by the user.
+ *
+ * Note: that some times you will have to resort to `getByTestId`, but treat it as a last resort.
+ */
+test('User will see errors for incorrect credentials', async () => {
+  render(<App />);
+
+  expect(
+    screen.getByRole('header', { name: 'Sign in to Example App' })
+  ).toBeOnTheScreen();
+
+  fireEvent.changeText(screen.getByLabelText('Username'), 'admin');
+  fireEvent.changeText(screen.getByLabelText('Password'), 'qwerty123');
+  fireEvent.press(screen.getByRole('button', { name: 'Sign In' }));
+
+  // Hint: you can use custom Jest Native matcher to check text content.
+  expect(await screen.findByRole('alert')).toHaveTextContent(
+    'Incorrect username or password'
+  );
+
+  expect(
+    screen.getByRole('header', { name: 'Sign in to Example App' })
+  ).toBeOnTheScreen();
+  expect(screen.getByLabelText('Username')).toBeOnTheScreen();
+  expect(screen.getByLabelText('Password')).toBeOnTheScreen();
+});
+
+/**
+ * Do not be afraid to write longer test scenarios, with repeating act and assert statements.
+ */
+test('User can sign in after incorrect attempt', async () => {
+  render(<App />);
+
+  expect(
+    screen.getByRole('header', { name: 'Sign in to Example App' })
+  ).toBeOnTheScreen();
+
+  fireEvent.changeText(screen.getByLabelText('Username'), 'admin');
+  fireEvent.changeText(screen.getByLabelText('Password'), 'qwerty123');
+  fireEvent.press(screen.getByRole('button', { name: 'Sign In' }));
+
+  expect(await screen.findByRole('alert')).toHaveTextContent(
+    'Incorrect username or password'
+  );
+
+  fireEvent.changeText(screen.getByLabelText('Password'), 'admin1');
+  fireEvent.press(screen.getByRole('button', { name: 'Sign In' }));
+
+  expect(await screen.findByText('Welcome admin!')).toBeOnTheScreen();
+  expect(
+    screen.queryByRole('header', { name: 'Sign in to Example App' })
+  ).not.toBeOnTheScreen();
+  expect(screen.queryByLabelText('Username')).not.toBeOnTheScreen();
+  expect(screen.queryByLabelText('Password')).not.toBeOnTheScreen();
+});

package/examples/basic/app.json

@@ -0,0 +1,31 @@
+{
+  "expo": {
+    "name": "RNTL Example Basic",
+    "slug": "rntl-example-basic",
+    "version": "1.0.0",
+    "orientation": "portrait",
+    "icon": "./assets/icon.png",
+    "userInterfaceStyle": "light",
+    "splash": {
+      "image": "./assets/splash.png",
+      "resizeMode": "contain",
+      "backgroundColor": "#ffffff"
+    },
+    "updates": {
+      "fallbackToCacheTimeout": 0
+    },
+    "assetBundlePatterns": ["**/*"],
+    "ios": {
+      "supportsTablet": true
+    },
+    "android": {
+      "adaptiveIcon": {
+        "foregroundImage": "./assets/adaptive-icon.png",
+        "backgroundColor": "#FFFFFF"
+      }
+    },
+    "web": {
+      "favicon": "./assets/favicon.png"
+    }
+  }
+}

package/examples/basic/babel.config.js

@@ -0,0 +1,6 @@
+module.exports = function (api) {
+  api.cache(true);
+  return {
+    presets: ['babel-preset-expo'],
+  };
+};

package/examples/basic/components/Home.tsx

@@ -0,0 +1,28 @@
+import * as React from 'react';
+import { StyleSheet, View, Text } from 'react-native';
+
+type Props = {
+  user: string;
+};
+
+export function Home({ user }: Props) {
+  return (
+    <View style={styles.container}>
+      <Text accessibilityRole="header" style={styles.title}>
+        Welcome {user}!
+      </Text>
+    </View>
+  );
+}
+
+const styles = StyleSheet.create({
+  container: {
+    padding: 20,
+  },
+  title: {
+    alignSelf: 'center',
+    fontSize: 24,
+    marginTop: 8,
+    marginBottom: 40,
+  },
+});

package/examples/basic/components/LoginForm.tsx

@@ -0,0 +1,138 @@
+import * as React from 'react';
+import {
+  StyleSheet,
+  View,
+  Text,
+  TextInput,
+  Pressable,
+  ActivityIndicator,
+} from 'react-native';
+
+type Props = {
+  onLoginSuccess: (user: string) => void;
+};
+
+export function LoginForm({ onLoginSuccess }: Props) {
+  const [username, setUsername] = React.useState('');
+  const [password, setPassword] = React.useState('');
+  const [error, setError] = React.useState<string | undefined>();
+  const [isLoading, setIsLoading] = React.useState(false);
+
+  const handleSignIn = async () => {
+    setIsLoading(true);
+
+    const user = await authUser(username, password);
+    setIsLoading(false);
+
+    if (user) {
+      setError(undefined);
+      onLoginSuccess(user);
+    } else {
+      setError('Incorrect username or password');
+    }
+  };
+
+  return (
+    <View style={styles.container}>
+      <Text accessibilityRole="header" style={styles.title}>
+        Sign in to Example App
+      </Text>
+
+      <Text style={styles.textLabel}>Username</Text>
+      <TextInput
+        value={username}
+        onChangeText={setUsername}
+        accessibilityLabel="Username"
+        autoCapitalize="none"
+        style={styles.textInput}
+      />
+
+      <Text style={styles.textLabel}>Password</Text>
+      <TextInput
+        value={password}
+        onChangeText={setPassword}
+        accessibilityLabel="Password"
+        secureTextEntry={true}
+        style={styles.textInput}
+      />
+
+      {error && (
+        <Text accessibilityRole="alert" style={styles.validator}>
+          {error}
+        </Text>
+      )}
+
+      <Pressable
+        accessibilityRole="button"
+        disabled={isLoading}
+        onPress={handleSignIn}
+        style={styles.button}
+      >
+        {isLoading ? (
+          <ActivityIndicator color="white" />
+        ) : (
+          <Text style={styles.buttonText}>Sign In</Text>
+        )}
+      </Pressable>
+    </View>
+  );
+}
+
+/**
+ * Fake authentication function according to our abilities.
+ * @param username The username to authenticate.
+ * @param password The password to authenticate.
+ * @returns username if the username and password are correct, null otherwise.
+ */
+async function authUser(
+  username: string,
+  password: string
+): Promise<string | null> {
+  return new Promise((resolve) =>
+    setTimeout(() => {
+      const hasValidCredentials = username === 'admin' && password === 'admin1';
+      resolve(hasValidCredentials ? username : null);
+    }, 250)
+  );
+}
+
+const styles = StyleSheet.create({
+  container: {
+    padding: 20,
+  },
+  title: {
+    alignSelf: 'center',
+    fontSize: 24,
+    marginTop: 8,
+    marginBottom: 40,
+  },
+  textLabel: {
+    fontSize: 16,
+    color: '#444',
+  },
+  textInput: {
+    fontSize: 20,
+    padding: 8,
+    marginVertical: 8,
+    borderColor: 'black',
+    borderWidth: 1,
+  },
+  button: {
+    backgroundColor: '#3256a8',
+    padding: 16,
+    alignItems: 'center',
+    justifyContent: 'center',
+    marginTop: 20,
+    minHeight: 56,
+  },
+  buttonText: {
+    fontSize: 20,
+    fontWeight: '600',
+    color: 'white',
+  },
+  validator: {
+    color: 'red',
+    fontSize: 18,
+    marginTop: 8,
+  },
+});

package/examples/basic/jest-setup.ts

@@ -0,0 +1,7 @@
+/* eslint-disable no-undef, import/no-extraneous-dependencies */
+
+// Import Jest Native matchers
+import '@testing-library/jest-native/extend-expect';
+
+// Silence the warning: Animated: `useNativeDriver` is not supported because the native animated module is missing
+jest.mock('react-native/Libraries/Animated/NativeAnimatedHelper');

package/examples/basic/jest.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+  preset: '@testing-library/react-native',
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json'],
+  setupFilesAfterEnv: ['./jest-setup.ts'],
+};

package/examples/basic/package.json

@@ -0,0 +1,30 @@
+{
+  "main": "node_modules/expo/AppEntry.js",
+  "scripts": {
+    "start": "expo start",
+    "android": "expo start --android",
+    "ios": "expo start --ios",
+    "web": "expo start --web",
+    "eject": "expo eject",
+    "test": "jest",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "expo": "^48.0.0",
+    "expo-status-bar": "~1.4.4",
+    "react": "18.2.0",
+    "react-dom": "18.2.0",
+    "react-native": "0.71.3",
+    "react-native-web": "~0.18.11"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.20.0",
+    "@testing-library/jest-native": "^5.4.2",
+    "@testing-library/react-native": "^12.1.2",
+    "@types/react": "~18.2.6",
+    "jest": "^29.3.0",
+    "react-test-renderer": "18.2.0",
+    "typescript": "^5.0.4"
+  },
+  "private": true
+}

package/examples/basic/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "expo/tsconfig.base",
+  "compilerOptions": {
+    "strict": true,
+    "allowJs": false
+  }
+}

package/examples/react-navigation/README.md

@@ -0,0 +1,14 @@
+# RNTL example app for React Navigation
+
+This example shows how to write integration tests using React Navigation without mocking it. Presented approach has been consulted with and influenced by React Navigation team.
+
+## Recommended tests
+
+There are two types of recommeded tests:
+1. Tests operating on navigator level - these use `renderNavigator` helper to render a navigator component used in the app. It is useful when you want to test a scenario that includes multiple screens.
+2. Tests operating on single screen level - these use regular `render` helper but require refactoring screen components into `Screen` and `ScreenContent` components. Where `Screen` receives React Navigation props and/or uses hooks like `useNavigation` while `ScreenContent` does not have a direct relation to React Navigation API but gets props from `Screen` and calls relevant callbacks to trigger navigation.
+
+## Non-recommended tests
+
+There also exists another popular type of screen level tests, where users mock React Navigation objects like `navigation`, `route` and/or hooks like  `useNavigation`, etc. We don't recommend this way of testing. **Mocking internal parts of the libraries is effectively testing implementation details, which goes against the Testing Library's [Guiding Principles](https://testing-library.com/docs/guiding-principles/)**.
+

package/examples/react-navigation/babel.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+  presets: ['module:metro-react-native-babel-preset'],
+  plugins: ['react-native-reanimated/plugin'],
+};

package/examples/react-navigation/jest-setup.js

@@ -0,0 +1,11 @@
+/* eslint-disable no-undef, import/no-extraneous-dependencies */
+
+// Import Jest Native matchers
+import '@testing-library/jest-native/extend-expect';
+
+// Silence the warning: Animated: `useNativeDriver` is not supported because the native animated module is missing
+jest.mock('react-native/Libraries/Animated/NativeAnimatedHelper');
+
+// Setup Reanimated mocking for Drawer navigation
+global.ReanimatedDataMock = { now: () => Date.now() };
+require('react-native-reanimated/lib/reanimated2/jestUtils').setUpTests();

package/examples/react-navigation/jest.config.js

@@ -0,0 +1,10 @@
+module.exports = {
+  preset: 'react-native',
+  setupFilesAfterEnv: [
+    './node_modules/react-native-gesture-handler/jestSetup.js',
+    './jest-setup.js',
+  ],
+  transformIgnorePatterns: [
+    'node_modules/(?!(jest-)?react-native|@react-native|@react-native-community|@react-navigation)',
+  ],
+};

package/examples/react-navigation/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "react-navigation-example",
+  "description": "Testing React Navigation with RNTL",
+  "version": "0.0.1",
+  "private": true,
+  "scripts": {
+    "test": "jest"
+  },
+  "dependencies": {
+    "@react-navigation/bottom-tabs": "^6.4.1",
+    "@react-navigation/drawer": "^6.5.1",
+    "@react-navigation/native": "^6.0.14",
+    "@react-navigation/native-stack": "^6.9.2",
+    "@react-navigation/stack": "^6.3.5",
+    "react": "^18.1.0",
+    "react-native": "^0.70.6",
+    "react-native-gesture-handler": "^2.8.0",
+    "react-native-reanimated": "^2.13.0",
+    "react-native-safe-area-context": "^4.4.1",
+    "react-native-screens": "^3.18.2"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.20.2",
+    "@testing-library/jest-native": "^5.4.0",
+    "@testing-library/react-native": "^11.5.0",
+    "babel-jest": "^29.3.1",
+    "jest": "^29.3.0",
+    "metro-react-native-babel-preset": "^0.72.3",
+    "react-test-renderer": "^18.1.0"
+  }
+}

package/examples/react-navigation/src/App.js

@@ -0,0 +1,21 @@
+import React from 'react';
+import { StatusBar, StyleSheet, View } from 'react-native';
+import { NavigationContainer } from '@react-navigation/native';
+import AppNavigator from './NativeStackNavigator';
+
+export default function App() {
+  return (
+    <NavigationContainer>
+      <View style={styles.container}>
+        <StatusBar barStyle="dark-content" />
+        <AppNavigator />
+      </View>
+    </NavigationContainer>
+  );
+}
+
+const styles = StyleSheet.create({
+  container: {
+    flex: 1,
+  },
+});

package/examples/react-navigation/src/DrawerNavigator.js

@@ -0,0 +1,15 @@
+import * as React from 'react';
+import { createDrawerNavigator } from '@react-navigation/drawer';
+import DrawerHomeScreen from './screens/DrawerHomeScreen';
+import SettingsScreen from './screens/SettingsScreen';
+
+const Drawer = createDrawerNavigator();
+
+export default function Navigation() {
+  return (
+    <Drawer.Navigator>
+      <Drawer.Screen name="Home" component={DrawerHomeScreen} />
+      <Drawer.Screen name="Settings" component={SettingsScreen} />
+    </Drawer.Navigator>
+  );
+}