creevey 0.9.0-beta.1 → 0.9.0-beta.10

package/lib/cjs/server/storybook/providers/hybrid.js

@@ -0,0 +1,82 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.loadStories = void 0;
+
+var _chokidar = _interopRequireDefault(require("chokidar"));
+
+var _browser = require("./browser");
+
+var _logger = require("../../logger");
+
+var _parser = _interopRequireDefault(require("../../testsFiles/parser"));
+
+var _utils = require("../../../server/utils");
+
+var _shared = require("../../../shared");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+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; }
+
+const loadStories = async (_config, _options, storiesListener) => {
+  let creeveyParamsByStoryId = {};
+
+  const mergeParamsFromTestsToStory = (story, creeveyParams) => {
+    if (story.parameters) {
+      story.parameters.creevey = (0, _shared.combineParameters)(story.parameters.creevey || {}, creeveyParams);
+    }
+  };
+
+  const stories = await (0, _browser.loadStories)(_config, {}, updatedStoriesByFiles => {
+    Array.from(updatedStoriesByFiles.entries()).forEach(([, storiesArray]) => {
+      storiesArray.forEach(story => {
+        const creeveyParams = creeveyParamsByStoryId[story.id];
+
+        if (creeveyParams) {
+          mergeParamsFromTestsToStory(story, creeveyParams);
+        }
+      });
+    });
+    storiesListener(updatedStoriesByFiles);
+  }); // TODO fix test files hot reloading
+
+  creeveyParamsByStoryId = await parseParams(_config
+  /*, (data) => console.log(data) */
+  );
+  Object.entries(stories).forEach(([storyId, story]) => {
+    mergeParamsFromTestsToStory(story, creeveyParamsByStoryId[storyId]);
+  });
+  return stories;
+};
+
+exports.loadStories = loadStories;
+
+async function parseParams(config, listener) {
+  if (!config.testsDir) {
+    return Promise.resolve({});
+  }
+
+  const testFiles = (0, _utils.readDirRecursive)(config.testsDir).filter(file => {
+    var _config$testsRegex;
+
+    return (_config$testsRegex = config.testsRegex) === null || _config$testsRegex === void 0 ? void 0 : _config$testsRegex.test(file);
+  });
+  await (await Promise.resolve().then(() => _interopRequireWildcard(require('../../testsFiles/register')))).default(config);
+
+  if (listener) {
+    _chokidar.default.watch(testFiles).on('change', filePath => {
+      _logger.logger.debug(`changed: ${filePath}`); // doesn't work, always returns {} due modules caching
+      // see https://github.com/nodejs/modules/issues/307
+
+
+      void (0, _parser.default)(testFiles).then(data => listener(data));
+    });
+  }
+
+  return (0, _parser.default)(testFiles);
+}

package/lib/cjs/server/storybook/providers/nodejs.js

