cli-testing-library/dist/cjs/wait-for.cjs.map

Simple and complete CLI testing utilities that encourage good testing practices.

{"version":3,"file":"wait-for.cjs","sources":["../../src/wait-for.ts"],"sourcesContent":["// Migrated from: https://github.com/testing-library/dom-testing-library/blob/main/src/wait-for.js\n// TODO: Migrate back to use `config.js` file\nimport { getCurrentInstance, jestFakeTimersAreEnabled } from \"./helpers\";\nimport { MutationObserver } from \"./mutation-observer\";\nimport { getConfig } from \"./config\";\nimport type { TestInstance } from \"./types\";\n\n// This is so the stack trace the developer sees is one that's\n// closer to their code (because async stack traces are hard to follow).\nfunction copyStackTrace(target: Error, source: Error) {\n  target.stack = source.stack!.replace(source.message, target.message);\n}\n\nexport interface waitForOptions {\n  instance?: TestInstance;\n  showOriginalStackTrace?: boolean;\n  timeout?: number;\n  interval?: number;\n  onTimeout?: (error: Error) => Error;\n  stackTraceError?: Error;\n}\n\nfunction waitFor<T>(\n  callback: () => Promise<T> | T,\n  {\n    instance = getCurrentInstance(),\n    timeout = getConfig().asyncUtilTimeout,\n    showOriginalStackTrace = getConfig().showOriginalStackTrace,\n    stackTraceError,\n    interval = 50,\n    onTimeout = (error) => {\n      error.message = getConfig().getInstanceError(\n        error.message,\n        instance!,\n      ).message;\n      return error;\n    },\n  }: Omit<waitForOptions, \"stackTraceError\"> & {\n    stackTraceError: Error;\n  } = {\n    stackTraceError: new Error(\"STACK_TRACE_MESSAGE\"),\n  },\n): Promise<T> {\n  if (typeof callback !== \"function\") {\n    throw new TypeError(\"Received `callback` 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: Error | null = null;\n    let intervalId!: NodeJS.Timeout;\n    let observer: MutationObserver;\n    let finished = false;\n    let promiseStatus = \"idle\";\n\n    const overallTimeoutTimer = setTimeout(handleTimeout, timeout);\n\n    const usingJestFakeTimers = jestFakeTimersAreEnabled();\n    if (usingJestFakeTimers) {\n      const { unstable_advanceTimersWrapper: advanceTimersWrapper } =\n        getConfig();\n      checkCallback();\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\n      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\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 (!showOriginalStackTrace) copyStackTrace(error, stackTraceError);\n          reject(error);\n          return;\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        advanceTimersWrapper(() => {\n          if (typeof jest !== \"undefined\") {\n            jest.advanceTimersByTime(interval);\n          } else if (typeof vi !== \"undefined\") {\n            vi.advanceTimersByTime(interval);\n          }\n        });\n\n        // It's really important that checkCallback 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        checkCallback();\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\n        await advanceTimersWrapper(async () => {\n          await new Promise((r) => {\n            setTimeout(r, 0);\n            if (typeof jest !== \"undefined\") jest.advanceTimersByTime(0);\n            else if (typeof vi !== \"undefined\") vi.advanceTimersByTime(0);\n          });\n        });\n      }\n    } else {\n      intervalId = setInterval(checkRealTimersCallback, interval);\n      observer = new MutationObserver(checkRealTimersCallback);\n      observer.observe();\n      checkCallback();\n    }\n\n    function onDone(error: null, result: T): void;\n    function onDone(error: Error, result: null): void;\n    function onDone(error: Error | null, result: T | null) {\n      finished = true;\n      clearTimeout(overallTimeoutTimer);\n\n      if (!usingJestFakeTimers) {\n        clearInterval(intervalId);\n        observer.disconnect();\n      }\n\n      if (error) {\n        reject(error);\n      } else {\n        resolve(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 (!showOriginalStackTrace) copyStackTrace(error, stackTraceError);\n        return reject(error);\n      } else {\n        return checkCallback();\n      }\n    }\n\n    function checkCallback() {\n      if (promiseStatus === \"pending\") return;\n      try {\n        const result = callback(); // runWithExpensiveErrorDiagnosticsDisabled(callback)\n        const isPromise = (r: unknown): r is Promise<T> =>\n          !!r && typeof (r as Promise<T>).then === \"function\";\n        if (isPromise(result)) {\n          promiseStatus = \"pending\";\n          result.then(\n            (resolvedValue) => {\n              promiseStatus = \"resolved\";\n              onDone(null, resolvedValue);\n            },\n            (rejectedValue) => {\n              promiseStatus = \"rejected\";\n              lastError = rejectedValue;\n            },\n          );\n        } else {\n          onDone(null, 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 as Error;\n      }\n    }\n\n    function handleTimeout() {\n      let error;\n      if (lastError) {\n        error = lastError;\n        if (\n          !showOriginalStackTrace &&\n          error.name === \"TestingLibraryElementError\"\n        ) {\n          copyStackTrace(error, stackTraceError);\n        }\n      } else {\n        error = new Error(\"Timed out in waitFor.\");\n        if (!showOriginalStackTrace) {\n          copyStackTrace(error, stackTraceError);\n        }\n      }\n      onDone(onTimeout(error), null);\n    }\n  });\n}\n\nfunction waitForWrapper<T>(\n  callback: () => Promise<T> | T,\n  options?: waitForOptions,\n): Promise<T> {\n  // create the error here so its stack trace is as close to the\n  // calling code as possible\n  const stackTraceError = new Error(\"STACK_TRACE_MESSAGE\");\n  return waitFor(callback, { stackTraceError, ...options });\n}\n\nexport { waitForWrapper as waitFor };\n"],"names":["getCurrentInstance","getConfig","jestFakeTimersAreEnabled","MutationObserver"],"mappings":";;;;;AASA,SAAS,eAAe,QAAe,QAAe;AACpD,SAAO,QAAQ,OAAO,MAAO,QAAQ,OAAO,SAAS,OAAO,OAAO;AACrE;AAWA,SAAS,QACP,UACA;AAAA,EACE,WAAWA,QAAAA,mBAAmB;AAAA,EAC9B,UAAUC,mBAAY;AAAA,EACtB,yBAAyBA,mBAAY;AAAA,EACrC;AAAA,EACA,WAAW;AAAA,EACX,YAAY,CAAC,UAAU;AACf,UAAA,UAAUA,mBAAY;AAAA,MAC1B,MAAM;AAAA,MACN;AAAA,IAAA,EACA;AACK,WAAA;AAAA,EAAA;AAEX,IAEI;AAAA,EACF,iBAAiB,IAAI,MAAM,qBAAqB;AAClD,GACY;AACR,MAAA,OAAO,aAAa,YAAY;AAC5B,UAAA,IAAI,UAAU,4CAA4C;AAAA,EAAA;AAIlE,SAAO,IAAI,QAAQ,OAAO,SAAS,WAAW;AAC5C,QAAI,YAA0B;AAC1B,QAAA;AACA,QAAA;AACJ,QAAI,WAAW;AACf,QAAI,gBAAgB;AAEd,UAAA,sBAAsB,WAAW,eAAe,OAAO;AAE7D,UAAM,sBAAsBC,QAAAA,yBAAyB;AACrD,QAAI,qBAAqB;AACvB,YAAM,EAAE,+BAA+B,qBAAqB,IAC1DD,iBAAU;AACE,oBAAA;AAOd,aAAO,CAAC,UAAU;AACZ,YAAA,CAACC,oCAA4B;AAC/B,gBAAM,QAAQ,IAAI;AAAA,YAChB;AAAA,UACF;AACA,cAAI,CAAC,uBAAuC,gBAAA,OAAO,eAAe;AAClE,iBAAO,KAAK;AACZ;AAAA,QAAA;AAOF,6BAAqB,MAAM;AACrB,cAAA,OAAO,SAAS,aAAa;AAC/B,iBAAK,oBAAoB,QAAQ;AAAA,UAAA,WACxB,OAAO,OAAO,aAAa;AACpC,eAAG,oBAAoB,QAAQ;AAAA,UAAA;AAAA,QACjC,CACD;AAMa,sBAAA;AAOd,cAAM,qBAAqB,YAAY;AAC/B,gBAAA,IAAI,QAAQ,CAAC,MAAM;AACvB,uBAAW,GAAG,CAAC;AACf,gBAAI,OAAO,SAAS,YAAa,MAAK,oBAAoB,CAAC;AAAA,qBAClD,OAAO,OAAO,YAAa,IAAG,oBAAoB,CAAC;AAAA,UAAA,CAC7D;AAAA,QAAA,CACF;AAAA,MAAA;AAAA,IACH,OACK;AACQ,mBAAA,YAAY,yBAAyB,QAAQ;AAC/C,iBAAA,IAAIC,kCAAiB,uBAAuB;AACvD,eAAS,QAAQ;AACH,oBAAA;AAAA,IAAA;AAKP,aAAA,OAAO,OAAqB,QAAkB;AAC1C,iBAAA;AACX,mBAAa,mBAAmB;AAEhC,UAAI,CAAC,qBAAqB;AACxB,sBAAc,UAAU;AACxB,iBAAS,WAAW;AAAA,MAAA;AAGtB,UAAI,OAAO;AACT,eAAO,KAAK;AAAA,MAAA,OACP;AACL,gBAAQ,MAAO;AAAA,MAAA;AAAA,IACjB;AAGF,aAAS,0BAA0B;AACjC,UAAID,oCAA4B;AAC9B,cAAM,QAAQ,IAAI;AAAA,UAChB;AAAA,QACF;AACA,YAAI,CAAC,uBAAuC,gBAAA,OAAO,eAAe;AAClE,eAAO,OAAO,KAAK;AAAA,MAAA,OACd;AACL,eAAO,cAAc;AAAA,MAAA;AAAA,IACvB;AAGF,aAAS,gBAAgB;AACvB,UAAI,kBAAkB,UAAW;AAC7B,UAAA;AACF,cAAM,SAAS,SAAS;AAClB,cAAA,YAAY,CAAC,MACjB,CAAC,CAAC,KAAK,OAAQ,EAAiB,SAAS;AACvC,YAAA,UAAU,MAAM,GAAG;AACL,0BAAA;AACT,iBAAA;AAAA,YACL,CAAC,kBAAkB;AACD,8BAAA;AAChB,qBAAO,MAAM,aAAa;AAAA,YAC5B;AAAA,YACA,CAAC,kBAAkB;AACD,8BAAA;AACJ,0BAAA;AAAA,YAAA;AAAA,UAEhB;AAAA,QAAA,OACK;AACL,iBAAO,MAAM,MAAM;AAAA,QAAA;AAAA,eAGd,OAAO;AAEF,oBAAA;AAAA,MAAA;AAAA,IACd;AAGF,aAAS,gBAAgB;AACnB,UAAA;AACJ,UAAI,WAAW;AACL,gBAAA;AACR,YACE,CAAC,0BACD,MAAM,SAAS,8BACf;AACA,yBAAe,OAAO,eAAe;AAAA,QAAA;AAAA,MACvC,OACK;AACG,gBAAA,IAAI,MAAM,uBAAuB;AACzC,YAAI,CAAC,wBAAwB;AAC3B,yBAAe,OAAO,eAAe;AAAA,QAAA;AAAA,MACvC;AAEK,aAAA,UAAU,KAAK,GAAG,IAAI;AAAA,IAAA;AAAA,EAC/B,CACD;AACH;AAEA,SAAS,eACP,UACA,SACY;AAGN,QAAA,kBAAkB,IAAI,MAAM,qBAAqB;AACvD,SAAO,QAAQ,UAAU,EAAE,iBAAiB,GAAG,SAAS;AAC1D;;"}