logos-delivery-js/packages/tests/src/utils/custom_mocha_hooks.ts

import { Logger } from "@waku/utils";
import { Suite } from "mocha";

import { MOCHA_HOOK_MAX_TIMEOUT } from "../constants";
const log = new Logger("test:mocha-hook");

function withGracefulTimeout(
  asyncOperation: () => Promise<void>,
  doneCallback: (error?: unknown) => void,
  timeoutDuration = MOCHA_HOOK_MAX_TIMEOUT
): void {
  let operationCompleted = false;

  const wrapperOperation: () => Promise<void> = async () => {
    try {
      await asyncOperation();
      if (!operationCompleted) {
        operationCompleted = true;
        log.info("Mocha hook completed successfully.");
        doneCallback();
      }
    } catch (error) {
      if (!operationCompleted) {
        operationCompleted = true;
        log.error(
          "Mocha hook failed. Proceeding to the test so it can retry.",
          error
        );
        doneCallback();
      }
    }
  };

  void wrapperOperation();
  setTimeout(() => {
    if (!operationCompleted) {
      log.info(
        "Custom timeout reached. Proceeding to the test so it can retry."
      );
      operationCompleted = true;
      doneCallback();
    }
  }, timeoutDuration);
}

export const beforeEachCustom = function (
  suite: Suite,
  cb: () => Promise<void>,
  timeout = MOCHA_HOOK_MAX_TIMEOUT
): void {
  const timeoutBefore = suite.timeout();
  suite.timeout(timeout);
  suite.beforeEach((done) => {
    withGracefulTimeout(cb, done, timeout);
  });
  suite.timeout(timeoutBefore); // restore timeout to the original value
};

export const afterEachCustom = function (
  suite: Suite,
  cb: () => Promise<void>,
  timeout = MOCHA_HOOK_MAX_TIMEOUT
): void {
  const timeoutBefore = suite.timeout();
  suite.timeout(timeout);
  suite.afterEach((done) => {
    withGracefulTimeout(cb, done, timeout);
  });
  suite.timeout(timeoutBefore); // restore timeout to the original value
};