@@ -0,0 +1,239 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.extractStoriesData = extractStoriesData;
+exports.loadStories = void 0;
+
+var _path = _interopRequireDefault(require("path"));
+
+var _cluster = _interopRequireDefault(require("cluster"));
+
+var _chokidar = _interopRequireDefault(require("chokidar"));
+
+var _types = require("../../../types");
+
+var _utils = require("../../utils");
+
+var _messages = require("../../messages");
+
+var _helpers = require("../helpers");
+
+var _logger = require("../../logger");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+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-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
+  // https://github.com/storybookjs/storybook/blob/v5.2.8/lib/core/src/client/preview/start.js#L98
+  // Example: "Mozilla/5.0 (linux) AppleWebKit/537.36 (KHTML, like Gecko) jsdom/15.2.1"
+
+  Object.defineProperty(window.navigator, 'userAgent', {
+    value: window.navigator.userAgent.split(' ').filter(token => !token.startsWith('jsdom')).join(' ')
+  }); // TODO Look at creevey debug flag
+
+  const {
+    logger
+  } = await (0, _helpers.importStorybookClientLogger)(); // NOTE: Disable duplication warnings for >=6.2 storybook
+
+  if (_cluster.default.isWorker) logger.warn = _types.noop; // NOTE: disable logger for 5.x storybook
+
+  logger.debug = _types.noop;
+  return Promise.resolve().then(() => _interopRequireWildcard(require('../entry')));
+}
+
+function watchStories(channel, watcher, initialFiles) {
+  const watchingFiles = initialFiles;
+  let storiesByFiles = new Map();
+  (0, _messages.subscribeOn)('shutdown', () => void watcher.close());
+  watcher.add(Array.from(watchingFiles));
+  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 = data.stories;
+    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));
+    watcher.add(addedFiles);
+    addedFiles.forEach(filePath => {
+      watchingFiles.add(filePath);
+      storiesByFiles.set(filePath, []);
+    });
+    removedFiles.forEach(filePath => watchingFiles.delete(filePath));
+    Object.values(stories).forEach(story => {
+      var _storiesByFiles$get;
+
+      return (_storiesByFiles$get = storiesByFiles.get(story.parameters.fileName)) === null || _storiesByFiles$get === void 0 ? void 0 : _storiesByFiles$get.push(story);
+    });
+    channel.emit('storiesUpdated', storiesByFiles);
+    storiesByFiles = new Map();
+  };
+}
+
+function loadStoriesFromBundle(watch) {
+  const bundlePath = _path.default.join((0, _utils.getCreeveyCache)(), 'storybook/main.js');
+
+  if (watch) {
+    (0, _messages.subscribeOn)('webpack', message => {
+      if (message.type != 'rebuild succeeded') return;
+      Object.values(global.__CREEVEY_HMR_DATA__).filter(({
+        callback
+      }) => callback).forEach(({
+        data,
+        callback
+      }) => callback(data));
+      delete require.cache[bundlePath];
+      Promise.resolve(`${bundlePath}`).then(s => _interopRequireWildcard(require(s)));
+    });
+  }
+
+  Promise.resolve(`${bundlePath}`).then(s => _interopRequireWildcard(require(s)));
+}
+
+async function loadStoriesDirectly(config, {
+  watcher,
+  debug
+}) {
+  const {
+    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);
+
+  const preview = (() => {
+    try {
+      return require.resolve(`${config.storybookDir}/preview`);
+    } catch (_) {
+      /* noop */
+    }
+  })();
+
+  const {
+    stories
+  } = await (0, _helpers.importStorybookConfig)();
+  const contexts = stories.map(entry => {
+    const normalizedEntry = normalizeStoriesEntry(entry, {
+      configDir: config.storybookDir,
+      workingDir: process.cwd()
+    });
+    const {
+      path: storiesPath,
+      recursive,
+      match
+    } = toRequireContext(normalizedEntry);
+    watcher === null || watcher === void 0 ? void 0 : watcher.add(_path.default.resolve(config.storybookDir, storiesPath));
+    return () => requireContext(storiesPath, recursive, new RegExp(match));
+  });
+
+  let disposeCallback = data => void data;
+
+  Object.assign(module, {
+    hot: {
+      data: {},
+
+      accept() {
+        /* noop */
+      },
+
+      dispose(callback) {
+        disposeCallback = callback;
+      }
+
+    }
+  });
+
+  async function startStorybook() {
+    if (preview) {
+      const {
+        parameters,
+        globals,
+        globalTypes
+      } = await Promise.resolve(`${preview}`).then(s => _interopRequireWildcard(require(s)));
+      if (parameters) addParameters(parameters);
+      if (globals) addParameters({
+        globals
+      });
+      if (globalTypes) addParameters({
+        globalTypes
+      });
+    }
+
+    try {
+      configure(contexts.map(ctx => ctx()), module, false);
+    } catch (error) {
+      if (_cluster.default.isPrimary) _logger.logger.error(error);
+    }
+  }
+
+  watcher === null || watcher === void 0 ? void 0 : watcher.add(config.storybookDir);
+  watcher === null || watcher === void 0 ? void 0 : watcher.on('all', (_event, filename) => {
+    var _module$hot;
+
+    disposeCallback((_module$hot = module.hot) === null || _module$hot === void 0 ? void 0 : _module$hot.data);
+    delete require.cache[filename];
+    void startStorybook();
+  });
+  void startStorybook();
+} // TODO Do we need to support multiple storybooks here?
+
+
+const loadStories = async (config, {
+  watch,
+  debug
+}, storiesListener) => {
+  const storybookApi = await initStorybookEnvironment();
+  const Events = await (0, _helpers.importStorybookCoreEvents)();
+  const {
+    channel
+  } = storybookApi;
+  channel.removeAllListeners(Events.CURRENT_STORY_WAS_SET);
+  channel.on('storiesUpdated', storiesListener);
+  let watcher;
+  if (watch) watcher = _chokidar.default.watch([], {
+    ignoreInitial: true
+  });
+  const loadPromise = new Promise(resolve => {
+    channel.once(Events.SET_STORIES, data => {
+      const stories = data.stories;
+      const files = new Set(Object.values(stories).map(story => story.parameters.fileName));
+      if (watcher) channel.on(Events.SET_STORIES, watchStories(channel, watcher, files));
+      resolve(stories);
+    });
+  });
+  if (config.useWebpackToExtractTests) loadStoriesFromBundle(watch);else void loadStoriesDirectly(config, {
+    watcher,
+    debug
+  });
+  return loadPromise;
+};
+
+exports.loadStories = loadStories;
+
+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/testsFiles/parser.js

