creevey 0.9.0-beta.20 → 0.9.0-beta.21

package/lib/cjs/server/master/pool.js

@@ -1,163 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _cluster = _interopRequireWildcard(require("cluster"));
-var _events = require("events");
-var _types = require("../../types");
-var _messages = require("../messages");
-var _utils = require("../utils");
-function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
-function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
-const FORK_RETRIES = 5;
-class Pool extends _events.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;
-    // TODO Init queue for workers to smooth browser starting load
-    this.workers = (await Promise.all(Array.from({
-      length: poolSize
-    }).map(() => this.forkWorker()))).filter(workerOrError => workerOrError instanceof _cluster.Worker);
-    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);
-    (0, _messages.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.default.setupPrimary({
-      args: ['--browser', this.browser, ...process.argv.slice(2)]
-    });
-    const worker = _cluster.default.fork();
-    const message = await new Promise(resolve => {
-      const readyHandler = message => {
-        if (!(0, _types.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 (_utils.isShuttingDown.current) return;
-      const workerOrError = await this.forkWorker();
-      if (!(workerOrError instanceof _cluster.Worker)) 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));
-    (0, _messages.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 = [(0, _messages.subscribeOnWorker)(worker, 'worker', message => {
-      if (message.type != 'error') return;
-      subscriptions.forEach(unsubscribe => unsubscribe());
-      this.gracefullyKill(worker);
-      this.handleTestResult(worker, test, {
-        status: 'failed',
-        ...message.payload
-      });
-    }), (0, _messages.subscribeOnWorker)(worker, 'test', message => {
-      if (message.type != 'end') return;
-      subscriptions.forEach(unsubscribe => unsubscribe());
-      this.handleTestResult(worker, test, message.payload);
-    })];
-  }
-}
-exports.default = Pool;

package/lib/cjs/server/master/runner.js

@@ -1,254 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _path = _interopRequireDefault(require("path"));
-var _fs = require("fs");
-var _util = require("util");
-var _events = require("events");
-var _types = require("../../types");
-var _pool = _interopRequireDefault(require("./pool"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const copyFileAsync = (0, _util.promisify)(_fs.copyFile);
-const mkdirAsync = (0, _util.promisify)(_fs.mkdir);
-class Runner extends _events.EventEmitter {
-  pools = {};
-  tests = {};
-  get isRunning() {
-    return Object.values(this.pools).some(pool => pool.isRunning);
-  }
-  constructor(config) {
-    super();
-    this.failFast = config.failFast;
-    this.screenDir = config.screenDir;
-    this.reportDir = config.reportDir;
-    this.browsers = Object.keys(config.browsers);
-    this.browsers.map(browser => this.pools[browser] = new _pool.default(config, browser)).map(pool => pool.on('test', this.handlePoolMessage));
-  }
-  handlePoolMessage = message => {
-    const {
-      id,
-      status,
-      result
-    } = message;
-    const test = this.tests[id];
-    if (!test) return;
-    const {
-      browser,
-      testName,
-      storyPath,
-      storyId
-    } = test;
-    // TODO Handle 'retrying' status
-    test.status = status == 'retrying' ? 'failed' : status;
-    if (!result) {
-      this.sendUpdate({
-        tests: {
-          [id]: {
-            id,
-            browser,
-            testName,
-            storyPath,
-            status: test.status,
-            storyId
-          }
-        }
-      });
-      return;
-    }
-    if (!test.results) {
-      test.results = [];
-    }
-    test.results.push(result);
-    this.sendUpdate({
-      tests: {
-        [id]: {
-          id,
-          browser,
-          testName,
-          storyPath,
-          status: test.status,
-          results: [result],
-          storyId
-        }
-      }
-    });
-    if (this.failFast && status == 'failed') this.stop();
-  };
-  handlePoolStop = () => {
-    if (!this.isRunning) {
-      this.sendUpdate({
-        isRunning: false
-      });
-      this.emit('stop');
-    }
-  };
-  async init() {
-    await Promise.all(Object.values(this.pools).map(pool => pool.init()));
-  }
-  updateTests(testsDiff) {
-    const tests = {};
-    const removedTests = [];
-    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;
-
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        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
-        });
-        delete this.tests[id];
-      }
-    });
-    this.sendUpdate({
-      tests,
-      removedTests
-    });
-  }
-  start(ids) {
-    if (this.isRunning) return;
-    const testsToStart = ids.map(id => this.tests[id]).filter(_types.isDefined).filter(test => !test.skip);
-    if (testsToStart.length == 0) return;
-    this.sendUpdate({
-      isRunning: true,
-      tests: testsToStart.reduce((update, {
-        id,
-        storyId,
-        browser,
-        testName,
-        storyPath
-      }) => ({
-        ...update,
-        [id]: {
-          id,
-          browser,
-          testName,
-          storyPath,
-          status: 'pending',
-          storyId
-        }
-      }), {})
-    });
-    const testsByBrowser = testsToStart.reduce((tests, test) => {
-      const {
-        id,
-        browser,
-        testName,
-        storyPath
-      } = test;
-      const restPath = [...storyPath, testName].filter(_types.isDefined);
-      test.status = 'pending';
-      return {
-        ...tests,
-        [browser]: [...(tests[browser] || []), {
-          id,
-          path: restPath
-        }]
-      };
-    }, {});
-    this.browsers.forEach(browser => {
-      const pool = this.pools[browser];
-      const tests = testsByBrowser[browser];
-      if (tests && tests.length > 0 && pool.start(tests)) {
-        pool.once('stop', this.handlePoolStop);
-      }
-    });
-  }
-  stop() {
-    if (!this.isRunning) return;
-    this.browsers.forEach(browser => this.pools[browser].stop());
-  }
-  get status() {
-    const tests = {};
-    Object.values(this.tests).filter(_types.isDefined)
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    .forEach(({
-      story,
-      fn,
-      ...test
-    }) => tests[test.id] = test);
-    return {
-      isRunning: this.isRunning,
-      tests,
-      browsers: this.browsers
-    };
-  }
-  async approve({
-    id,
-    retry,
-    image
-  }) {
-    const test = this.tests[id];
-    if (!test || !test.results) return;
-    const result = test.results[retry];
-    if (!result || !result.images) return;
-    const images = result.images[image];
-    if (!images) return;
-    if (!test.approved) {
-      test.approved = {};
-    }
-    const {
-      browser,
-      testName,
-      storyPath
-    } = test;
-    const restPath = [...storyPath, testName].filter(_types.isDefined);
-    const testPath = _path.default.join(...restPath, image == browser ? '' : browser);
-    const srcImagePath = _path.default.join(this.reportDir, testPath, images.actual);
-    const dstImagePath = _path.default.join(this.screenDir, testPath, `${image}.png`);
-    await mkdirAsync(_path.default.join(this.screenDir, testPath), {
-      recursive: true
-    });
-    await copyFileAsync(srcImagePath, dstImagePath);
-    test.approved[image] = retry;
-    this.sendUpdate({
-      tests: {
-        [id]: {
-          id,
-          browser,
-          testName,
-          storyPath,
-          approved: {
-            [image]: retry
-          },
-          storyId: test.storyId
-        }
-      }
-    });
-  }
-  sendUpdate(data) {
-    this.emit('update', data);
-  }
-}
-exports.default = Runner;

