creevey 0.9.0-non-webpack.2.fix-capture-element → 0.9.1

package/src/server/master/index.ts

@@ -0,0 +1,111 @@
+import path from 'path';
+import { existsSync } from 'fs';
+import { fileURLToPath, pathToFileURL } from 'url';
+import { copyFile, readdir, mkdir, writeFile } from 'fs/promises';
+import master from './master.js';
+import creeveyApi, { CreeveyApi } from './api.js';
+import { Config, Options, TestData, isDefined } from '../../types.js';
+import { shutdown, shutdownWorkers, testsToImages, readDirRecursive } from '../utils.js';
+import { subscribeOn } from '../messages.js';
+import Runner from './runner.js';
+import { logger } from '../logger.js';
+import { sendScreenshotsCount } from '../telemetry.js';
+
+const importMetaUrl = pathToFileURL(__filename).href;
+
+async function copyStatics(reportDir: string): Promise<void> {
+  const clientDir = path.join(path.dirname(fileURLToPath(importMetaUrl)), '../../client/web');
+  const files = (await readdir(clientDir, { withFileTypes: true }))
+    .filter((dirent) => dirent.isFile() && !dirent.name.endsWith('.d.ts') && !dirent.name.endsWith('.tsx'))
+    .map((dirent) => dirent.name);
+  await mkdir(reportDir, { recursive: true });
+  for (const file of files) {
+    await copyFile(path.join(clientDir, file), path.join(reportDir, file));
+  }
+}
+
+function reportDataModule(data: Partial<Record<string, TestData>>): string {
+  return `
+(function (root, factory) {
+  if (typeof module === 'object' && module.exports) {
+    module.exports = factory();
+  } else {
+    root.__CREEVEY_DATA__ = factory();
+  }
+}(this, function () { return ${JSON.stringify(data)} }));
+`;
+}
+
+function outputUnnecessaryImages(imagesDir: string, images: Set<string>): void {
+  if (!existsSync(imagesDir)) return;
+  const unnecessaryImages = readDirRecursive(imagesDir)
+    .map((imagePath) => path.posix.relative(imagesDir, imagePath))
+    .filter((imagePath) => !images.has(imagePath));
+  if (unnecessaryImages.length > 0) {
+    logger.warn('We found unnecessary screenshot images, those can be safely removed:\n', unnecessaryImages.join('\n'));
+  }
+}
+
+export async function start(config: Config, options: Options, resolveApi: (api: CreeveyApi) => void): Promise<void> {
+  let runner: Runner | null = null;
+  if (config.hooks.before) {
+    await config.hooks.before();
+  }
+  subscribeOn('shutdown', () => config.hooks.after?.());
+  process.removeListener('SIGINT', shutdown);
+  process.on('SIGINT', () => {
+    runner?.removeAllListeners('stop');
+    if (runner?.isRunning) {
+      // TODO Better handle stop
+      void Promise.race([
+        new Promise((resolve) => setTimeout(resolve, 10000)),
+        new Promise((resolve) => runner?.once('stop', resolve)),
+      ]).then(() => shutdownWorkers());
+      runner.stop();
+    } else {
+      void shutdownWorkers();
+    }
+  });
+
+  runner = await master(config, { watch: options.ui, debug: options.debug, port: options.port });
+
+  if (options.saveReport) {
+    runner.on('stop', () => {
+      void copyStatics(config.reportDir).then(() =>
+        writeFile(path.join(config.reportDir, 'data.js'), reportDataModule(runner.status.tests)),
+      );
+    });
+  }
+
+  if (options.ui) {
+    resolveApi(creeveyApi(runner));
+    logger.info(`Started on http://localhost:${options.port}`);
+  } else {
+    if (Object.values(runner.status.tests).filter((test) => test && !test.skip).length == 0) {
+      logger.warn("Don't have any tests to run");
+
+      void shutdownWorkers().then(() => process.exit());
+      return;
+    }
+    runner.once('stop', () => {
+      const tests = Object.values(runner.status.tests);
+      const isSuccess = tests
+        .filter(isDefined)
+        .filter(({ skip }) => !skip)
+        .every(({ status }) => status == 'success');
+      // TODO output summary
+      process.exitCode = isSuccess ? 0 : -1;
+      if (!config.failFast) outputUnnecessaryImages(config.screenDir, testsToImages(tests));
+      void sendScreenshotsCount(config, options, runner.status)
+        .catch((reason: unknown) => {
+          const error = reason instanceof Error ? (reason.stack ?? reason.message) : (reason as string);
+          logger.warn(`Can't send telemetry: ${error}`);
+        })
+        .finally(() => {
+          void shutdownWorkers().then(() => process.exit());
+        });
+    });
+    // TODO grep
+    runner.start(Object.keys(runner.status.tests));
+  }
+}

