creevey 0.9.0-beta.2 → 0.9.0-beta.20

package/lib/esm/client/web/main.js.LICENSE.txt

@@ -0,0 +1,34 @@
+/*
+object-assign
+(c) Sindre Sorhus
+@license MIT
+*/
+
+/*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */
+
+/** @license React v0.20.2
+ * scheduler.production.min.js
+ *
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/** @license React v17.0.2
+ * react-dom.production.min.js
+ *
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/** @license React v17.0.2
+ * react.production.min.js
+ *
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */

package/lib/esm/creevey.js

@@ -6,12 +6,9 @@ import { emitWorkerMessage } from './server/messages';
 import { isShuttingDown, shutdown, shutdownWorkers } from './server/utils';
 import { setDefaultLevel, levels } from 'loglevel';
 import { logger } from './server/logger';
-
 function shutdownOnException(reason) {
-  var _reason$stack;
-
   if (isShuttingDown.current) return;
-  const error = reason instanceof Error ? (_reason$stack = reason.stack) !== null && _reason$stack !== void 0 ? _reason$stack : reason.message : reason;
+  const error = reason instanceof Error ? reason.stack ?? reason.message : reason;
   logger.error(error);
   process.exitCode = -1;
   if (cluster.isWorker) emitWorkerMessage({
@@ -20,16 +17,15 @@ function shutdownOnException(reason) {
       error
     }
   });
-  if (cluster.isMaster && !isShuttingDown.current) void shutdownWorkers();
+  if (cluster.isPrimary && !isShuttingDown.current) void shutdownWorkers();
 }
-
 process.on('uncaughtException', shutdownOnException);
 process.on('unhandledRejection', shutdownOnException);
 if (cluster.isWorker) process.on('SIGINT', noop);
-if (cluster.isMaster) process.on('SIGINT', shutdown);
+if (cluster.isPrimary) process.on('SIGINT', shutdown);
 const argv = minimist(process.argv.slice(2), {
-  string: ['browser', 'config', 'reporter', 'reportDir', 'screenDir'],
-  boolean: ['debug', 'ui', 'saveReport', 'webpack', 'tests'],
+  string: ['browser', 'config', 'reporter', 'reportDir', 'screenDir', 'storybookUrl'],
+  boolean: ['debug', 'trace', 'ui', 'saveReport', 'tests'],
   default: {
     port: 3000,
     saveReport: true
@@ -38,19 +34,20 @@ const argv = minimist(process.argv.slice(2), {
     port: 'p',
     config: 'c',
     debug: 'd',
-    update: 'u',
-    extract: 'e'
+    update: 'u'
   }
-}); // @ts-expect-error: define log level for storybook
+});
 
