creevey 0.10.0-beta.42 → 0.10.0-beta.44

package/src/server/master/handlers/capture-handler.ts

@@ -0,0 +1,39 @@
+import { Request, Response } from 'hyper-express';
+import cluster from 'cluster';
+import { subscribeOnWorker, sendStoriesMessage } from '../../messages.js';
+import { CaptureOptions, isDefined } from '../../../types.js';
+
+export async function captureHandler(request: Request, response: Response): Promise<void> {
+  const { workerId, options } = await request.json<
+    { workerId: number; options?: CaptureOptions },
+    {
+      workerId: number;
+      options?: CaptureOptions;
+    }
+  >({
+    workerId: 0,
+    options: undefined,
+  });
+
+  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) {
+    response.send();
+    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
+  response.send('Ok');
+}

package/src/server/master/handlers/index.ts

@@ -0,0 +1,4 @@
+export * from './ping-handler.js';
+export * from './stories-handler.js';
+export * from './capture-handler.js';
+export * from './static-handler.js';

package/src/server/master/handlers/ping-handler.ts

@@ -0,0 +1,5 @@
+import { Request, Response } from 'hyper-express';
+
+export function pingHandler(_request: Request, response: Response): void {
+  response.send('pong');
+}

package/src/server/master/handlers/static-handler.ts

@@ -0,0 +1,29 @@
+import { Request, Response } from 'hyper-express';
+import path from 'path';
+import fs from 'fs';
+import { logger } from '../../logger.js';
+
+export function createStaticFileHandler(baseDir: string, pathPrefix?: string) {
+  return (request: Request, response: Response): void => {
+    try {
+      const decodedPath = decodeURIComponent(request.path);
+      const relativePath = pathPrefix ? decodedPath.replace(pathPrefix, '') : decodedPath;
+      let filePath = path.join(baseDir, relativePath || 'index.html');
+
+      // If the path points to a directory, append index.html
+      if (fs.existsSync(filePath) && fs.statSync(filePath).isDirectory()) {
+        filePath = path.join(filePath, 'index.html');
+      }
+
+      if (!fs.existsSync(filePath)) {
+        response.status(404).send('File not found');
+        return;
+      }
+
+      response.sendFile(filePath);
+    } catch (error) {
+      logger().error('Error serving file', error);
+      response.status(500).send('Internal server error');
+    }
+  };
+}

package/src/server/master/handlers/stories-handler.ts

@@ -0,0 +1,48 @@
+import { Request, Response } from 'hyper-express';
+import cluster from 'cluster';
+import { emitStoriesMessage, sendStoriesMessage } from '../../messages.js';
+import { isDefined, StoryInput } from '../../../types.js';
+import { deserializeStory } from '../../../shared/index.js';
+
+export function createStoriesHandler() {
+  let setStoriesCounter = 0;
+
+  // TODO We need this handler for getting stories updates from a browser
+  return async (request: Request, response: Response): Promise<void> => {
+    const { setStoriesCounter: counter, stories } = await request.json<
+      {
+        setStoriesCounter: number;
+        stories: [string, StoryInput[]][];
+      },
+      {
+        setStoriesCounter: number;
+        stories: [string, StoryInput[]][];
+      }
+    >({
+      setStoriesCounter: 0,
+      stories: [],
+    });
+
+    if (setStoriesCounter >= counter) {
+      response.send();
+      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 });
+      });
+
+    response.send();
+  };
+}

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);
   }