creevey 0.10.0-beta.43 → 0.10.0-beta.44

package/src/server/master/master.ts

@@ -1,44 +1,27 @@
-import path from 'path';
-import { Config, TestData, isDefined, ServerTest } from '../../types.js';
-import { loadTestsFromStories, saveTestsJson } from '../stories.js';
+import { Config } from '../../types.js';
+import { loadTestsFromStories } 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;
-}
+import { TestsManager } from './testsManager.js';
 
 export default async function master(config: Config, gridUrl?: string): Promise<Runner> {
-  const runner = new Runner(config, gridUrl);
-  const reportDataPath = path.join(config.reportDir, 'data.js');
-  const testsFromReport = tryToLoadTestsData(reportDataPath) ?? {};
+  // Create TestsManager instance
+  const testsManager = new TestsManager(config.screenDir, config.reportDir);
+
+  // Create Runner with TestsManager
+  const runner = new Runner(config, testsManager, gridUrl);
 
   await runner.init();
 
+  // Load tests from stories and update TestsManager
   const tests = await loadTestsFromStories(
     Object.keys(config.browsers),
     (listener) => config.storiesProvider(config, listener),
     (testsDiff) => {
       runner.updateTests(testsDiff);
-      saveTestsJson(runner.tests, config.reportDir);
     },
   );
 
-  runner.tests = mergeTests(testsFromReport, tests);
-  saveTestsJson(runner.tests, config.reportDir);
+  testsManager.updateTests(testsManager.loadAndMergeTests(tests));
 
   return runner;
 }

package/src/server/master/runner.ts

