creevey 0.8.0-beta.0 → 0.8.0

package/lib/cjs/server/utils.js

@@ -3,14 +3,17 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.shouldSkip = shouldSkip;
-exports.shutdownWorkers = shutdownWorkers;
-exports.shutdown = shutdown;
+exports.extensions = exports.downloadBinary = exports.LOCALHOST_REGEXP = void 0;
 exports.getCreeveyCache = getCreeveyCache;
+exports.isShuttingDown = exports.isInsideDocker = void 0;
+exports.removeProps = removeProps;
 exports.runSequence = runSequence;
+exports.shouldSkip = shouldSkip;
+exports.shouldSkipByOption = shouldSkipByOption;
+exports.shutdown = shutdown;
+exports.shutdownWorkers = shutdownWorkers;
+exports.skipOptionKeys = void 0;
 exports.testsToImages = testsToImages;
-exports.removeProps = removeProps;
-exports.downloadBinary = exports.isInsideDocker = exports.skipOptionKeys = exports.extensions = exports.LOCALHOST_REGEXP = exports.isShuttingDown = void 0;
 
 var _fs = require("fs");
 
@@ -46,38 +49,30 @@ function shouldSkip(browser, meta, skipOptions, test) {
     return skipOptions;
   }
 
-  if (Array.isArray(skipOptions)) {
-    for (const skip of skipOptions) {
-      const reason = shouldSkip(browser, meta, skip, test);
-      if (reason) return reason;
-    }
-
-    return false;
+  for (const skipKey in skipOptions) {
+    const reason = shouldSkipByOption(browser, meta, skipOptions[skipKey], skipKey, test);
+    if (reason) return reason;
   }
 
-  let hasSkipOptionKeys = false;
+  return false;
+}
 
