@stryker-mutator/core/src/test-runner/timeout-decorator.ts

The extendable JavaScript mutation testing framework

import {
  DryRunStatus,
  DryRunResult,
  DryRunOptions,
  MutantRunOptions,
  MutantRunResult,
  MutantRunStatus,
  TestRunner,
} from '@stryker-mutator/api/test-runner';
import { ExpirableTask } from '@stryker-mutator/util';

import { TestRunnerDecorator } from './test-runner-decorator.js';
import { Logger } from '@stryker-mutator/api/logging';

/**
 * Wraps a test runner and implements the timeout functionality.
 */
export class TimeoutDecorator extends TestRunnerDecorator {
  constructor(
    private readonly log: Logger,
    producer: () => TestRunner,
  ) {
    super(producer);
  }

  public async dryRun(options: DryRunOptions): Promise<DryRunResult> {
    const result = await this.run(options, () => super.dryRun(options));
    if (result === ExpirableTask.TimeoutExpired) {
      return {
        status: DryRunStatus.Timeout,
      };
    } else {
      return result;
    }
  }

  public async mutantRun(options: MutantRunOptions): Promise<MutantRunResult> {
    const result = await this.run(options, () => super.mutantRun(options));
    if (result === ExpirableTask.TimeoutExpired) {
      return {
        status: MutantRunStatus.Timeout,
      };
    } else {
      return result;
    }
  }

  private async run<TResult>(
    options: { timeout: number },
    actRun: () => Promise<TResult>,
  ): Promise<TResult | typeof ExpirableTask.TimeoutExpired> {
    this.log.debug(
      'Starting timeout timer (%s ms) for a test run',
      options.timeout,
    );
    const result = await ExpirableTask.timeout(actRun(), options.timeout);
    if (result === ExpirableTask.TimeoutExpired) {
      await this.handleTimeout();
      return result;
    } else {
      return result;
    }
  }

  private async handleTimeout(): Promise<void> {
    this.log.debug(
      'Timeout expired, restarting the process and reporting timeout',
    );
    await this.recover();
  }
}