creevey/src/server/providers/browser.ts

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

import cluster from 'cluster';
import type { CreeveyStory, StoriesProvider, StoriesRaw } from '../../types.js';
import { emitStoriesMessage, sendStoriesMessage, subscribeOn, subscribeOnWorker } from '../messages.js';
import { isDefined } from '../../types.js';
import { logger } from '../logger.js';
import { deserializeRawStories } from '../../shared/index.js';

// TODO Don't have updates from stories
export const loadStories: StoriesProvider = async (_config, storiesListener, webdriver) => {
  if (cluster.isPrimary) {
    return new Promise<StoriesRaw>((resolve) => {
      const worker = Object.values(cluster.workers ?? {})
        .filter(isDefined)
        .find((worker) => worker.isConnected());

      if (worker) {
        const unsubscribe = subscribeOnWorker(worker, 'stories', (message) => {
          if (message.type == 'set') {
            const { stories, oldTests } = message.payload;
            if (oldTests.length > 0)
              logger().warn(
                `If you use browser stories provider of CSFv3 Storybook feature\n` +
                  `Creevey will not load tests defined in story parameters from following stories:\n` +
                  oldTests.join('\n'),
              );
            unsubscribe();
            resolve(deserializeRawStories(stories));
          }
        });
        sendStoriesMessage(worker, { type: 'get' });
      }
      subscribeOn('stories', (message) => {
        // TODO updates only one browser :(
        if (message.type == 'update') storiesListener(new Map(message.payload));
      });
    });
  } else {
    subscribeOn('stories', (message) => {
      if (message.type == 'get')
        emitStoriesMessage({ type: 'set', payload: { stories: rawStories, oldTests: storiesWithOldTests } });
      if (message.type == 'update') storiesListener(new Map(message.payload));
    });
    const rawStories = (await webdriver?.loadStoriesFromBrowser()) ?? {};
    const stories = deserializeRawStories(rawStories);

    const storiesWithOldTests: string[] = [];

    Object.values(stories).forEach((story) => {
      if ((story as CreeveyStory).parameters?.creevey?.tests) {
        delete (story as CreeveyStory).parameters?.creevey?.tests;
        storiesWithOldTests.push(`${story.title}/${story.name}`);
      }
    });

    return stories;
  }
};

loadStories.providerName = 'browser';