creevey 0.7.39 → 0.9.0-beta.0

package/lib/cjs/server/storybook/{nodejs-provider.js → providers/nodejs.js}

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.loadStories = loadStories;
+exports.extractStoriesData = extractStoriesData;
 
 var _path = _interopRequireDefault(require("path"));
 
@@ -11,17 +12,17 @@ var _cluster = require("cluster");
 
 var _chokidar = _interopRequireDefault(require("chokidar"));
 
-var _types = require("../../types");
+var _types = require("../../../types");
 
-var _utils = require("../utils");
+var _utils = require("../../utils");
 
-var _messages = require("../messages");
+var _messages = require("../../messages");
 
-var _helpers = require("./helpers");
+var _helpers = require("../helpers");
 
-var _logger = require("../logger");
+var _logger = require("../../logger");
 
-var _stories = require("../stories");
+var _shared = require("../../../shared");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
@@ -30,7 +31,7 @@ function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "functio
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 
 async function initStorybookEnvironment() {
-  // @ts-ignore
+  // @ts-expect-error There is no @types/global-jsdom package
   (await Promise.resolve().then(() => _interopRequireWildcard(require('global-jsdom')))).default(undefined, {
     url: 'http://localhost'
   }); // NOTE Cutoff `jsdom` part from userAgent, because storybook check enviroment and create events channel if runs in browser
@@ -48,7 +49,7 @@ async function initStorybookEnvironment() {
   if (_cluster.isWorker) logger.warn = _types.noop; // NOTE: disable logger for 5.x storybook
 
   logger.debug = _types.noop;
-  return Promise.resolve().then(() => _interopRequireWildcard(require('./entry')));
+  return Promise.resolve().then(() => _interopRequireWildcard(require('../entry')));
 }
 
 function watchStories(channel, watcher, initialFiles) {
@@ -59,7 +60,7 @@ function watchStories(channel, watcher, initialFiles) {
   watcher.on('change', filePath => storiesByFiles.set(_path.default.isAbsolute(filePath) ? filePath : `./${filePath.replace(/\\/g, '/')}`, []));
   watcher.on('unlink', filePath => storiesByFiles.set(_path.default.isAbsolute(filePath) ? filePath : `./${filePath.replace(/\\/g, '/')}`, []));
   return data => {
-    const stories = (0, _helpers.isStorybookVersionLessThan)(6) ? data.stories : (0, _stories.flatStories)(data);
+    const stories = (0, _helpers.isStorybookVersionLessThan)(6) || (0, _helpers.isStorybookVersionGreaterThan)(6, 3) ? data.stories : (0, _shared.denormalizeStoryParameters)(data);
     const files = new Set(Object.values(stories).map(story => story.parameters.fileName));
     const addedFiles = Array.from(files).filter(filePath => !watchingFiles.has(filePath));
     const removedFiles = Array.from(watchingFiles).filter(filePath => !files.has(filePath));
@@ -104,13 +105,14 @@ async function loadStoriesDirectly(config, {
   debug
 }) {
   const {
-    toRequireContext
+    toRequireContext,
+    normalizeStoriesEntry
   } = await (0, _helpers.importStorybookCoreCommon)();
   const {
     addParameters,
     configure
-  } = await Promise.resolve().then(() => _interopRequireWildcard(require('./entry')));
-  const requireContext = await (await Promise.resolve().then(() => _interopRequireWildcard(require('../loaders/babel/register')))).default(config, debug);
+  } = await Promise.resolve().then(() => _interopRequireWildcard(require('../entry')));
+  const requireContext = await (await Promise.resolve().then(() => _interopRequireWildcard(require('../../loaders/babel/register')))).default(config, debug);
 
   const preview = (() => {
     try {
@@ -123,12 +125,16 @@ async function loadStoriesDirectly(config, {
   const {
     stories
   } = await (0, _helpers.importStorybookConfig)();
-  const contexts = stories.map(input => {
+  const contexts = stories.map(entry => {
+    const normalizedEntry = (0, _helpers.isStorybookVersionLessThan)(6, 4) ? entry : normalizeStoriesEntry(entry, {
+      configDir: config.storybookDir,
+      workingDir: process.cwd()
+    });
     const {
       path: storiesPath,
       recursive,
       match
-    } = toRequireContext(input);
+    } = toRequireContext(normalizedEntry);
     watcher === null || watcher === void 0 ? void 0 : watcher.add(_path.default.resolve(config.storybookDir, storiesPath));
     return () => requireContext(storiesPath, recursive, new RegExp(match));
   });
@@ -182,7 +188,8 @@ async function loadStoriesDirectly(config, {
     void startStorybook();
   });
   void startStorybook();
-}
+} // TODO Do we need to support multiple storybooks here?
+
 
 async function loadStories(config, {
   watch,
@@ -195,16 +202,16 @@ async function loadStories(config, {
   } = storybookApi;
   channel.removeAllListeners(Events.CURRENT_STORY_WAS_SET);
   channel.on('storiesUpdated', storiesListener);
-  let watcher = null;
+  let watcher;
   if (watch) watcher = _chokidar.default.watch([], {
     ignoreInitial: true
   });
   const loadPromise = new Promise(resolve => {
     channel.once(Events.SET_STORIES, data => {
-      const stories = (0, _helpers.isStorybookVersionLessThan)(6) ? data.stories : (0, _stories.flatStories)(data);
+      const stories = (0, _helpers.isStorybookVersionLessThan)(6) || (0, _helpers.isStorybookVersionGreaterThan)(6, 3) ? data.stories : (0, _shared.denormalizeStoryParameters)(data);
       const files = new Set(Object.values(stories).map(story => story.parameters.fileName));
       if (watcher) channel.on(Events.SET_STORIES, watchStories(channel, watcher, files));
-      resolve(data);
+      resolve(stories);
     });
   });
   if (config.useWebpackToExtractTests) loadStoriesFromBundle(watch);else void loadStoriesDirectly(config, {
@@ -212,4 +219,21 @@ async function loadStories(config, {
     debug
   });
   return loadPromise;
+}
+
+async function extractStoriesData(config, {
+  watch,
+  debug
+}) {
+  const storybookApi = await initStorybookEnvironment();
+  const Events = await (0, _helpers.importStorybookCoreEvents)();
+  const {
+    channel
+  } = storybookApi;
+  channel.removeAllListeners(Events.CURRENT_STORY_WAS_SET);
+  const loadPromise = new Promise(resolve => channel.once(Events.SET_STORIES, resolve));
+  if (config.useWebpackToExtractTests) loadStoriesFromBundle(watch);else void loadStoriesDirectly(config, {
+    debug
+  });
+  return loadPromise;
 }

package/lib/cjs/server/utils.js

@@ -10,7 +10,8 @@ exports.getCreeveyCache = getCreeveyCache;
 exports.runSequence = runSequence;
 exports.testsToImages = testsToImages;
 exports.removeProps = removeProps;
-exports.downloadBinary = exports.isInsideDocker = exports.extensions = exports.LOCALHOST_REGEXP = exports.isShuttingDown = void 0;
+exports.readDirRecursive = readDirRecursive;
+exports.downloadBinary = exports.isInsideDocker = exports.skipOptionKeys = exports.extensions = exports.LOCALHOST_REGEXP = exports.isShuttingDown = void 0;
 
 var _fs = require("fs");
 
@@ -34,6 +35,8 @@ const LOCALHOST_REGEXP = /(localhost|127\.0\.0\.1)/i;
 exports.LOCALHOST_REGEXP = LOCALHOST_REGEXP;
 const extensions = ['.js', '.jsx', '.ts', '.tsx'];
 exports.extensions = extensions;
+const skipOptionKeys = ['in', 'kinds', 'stories', 'tests', 'reason'];
+exports.skipOptionKeys = skipOptionKeys;
 
 function matchBy(pattern, value) {
   return typeof pattern == 'string' && pattern == value || Array.isArray(pattern) && pattern.includes(value) || pattern instanceof RegExp && pattern.test(value) || !(0, _types.isDefined)(pattern);
@@ -45,9 +48,30 @@ function shouldSkip(browser, meta, skipOptions, test) {
   }
 
   if (Array.isArray(skipOptions)) {
-    return skipOptions.map(skipOption => shouldSkip(browser, meta, skipOption, test)).find(Boolean) || false;
+    for (const skip of skipOptions) {
+      const reason = shouldSkip(browser, meta, skip, test);
+      if (reason) return reason;
+    }
+
+    return false;
   }
 
+  let hasSkipOptionKeys = false;
+
+  for (const skipKey in skipOptions) {
+    if (skipOptionKeys.includes(skipKey)) {
+      hasSkipOptionKeys = true;
+      continue;
+    }
+
+    const reason = shouldSkip(browser, meta, {
+      reason: skipKey,
+      ...skipOptions[skipKey]
+    }, test);
+    if (reason) return reason;
+  }
+
+  if (!hasSkipOptionKeys) return false;
   const {
     in: browsers,
     kinds,
@@ -152,4 +176,10 @@ function removeProps(obj, propPath) {
     if (typeof prop == 'string') delete obj[prop];
     if ((0, _types.isFunction)(prop)) Object.keys(obj).filter(prop).forEach(key => delete obj[key]);
   }
+}
+
+function readDirRecursive(dirPath) {
+  return [].concat(...(0, _fs.readdirSync)(dirPath, {
+    withFileTypes: true
+  }).map(dirent => dirent.isDirectory() ? readDirRecursive(`${dirPath}/${dirent.name}`) : [`${dirPath}/${dirent.name}`]));
 }

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/worker.js

@@ -72,6 +72,7 @@ async function worker(config, options) {
   let retries = 0;
   let images = {};
   let error = undefined;
+  const screenshots = [];
   const testScope = [];
 
   function runHandler(failures) {
@@ -201,13 +202,23 @@ async function worker(config, options) {
 
   _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 +233,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 => {

package/lib/cjs/shared.js

@@ -0,0 +1,107 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.deserializeStory = exports.deserializeRawStories = exports.serializeRawStories = exports.deserializeRegExp = exports.serializeRegExp = exports.isSerializedRegExp = exports.denormalizeStoryParameters = exports.combineParameters = void 0;
+
+var _lodash = require("lodash");
+
+// NOTE: Copy-paste from storybook/api
+const combineParameters = (...parameterSets) => // 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 = ({
+  globalParameters,
+  kindParameters,
+  stories
+}) => {
+  return (0, _lodash.mapValues)(stories, storyData => {
+    var _globalParameters$cre, _kindParameters$story, _kindParameters$story2;
+
+    storyData.parameters.creevey = combineParameters((_globalParameters$cre = globalParameters.creevey) !== null && _globalParameters$cre !== void 0 ? _globalParameters$cre : {}, (_kindParameters$story = (_kindParameters$story2 = kindParameters[storyData.kind]) === null || _kindParameters$story2 === void 0 ? void 0 : _kindParameters$story2.creevey) !== null && _kindParameters$story !== void 0 ? _kindParameters$story : {}, storyData.parameters.creevey);
+    return storyData;
+  });
+};
+
+exports.denormalizeStoryParameters = denormalizeStoryParameters;
+
+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 = ({
+  source,
+  flags
+}) => {
+  return new RegExp(source, flags);
+};
+
+exports.deserializeRegExp = deserializeRegExp;
+
+const serializeRawStories = stories => {
+  return (0, _lodash.mapValues)(stories, storyData => {
+    const creevey = storyData.parameters.creevey;
+
+    if ((creevey === null || creevey === void 0 ? void 0 : creevey.skip) !== undefined) {
+      creevey.skip = (0, _lodash.cloneDeepWith)(creevey.skip, value => {
+        if (value instanceof RegExp) {
+          return 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 ? void 0 : creevey.skip) !== undefined) {
+    creevey.skip = (0, _lodash.cloneDeepWith)(creevey.skip, value => {
+      if (isSerializedRegExp(value)) {
+        return deserializeRegExp(value);
+      }
+
+      return undefined;
+    });
+  }
+
+  return story;
+};
+
+exports.deserializeStory = deserializeStory;

package/lib/cjs/types.js

@@ -12,6 +12,7 @@ exports.isFunction = isFunction;
 exports.isImageError = isImageError;
 exports.isProcessMessage = isProcessMessage;
 exports.isWorkerMessage = isWorkerMessage;
+exports.isStoriesMessage = isStoriesMessage;
 exports.isTestMessage = isTestMessage;
 exports.isWebpackMessage = isWebpackMessage;
 exports.isDockerMessage = isDockerMessage;
@@ -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';
 }

package/lib/esm/client/addon/Manager.js

@@ -31,11 +31,12 @@ function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _d
 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; }
 
 import { SET_STORIES, STORY_RENDERED } from '@storybook/core-events';
+import { denormalizeStoryParameters } from '../../shared';
 import { isDefined } from '../../types';
 import { initCreeveyClientApi } from '../shared/creeveyClientApi';
 import { calcStatus } from '../shared/helpers';
 import { ADDON_ID } from './register';
-import { getEmojiByTestStatus, denormalizeStoryParameters } from './utils';
+import { getEmojiByTestStatus } from './utils';
 export var CreeveyManager = /*#__PURE__*/function () {
   function CreeveyManager(storybookApi) {
     var _this = this;
@@ -229,8 +230,7 @@ export var CreeveyManager = /*#__PURE__*/function () {
     });
 
     _defineProperty(this, "onSetStories", function (data) {
-      // TODO: Send PR to storybook to fix this
-      var stories = data.v ? denormalizeStoryParameters(data) : data;
+      var stories = data.v ? denormalizeStoryParameters(data) : data.stories;
       _this.stories = stories;
     });
 

package/lib/esm/client/addon/preset.js

@@ -47,6 +47,7 @@ export function managerWebpack(config, options) {
         DefinePlugin = _ref$DefinePlugin === void 0 ? FallbackDefinePlugin : _ref$DefinePlugin;
 
     (_config$plugins = config.plugins) === null || _config$plugins === void 0 ? void 0 : _config$plugins.push(new DefinePlugin({
+      __CREEVEY_SERVER_HOST__: options.creeveyHost,
       __CREEVEY_SERVER_PORT__: (_options$creeveyPort = options.creeveyPort) !== null && _options$creeveyPort !== void 0 ? _options$creeveyPort : 3000,
       __CREEVEY_CLIENT_PORT__: options.clientPort
     }));

package/lib/esm/client/addon/readyForCapture.js

@@ -0,0 +1,5 @@
+export function readyForCapture() {
+  var _window$__CREEVEY_SET, _window;
+
+  (_window$__CREEVEY_SET = (_window = window).__CREEVEY_SET_READY_FOR_CAPTURE__) === null || _window$__CREEVEY_SET === void 0 ? void 0 : _window$__CREEVEY_SET.call(_window);
+}

package/lib/esm/client/addon/utils.js

@@ -1,10 +1,3 @@
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
-
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
-
-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; }
-
-import { mapValues, mergeWith } from 'lodash';
 export function getEmojiByTestStatus(status) {
   var skip = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
 
@@ -35,29 +28,4 @@ export function getEmojiByTestStatus(status) {
         return '';
       }
   }
-} // NOTE: Copy-paste from storybook/api
-
-export var combineParameters = function combineParameters() {
-  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
-    mergeWith.apply(void 0, [{}].concat(parameterSets, [function (_, srcValue) {
-      // Treat arrays as scalars:
-      if (Array.isArray(srcValue)) return srcValue;
-      return undefined;
-    }]))
-  );
-}; // NOTE: Copy-paste from storybook/api
-
-export var denormalizeStoryParameters = function denormalizeStoryParameters(_ref) {
-  var globalParameters = _ref.globalParameters,
-      kindParameters = _ref.kindParameters,
-      stories = _ref.stories;
-  return mapValues(stories, function (storyData) {
-    return _objectSpread(_objectSpread({}, storyData), {}, {
-      parameters: combineParameters(globalParameters, kindParameters[storyData.kind], storyData.parameters)
-    });
-  });
-};
+}