hardhat/src/internal/builtin-plugins/solidity-test/runner.ts

Hardhat is an extensible developer tool that helps smart contract developers increase productivity by reliably bringing together the tools they want.

import type { TestEvent, TestsStream } from "./types.js";
import type { ChainType } from "../../../types/network.js";
import type {
  ArtifactId,
  Artifact,
  SolidityTestRunnerConfigArgs,
  TracingConfigWithBuffers,
} from "@nomicfoundation/edr";

import { Readable } from "node:stream";

import { HardhatError } from "@nomicfoundation/hardhat-errors";
import { ensureError } from "@nomicfoundation/hardhat-utils/error";

import { hardhatChainTypeToEdrChainType } from "../../edr/chain-type.js";
import { getGlobalEdrContext } from "../../edr/context.js";

import { formatArtifactId } from "./formatters.js";

export interface RunOptions {
  /**
   * The maximum time in milliseconds to wait for all the test suites to finish.
   */
  timeout?: number;
}

/**
 * Run all the given solidity tests and returns the stream of results.
 *
 * It returns a Readable stream that emits the test events similarly to how the
 * node test runner does it.
 *
 * The stream is closed when all the test suites have been run.
 *
 * This function, initially, was a direct port of the example v2 integration in
 * the EDR repo (see  https://github.com/NomicFoundation/edr/blob/main/js/helpers/src/index.ts).
 *
 * Despite the changes, the signature of the function should still be considered
 * a draft that may change in the future.
 *
 * TODO: Once the signature is finalised, give feedback to the EDR team.
 */
export function run(
  chainType: ChainType,
  artifacts: Artifact[],
  testSuiteIds: ArtifactId[],
  configArgs: SolidityTestRunnerConfigArgs,
  tracingConfig: TracingConfigWithBuffers,
  sourceNameToUserSourceName: Map<string, string>,
  options?: RunOptions,
): TestsStream {
  const stream = new ReadableStream<TestEvent>({
    async start(controller) {
      if (testSuiteIds.length === 0) {
        controller.close();
        return;
      }
      let runCompleted = false;

      const remainingSuites = new Set(
        testSuiteIds.map((id) =>
          formatArtifactId(id, sourceNameToUserSourceName),
        ),
      );

      let timeout: NodeJS.Timeout | undefined;
      if (options?.timeout !== undefined) {
        timeout = setTimeout(() => {
          controller.error(
            new HardhatError(
              HardhatError.ERRORS.CORE.SOLIDITY_TESTS.RUNNER_TIMEOUT,
              {
                duration: options.timeout,
                suites: Array.from(remainingSuites).join(", "),
              },
            ),
          );
        }, options.timeout);
      }

      // TODO: Add support for predeploys once EDR supports them.
      try {
        const edrContext = await getGlobalEdrContext();
        const solidityTestResult = await edrContext.runSolidityTests(
          hardhatChainTypeToEdrChainType(chainType),
          artifacts,
          testSuiteIds,
          configArgs,
          tracingConfig,
          (suiteResult) => {
            controller.enqueue({
              type: "suite:done",
              data: suiteResult,
            });
            remainingSuites.delete(
              formatArtifactId(suiteResult.id, sourceNameToUserSourceName),
            );
            if (remainingSuites.size === 0) {
              clearTimeout(timeout);

              if (runCompleted) {
                controller.close();
              }
            }
          },
        );
        controller.enqueue({
          type: "run:done",
          data: solidityTestResult,
        });
        runCompleted = true;

        if (remainingSuites.size === 0) {
          controller.close();
        }
      } catch (error) {
        ensureError(error);

        clearTimeout(timeout);

        controller.error(
          new HardhatError(
            HardhatError.ERRORS.CORE.SOLIDITY_TESTS.UNHANDLED_EDR_ERROR_SOLIDITY_TESTS,
            {
              error: error.message,
            },
          ),
        );
      }
    },
  });

  return Readable.from(stream);
}