creevey 0.9.0-beta.1 → 0.9.0-non-webpack.0

package/lib/esm/server/loaders/webpack/mdx-loader.js

@@ -0,0 +1,58 @@
+/* eslint-disable */
+
+/* Copy-paste from storybook/addons/docs/src/frameworks/common/preset.ts */
+import { isStorybookVersionLessThan, resolveFromStorybook, resolveFromStorybookAddonDocs, resolveFromStorybookBuilderWebpack4, resolveFromStorybookCore } from '../../storybook/helpers';
+export let mdxLoaders = []; // for frameworks that are not working with react, we need to configure
+// the jsx to transpile mdx, for now there will be a flag for that
+// for more complex solutions we can find alone that we need to add '@babel/plugin-transform-react-jsx'
+
+function createBabelOptions({
+  babelOptions,
+  mdxBabelOptions,
+  configureJSX
+}) {
+  const babelPlugins = (mdxBabelOptions === null || mdxBabelOptions === void 0 ? void 0 : mdxBabelOptions.plugins) || (babelOptions === null || babelOptions === void 0 ? void 0 : babelOptions.plugins) || [];
+  const jsxPlugin = [resolveFromStorybookAddonDocs('@babel/plugin-transform-react-jsx'), {
+    pragma: 'React.createElement',
+    pragmaFrag: 'React.Fragment'
+  }];
+  const plugins = configureJSX ? [...babelPlugins, jsxPlugin] : babelPlugins;
+  return {
+    // don't use the root babelrc by default (users can override this in mdxBabelOptions)
+    babelrc: false,
+    configFile: false,
+    ...babelOptions,
+    ...mdxBabelOptions,
+    plugins
+  };
+}
+
+const remarkPlugins = ['remark-slug', 'remark-external-links'].map(plugin => require(resolveFromStorybookAddonDocs(plugin)));
+
+const createCompiler = require(resolveFromStorybook('@storybook/addon-docs/mdx-compiler-plugin'));
+
+export const mdxOptions = (options = {}) => ({
+  compilers: [createCompiler(options)],
+  remarkPlugins
+});
+export function webpack(webpackConfig = {}, options = {}) {
+  // it will reuse babel options that are already in use in storybook
+  // also, these babel options are chained with other presets.
+  const {
+    babelOptions,
+    mdxBabelOptions,
+    configureJSX = true
+  } = options;
+  mdxLoaders = [{
+    loader: isStorybookVersionLessThan(6, 2) ? resolveFromStorybookCore('babel-loader') : resolveFromStorybookBuilderWebpack4('babel-loader'),
+    options: createBabelOptions({
+      babelOptions,
+      mdxBabelOptions,
+      configureJSX
+    })
+  }, {
+    loader: resolveFromStorybookAddonDocs('@mdx-js/loader'),
+    options: mdxOptions(options)
+  }];
+  return webpackConfig;
+}

package/lib/esm/server/loaders/webpack/start.js

@@ -0,0 +1,27 @@
+import cluster from 'cluster';
+import { isWebpackMessage } from '../../../types';
+import { emitWebpackMessage } from '../../messages';
+export function startWebpackCompiler() {
+  return new Promise((resolve, reject) => {
+    cluster.setupMaster({
+      args: ['--webpack', ...process.argv.slice(2)]
+    });
+    const webpackCompiler = cluster.fork();
+    webpackCompiler.on('message', message => {
+      if (!isWebpackMessage(message)) return;
+      Object.values(cluster.workers ?? {}).filter(worker => worker != webpackCompiler).forEach(worker => worker === null || worker === void 0 ? void 0 : worker.send(message));
+
+      switch (message.type) {
+        case 'success':
+          return resolve();
+
+        case 'fail':
+          return reject();
+
+        case 'rebuild succeeded':
+        case 'rebuild failed':
+          return emitWebpackMessage(message);
+      }
+    });
+  });
+}

package/lib/esm/server/logger.js

@@ -0,0 +1,20 @@
+import chalk from 'chalk';
+import { default as Logger } from 'loglevel';
+import prefix from 'loglevel-plugin-prefix';
+export { getLogger } from 'loglevel';
+export const colors = {
+  TRACE: chalk.magenta,
+  DEBUG: chalk.cyan,
+  INFO: chalk.blue,
+  WARN: chalk.yellow,
+  ERROR: chalk.red
+};
+prefix.reg(Logger);
+prefix.apply(Logger, {
+  format(level, name = 'Creevey') {
+    const levelColor = colors[level.toUpperCase()];
+    return `[${name}:${chalk.gray(process.pid)}] ${levelColor(level)} =>`;
+  }
+
+});
+export const logger = Logger.getLogger('Creevey');