package/src/server/master/master.ts

@@ -0,0 +1,47 @@
+import path from 'path';
+import { Config, TestData, isDefined, ServerTest } from '../../types.js';
+import { loadTestsFromStories, saveTestsJson } from '../stories.js';
+import Runner from './runner.js';
+import { tryToLoadTestsData } from '../utils.js';
+
+function mergeTests(
+  testsWithReports: Partial<Record<string, TestData>>,
+  testsFromStories: Partial<Record<string, ServerTest>>,
+): Partial<Record<string, ServerTest>> {
+  Object.values(testsFromStories)
+    .filter(isDefined)
+    .forEach((test) => {
+      const testWithReport = testsWithReports[test.id];
+      if (!testWithReport) return;
+      test.retries = testWithReport.retries;
+      if (testWithReport.status == 'success' || testWithReport.status == 'failed') test.status = testWithReport.status;
+      test.results = testWithReport.results;
+      test.approved = testWithReport.approved;
+    });
+  return testsFromStories;
+}
+
+export default async function master(
+  config: Config,
+  options: { watch: boolean; debug: boolean; port: number },
+): Promise<Runner> {
+  const runner = new Runner(config);
+  const reportDataPath = path.join(config.reportDir, 'data.js');
+  const testsFromReport = tryToLoadTestsData(reportDataPath) ?? {};
+
+  await runner.init();
+
+  const tests = await loadTestsFromStories(
+    Object.keys(config.browsers),
+    (listener) => config.storiesProvider(config, options, listener),
+    (testsDiff) => {
+      runner.updateTests(testsDiff);
+      saveTestsJson(runner.tests, config.reportDir);
+    },
+  );
+
+  runner.tests = mergeTests(testsFromReport, tests);
+  saveTestsJson(runner.tests, config.reportDir);
+
+  return runner;
+}

package/src/server/master/pool.ts