package/lib/cjs/server/master/server.js

@@ -1,110 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = server;
-var _path = _interopRequireDefault(require("path"));
-var _http = _interopRequireDefault(require("http"));
-var _cluster = _interopRequireDefault(require("cluster"));
-var _koa = _interopRequireDefault(require("koa"));
-var _cors = _interopRequireDefault(require("@koa/cors"));
-var _koaStatic = _interopRequireDefault(require("koa-static"));
-var _koaMount = _interopRequireDefault(require("koa-mount"));
-var _koaBodyparser = _interopRequireDefault(require("koa-bodyparser"));
-var _ws = _interopRequireDefault(require("ws"));
-var _messages = require("../messages");
-var _types = require("../../types");
-var _logger = require("../logger");
-var _shared = require("../../shared");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-function server(reportDir, port, ui) {
-  let resolveApi = _types.noop;
-  let setStoriesCounter = 0;
-  const creeveyApi = new Promise(resolve => resolveApi = resolve);
-  const app = new _koa.default();
-  const server = _http.default.createServer(app.callback());
-  const wss = new _ws.default.Server({
-    server
-  });
-  app.use((0, _cors.default)());
-  app.use((0, _koaBodyparser.default)());
-  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();
-    });
-  }
-  app.use(async (ctx, next) => {
-    if (ctx.method == 'POST' && ctx.path == '/stories') {
-      const {
-        setStoriesCounter: counter,
-        stories
-      } = ctx.request.body;
-      if (setStoriesCounter >= counter) return;
-      const deserializedStories = stories.map(([file, stories]) => [file, stories.map(_shared.deserializeStory)]);
-      setStoriesCounter = counter;
-      (0, _messages.emitStoriesMessage)({
-        type: 'update',
-        payload: deserializedStories
-      });
-      Object.values(_cluster.default.workers ?? {}).filter(_types.isDefined).filter(worker => worker.isConnected()).forEach(worker => (0, _messages.sendStoriesMessage)(worker, {
-        type: 'update',
-        payload: deserializedStories
-      }));
-      return;
-    }
-    await next();
-  });
-  app.use(async (ctx, next) => {
-    if (ctx.method == 'POST' && ctx.path == '/capture') {
-      const {
-        workerId,
-        options
-      } = ctx.request.body;
-      const worker = Object.values(_cluster.default.workers ?? {}).filter(_types.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(resolve => {
-        const unsubscribe = (0, _messages.subscribeOnWorker)(worker, 'stories', message => {
-          if (message.type != 'capture') return;
-          unsubscribe();
-          resolve();
-        });
-        (0, _messages.sendStoriesMessage)(worker, {
-          type: 'capture',
-          payload: options
-        });
-      });
-      // TODO Pass screenshot result to show it in inspector
-      ctx.body = 'Ok';
-      return;
-    }
-    await next();
-  });
-  app.use((0, _koaStatic.default)(_path.default.join(__dirname, '../../client/web')));
-  app.use((0, _koaMount.default)('/report', (0, _koaStatic.default)(reportDir)));
-  wss.on('error', error => _logger.logger.error(error));
-  server.listen(port);
-  (0, _messages.subscribeOn)('shutdown', () => {
-    server.close();
-    wss.close();
-    wss.clients.forEach(ws => ws.close());
-  });
-  void creeveyApi.then(api => {
-    api.subscribe(wss);
-    wss.on('connection', ws => {
-      ws.on('message', (message, isBinary) => {
-        api.handleMessage(ws, isBinary ? message : message.toString());
-      });
-    });
-  });
-  return resolveApi;
-}