-  for (const skipKey in skipOptions) {
-    if (skipOptionKeys.includes(skipKey)) {
-      hasSkipOptionKeys = true;
-      continue;
+function shouldSkipByOption(browser, meta, skipOption, reason, test) {
+  if (Array.isArray(skipOption)) {
+    for (const skip of skipOption) {
+      const result = shouldSkipByOption(browser, meta, skip, reason, test);
+      if (result) return result;
     }
 
-    const reason = shouldSkip(browser, meta, {
-      reason: skipKey,
-      ...skipOptions[skipKey]
-    }, test);
-    if (reason) return reason;
+    return false;
   }
 
-  if (!hasSkipOptionKeys) return false;
   const {
     in: browsers,
     kinds,
     stories,
-    tests,
-    reason = true
-  } = skipOptions;
+    tests
+  } = skipOption;
   const {
     kind,
     story
@@ -91,7 +86,7 @@ function shouldSkip(browser, meta, skipOptions, test) {
 
 async function shutdownWorkers() {
   isShuttingDown.current = true;
-  await Promise.all(Object.values(_cluster.default.workers).filter(_types.isDefined).filter(worker => worker.isConnected()).map(worker => new Promise(resolve => {
+  await Promise.all(Object.values(_cluster.default.workers ?? {}).filter(_types.isDefined).filter(worker => worker.isConnected()).map(worker => new Promise(resolve => {
     const timeout = setTimeout(() => worker.kill(), 10000);
     worker.on('exit', () => {
       clearTimeout(timeout);
@@ -127,9 +122,9 @@ function testsToImages(tests) {
     storyPath,
     results
   }) => {
-    var _results$slice$0$imag, _results$slice$;
+    var _results$slice$;
 
-    return Object.keys((_results$slice$0$imag = results === null || results === void 0 ? void 0 : (_results$slice$ = results.slice(-1)[0]) === null || _results$slice$ === void 0 ? void 0 : _results$slice$.images) !== null && _results$slice$0$imag !== void 0 ? _results$slice$0$imag : {}).map(image => `${[...storyPath, testName, browser, browser == image ? undefined : image].filter(_types.isDefined).join('/')}.png`);
+    return Object.keys((results === null || results === void 0 ? void 0 : (_results$slice$ = results.slice(-1)[0]) === null || _results$slice$ === void 0 ? void 0 : _results$slice$.images) ?? {}).map(image => `${[...storyPath, testName, browser, browser == image ? undefined : image].filter(_types.isDefined).join('/')}.png`);
   })));
 } // https://tuhrig.de/how-to-know-you-are-inside-a-docker-container/
 
@@ -138,19 +133,15 @@ const isInsideDocker = (0, _fs.existsSync)('/proc/1/cgroup') && /docker/.test((0
 exports.isInsideDocker = isInsideDocker;
 
 const downloadBinary = (downloadUrl, destination) => new Promise((resolve, reject) => (0, _https.get)(downloadUrl, response => {
-  var _response$statusCode2;
-
   if (response.statusCode == 302) {
-    var _response$statusCode;
-
     const {
       location
     } = response.headers;
-    if (!location) return reject(new Error(`Couldn't download selenoid. Status code: ${(_response$statusCode = response.statusCode) !== null && _response$statusCode !== void 0 ? _response$statusCode : 'UNKNOWN'}`));
+    if (!location) return reject(new Error(`Couldn't download selenoid. Status code: ${response.statusCode ?? 'UNKNOWN'}`));
     return resolve(downloadBinary(location, destination));
   }
 
-  if (response.statusCode != 200) return reject(new Error(`Couldn't download selenoid. Status code: ${(_response$statusCode2 = response.statusCode) !== null && _response$statusCode2 !== void 0 ? _response$statusCode2 : 'UNKNOWN'}`));
+  if (response.statusCode != 200) return reject(new Error(`Couldn't download selenoid. Status code: ${response.statusCode ?? 'UNKNOWN'}`));
   const fileStream = (0, _fs.createWriteStream)(destination);
   response.pipe(fileStream);
   fileStream.on('finish', () => {

package/lib/cjs/server/worker/helpers.js

@@ -56,14 +56,10 @@ function removeTestOrSuite(testOrSuite) {
 
 async function addTestsFromStories(rootSuite, config, {
   browser,
-  watch,
-  debug
+  ...options
 }) {
   const mochaTestsById = new Map();
-  const tests = await (0, _stories.loadTestsFromStories)([browser], listener => config.storiesProvider(config, {
-    watch,
-    debug
-  }, listener), testsDiff => Object.entries(testsDiff).forEach(([id, newTest]) => {
+  const tests = await (0, _stories.loadTestsFromStories)([browser], listener => config.storiesProvider(config, options, listener), testsDiff => Object.entries(testsDiff).forEach(([id, newTest]) => {
     const oldTest = mochaTestsById.get(id);
     mochaTestsById.delete(id);
     if (oldTest) removeTestOrSuite(oldTest);

package/lib/cjs/server/worker/reporter.js

@@ -17,8 +17,6 @@ var _logger = require("../logger");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
 const testLevels = {
   INFO: _chalk.default.green('PASS'),
   WARN: _chalk.default.yellow('START'),
@@ -43,11 +41,7 @@ class CreeveyReporter extends _mocha.reporters.Base {
 
     runner.on('test', test => testLogger.warn(_chalk.default.cyan(test.titlePath().join('/'))));
     runner.on('pass', test => testLogger.info(_chalk.default.cyan(test.titlePath().join('/'))));
-    runner.on('fail', (test, error) => testLogger.error(_chalk.default.cyan(test.titlePath().join('/')), '\n  ', getErrors(error, (error, imageName) => `${_chalk.default.bold(imageName !== null && imageName !== void 0 ? imageName : topLevelSuite)}:${error}`, error => {
-      var _error$stack;
-
-      return `${(_error$stack = error.stack) !== null && _error$stack !== void 0 ? _error$stack : error.message}`;
-    }).join('\n  ')));
+    runner.on('fail', (test, error) => testLogger.error(_chalk.default.cyan(test.titlePath().join('/')), '\n  ', getErrors(error, (error, imageName) => `${_chalk.default.bold(imageName ?? topLevelSuite)}:${error}`, error => `${error.stack ?? error.message}`).join('\n  ')));
   }
 
 }
@@ -57,20 +51,11 @@ exports.CreeveyReporter = CreeveyReporter;
 class TeamcityReporter extends _mocha.reporters.Base {
   constructor(runner, options) {
     super(runner);
-
-    _defineProperty(this, "escape", str => {
-      if (!str) return '';
-      return str.toString() // eslint-disable-next-line no-control-regex
-      .replace(/\x1B.*?m/g, '').replace(/\|/g, '||').replace(/\n/g, '|n').replace(/\r/g, '|r').replace(/\[/g, '|[').replace(/\]/g, '|]').replace(/\u0085/g, '|x').replace(/\u2028/g, '|l').replace(/\u2029/g, '|p').replace(/'/g, "|'");
-    });
-
     const topLevelSuite = this.escape(options.reporterOptions.topLevelSuite);
     const reporterOptions = options.reporterOptions;
     runner.on('suite', suite => suite.root ? console.log(`##teamcity[testSuiteStarted name='${topLevelSuite}' flowId='${process.pid}']`) : console.log(`##teamcity[testSuiteStarted name='${this.escape(suite.title)}' flowId='${process.pid}']`));
     runner.on('test', test => console.log(`##teamcity[testStarted name='${this.escape(test.title)}' flowId='${process.pid}']`));
     runner.on('fail', (test, error) => {
-      var _error$stack2;
-
       Object.entries(reporterOptions.images).forEach(([name, image]) => {
         if (!image) return;
         const filePath = test.titlePath().concat(name == topLevelSuite ? [] : [topLevelSuite]).map(this.escape).join('/'); // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -86,7 +71,7 @@ class TeamcityReporter extends _mocha.reporters.Base {
       }); // Output failed test as passed due TC don't support retry mechanic
       // https://teamcity-support.jetbrains.com/hc/en-us/community/posts/207216829-Count-test-as-successful-if-at-least-one-try-is-successful?page=1#community_comment_207394125
 
-      reporterOptions.willRetry ? console.log(`##teamcity[testFinished name='${this.escape(test.title)}' flowId='${process.pid}']`) : console.log(`##teamcity[testFailed name='${this.escape(test.title)}' message='${this.escape(error.message)}' details='${this.escape((_error$stack2 = error.stack) !== null && _error$stack2 !== void 0 ? _error$stack2 : '')}' flowId='${process.pid}']`);
+      reporterOptions.willRetry ? console.log(`##teamcity[testFinished name='${this.escape(test.title)}' flowId='${process.pid}']`) : console.log(`##teamcity[testFailed name='${this.escape(test.title)}' message='${this.escape(error.message)}' details='${this.escape(error.stack ?? '')}' flowId='${process.pid}']`);
     });
     runner.on('pending', test => console.log(`##teamcity[testIgnored name='${this.escape(test.title)}' message='${this.escape(typeof test.skipReason == 'boolean' ? test.title : test.skipReason)}' flowId='${process.pid}']`));
     runner.on('test end', test => console.log(`##teamcity[testFinished name='${this.escape(test.title)}' flowId='${process.pid}']`));
@@ -94,6 +79,11 @@ class TeamcityReporter extends _mocha.reporters.Base {
     runner.on('end', () => console.log(`##teamcity[testSuiteFinished name='${topLevelSuite}' flowId='${process.pid}']`));
   }
 
+  escape = str => {
+    if (!str) return '';
+    return str.toString() // eslint-disable-next-line no-control-regex
+    .replace(/\x1B.*?m/g, '').replace(/\|/g, '||').replace(/\n/g, '|n').replace(/\r/g, '|r').replace(/\[/g, '|[').replace(/\]/g, '|]').replace(/\u0085/g, '|x').replace(/\u2028/g, '|l').replace(/\u2029/g, '|p').replace(/'/g, "|'");
+  };
 }
 
 exports.TeamcityReporter = TeamcityReporter;
@@ -110,9 +100,7 @@ function getErrors(error, imageErrorToString, errorToString) {
   } else {
     const imageErrors = error.images;
     Object.keys(imageErrors).forEach(imageName => {
-      var _imageErrors$imageNam;
-
-      errors.push(imageErrorToString((_imageErrors$imageNam = imageErrors[imageName]) !== null && _imageErrors$imageNam !== void 0 ? _imageErrors$imageNam : '', imageName));
+      errors.push(imageErrorToString(imageErrors[imageName] ?? '', imageName));
     });
   }
 

package/lib/cjs/server/worker/worker.js

@@ -57,9 +57,7 @@ async function getLastImageNumber(imageDir, imageName) {
   const actualImagesRegexp = new RegExp(`${imageName}-actual-(\\d+)\\.png`);
 
   try {
-    var _await$readdirAsync$m;
-
-    return (_await$readdirAsync$m = (await readdirAsync(imageDir)).map(filename => filename.replace(actualImagesRegexp, '$1')).map(Number).filter(x => !isNaN(x)).sort((a, b) => b - a)[0]) !== null && _await$readdirAsync$m !== void 0 ? _await$readdirAsync$m : 0;
+    return (await readdirAsync(imageDir)).map(filename => filename.replace(actualImagesRegexp, '$1')).map(Number).filter(x => !isNaN(x)).sort((a, b) => b - a)[0] ?? 0;
   } catch (_error) {
     return 0;
   }
@@ -72,12 +70,11 @@ async function worker(config, options) {
   let retries = 0;
   let images = {};
   let error = undefined;
+  const screenshots = [];
   const testScope = [];
 
   function runHandler(failures) {
     if (failures > 0 && (error || Object.values(images).some(image => (image === null || image === void 0 ? void 0 : image.error) != null))) {
-      var _error2;
-
       const isTimeout = hasTimeout(error) || Object.values(images).some(image => hasTimeout(image === null || image === void 0 ? void 0 : image.error));
       const payload = {
         status: 'failed',
@@ -87,7 +84,7 @@ async function worker(config, options) {
       isTimeout ? (0, _messages.emitWorkerMessage)({
         type: 'error',
         payload: {
-          error: (_error2 = error) !== null && _error2 !== void 0 ? _error2 : 'Unknown error'
+          error: error ?? 'Unknown error'
         }
       }) : (0, _messages.emitTestMessage)({
         type: 'end',
@@ -118,20 +115,18 @@ async function worker(config, options) {
   }
 
   async function getExpected(assertImageName) {
-    var _images$imageName;
-
     // context => [kind, story, test, browser]
     // rootSuite -> kindSuite -> storyTest -> [browsers.png]
     // rootSuite -> kindSuite -> storySuite -> test -> [browsers.png]
     const testPath = [...testScope];
-    const imageName = assertImageName !== null && assertImageName !== void 0 ? assertImageName : testPath.pop();
+    const imageName = assertImageName ?? testPath.pop();
     const imagesMeta = [];
 
     const reportImageDir = _path.default.join(config.reportDir, ...testPath);
 
     const imageNumber = (await getLastImageNumber(reportImageDir, imageName)) + 1;
     const actualImageName = `${imageName}-actual-${imageNumber}.png`;
-    const image = images[imageName] = (_images$imageName = images[imageName]) !== null && _images$imageName !== void 0 ? _images$imageName : {
+    const image = images[imageName] = images[imageName] ?? {
       actual: actualImageName
     };
 
@@ -194,20 +189,28 @@ async function worker(config, options) {
 
     }
   };
-  const mocha = new _mocha.default(mochaOptions); // @ts-expect-error: @types/mocha has out-dated types
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-call
-
+  const mocha = new _mocha.default(mochaOptions);
   mocha.cleanReferencesAfterRun(false);
 
   _chai.default.use((0, _chaiImage.default)(getExpected, config.diffOptions));
 
+  if ((await (0, _selenium.getBrowser)(config, options.browser)) == null) return;
   await (0, _helpers.addTestsFromStories)(mocha.suite, config, {
     browser: options.browser,
     watch: options.ui,
-    debug: options.debug
+    debug: options.debug,
+    port: options.port
   });
-  const browserConfig = config.browsers[options.browser];
-  const browser = await (0, _selenium.getBrowser)(config, browserConfig);
+
+  try {
+    var _await$getBrowser;
+
+    await ((_await$getBrowser = await (0, _selenium.getBrowser)(config, options.browser)) === null || _await$getBrowser === void 0 ? void 0 : _await$getBrowser.getCurrentUrl());
+  } catch (_) {
+    await (0, _selenium.closeBrowser)();
+  }
+
+  const browser = await (0, _selenium.getBrowser)(config, options.browser);
   const sessionId = (_await$browser$getSes = await (browser === null || browser === void 0 ? void 0 : browser.getSession())) === null || _await$browser$getSes === void 0 ? void 0 : _await$browser$getSes.getId();
   if (browser == null) return;
   const interval = setInterval(() => void browser.getCurrentUrl().then(url => {
@@ -222,6 +225,7 @@ async function worker(config, options) {
     this.expect = _chai.default.expect;
     this.browserName = options.browser;
     this.testScope = testScope;
+    this.screenshots = screenshots;
   });
   mocha.suite.beforeEach(_selenium.switchStory);
   (0, _messages.subscribeOn)('test', message => {
@@ -238,9 +242,7 @@ async function worker(config, options) {
       if (!(reason instanceof Error)) {
         error = reason;
       } else if (!(0, _types.isImageError)(reason)) {
-        var _reason$stack;
-
-        error = (_reason$stack = reason.stack) !== null && _reason$stack !== void 0 ? _reason$stack : reason.message;
+        error = reason.stack ?? reason.message;
       } else if (typeof reason.images == 'string') {
         const image = images[testScope.slice(-1)[0]];
         if (image) image.error = reason.images;

package/lib/cjs/shared/index.js

@@ -0,0 +1,101 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.serializeRawStories = exports.deserializeStory = exports.deserializeRawStories = exports.denormalizeStoryParameters = exports.combineParameters = void 0;
+
+var _lodash = require("lodash");
+
+var _serializeRegExp = require("./serializeRegExp");
+
+// NOTE: Copy-paste from storybook/api
+const combineParameters = function () {
+  for (var _len = arguments.length, parameterSets = new Array(_len), _key = 0; _key < _len; _key++) {
+    parameterSets[_key] = arguments[_key];
+  }
+
+  return (// eslint-disable-next-line @typescript-eslint/no-unsafe-return
+    (0, _lodash.mergeWith)({}, ...parameterSets, (_, srcValue) => {
+      // Treat arrays as scalars:
+      if (Array.isArray(srcValue)) return srcValue;
+      return undefined;
+    })
+  );
+}; // NOTE: Copy-paste from storybook/api
+
+
+exports.combineParameters = combineParameters;
+
+const denormalizeStoryParameters = _ref => {
+  let {
+    globalParameters,
+    kindParameters,
+    stories
+  } = _ref;
+  return (0, _lodash.mapValues)(stories, storyData => {
+    var _kindParameters$story;
+
+    return { ...storyData,
+      parameters: combineParameters(globalParameters, (_kindParameters$story = kindParameters[storyData.kind]) !== null && _kindParameters$story !== void 0 ? _kindParameters$story : {}, storyData.parameters)
+    };
+  });
+};
+
+exports.denormalizeStoryParameters = denormalizeStoryParameters;
+
+const serializeRawStories = stories => {
+  return (0, _lodash.mapValues)(stories, storyData => {
+    const creevey = storyData.parameters.creevey;
+
+    if (creevey !== null && creevey !== void 0 && creevey.skip) {
+      return { ...storyData,
+        parameters: { ...storyData.parameters,
+          creevey: { ...creevey,
+            skip: (0, _lodash.cloneDeepWith)(creevey.skip, value => {
+              if ((0, _serializeRegExp.isRegExp)(value)) {
+                return (0, _serializeRegExp.serializeRegExp)(value);
+              }
+
+              return undefined;
+            })
+          }
+        }
+      };
+    }
+
+    return storyData;
+  });
+};
+
+exports.serializeRawStories = serializeRawStories;
+
+const deserializeRawStories = stories => {
+  return (0, _lodash.mapValues)(stories, deserializeStory);
+};
+
+exports.deserializeRawStories = deserializeRawStories;
+
+const deserializeStory = story => {
+  const creevey = story.parameters.creevey;
+
+  if (creevey !== null && creevey !== void 0 && creevey.skip) {
+    return { ...story,
+      parameters: { ...story.parameters,
+        creevey: { ...creevey,
+          skip: (0, _lodash.cloneDeepWith)(creevey.skip, value => {
+            if ((0, _serializeRegExp.isSerializedRegExp)(value)) {
+              return (0, _serializeRegExp.deserializeRegExp)(value);
+            }
+
+            return undefined;
+          })
+        }
+      }
+    };
+  }
+
+  return story;
+};
+
+exports.deserializeStory = deserializeStory;

package/lib/cjs/shared/serializeRegExp.js

@@ -0,0 +1,42 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.serializeRegExp = exports.isSerializedRegExp = exports.isRegExp = exports.deserializeRegExp = void 0;
+
+const isRegExp = exp => {
+  return exp instanceof RegExp;
+};
+
+exports.isRegExp = isRegExp;
+
+const isSerializedRegExp = exp => {
+  return typeof exp === 'object' && exp !== null && Reflect.get(exp, '__regexp') === true;
+};
+
+exports.isSerializedRegExp = isSerializedRegExp;
+
+const serializeRegExp = exp => {
+  const {
+    source,
+    flags
+  } = exp;
+  return {
+    __regexp: true,
+    source,
+    flags
+  };
+};
+
+exports.serializeRegExp = serializeRegExp;
+
+const deserializeRegExp = _ref => {
+  let {
+    source,
+    flags
+  } = _ref;
+  return new RegExp(source, flags);
+};
+
+exports.deserializeRegExp = deserializeRegExp;

package/lib/cjs/types.js

@@ -3,18 +3,19 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.noop = noop;
 exports.isDefined = isDefined;
-exports.isTest = isTest;
-exports.isObject = isObject;
-exports.isString = isString;
+exports.isDockerMessage = isDockerMessage;
 exports.isFunction = isFunction;
 exports.isImageError = isImageError;
+exports.isObject = isObject;
 exports.isProcessMessage = isProcessMessage;
-exports.isWorkerMessage = isWorkerMessage;
+exports.isStoriesMessage = isStoriesMessage;
+exports.isString = isString;
+exports.isTest = isTest;
 exports.isTestMessage = isTestMessage;
 exports.isWebpackMessage = isWebpackMessage;
-exports.isDockerMessage = isDockerMessage;
+exports.isWorkerMessage = isWorkerMessage;
+exports.noop = noop;
 
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
@@ -56,6 +57,10 @@ function isWorkerMessage(message) {
   return isProcessMessage(message) && message.scope == 'worker';
 }
 
+function isStoriesMessage(message) {
+  return isProcessMessage(message) && message.scope == 'stories';
+}
+
 function isTestMessage(message) {
   return isProcessMessage(message) && message.scope == 'test';
 }