creevey/src/server/report.ts

Cross-browser screenshot testing tool for Storybook with fancy UI Runner

import { Config, ServerTest, TestMessage } from '../types.js';
import { logger } from './logger.js';
import { TestsManager } from './master/testsManager.js';
import { start as startServer } from './master/server.js';
import { CreeveyApi } from './master/api.js';
import { shutdownWorkers } from './utils.js';
import { subscribeOn } from './messages.js';

/**
 * UI Update Mode implementation.
 * This mode allows users to review and approve screenshots from the browser interface.
 * It combines the functionality of both --ui and --update flags.
 *
 * @param config Creevey configuration
 * @param port Port to run the server on
 */
export function report(config: Config, reportDir: string, port: number): void {
  logger().info('Starting UI Update Mode');

  process.on('SIGINT', () => void shutdownWorkers());

  const url = `http://localhost:${port}`;

  // Initialize TestsManager with the configured directories
  const testsManager = new TestsManager(config.screenDir, reportDir);

  // Load tests from the report
  const testsFromReport = testsManager.loadTestsFromReport();

  if (Object.keys(testsFromReport).length === 0) {
    logger().warn('No tests found in report. Run tests first to generate report data.');
  }

  // Set tests in the manager
  testsManager.updateTests(testsFromReport);

  subscribeOn('test', (message: TestMessage) => {
    if (message.type != 'update' || !message.payload) return;
    // TODO: fix type for now
    testsManager.updateTests(message.payload as Partial<Record<string, ServerTest>>);
  });

  // Start API server with UI enabled
  const resolveApi = startServer(reportDir, port, true);

  // Initialize API
  const api = new CreeveyApi(testsManager);

  // Resolve the API for the server
  resolveApi(api);

  logger().info(`UI Update Mode started on ${url}`);
  logger().info('You can now review and approve screenshots from the browser.');

  void import('open').then(({ default: open }) => open(url));
}