@@ -1,5 +1,3 @@
-import path from 'path';
-import { copyFile, mkdir } from 'fs/promises';
 import { EventEmitter } from 'events';
 import {
   Config,
@@ -10,7 +8,6 @@ import {
   CreeveyUpdate,
   TestStatus,
   ServerTest,
-  TestMeta,
   TEST_EVENTS,
   FakeSuite,
   FakeTest,
@@ -19,6 +16,7 @@ import Pool from './pool.js';
 import { WorkerQueue } from './queue.js';
 import { getTestPath } from '../utils.js';
 import { getReporter } from '../reporters/index.js';
+import { TestsManager } from './testsManager.js';
 
 // NOTE: This is workaround to fix parallel tests running with mocha-junit-reporter
 let isJUnit = false;
@@ -33,24 +31,23 @@ class FakeRunner extends EventEmitter {
 
 export default class Runner extends EventEmitter {
   private failFast: boolean;
-  private screenDir: string;
-  private reportDir: string;
   private browsers: string[];
   private scheduler: WorkerQueue;
   private pools: Record<string, Pool> = {};
   private fakeRunner: FakeRunner;
   private config: Config;
-  tests: Partial<Record<string, ServerTest>> = {};
+  public testsManager: TestsManager;
+
   public get isRunning(): boolean {
     return Object.values(this.pools).some((pool) => pool.isRunning);
   }
-  constructor(config: Config, gridUrl?: string) {
+
+  constructor(config: Config, testsManager: TestsManager, gridUrl?: string) {
     super();
 
     this.config = config;
     this.failFast = config.failFast;
-    this.screenDir = config.screenDir;
-    this.reportDir = config.reportDir;
+    this.testsManager = testsManager;
     this.scheduler = new WorkerQueue(config.useWorkerQueue);
     this.browsers = Object.keys(config.browsers);
 
@@ -61,7 +58,7 @@ export default class Runner extends EventEmitter {
       isJUnit = true;
     }
 
-    new Reporter(runner, { reportDir: this.reportDir, reporterOptions: config.reporterOptions });
+    new Reporter(runner, { reportDir: config.reportDir, reporterOptions: config.reporterOptions });
     this.fakeRunner = runner;
 
     this.browsers
@@ -71,10 +68,10 @@ export default class Runner extends EventEmitter {
 
   private handlePoolMessage = (message: { id: string; status: TestStatus; result?: TestResult }): void => {
     const { id, status, result } = message;
-    const test = this.tests[id];
+    const test = this.testsManager.getTest(id);
 
     if (!test) return;
-    const { browser, testName, storyPath, storyId } = test;
+    const { browser, testName } = test;
 
     const fakeSuite: FakeSuite = {
       title: test.storyPath.slice(0, -1).join('/'),
@@ -103,20 +100,14 @@ export default class Runner extends EventEmitter {
 
     fakeSuite.tests.push(fakeTest);
 
-    // TODO Handle 'retrying' status
-    test.status = status == 'retrying' ? 'failed' : status;
+    const update = this.testsManager.updateTestStatus(id, status, result);
+    if (!update) return;
+
     if (!result) {
-      // NOTE: Running status
       this.fakeRunner.emit(TEST_EVENTS.TEST_BEGIN, fakeTest);
-      this.sendUpdate({ tests: { [id]: { id, browser, testName, storyPath, status: test.status, storyId } } });
+      this.sendUpdate(update);
       return;
     }
-    test.results ??= [];
-    test.results.push(result);
-
-    if (status == 'failed') {
-      test.approved = null;
-    }
 
     const { duration, attachments } = result;
 
@@ -146,20 +137,7 @@ export default class Runner extends EventEmitter {
 
     this.fakeRunner.emit(TEST_EVENTS.TEST_END, fakeTest);
 
-    this.sendUpdate({
-      tests: {
-        [id]: {
-          id,
-          browser,
-          testName,
-          storyPath,
-          status: test.status,
-          approved: test.approved,
-          results: [result],
-          storyId,
-        },
-      },
-    });
+    this.sendUpdate(update);
 
     if (this.failFast && status == 'failed') this.stop();
   };
@@ -177,31 +155,8 @@ export default class Runner extends EventEmitter {
   }
 
   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 });
+    const update = this.testsManager.updateTests(testsDiff);
+    if (update) this.sendUpdate(update);
   }
 
   public start(ids: string[]): void {
@@ -209,27 +164,32 @@ export default class Runner extends EventEmitter {
     if (this.isRunning) return;
 
     const testsToStart = ids
-      .map((id) => this.tests[id])
+      .map((id) => this.testsManager.getTest(id))
       .filter(isDefined)
       .filter((test) => !test.skip);
 
     if (testsToStart.length == 0) return;
 
+    const pendingTests: CreeveyUpdate['tests'] = testsToStart.reduce(
+      (update: CreeveyUpdate['tests'], { id, storyId, browser, testName, storyPath }) => ({
+        ...update,
+        [id]: { id, browser, testName, storyPath, status: 'pending', storyId },
+      }),
+      {},
+    );
+
     this.sendUpdate({
       isRunning: true,
-      tests: testsToStart.reduce(
-        (update: CreeveyUpdate['tests'], { id, storyId, browser, testName, storyPath }) => ({
-          ...update,
-          [id]: { id, browser, testName, storyPath, status: 'pending', storyId },
-        }),
-        {},
-      ),
+      tests: pendingTests,
     });
 
     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';
+
+      // Update status to pending in TestsManager
+      this.testsManager.updateTestStatus(id, 'pending');
+
       return {
         ...tests,
         [browser]: [...(tests[browser] ?? []), { id, path: restPath }],
@@ -255,78 +215,24 @@ export default class Runner extends EventEmitter {
   }
 
   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,
+      tests: this.testsManager.getTestsData(),
       browsers: this.browsers,
+      isUpdateMode: false,
     };
   }
 
-  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);
-
-        test.approved ??= {};
-        test.approved[name] = retry;
-        test.status = 'approved';
-
-        updatedTests[test.id] = {
-          id: test.id,
-          browser: test.browser,
-          storyPath: test.storyPath,
-          storyId: test.storyId,
-          status: test.status,
-          approved: { [name]: retry },
-        };
-      }
-    }
-    this.sendUpdate({ tests: updatedTests });
+    const update = await this.testsManager.approveAll();
+    this.sendUpdate(update);
   }
 
-  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;
-    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 } },
-    });
+  public async approve(payload: ApprovePayload): Promise<void> {
+    const update = await this.testsManager.approve(payload);
+    if (update) this.sendUpdate(update);
   }
+
   private sendUpdate(data: CreeveyUpdate): void {
     this.emit('update', data);
   }

package/src/server/master/server.ts

@@ -1,125 +1,121 @@
 import path from 'path';
-import http from 'http';
-import cluster from 'cluster';
-import Koa from 'koa';
-import cors from '@koa/cors';
-import serve from 'koa-static';
-import mount from 'koa-mount';
-import body from 'koa-bodyparser';
-import WebSocket from 'ws';
+import HyperExpress from 'hyper-express';
 import { fileURLToPath, pathToFileURL } from 'url';
 import { CreeveyApi } from './api.js';
-import { emitStoriesMessage, sendStoriesMessage, subscribeOn, subscribeOnWorker } from '../messages.js';
-import { CaptureOptions, isDefined, noop, StoryInput } from '../../types.js';
+import { subscribeOn } from '../messages.js';
+import { noop } from '../../types.js';
 import { logger } from '../logger.js';