@@ -0,0 +1,72 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = parse;
+exports.test = exports.story = exports.kind = void 0;
+
+var _csf = require("@storybook/csf");
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+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 parse(files) {
+  result = {};
+  await Promise.all(files.map(async file => Promise.resolve(`${file}`).then(s => _interopRequireWildcard(require(s)))));
+  return result;
+}
+
+let result = {};
+let kindTitle = '';
+let storyTitle = '';
+let storyParams = null;
+
+const setStoryParameters = params => {
+  storyParams = params;
+};
+
+const getStoryId = (kindTitle, storyTitle) => {
+  return (0, _csf.toId)(kindTitle, (0, _csf.storyNameFromExport)(storyTitle));
+};
+
+const kind = (title, kindFn) => {
+  kindTitle = title;
+  kindFn();
+  kindTitle = '';
+};
+
+exports.kind = kind;
+
+const story = (title, storyFn) => {
+  var _result$storyId;
+
+  storyTitle = title;
+  storyParams = null;
+  storyFn({
+    setStoryParameters
+  });
+  const storyId = getStoryId(kindTitle, storyTitle);
+  result[storyId] = Object.assign({}, storyParams, {
+    tests: (_result$storyId = result[storyId]) === null || _result$storyId === void 0 ? void 0 : _result$storyId.tests
+  });
+  storyTitle = '';
+  storyParams = null;
+};
+
+exports.story = story;
+
+const test = (title, testFn) => {
+  const storyId = getStoryId(kindTitle, storyTitle);
+
+  if (!result[storyId]) {
+    result[storyId] = {};
+  }
+
+  result[storyId].tests = Object.assign({}, result[storyId].tests, {
+    [title]: testFn
+  });
+};
+
+exports.test = test;

package/lib/cjs/server/testsFiles/register.js

