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

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

"use strict";
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
const helpers = require("./helpers.cjs");
const mutationObserver = require("./mutation-observer.cjs");
const config = require("./config.cjs");
function copyStackTrace(target, source) {
  target.stack = source.stack.replace(source.message, target.message);
}
function waitFor(callback, {
  instance = helpers.getCurrentInstance(),
  timeout = config.getConfig().asyncUtilTimeout,
  showOriginalStackTrace = config.getConfig().showOriginalStackTrace,
  stackTraceError,
  interval = 50,
  onTimeout = (error) => {
    error.message = config.getConfig().getInstanceError(
      error.message,
      instance
    ).message;
    return error;
  }
} = {
  stackTraceError: new Error("STACK_TRACE_MESSAGE")
}) {
  if (typeof callback !== "function") {
    throw new TypeError("Received `callback` arg must be a function");
  }
  return new Promise(async (resolve, reject) => {
    let lastError = null;
    let intervalId;
    let observer;
    let finished = false;
    let promiseStatus = "idle";
    const overallTimeoutTimer = setTimeout(handleTimeout, timeout);
    const usingJestFakeTimers = helpers.jestFakeTimersAreEnabled();
    if (usingJestFakeTimers) {
      const { unstable_advanceTimersWrapper: advanceTimersWrapper } = config.getConfig();
      checkCallback();
      while (!finished) {
        if (!helpers.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 (!showOriginalStackTrace) copyStackTrace(error, stackTraceError);
          reject(error);
          return;
        }
        advanceTimersWrapper(() => {
          if (typeof jest !== "undefined") {
            jest.advanceTimersByTime(interval);
          } else if (typeof vi !== "undefined") {
            vi.advanceTimersByTime(interval);
          }
        });
        checkCallback();
        await advanceTimersWrapper(async () => {
          await new Promise((r) => {
            setTimeout(r, 0);
            if (typeof jest !== "undefined") jest.advanceTimersByTime(0);
            else if (typeof vi !== "undefined") vi.advanceTimersByTime(0);
          });
        });
      }
    } else {
      intervalId = setInterval(checkRealTimersCallback, interval);
      observer = new mutationObserver.MutationObserver(checkRealTimersCallback);
      observer.observe();
      checkCallback();
    }
    function onDone(error, result) {
      finished = true;
      clearTimeout(overallTimeoutTimer);
      if (!usingJestFakeTimers) {
        clearInterval(intervalId);
        observer.disconnect();
      }
      if (error) {
        reject(error);
      } else {
        resolve(result);
      }
    }
    function checkRealTimersCallback() {
      if (helpers.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 (!showOriginalStackTrace) copyStackTrace(error, stackTraceError);
        return reject(error);
      } else {
        return checkCallback();
      }
    }
    function checkCallback() {
      if (promiseStatus === "pending") return;
      try {
        const result = callback();
        const isPromise = (r) => !!r && typeof r.then === "function";
        if (isPromise(result)) {
          promiseStatus = "pending";
          result.then(
            (resolvedValue) => {
              promiseStatus = "resolved";
              onDone(null, resolvedValue);
            },
            (rejectedValue) => {
              promiseStatus = "rejected";
              lastError = rejectedValue;
            }
          );
        } else {
          onDone(null, result);
        }
      } catch (error) {
        lastError = error;
      }
    }
    function handleTimeout() {
      let error;
      if (lastError) {
        error = lastError;
        if (!showOriginalStackTrace && error.name === "TestingLibraryElementError") {
          copyStackTrace(error, stackTraceError);
        }
      } else {
        error = new Error("Timed out in waitFor.");
        if (!showOriginalStackTrace) {
          copyStackTrace(error, stackTraceError);
        }
      }
      onDone(onTimeout(error), null);
    }
  });
}
function waitForWrapper(callback, options) {
  const stackTraceError = new Error("STACK_TRACE_MESSAGE");
  return waitFor(callback, { stackTraceError, ...options });
}
exports.waitFor = waitForWrapper;
//# sourceMappingURL=wait-for.cjs.map