@@ -0,0 +1,203 @@
+import cluster, { Worker as ClusterWorker } from 'cluster';
+import { EventEmitter } from 'events';
+import { Worker, Config, TestResult, BrowserConfig, WorkerMessage, TestStatus, isWorkerMessage } from '../../types.js';
+import { sendTestMessage, sendShutdownMessage, subscribeOnWorker } from '../messages.js';
+import { isShuttingDown } from '../utils.js';
+
+const FORK_RETRIES = 5;
+
+interface WorkerTest {
+  id: string;
+  path: string[];
+  retries: number;
+}
+
+export default class Pool extends EventEmitter {
+  private maxRetries: number;
+  private config: BrowserConfig;
+  private workers: Worker[] = [];
+  private queue: WorkerTest[] = [];
+  private forcedStop = false;
+  private failFast: boolean;
+  public get isRunning(): boolean {
+    return this.workers.length !== this.freeWorkers.length;
+  }
+  constructor(
+    config: Config,
+    private browser: string,
+  ) {
+    super();
+
+    this.failFast = config.failFast;
+    this.maxRetries = config.maxRetries;
+    this.config = config.browsers[browser] as BrowserConfig;
+  }
+
+  async init(): Promise<void> {
+    const poolSize = Math.max(1, this.config.limit ?? 1);
+    // TODO Init queue for workers to smooth browser starting load
+    this.workers = (await Promise.all(Array.from({ length: poolSize }).map(() => this.forkWorker()))).filter(
+      (workerOrError): workerOrError is Worker => workerOrError instanceof ClusterWorker,
+    );
+    if (this.workers.length != poolSize)
+      throw new Error(`Can't instantiate workers for ${this.browser} due many errors`);
+    this.workers.forEach((worker) => {
+      this.exitHandler(worker);
+    });
+  }
+
+  start(tests: { id: string; path: string[] }[]): boolean {
+    if (this.isRunning) return false;
+
+    this.queue = tests.map(({ id, path }) => ({ id, path, retries: 0 }));
+    this.process();
+
+    return true;
+  }
+
+  stop(): void {
+    if (!this.isRunning) {
+      this.emit('stop');
+      return;
+    }
+
+    this.forcedStop = true;
+    this.queue = [];
+  }
+
+  process(): void {
+    const worker = this.getFreeWorker();
+    const test = this.queue.at(0);
+
+    if (this.queue.length == 0 && this.workers.length === this.freeWorkers.length) {
+      this.forcedStop = false;
+      this.emit('stop');
+      return;
+    }
+
+    if (!worker || !test) return;
+
+    worker.isRunning = true;
+
+    const { id } = test;
+
+    this.queue.shift();
+    this.sendStatus({ id, status: 'running' });
+
+    this.subscribe(worker, test);
+
+    sendTestMessage(worker, { type: 'start', payload: test });
+
+    this.process();
+  }
+
+  private sendStatus(message: { id: string; status: TestStatus; result?: TestResult }): void {
+    this.emit('test', message);
+  }
+
+  private getFreeWorker(): Worker | undefined {
+    return this.freeWorkers[Math.floor(Math.random() * this.freeWorkers.length)];
+  }
+
+  private get aliveWorkers(): Worker[] {
+    return this.workers.filter((worker) => !worker.exitedAfterDisconnect);
+  }
+
+  private get freeWorkers(): Worker[] {
+    return this.aliveWorkers.filter((worker) => !worker.isRunning);
+  }
+
+  private async forkWorker(retry = 0): Promise<Worker | { error: string }> {
+    cluster.setupPrimary({
+      args: ['--browser', this.browser, ...process.argv.slice(2)],
+    });
+    const worker = cluster.fork();
+    const message = await new Promise((resolve: (value: WorkerMessage) => void) => {
+      const readyHandler = (message: unknown): void => {
+        if (!isWorkerMessage(message)) return;
+        worker.off('message', readyHandler);
+        resolve(message);
+      };
+      worker.on('message', readyHandler);
+    });
+
+    if (message.type != 'error') return worker;
+
+    this.gracefullyKill(worker);
+
+    if (retry == FORK_RETRIES) return message.payload;
+    return this.forkWorker(retry + 1);
+  }
+
+  private exitHandler(worker: Worker): void {
+    // eslint-disable-next-line @typescript-eslint/no-misused-promises
+    worker.once('exit', async () => {
+      if (isShuttingDown.current) return;
+
+      const workerOrError = await this.forkWorker();
+
+      if (!(workerOrError instanceof ClusterWorker))
+        throw new Error(`Can't instantiate worker for ${this.browser} due many errors`);
+
+      this.exitHandler(workerOrError);
+      this.workers[this.workers.indexOf(worker)] = workerOrError;
+      this.process();
+    });
+  }
+
+  private gracefullyKill(worker: Worker): void {
+    const timeout = setTimeout(() => {
+      worker.kill();
+    }, 10000);
+    worker.on('exit', () => {
+      clearTimeout(timeout);
+    });
+    sendShutdownMessage(worker);
+  }
+
+  private shouldRetry(test: WorkerTest): boolean {
+    return test.retries < this.maxRetries && !this.forcedStop;
+  }
+
+  private handleTestResult(worker: Worker, test: WorkerTest, result: TestResult): void {
+    const shouldRetry = result.status == 'failed' && this.shouldRetry(test);
+
+    if (shouldRetry) {
+      test.retries += 1;
+      this.queue[this.failFast ? 'unshift' : 'push'](test);
+    }
+
+    this.sendStatus({ id: test.id, status: shouldRetry ? 'retrying' : result.status, result });
+
+    worker.isRunning = false;
+
+    setImmediate(() => {
+      this.process();
+    });
+  }
+
+  private subscribe(worker: Worker, test: WorkerTest): void {
+    const subscriptions = [
+      subscribeOnWorker(worker, 'worker', (message) => {
+        if (message.type != 'error') return;
+
+        subscriptions.forEach((unsubscribe) => {
+          unsubscribe();
+        });
+
+        this.gracefullyKill(worker);
+
+        this.handleTestResult(worker, test, { status: 'failed', ...message.payload });
+      }),
+      subscribeOnWorker(worker, 'test', (message) => {
+        if (message.type != 'end') return;
+
+        subscriptions.forEach((unsubscribe) => {
+          unsubscribe();
+        });
+
+        this.handleTestResult(worker, test, message.payload);
+      }),
+    ];
+  }
+}

