Function createRunnerFunction

packages/plugin-axe/src/lib/runner/runner.ts:15–58

(
  urls: string[],
  ruleIds: string[],
  timeout: number,
  setupScript?: string,
)

/** Creates a runner function that executes Axe accessibility audits for given URLs. */
export function createRunnerFunction(
  urls: string[],
  ruleIds: string[],
  timeout: number,
  setupScript?: string,
): RunnerFunction {
  return async (): Promise<AuditOutputs> => {
    const runner = new AxeRunner();
    const urlsCount = urls.length;

    logger.info(
      `Running Axe accessibility checks for ${pluralizeToken('URL', urlsCount)} ...`,
    );

    try {
      if (setupScript) {
        const setupFn = await loadSetupScript(setupScript);
        await runner.captureAuthState(setupFn, timeout);
      }

      const results = await asyncSequential(
        urls,
        async (url, urlIndex): Promise<AxeUrlResult | null> =>
          runForUrl(runner, { urlsCount, ruleIds, timeout, url, urlIndex }),
      );

      const collectedResults = results.filter(res => res != null);
      const auditOutputs = collectedResults.flatMap(res => res.auditOutputs);
      if (collectedResults.length === 0) {
        throw new Error(
          shouldExpandForUrls(urlsCount)
            ? 'Axe failed to produce results for all URLs.'
            : 'Axe did not produce any results.',
        );
      }

      logResultsForAllUrls(collectedResults);

      return auditOutputs;
    } finally {
      await runner.close();
    }
  };
}

async function runForUrl(
  runner: AxeRunner,