package/lib/esm/server/master/api.js

@@ -0,0 +1,60 @@
+import WebSocket from 'ws';
+import { logger } from '../logger';
+
+function broadcast(wss, message) {
+  wss.clients.forEach(ws => {
+    if (ws.readyState === WebSocket.OPEN) {
+      ws.send(JSON.stringify(message));
+    }
+  });
+}
+
+export default function creeveyApi(runner) {
+  return {
+    subscribe(wss) {
+      runner.on('update', payload => broadcast(wss, {
+        type: 'update',
+        payload
+      }));
+    },
+
+    handleMessage(ws, message) {
+      if (typeof message != 'string') {
+        logger.info('unhandled message', message);
+        return;
+      }
+
+      const command = JSON.parse(message);
+
+      switch (command.type) {
+        case 'status':
+          {
+            ws.send(JSON.stringify({
+              type: 'status',
+              payload: runner.status
+            }));
+            return;
+          }
+
+        case 'start':
+          {
+            runner.start(command.payload);
+            return;
+          }
+
+        case 'stop':
+          {
+            runner.stop();
+            return;
+          }
+
+        case 'approve':
+          {
+            void runner.approve(command.payload);
+            return;
+          }
+      }
+    }
+
+  };
+}

package/lib/esm/server/master/index.js