package/src/server/master/runner.ts

@@ -0,0 +1,245 @@
+import path from 'path';
+import { copyFile, mkdir } from 'fs/promises';
+import { EventEmitter } from 'events';
+import {
+  Config,
+  CreeveyStatus,
+  TestResult,
+  ApprovePayload,
+  isDefined,
+  CreeveyUpdate,
+  TestStatus,
+  ServerTest,
+  TestMeta,
+} from '../../types.js';
+import Pool from './pool.js';
+
+export default class Runner extends EventEmitter {
+  private failFast: boolean;
+  private screenDir: string;
+  private reportDir: string;
+  private browsers: string[];
+  private pools: Record<string, Pool> = {};
+  tests: Partial<Record<string, ServerTest>> = {};
+  public get isRunning(): boolean {
+    return Object.values(this.pools).some((pool) => pool.isRunning);
+  }
+  constructor(config: Config) {
+    super();
+
+    this.failFast = config.failFast;
+    this.screenDir = config.screenDir;
+    this.reportDir = config.reportDir;
+    this.browsers = Object.keys(config.browsers);
+    this.browsers
+      .map((browser) => (this.pools[browser] = new Pool(config, browser)))
+      .map((pool) => pool.on('test', this.handlePoolMessage));
+  }
+
+  private handlePoolMessage = (message: { id: string; status: TestStatus; result?: TestResult }): void => {
+    const { id, status, result } = message;
+    const test = this.tests[id];
+
+    if (!test) return;
+    const { browser, testName, storyPath, storyId } = test;
+    // TODO Handle 'retrying' status
+    test.status = status == 'retrying' ? 'failed' : status;
+    if (!result) {
+      // NOTE: Running status
+      this.sendUpdate({ tests: { [id]: { id, browser, testName, storyPath, status: test.status, storyId } } });
+      return;
+    }
+    if (!test.results) {
+      test.results = [];
+    }
+    test.results.push(result);
+
+    if (status == 'failed') {
+      test.approved = null;
+    }
+
+    this.sendUpdate({
+      tests: {
+        [id]: {
+          id,
+          browser,
+          testName,
+          storyPath,
+          status: test.status,
+          approved: test.approved,
+          results: [result],
+          storyId,
+        },
+      },
+    });
+
+    if (this.failFast && status == 'failed') this.stop();
+  };
+
+  private handlePoolStop = (): void => {
+    if (!this.isRunning) {
+      this.sendUpdate({ isRunning: false });
+      this.emit('stop');
+    }
+  };
+
+  public async init(): Promise<void> {
+    await Promise.all(Object.values(this.pools).map((pool) => pool.init()));
+  }
+
+  public updateTests(testsDiff: Partial<Record<string, ServerTest>>): void {
+    const tests: CreeveyStatus['tests'] = {};
+    const removedTests: TestMeta[] = [];
+    Object.entries(testsDiff).forEach(([id, newTest]) => {
+      const oldTest = this.tests[id];
+      if (newTest) {
+        if (oldTest) {
+          this.tests[id] = {
+            ...newTest,
+            retries: oldTest.retries,
+            results: oldTest.results,
+            approved: oldTest.approved,
+          };
+        } else this.tests[id] = newTest;
+
+        const { story: _, fn: __, ...restTest } = newTest;
+        tests[id] = { ...restTest, status: 'unknown' };
+      } else if (oldTest) {
+        const { id, browser, testName, storyPath, storyId } = oldTest;
+        removedTests.push({ id, browser, testName, storyPath, storyId });
+        // TODO Use Map instead
+        // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
+        delete this.tests[id];
+      }
+    });
+    this.sendUpdate({ tests, removedTests });
+  }
+
+  public start(ids: string[]): void {
+    type TestsByBrowser = Record<string, { id: string; path: string[] }[]>;
+    if (this.isRunning) return;
+
+    const testsToStart = ids
+      .map((id) => this.tests[id])
+      .filter(isDefined)
+      .filter((test) => !test.skip);
+
+    if (testsToStart.length == 0) return;
+
+    this.sendUpdate({
+      isRunning: true,
+      tests: testsToStart.reduce(
+        (update: CreeveyUpdate['tests'], { id, storyId, browser, testName, storyPath }) => ({
+          ...update,
+          [id]: { id, browser, testName, storyPath, status: 'pending', storyId },
+        }),
+        {},
+      ),
+    });
+
+    const testsByBrowser: Partial<TestsByBrowser> = testsToStart.reduce((tests: Partial<TestsByBrowser>, test) => {
+      const { id, browser, testName, storyPath } = test;
+      const restPath = [...storyPath, testName].filter(isDefined);
+      test.status = 'pending';
+      return {
+        ...tests,
+        [browser]: [...(tests[browser] ?? []), { id, path: restPath }],
+      };
+    }, {});
+
+    this.browsers.forEach((browser) => {
+      const pool = this.pools[browser];
+      const tests = testsByBrowser[browser];
+
+      if (tests && tests.length > 0 && pool.start(tests)) {
+        pool.once('stop', this.handlePoolStop);
+      }
+    });
+  }
+
+  public stop(): void {
+    if (!this.isRunning) return;
+    this.browsers.forEach((browser) => {
+      this.pools[browser].stop();
+    });
+  }
+
+  public get status(): CreeveyStatus {
+    const tests: CreeveyStatus['tests'] = {};
+    Object.values(this.tests)
+      .filter(isDefined)
+
+      .forEach(({ story: _, fn: __, ...test }) => (tests[test.id] = test));
+    return {
+      isRunning: this.isRunning,
+      tests,
+      browsers: this.browsers,
+    };
+  }
+
+  private async copyImage(test: ServerTest, image: string, actual: string): Promise<void> {
+    const { browser, testName, storyPath } = test;
+    const restPath = [...storyPath, testName].filter(isDefined);
+    const testPath = path.join(...restPath, image == browser ? '' : browser);
+    const srcImagePath = path.join(this.reportDir, testPath, actual);
+    const dstImagePath = path.join(this.screenDir, testPath, `${image}.png`);
+    await mkdir(path.join(this.screenDir, testPath), { recursive: true });
+    await copyFile(srcImagePath, dstImagePath);
+  }
+
+  public async approveAll(): Promise<void> {
+    const updatedTests: NonNullable<CreeveyUpdate['tests']> = {};
+    for (const test of Object.values(this.tests)) {
+      if (!test?.results) continue;
+      const retry = test.results.length - 1;
+      const { images, status } = test.results.at(retry) ?? {};
+      if (!images || status != 'failed') continue;
+      for (const [name, image] of Object.entries(images)) {
+        if (!image) continue;
+        await this.copyImage(test, name, image.actual);
+
+        if (!test.approved) {
+          test.approved = {};
+        }
+        test.approved[name] = retry;
+
+        updatedTests[test.id] = {
+          id: test.id,
+          browser: test.browser,
+          storyPath: test.storyPath,
+          storyId: test.storyId,
+          approved: { [name]: retry },
+        };
+      }
+    }
+    this.sendUpdate({ tests: updatedTests });
+  }
+
+  public async approve({ id, retry, image }: ApprovePayload): Promise<void> {
+    const test = this.tests[id];
+    if (!test?.results) return;
+    const result = test.results[retry];
+    if (!result.images) return;
+    const images = result.images[image];
+    if (!images) return;
+    if (!test.approved) {
+      test.approved = {};
+    }
+    const { browser, testName, storyPath, storyId } = test;
+
+    await this.copyImage(test, image, images.actual);
+
+    test.approved[image] = retry;
+
+    if (Object.keys(result.images).every((name) => typeof test.approved?.[name] == 'number')) {
+      test.status = 'approved';
+    }
+
+    this.sendUpdate({
+      tests: { [id]: { id, browser, testName, storyPath, status: test.status, approved: { [image]: retry }, storyId } },
+    });
+  }
+  private sendUpdate(data: CreeveyUpdate): void {
+    this.emit('update', data);
+  }
+}