@@ -0,0 +1,44 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = register;
+
+var _pirates = require("pirates");
+
+var _getTsconfig = require("get-tsconfig");
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+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 register(config) {
+  (0, _pirates.addHook)(() => '', {
+    exts: ['.jpg', '.jpeg', '.png', '.gif', '.eot', '.otf', '.svg', '.ttf', '.woff', '.woff2', '.css', '.less', '.scss', '.styl'],
+    ignoreNodeModules: false
+  });
+  const {
+    path: tsConfigPath
+  } = (0, _getTsconfig.getTsconfig)(config.tsConfig) || {}; // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
+
+  (await Promise.resolve().then(() => _interopRequireWildcard(require('@babel/register')))).default(config.babelOptions({
+    babelrc: false,
+    rootMode: 'upward-optional',
+    ignore: [/node_modules/],
+    extensions: ['.js', '.jsx', '.ts', '.tsx'],
+    parserOpts: {
+      sourceType: 'module',
+      plugins: ['jsx', 'typescript']
+    },
+    presets: ['@babel/preset-typescript', ['@babel/preset-env', {
+      targets: {
+        node: '10'
+      },
+      modules: 'commonjs'
+    }]],
+    plugins: [['@babel/plugin-transform-runtime'], ...(tsConfigPath ? [['babel-plugin-tsconfig-paths', {
+      tsconfig: tsConfigPath
+    }]] : [])]
+  })); // (await import('ts-node')).register({ project: tsConfigPath, transpileOnly: true });
+}

package/lib/cjs/server/update.js

@@ -0,0 +1,79 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = update;
+
+var _path = _interopRequireDefault(require("path"));
+
+var _fs = _interopRequireWildcard(require("fs"));
+
+var _micromatch = _interopRequireDefault(require("micromatch"));
+
+var _types = require("../types");
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+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; }
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function tryToLoadTestsData(filename) {
+  try {
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    return require(filename);
+  } catch (_) {
+    /* noop */
+  }
+}
+
+const actualRegex = /^(.*)-actual-(\d+)\.png$/i;
+
+function approve(dirents, srcPath, dstPath, testPaths, isMatch) {
+  dirents.filter(dirent => dirent.isFile()).map(dirent => actualRegex.exec(dirent.name)).filter(_types.isDefined).filter(([fileName, imageName]) => !testPaths || testPaths.find(([token]) => token == imageName) && isMatch(_path.default.join(srcPath, fileName))).reduce((images, [, imageName, retry]) => Number(retry) > (images.get(imageName) ?? -1) ? images.set(imageName, Number(retry)) : images, new Map()).forEach((retry, imageName) => {
+    (0, _fs.mkdirSync)(dstPath, {
+      recursive: true
+    });
+
+    _fs.default.copyFileSync(_path.default.join(srcPath, `${imageName}-actual-${retry}.png`), _path.default.join(dstPath, `${imageName}.png`));
+  });
+}
+
+function traverse(srcPath, dstPath, testPaths, isMatch) {
+  const dirents = _fs.default.readdirSync(srcPath, {
+    withFileTypes: true
+  });
+
+  approve(dirents, srcPath, dstPath, testPaths, isMatch);
+  dirents.filter(dirent => dirent.isDirectory()).map(dirent => [dirent.name, testPaths === null || testPaths === void 0 ? void 0 : testPaths.map(([token, ...restPath]) => token == dirent.name ? restPath : null).filter(_types.isDefined)]).filter(([, paths]) => !paths || paths.length > 0).forEach(([dirname, paths]) => traverse(_path.default.join(srcPath, dirname), _path.default.join(dstPath, dirname), paths, isMatch));
+}
+
+function update(config, grepPattern) {
+  const {
+    reportDir,
+    screenDir
+  } = config;
+  const isMatch = grepPattern ? _micromatch.default.matcher(grepPattern, {
+    contains: true
+  }) : () => true;
+  const testsMeta = tryToLoadTestsData(`${reportDir}/tests.json`);
+  const testsReport = tryToLoadTestsData(`${reportDir}/data`);
+  let testPaths = null;
+
+  if (testsMeta && testsReport) {
+    testPaths = Object.values(testsMeta).filter(_types.isDefined).filter(({
+      id
+    }) => {
+      var _testsReport$id;
+
+      return ((_testsReport$id = testsReport[id]) === null || _testsReport$id === void 0 ? void 0 : _testsReport$id.status) == 'failed';
+    }).map(({
+      storyPath,
+      testName,
+      browser
+    }) => [...storyPath, ...(testName ? [testName] : []), browser]);
+  }
+
+  traverse(reportDir, screenDir, testPaths, value => isMatch(_path.default.relative(reportDir, value)));
+}