-global.LOGLEVEL = argv.debug ? 'debug' : 'warn';
-
-if (argv.debug) {
+// @ts-expect-error: define log level for storybook
+global.LOGLEVEL = argv.trace ? 'trace' : argv.debug ? 'debug' : 'warn';
+if (argv.trace) {
+  logger.setDefaultLevel(levels.TRACE);
+  setDefaultLevel(levels.TRACE);
+} else if (argv.debug) {
   logger.setDefaultLevel(levels.DEBUG);
   setDefaultLevel(levels.DEBUG);
 } else {
   logger.setDefaultLevel(levels.INFO);
   setDefaultLevel(levels.INFO);
 }
-
 void creevey(argv);

package/lib/esm/index.js

@@ -1,7 +1,4 @@
-export * from './types'; // export * from './client/addon/withCreevey';
-// export * from './client/addon/readyForCapture';
-
+export * from './types';
 export { loadStories as browserStoriesProvider } from './server/storybook/providers/browser';
-export { loadStories as nodejsStoriesProvider } from './server/storybook/providers/nodejs';
 export { loadStories as hybridStoriesProvider } from './server/storybook/providers/hybrid';
 export * from './server/testsFiles/parser';

package/lib/esm/server/config.js

@@ -1,13 +1,11 @@
 import fs from 'fs';
 import path from 'path';
-import { isCSFv3Enabled, isStorybookVersionGreaterThan, isStorybookVersionLessThan, storybookDirRef } from './storybook/helpers';
-import { loadStories as nodejsStoriesProvider } from './storybook/providers/nodejs';
 import { loadStories as browserStoriesProvider } from './storybook/providers/browser';
 import { isDefined } from '../types';
 export const defaultBrowser = 'chrome';
 export const defaultConfig = {
+  disableTelemetry: false,
   useDocker: true,
-  useWebpackToExtractTests: false,
   dockerImage: 'aerokube/selenoid:latest-release',
   dockerImagePlatform: '',
   pullImages: true,
@@ -15,7 +13,6 @@ export const defaultConfig = {
   storybookUrl: 'http://localhost:6006',
   screenDir: path.resolve('images'),
   reportDir: path.resolve('report'),
-  storybookDir: path.resolve('.storybook'),
   maxRetries: 0,
   diffOptions: {
     threshold: 0,
@@ -28,7 +25,6 @@ export const defaultConfig = {
   babelOptions: _ => _,
   testsRegex: /\.creevey\.(t|j)s$/
 };
-
 function normalizeBrowserConfig(name, config) {
   if (typeof config == 'boolean') return {
     browserName: name
@@ -38,35 +34,32 @@ function normalizeBrowserConfig(name, config) {
   };
   return config;
 }
-
 function resolveConfigPath(configPath) {
   const rootDir = process.cwd();
   const configDir = path.resolve('.creevey');
-
   if (isDefined(configPath)) {
     configPath = path.resolve(configPath);
   } else if (fs.existsSync(configDir)) {
-    configPath = path.join(configDir, 'config'); // TODO We already find file with extension, why not use it?
+    configPath = path.join(configDir, 'config');
+    // TODO We already find file with extension, why not use it?
   } else if (fs.readdirSync(rootDir).find(filename => filename.startsWith('creevey.config'))) {
     configPath = path.join(rootDir, 'creevey.config');
   }
-
   return configPath;
 }
-
 export async function readConfig(options) {
   const configPath = resolveConfigPath(options.config);
-  const userConfig = { ...defaultConfig
+  const userConfig = {
+    ...defaultConfig
   };
   if (isDefined(configPath)) Object.assign(userConfig, (await import(configPath)).default);
-  storybookDirRef.current = userConfig.storybookDir;
-  if (isStorybookVersionLessThan(6, 2)) userConfig.useWebpackToExtractTests = true;
-  if (!userConfig.storiesProvider) userConfig.storiesProvider = (await isCSFv3Enabled()) && isStorybookVersionGreaterThan(5) ? browserStoriesProvider : nodejsStoriesProvider;
-  if (userConfig.storiesProvider == browserStoriesProvider && isStorybookVersionLessThan(6)) throw new Error("Creevey browser stories provider doesn't support Storybook 5.x or older versions");
+  if (!userConfig.storiesProvider) userConfig.storiesProvider = browserStoriesProvider;
   if (options.failFast != undefined) userConfig.failFast = Boolean(options.failFast);
   if (options.reportDir) userConfig.reportDir = path.resolve(options.reportDir);
-  if (options.screenDir) userConfig.screenDir = path.resolve(options.screenDir); // NOTE: Hack to pass typescript checking
+  if (options.screenDir) userConfig.screenDir = path.resolve(options.screenDir);
+  if (options.storybookUrl) userConfig.storybookUrl = options.storybookUrl;
 
+  // NOTE: Hack to pass typescript checking
   const config = userConfig;
   Object.entries(config.browsers).forEach(([browser, browserConfig]) => config.browsers[browser] = normalizeBrowserConfig(browser, browserConfig));
   return config;

package/lib/esm/server/docker.js

@@ -1,4 +1,4 @@
-import cluster, { isMaster } from 'cluster';
+import cluster from 'cluster';
 import { isDockerMessage } from '../types';
 import { subscribeOn, sendDockerMessage, emitDockerMessage } from './messages';
 import { isInsideDocker, LOCALHOST_REGEXP } from './utils';
@@ -7,14 +7,11 @@ import { Writable } from 'stream';
 import ora from 'ora';
 import { logger } from './logger';
 const docker = new Dockerode();
-
 class DevNull extends Writable {
   _write(_chunk, _encoding, callback) {
     setImmediate(callback);
   }
-
 }
-
 export async function pullImages(images, {
   auth,
   platform
@@ -23,30 +20,27 @@ export async function pullImages(images, {
   if (auth) args.authconfig = auth;
   if (platform) args.platform = platform;
   logger.info('Pull docker images');
-
   for (const image of images) {
     await new Promise((resolve, reject) => {
-      const spinner = ora(`${image}: Pull start`).start(); // eslint-disable-next-line @typescript-eslint/no-floating-promises
+      const spinner = ora(`${image}: Pull start`).start();
 
+      // eslint-disable-next-line @typescript-eslint/no-floating-promises
       docker.pull(image, args, function (pullError, stream) {
         if (pullError) {
           spinner.fail();
           return reject(pullError);
-        } // eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
-
+        }
 
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
         docker.modem.followProgress(stream, onFinished, onProgress);
-
         function onFinished(error) {
           if (error) {
             spinner.fail();
             return reject(error);
           }
-
           spinner.succeed(`${image}: Pull complete`);
           resolve();
         }
-
         function onProgress(event) {
           if (!/^[a-z0-9]{12}$/i.test(event.id)) return;
           spinner.text = `${image}: [${event.id}] ${event.status} ${event.progress ? `${event.progress}` : ''}`;
@@ -63,13 +57,11 @@ export async function runImage(image, args, options, debug) {
     }
   })).map(async info => {
     const container = docker.getContainer(info.Id);
-
     try {
       await container.stop();
     } catch (_) {
       /* noop */
     }
-
     await container.remove();
   }));
   const hub = docker.run(image, args, debug ? process.stdout : new DevNull(), options, error => {
@@ -91,7 +83,7 @@ export async function runImage(image, args, options, debug) {
   });
 }
 export default async function (config, browser, startContainer) {
-  if (isMaster) {
+  if (cluster.isPrimary) {
     const host = await startContainer();
     let gridUrl = 'http://localhost:4444/wd/hub';
     gridUrl = isInsideDocker ? gridUrl.replace(LOCALHOST_REGEXP, host) : gridUrl;

package/lib/esm/server/index.js

@@ -1,7 +1,8 @@
 import cluster from 'cluster';
 import { readConfig, defaultBrowser } from './config';
-import { logger } from './logger'; // NOTE: Impure function, mutate config by adding gridUrl prop
+import { logger } from './logger';
 
+// NOTE: Impure function, mutate config by adding gridUrl prop
 async function startWebdriverServer(config, options) {
   if (config.useDocker) {
     return (await import('./docker')).default(config, options.browser, async () => (await import('./selenium/selenoid')).startSelenoidContainer(config, options.debug));
@@ -9,54 +10,39 @@ async function startWebdriverServer(config, options) {
     return (await import('./selenium/selenoid')).startSelenoidStandalone(config, options.debug);
   }
 }
-
 export default async function (options) {
   const config = await readConfig(options);
   const {
     browser = defaultBrowser,
-    extract,
     tests,
     update,
-    webpack,
     ui,
     port
   } = options;
-  if (!config) return; // NOTE: We don't need docker nor selenoid for webpack or update options
+  if (!config) return;
 
+  // NOTE: We don't need docker nor selenoid for webpack or update options
   if (!(config.gridUrl || Object.values(config.browsers).every(({
     gridUrl
-  }) => gridUrl)) && !extract && !webpack && !tests && !update) {
+  }) => gridUrl)) && !tests && !update) {
     await startWebdriverServer(config, options);
   }
-
   switch (true) {
-    case Boolean(extract) || tests:
-      {
-        return (await import('./extract')).default(config, options);
-      }
-
     case Boolean(update):
       {
         return (await import('./update')).default(config, typeof update == 'string' ? update : undefined);
       }
-
-    case webpack:
-      {
-        logger.info('Starting Webpack Compiler');
-        return (await import('./loaders/webpack/compile')).default(config, options);
-      }
-
-    case cluster.isMaster:
+    case cluster.isPrimary:
       {
         logger.info('Starting Master Process');
         const resolveApi = (await import('./master/server')).default(config.reportDir, port, ui);
         return (await import('./master')).default(config, options, resolveApi);
       }
-
     default:
       {
         logger.info(`Starting Worker for ${browser}`);
-        return (await import('./worker')).default(config, { ...options,
+        return (await import('./worker')).default(config, {
+          ...options,
           browser
         });
       }

package/lib/esm/server/logger.js

@@ -15,6 +15,5 @@ prefix.apply(Logger, {
     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

@@ -1,6 +1,5 @@
 import WebSocket from 'ws';
 import { logger } from '../logger';
-
 function broadcast(wss, message) {
   wss.clients.forEach(ws => {
     if (ws.readyState === WebSocket.OPEN) {
@@ -8,7 +7,6 @@ function broadcast(wss, message) {
     }
   });
 }
-
 export default function creeveyApi(runner) {
   return {
     subscribe(wss) {
@@ -17,15 +15,12 @@ export default function creeveyApi(runner) {
         payload
       }));
     },
-
     handleMessage(ws, message) {
       if (typeof message != 'string') {
         logger.info('unhandled message', message);
         return;
       }
-
       const command = JSON.parse(message);
-
       switch (command.type) {
         case 'status':
           {
@@ -35,19 +30,16 @@ export default function creeveyApi(runner) {
             }));
             return;
           }
-
         case 'start':
           {
             runner.start(command.payload);
             return;
           }
-
         case 'stop':
           {
             runner.stop();
             return;
           }
-
         case 'approve':
           {
             void runner.approve(command.payload);
@@ -55,6 +47,5 @@ export default function creeveyApi(runner) {
           }
       }
     }
-
   };
 }

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

@@ -1,5 +1,5 @@
 import path from 'path';
-import { writeFileSync, copyFile, readdir, mkdir, existsSync } from 'fs';
+import { copyFile, readdir, mkdir, existsSync, writeFile } from 'fs';
 import { promisify } from 'util';
 import master from './master';
 import creeveyApi from './api';
@@ -7,10 +7,11 @@ import { isDefined } from '../../types';
 import { shutdown, shutdownWorkers, testsToImages, readDirRecursive } from '../utils';
 import { subscribeOn } from '../messages';
 import { logger } from '../logger';
+import { sendScreenshotsCount } from '../telemetry';
+const writeFileAsync = promisify(writeFile);
 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, {
@@ -19,12 +20,10 @@ async function copyStatics(reportDir) {
   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) {
@@ -36,44 +35,34 @@ function reportDataModule(data) {
 }(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');
-
+    (_runner = runner) === null || _runner === 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();
+      (_runner4 = runner) === null || _runner4 === void 0 || _runner4.stop();
     } else {
       void shutdownWorkers();
     }
@@ -83,43 +72,44 @@ export default async function (config, options, resolveApi) {
     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));
+      void copyStatics(config.reportDir).then(() => {
+        var _runner5;
+        return writeFileAsync(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
-
+      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 _runner$status$tests, _runner6;
-
-      const tests = Object.values((_runner$status$tests = (_runner6 = runner) === null || _runner6 === void 0 ? void 0 : _runner6.status.tests) !== null && _runner$status$tests !== void 0 ? _runner$status$tests : {});
+      var _runner6, _runner7;
+      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
-
+      }) => 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
-
+      if (!config.failFast) outputUnnecessaryImages(config.screenDir, testsToImages(tests));
+      sendScreenshotsCount(config, options, (_runner7 = runner) === null || _runner7 === void 0 ? void 0 : _runner7.status).catch(reason => {
+        const error = reason instanceof Error ? reason.stack ?? reason.message : reason;
+        logger.warn(`Can't send telemetry: ${error}`);
+      }).finally(() => {
+        // 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

@@ -2,8 +2,6 @@ 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];
@@ -15,18 +13,15 @@ function mergeTests(testsWithReports, testsFromStories) {
   });
   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
+  } 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);