@@ -0,0 +1,125 @@
+import path from 'path';
+import { writeFileSync, copyFile, readdir, mkdir, existsSync } from 'fs';
+import { promisify } from 'util';
+import master from './master';
+import creeveyApi from './api';
+import { isDefined } from '../../types';
+import { shutdown, shutdownWorkers, testsToImages, readDirRecursive } from '../utils';
+import { subscribeOn } from '../messages';
+import { logger } from '../logger';
+const copyFileAsync = promisify(copyFile);
+const readdirAsync = promisify(readdir);
+const mkdirAsync = promisify(mkdir);
+
+async function copyStatics(reportDir) {
+  const clientDir = path.join(__dirname, '../../client/web');
+  const files = (await readdirAsync(clientDir, {
+    withFileTypes: true
+  })).filter(dirent => dirent.isFile() && !dirent.name.endsWith('.d.ts') && !dirent.name.endsWith('.tsx')).map(dirent => dirent.name);
+  await mkdirAsync(reportDir, {
+    recursive: true
+  });
+
+  for (const file of files) {
+    await copyFileAsync(path.join(clientDir, file), path.join(reportDir, file));
+  }
+}
+
+function reportDataModule(data) {
+  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, images) {
+  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 default async function (config, options, resolveApi) {
+  let runner = null;
+
+  if (config.hooks.before) {
+    await config.hooks.before();
+  }
+
+  subscribeOn('shutdown', () => {
+    var _config$hooks$after, _config$hooks;
+
+    return (_config$hooks$after = (_config$hooks = config.hooks).after) === null || _config$hooks$after === void 0 ? void 0 : _config$hooks$after.call(_config$hooks);
+  });
+  process.removeListener('SIGINT', shutdown);
+  process.on('SIGINT', () => {
+    var _runner, _runner2;
+
+    (_runner = runner) === null || _runner === void 0 ? void 0 : _runner.removeAllListeners('stop');
+
+    if ((_runner2 = runner) !== null && _runner2 !== void 0 && _runner2.isRunning) {
+      var _runner4;
+
+      // TODO Better handle stop
+      void Promise.race([new Promise(resolve => setTimeout(resolve, 10000)), new Promise(resolve => {
+        var _runner3;
+
+        return (_runner3 = runner) === null || _runner3 === void 0 ? void 0 : _runner3.once('stop', resolve);
+      })]).then(() => shutdownWorkers());
+      (_runner4 = runner) === null || _runner4 === void 0 ? void 0 : _runner4.stop();
+    } else {
+      void shutdownWorkers();
+    }
+  });
+  runner = await master(config, {
+    watch: options.ui,
+    debug: options.debug,
+    port: options.port
+  });
+
+  if (options.saveReport) {
+    await copyStatics(config.reportDir);
+    runner.on('stop', () => {
+      var _runner5;
+
+      return writeFileSync(path.join(config.reportDir, 'data.js'), reportDataModule((_runner5 = runner) === null || _runner5 === void 0 ? void 0 : _runner5.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"); // eslint-disable-next-line no-process-exit
+
+      void shutdownWorkers().then(() => process.exit());
+      return;
+    }
+
+    runner.once('stop', () => {
+      var _runner6;
+
+      const tests = Object.values(((_runner6 = runner) === null || _runner6 === void 0 ? void 0 : _runner6.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)); // eslint-disable-next-line no-process-exit
+
+      void shutdownWorkers().then(() => process.exit());
+    }); // TODO grep
+
+    runner.start(Object.keys(runner.status.tests));
+  }
+}

package/lib/esm/server/master/master.js

@@ -0,0 +1,38 @@
+import path from 'path';
+import { isDefined } from '../../types';
+import { loadTestsFromStories, saveTestsJson } from '../stories';
+import Runner from './runner';
+import { startWebpackCompiler } from '../loaders/webpack/start';
+
+function mergeTests(testsWithReports, testsFromStories) {
+  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, options) {
+  if (config.useWebpackToExtractTests) await startWebpackCompiler();
+  const runner = new Runner(config);
+  const reportDataPath = path.join(config.reportDir, 'data.js');
+  let testsFromReport = {};
+
+  try {
+    testsFromReport = await import(reportDataPath);
+  } catch (error) {// Ignore error
+  }
+
+  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/lib/esm/server/master/pool.js

@@ -0,0 +1,176 @@
+import cluster, { Worker as ClusterWorker } from 'cluster';
+import { EventEmitter } from 'events';
+import { isWorkerMessage } from '../../types';
+import { sendTestMessage, sendShutdownMessage, subscribeOnWorker } from '../messages';
+import { isShuttingDown } from '../utils';
+const FORK_RETRIES = 5;
+export default class Pool extends EventEmitter {
+  workers = [];
+  queue = [];
+  forcedStop = false;
+
+  get isRunning() {
+    return this.workers.length !== this.freeWorkers.length;
+  }
+
+  constructor(config, browser) {
+    super();
+    this.browser = browser;
+    this.failFast = config.failFast;
+    this.maxRetries = config.maxRetries;
+    this.config = config.browsers[browser];
+  }
+
+  async init() {
+    const poolSize = this.config.limit || 1;
+    this.workers = (await Promise.all(Array.from({
+      length: poolSize
+    }).map(() => this.forkWorker()))).filter(workerOrError => 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) {
+    if (this.isRunning) return false;
+    this.queue = tests.map(({
+      id,
+      path
+    }) => ({
+      id,
+      path,
+      retries: 0
+    }));
+    this.process();
+    return true;
+  }
+
+  stop() {
+    if (!this.isRunning) {
+      this.emit('stop');
+      return;
+    }
+
+    this.forcedStop = true;
+    this.queue = [];
+  }
+
+  process() {
+    const worker = this.getFreeWorker();
+    const [test] = this.queue;
+
+    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();
+  }
+
+  sendStatus(message) {
+    this.emit('test', message);
+  }
+
+  getFreeWorker() {
+    return this.freeWorkers[Math.floor(Math.random() * this.freeWorkers.length)];
+  }
+
+  get aliveWorkers() {
+    return this.workers.filter(worker => !worker.exitedAfterDisconnect);
+  }
+
+  get freeWorkers() {
+    return this.aliveWorkers.filter(worker => !worker.isRunning);
+  }
+
+  async forkWorker(retry = 0) {
+    cluster.setupMaster({
+      args: ['--browser', this.browser, ...process.argv.slice(2)]
+    });
+    const worker = cluster.fork();
+    const message = await new Promise(resolve => {
+      const readyHandler = message => {
+        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);
+  }
+
+  exitHandler(worker) {
+    // 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();
+    });
+  }
+
+  gracefullyKill(worker) {
+    const timeout = setTimeout(() => worker.kill(), 10000);
+    worker.on('exit', () => clearTimeout(timeout));
+    sendShutdownMessage(worker);
+  }
+
+  shouldRetry(test) {
+    return test.retries < this.maxRetries && !this.forcedStop;
+  }
+
+  handleTestResult(worker, test, result) {
+    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());
+  }
+
+  subscribe(worker, test) {
+    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);
+    })];
+  }
+
+}