-import { deserializeStory } from '../../shared/index.js';
+import { pingHandler, createStoriesHandler, captureHandler, createStaticFileHandler } from './handlers/index.js';
 
 const importMetaUrl = pathToFileURL(__filename).href;
 
 export function start(reportDir: string, port: number, ui: boolean): (api: CreeveyApi) => void {
   let resolveApi: (api: CreeveyApi) => void = noop;
-  let setStoriesCounter = 0;
   const creeveyApi = new Promise<CreeveyApi>((resolve) => (resolveApi = resolve));
-  const app = new Koa();
-  // eslint-disable-next-line @typescript-eslint/no-misused-promises
-  const server = http.createServer(app.callback());
-  const wss = new WebSocket.Server({ server });
-
-  app.use(cors());
-  app.use(body());
-
-  app.use(async (ctx, next) => {
-    if (ctx.method == 'GET' && ctx.path == '/ping') {
-      ctx.body = 'pong';
-      return;
-    }
-    await next();
-  });
 
-  if (ui) {
-    app.use(async (_, next) => {
-      await creeveyApi;
-      await next();
-    });
-  }
+  // Create HyperExpress server instance
+  const server = new HyperExpress.Server();
 
-  app.use(async (ctx, next) => {
-    if (ctx.method == 'POST' && ctx.path == '/stories') {
-      const { setStoriesCounter: counter, stories } = ctx.request.body as {
-        setStoriesCounter: number;
-        stories: [string, StoryInput[]][];
-      };
-      if (setStoriesCounter >= counter) return;
-
-      const deserializedStories = stories.map<[string, StoryInput[]]>(([file, stories]) => [
-        file,
-        stories.map(deserializeStory),
-      ]);
-
-      setStoriesCounter = counter;
-      emitStoriesMessage({ type: 'update', payload: deserializedStories });
-      Object.values(cluster.workers ?? {})
-        .filter(isDefined)
-        .filter((worker) => worker.isConnected())
-        .forEach((worker) => {
-          sendStoriesMessage(worker, { type: 'update', payload: deserializedStories });
-        });
-      return;
-    }
-    await next();
-  });
+  // Store active WebSocket connections
+  const activeConnections = new Set<HyperExpress.Websocket>();
 
-  app.use(async (ctx, next) => {
-    if (ctx.method == 'POST' && ctx.path == '/capture') {
-      const { workerId, options } = ctx.request.body as { workerId: number; options?: CaptureOptions };
-      const worker = Object.values(cluster.workers ?? {})
-        .filter(isDefined)
-        .find((worker) => worker.process.pid == workerId);
-      // NOTE: Hypothetical case when someone send to us capture req and we don't have a worker with browser session for it
-      if (!worker) return;
-      await new Promise<void>((resolve) => {
-        const unsubscribe = subscribeOnWorker(worker, 'stories', (message) => {
-          if (message.type != 'capture') return;
-          unsubscribe();
-          resolve();
-        });
-        sendStoriesMessage(worker, { type: 'capture', payload: options });
-      });
-      // TODO Pass screenshot result to show it in inspector
-      ctx.body = 'Ok';
-      return;
+  // Enable CORS for all routes
+  server.use((request, response, next) => {
+    response.header('Access-Control-Allow-Origin', '*');
+    response.header('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS');
+    response.header('Access-Control-Allow-Headers', 'Origin, X-Requested-With, Content-Type, Accept');
+
+    if (request.method === 'OPTIONS') {
+      return response.status(200).send();
     }
-    await next();
+
+    next();
   });
 
-  app.use(serve(path.join(path.dirname(fileURLToPath(importMetaUrl)), '../../client/web')));
-  app.use(mount('/report', serve(reportDir)));
+  // Health check endpoint
+  server.get('/ping', pingHandler);
 
-  wss.on('error', (error) => {
-    logger().error(error);
-  });
+  // Stories endpoint
+  server.post('/stories', createStoriesHandler());
 
-  server.listen(port);
+  // Capture endpoint
+  server.post('/capture', captureHandler);
 
-  subscribeOn('shutdown', () => {
-    server.close();
-    wss.close();
-    wss.clients.forEach((ws) => {
-      ws.close();
+  // Serve report files
+  server.get('/report/*', createStaticFileHandler(reportDir, '/report/'));
+
+  // Serve static files
+  const webDir = path.join(path.dirname(fileURLToPath(importMetaUrl)), '../../client/web');
+  server.get('/*', createStaticFileHandler(webDir));
+
+  // If UI mode, wait for CreeveyApi to be resolved
+  if (ui) {
+    // Create a custom broadcast function that works with our connections
+    const broadcast = (message: string) => {
+      for (const connection of activeConnections) {
+        connection.send(message);
+      }
+    };
+
+    // Create a custom WebSocket server that simulates the standard behavior
+    const customWsServer = {
+      clients: activeConnections,
+      publish: broadcast,
+    };
+
+    let api: CreeveyApi | null = null;
+
+    server.use(async (request, _response, next) => {
+      if (!api && request.path === '/') {
+        api = await creeveyApi;
+        api.subscribe(customWsServer);
+      }
+      next();
     });
-  });
 
-  void creeveyApi.then((api) => {
-    api.subscribe(wss);
+    // Create WebSocket listener
+    server.ws('/', (ws) => {
+      // Add connection to the set of active connections
+      activeConnections.add(ws);
 
-    wss.on('connection', (ws) => {
-      ws.on('message', (message: WebSocket.RawData, isBinary: boolean) => {
-        // NOTE Text messages are passed as Buffer https://github.com/websockets/ws/releases/tag/8.0.0
-        // eslint-disable-next-line @typescript-eslint/no-base-to-string
-        api.handleMessage(ws, isBinary ? message : message.toString('utf-8'));
+      // Handle message events
+      ws.on('message', (message: string | Buffer) => {
+        api?.handleMessage(ws, message);
+      });
+
+      // Handle close events to clean up connections
+      ws.on('close', () => {
+        activeConnections.delete(ws);
       });
     });
+  }
+
+  // Shutdown handling
+  subscribeOn('shutdown', () => {
+    // Close all WebSocket connections
+    for (const connection of activeConnections) {
+      try {
+        connection.close();
+      } catch (error) {
+        logger().error('Error closing WebSocket connection', error);
+      }
+    }
+
+    // Close the server
+    server.close();
   });
 
+  // Start server
+  server
+    .listen(port)
+    .then(() => {
+      logger().info(`Server starting on port ${port}`);
+    })
+    .catch((error: unknown) => {
+      logger().error('Failed to start server', error);
+      process.exit(1);
+    });
+
+  // Return the function to resolve the API
   return resolveApi;
 }

package/src/server/master/start.ts

@@ -1,41 +1,14 @@
 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 { shutdownWorkers, testsToImages, readDirRecursive } from '../utils.js';
+import { CreeveyApi } from './api.js';
+import { Config, Options, isDefined } from '../../types.js';
+import { shutdownWorkers, testsToImages, readDirRecursive, copyStatics } 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)), '../../../dist/client/web');
-  const assets = (await readdir(path.join(clientDir, 'assets'), { withFileTypes: true }))
-    .filter((dirent) => dirent.isFile())
-    .map((dirent) => dirent.name);
-  await mkdir(path.join(reportDir, 'assets'), { recursive: true });
-  await copyFile(path.join(clientDir, 'index.html'), path.join(reportDir, 'index.html'));
-  for (const asset of assets) {
-    await copyFile(path.join(clientDir, 'assets', asset), path.join(reportDir, 'assets', asset));
-  }
-}
-
-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)} }));
-`;
-}
+import { start as startServer } from './server.js';
 
 function outputUnnecessaryImages(imagesDir: string, images: Set<string>): void {
   if (!existsSync(imagesDir)) return;
@@ -50,12 +23,9 @@ function outputUnnecessaryImages(imagesDir: string, images: Set<string>): void {
   }
 }
 
-export async function start(
-  gridUrl: string | undefined,
-  config: Config,
-  options: Options,
-  resolveApi: (api: CreeveyApi) => void,
-): Promise<void> {
+export async function start(gridUrl: string | undefined, config: Config, options: Options): Promise<void> {
+  const resolveApi = startServer(config.reportDir, options.port, options.ui);
+
   let runner: Runner | null = null;
   if (config.hooks.before) {
     await config.hooks.before();
@@ -78,13 +48,19 @@ export async function start(
   runner = await master(config, gridUrl);
 
   runner.on('stop', () => {
-    void copyStatics(config.reportDir).then(() =>
-      writeFile(path.join(config.reportDir, 'data.js'), reportDataModule(runner.status.tests)),
-    );
+    void copyStatics(config.reportDir).then(() => runner.testsManager.saveTestData());
   });
 
   if (options.ui) {
-    resolveApi(creeveyApi(runner));
+    // Initialize TestsManager
+    const testsManager = runner.testsManager;
+
+    // Create the CreeveyApi instance using the existing runner
+    const api = new CreeveyApi(testsManager, runner);
+
+    // Resolve the API for the server
+    resolveApi(api);
+
     logger().info(`Started on http://localhost:${options.port}`);
   } else {
     if (Object.values(runner.status.tests).filter((test) => test && !test.skip).length == 0) {