creevey 0.9.0-beta.1 → 0.9.0-beta.2

package/lib/cjs/server/config.js

@@ -0,0 +1,96 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.readConfig = readConfig;
+exports.defaultConfig = exports.defaultBrowser = void 0;
+
+var _fs = _interopRequireDefault(require("fs"));
+
+var _path = _interopRequireDefault(require("path"));
+
+var _helpers = require("./storybook/helpers");
+
+var _nodejs = require("./storybook/providers/nodejs");
+
+var _browser = require("./storybook/providers/browser");
+
+var _types = require("../types");
+
+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 defaultBrowser = 'chrome';
+exports.defaultBrowser = defaultBrowser;
+const defaultConfig = {
+  useDocker: true,
+  useWebpackToExtractTests: false,
+  dockerImage: 'aerokube/selenoid:latest-release',
+  dockerImagePlatform: '',
+  pullImages: true,
+  failFast: false,
+  storybookUrl: 'http://localhost:6006',
+  screenDir: _path.default.resolve('images'),
+  reportDir: _path.default.resolve('report'),
+  storybookDir: _path.default.resolve('.storybook'),
+  maxRetries: 0,
+  diffOptions: {
+    threshold: 0,
+    includeAA: true
+  },
+  browsers: {
+    [defaultBrowser]: true
+  },
+  hooks: {},
+  babelOptions: _ => _,
+  testsRegex: /\.creevey\.(t|j)s$/
+};
+exports.defaultConfig = defaultConfig;
+
+function normalizeBrowserConfig(name, config) {
+  if (typeof config == 'boolean') return {
+    browserName: name
+  };
+  if (typeof config == 'string') return {
+    browserName: config
+  };
+  return config;
+}
+
+function resolveConfigPath(configPath) {
+  const rootDir = process.cwd();
+
+  const configDir = _path.default.resolve('.creevey');
+
+  if ((0, _types.isDefined)(configPath)) {
+    configPath = _path.default.resolve(configPath);
+  } else if (_fs.default.existsSync(configDir)) {
+    configPath = _path.default.join(configDir, 'config'); // TODO We already find file with extension, why not use it?
+  } else if (_fs.default.readdirSync(rootDir).find(filename => filename.startsWith('creevey.config'))) {
+    configPath = _path.default.join(rootDir, 'creevey.config');
+  }
+
+  return configPath;
+}
+
+async function readConfig(options) {
+  const configPath = resolveConfigPath(options.config);
+  const userConfig = { ...defaultConfig
+  };
+  if ((0, _types.isDefined)(configPath)) Object.assign(userConfig, (await Promise.resolve(`${configPath}`).then(s => _interopRequireWildcard(require(s)))).default);
+  _helpers.storybookDirRef.current = userConfig.storybookDir;
+  if ((0, _helpers.isStorybookVersionLessThan)(6, 2)) userConfig.useWebpackToExtractTests = true;
+  if (!userConfig.storiesProvider) userConfig.storiesProvider = (await (0, _helpers.isCSFv3Enabled)()) && (0, _helpers.isStorybookVersionGreaterThan)(5) ? _browser.loadStories : _nodejs.loadStories;
+  if (userConfig.storiesProvider == _browser.loadStories && (0, _helpers.isStorybookVersionLessThan)(6)) throw new Error("Creevey browser stories provider doesn't support Storybook 5.x or older versions");
+  if (options.failFast != undefined) userConfig.failFast = Boolean(options.failFast);
+  if (options.reportDir) userConfig.reportDir = _path.default.resolve(options.reportDir);
+  if (options.screenDir) userConfig.screenDir = _path.default.resolve(options.screenDir); // 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/cjs/server/docker.js

@@ -0,0 +1,150 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.pullImages = pullImages;
+exports.runImage = runImage;
+exports.default = _default;
+
+var _cluster = _interopRequireWildcard(require("cluster"));
+
+var _types = require("../types");
+
+var _messages = require("./messages");
+
+var _utils = require("./utils");
+
+var _dockerode = _interopRequireDefault(require("dockerode"));
+
+var _stream = require("stream");
+
+var _ora = _interopRequireDefault(require("ora"));
+
+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; }
+
+const docker = new _dockerode.default();
+
+class DevNull extends _stream.Writable {
+  _write(_chunk, _encoding, callback) {
+    setImmediate(callback);
+  }
+
+}
+
+async function pullImages(images, {
+  auth,
+  platform
+} = {}) {
+  const args = {};
+  if (auth) args.authconfig = auth;
+  if (platform) args.platform = platform;
+
+  _logger.logger.info('Pull docker images');
+
+  for (const image of images) {
+    await new Promise((resolve, reject) => {
+      const spinner = (0, _ora.default)(`${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
+
+
+        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}` : ''}`;
+        }
+      });
+    });
+  }
+}
+
+async function runImage(image, args, options, debug) {
+  await Promise.all((await docker.listContainers({
+    all: true,
+    filters: {
+      ancestor: [image]
+    }
+  })).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 => {
+    if (error) throw error;
+  });
+  return new Promise(resolve => {
+    hub.once('container', container => {
+      // eslint-disable-next-line @typescript-eslint/no-misused-promises
+      (0, _messages.subscribeOn)('shutdown', async () => {
+        try {
+          await container.stop();
+          await container.remove();
+        } catch (error) {
+          /* noop */
+        }
+      });
+    });
+    hub.once('start', container => void container.inspect().then(info => resolve(info.NetworkSettings.Networks.bridge.IPAddress)));
+  });
+}
+
+async function _default(config, browser, startContainer) {
+  if (_cluster.isMaster) {
+    const host = await startContainer();
+    let gridUrl = 'http://localhost:4444/wd/hub';
+    gridUrl = _utils.isInsideDocker ? gridUrl.replace(_utils.LOCALHOST_REGEXP, host) : gridUrl;
+
+    _cluster.default.on('message', (worker, message) => {
+      if (!(0, _types.isDockerMessage)(message)) return;
+      const dockerMessage = message;
+      if (dockerMessage.type != 'start') return;
+      (0, _messages.sendDockerMessage)(worker, {
+        type: 'success',
+        payload: {
+          gridUrl
+        }
+      });
+    });
+  } else {
+    if (browser && config.browsers[browser].gridUrl) return Promise.resolve();
+    return new Promise(resolve => {
+      (0, _messages.subscribeOn)('docker', message => {
+        if (message.type == 'success') {
+          config.gridUrl = message.payload.gridUrl;
+          resolve();
+        }
+      });
+      (0, _messages.emitDockerMessage)({
+        type: 'start'
+      });
+    });
+  }
+}

package/lib/cjs/server/extract.js

@@ -0,0 +1,50 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = extract;
+
+var _shared = require("../shared");
+
+var _messages = require("./messages");
+
+var _stories = require("./stories");
+
+var _helpers = require("./storybook/helpers");
+
+var _nodejs = require("./storybook/providers/nodejs");
+
+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 extract(config, options) {
+  if (config.useWebpackToExtractTests && process.env.__CREEVEY_ENV__ != 'test') {
+    await new Promise((resolve, reject) => {
+      (0, _messages.subscribeOn)('webpack', message => {
+        switch (message.type) {
+          case 'success':
+            return resolve();
+
+          case 'fail':
+            return reject();
+        }
+      });
+      void (async () => (await Promise.resolve().then(() => _interopRequireWildcard(require('./loaders/webpack/compile')))).default(config, options))();
+    });
+  }
+
+  const tests = await (0, _stories.loadTestsFromStories)(Object.keys(config.browsers), async () => {
+    const data = await (0, _nodejs.extractStoriesData)(config, {
+      watch: false,
+      debug: options.debug
+    });
+    const stories = (0, _helpers.isStorybookVersionLessThan)(6) || (0, _helpers.isStorybookVersionGreaterThan)(6, 3) ? data.stories : (0, _shared.denormalizeStoryParameters)(data);
+    if (options.extract) (0, _stories.saveStoriesJson)(data, options.extract);
+    return stories;
+  });
+  if (options.tests) (0, _stories.saveTestsJson)(tests); // eslint-disable-next-line no-process-exit
+
+  process.exit(0);
+}

package/lib/cjs/server/index.js

@@ -0,0 +1,83 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = _default;
+
+var _cluster = _interopRequireDefault(require("cluster"));
+
+var _config = require("./config");
+
+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; }
+
+// NOTE: Impure function, mutate config by adding gridUrl prop
+async function startWebdriverServer(config, options) {
+  if (config.useDocker) {
+    return (await Promise.resolve().then(() => _interopRequireWildcard(require('./docker')))).default(config, options.browser, async () => (await Promise.resolve().then(() => _interopRequireWildcard(require('./selenium/selenoid')))).startSelenoidContainer(config, options.debug));
+  } else {
+    return (await Promise.resolve().then(() => _interopRequireWildcard(require('./selenium/selenoid')))).startSelenoidStandalone(config, options.debug);
+  }
+}
+
+async function _default(options) {
+  const config = await (0, _config.readConfig)(options);
+  const {
+    browser = _config.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.gridUrl || Object.values(config.browsers).every(({
+    gridUrl
+  }) => gridUrl)) && !extract && !webpack && !tests && !update) {
+    await startWebdriverServer(config, options);
+  }
+
+  switch (true) {
+    case Boolean(extract) || tests:
+      {
+        return (await Promise.resolve().then(() => _interopRequireWildcard(require('./extract')))).default(config, options);
+      }
+
+    case Boolean(update):
+      {
+        return (await Promise.resolve().then(() => _interopRequireWildcard(require('./update')))).default(config, typeof update == 'string' ? update : undefined);
+      }
+
+    case webpack:
+      {
+        _logger.logger.info('Starting Webpack Compiler');
+
+        return (await Promise.resolve().then(() => _interopRequireWildcard(require('./loaders/webpack/compile')))).default(config, options);
+      }
+
+    case _cluster.default.isMaster:
+      {
+        _logger.logger.info('Starting Master Process');
+
+        const resolveApi = (await Promise.resolve().then(() => _interopRequireWildcard(require('./master/server')))).default(config.reportDir, port, ui);
+        return (await Promise.resolve().then(() => _interopRequireWildcard(require('./master')))).default(config, options, resolveApi);
+      }
+
+    default:
+      {
+        _logger.logger.info(`Starting Worker for ${browser}`);
+
+        return (await Promise.resolve().then(() => _interopRequireWildcard(require('./worker')))).default(config, { ...options,
+          browser
+        });
+      }
+  }
+}

package/lib/cjs/server/loaders/babel/creevey-plugin.js

@@ -0,0 +1,88 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = _default;
+
+var _path = _interopRequireDefault(require("path"));
+
+var _helpers = require("./helpers");
+
+var _logger = require("../../logger");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+let lastStoryFile = null;
+const stories = new Set();
+const reexportedStories = new Map();
+
+function _default() {
+  return {
+    pre() {
+      var _this$opts$parents;
+
+      const parents = (_this$opts$parents = this.opts.parents()) !== null && _this$opts$parents !== void 0 ? _this$opts$parents : [];
+      const story = this.opts.story();
+      this.resourcePath = this.filename;
+      this.fileType = _helpers.FileType.Invalid; // eslint-disable-next-line @typescript-eslint/no-explicit-any
+
+      this.visitedTopPaths = new Set();
+      this.visitedBindings = new Set();
+      this.reexportedStories = reexportedStories;
+
+      if (story && this.filename.startsWith(story) || parents.find(parent => this.reexportedStories.has(parent))) {
+        this.fileType = _helpers.FileType.Story;
+        this.isMDX = _path.default.parse(this.filename).ext == '.mdx';
+        lastStoryFile = this.filename;
+        stories.add(this.filename);
+      } else if (this.filename.startsWith(this.opts.preview)) this.fileType = _helpers.FileType.Preview;else if (lastStoryFile && this.opts.debug) {
+        _logger.logger.warn('Trying to transform possible non-story file', this.resourcePath, 'Please check the', lastStoryFile);
+
+        lastStoryFile = null; // TODO Add link to docs, how creevey works and what user should do in this situation
+      }
+    },
+
+    visitor: { ..._helpers.commonVisitor,
+
+      ExportAllDeclaration(path) {
+        if (this.fileType == _helpers.FileType.Story && typeof _helpers.storyVisitor.ExportAllDeclaration == 'function') {
+          _helpers.storyVisitor.ExportAllDeclaration.call(this, path, this);
+        }
+      },
+
+      ExportDefaultDeclaration(path) {
+        if (this.fileType == _helpers.FileType.Story && typeof _helpers.storyVisitor.ExportDefaultDeclaration == 'function') {
+          _helpers.storyVisitor.ExportDefaultDeclaration.call(this, path, this);
+        }
+      },
+
+      ExportNamedDeclaration(path) {
+        if (this.fileType == _helpers.FileType.Preview && typeof _helpers.previewVisitor.ExportNamedDeclaration == 'function') {
+          _helpers.previewVisitor.ExportNamedDeclaration.call(this, path, this);
+        }
+
+        if (this.fileType == _helpers.FileType.Story && typeof _helpers.storyVisitor.ExportNamedDeclaration == 'function') {
+          _helpers.storyVisitor.ExportNamedDeclaration.call(this, path, this);
+        }
+      },
+
+      CallExpression(path) {
+        if (this.fileType == _helpers.FileType.Preview && typeof _helpers.previewVisitor.CallExpression == 'function') {
+          _helpers.previewVisitor.CallExpression.call(this, path, this);
+        }
+
+        if (this.fileType == _helpers.FileType.Story && typeof _helpers.storyVisitor.CallExpression == 'function') {
+          _helpers.storyVisitor.CallExpression.call(this, path, this);
+        }
+      },
+
+      FunctionDeclaration(path) {
+        if (this.isMDX && typeof _helpers.mdxVisitor.FunctionDeclaration == 'function') {
+          _helpers.mdxVisitor.FunctionDeclaration.call(this, path, this);
+        }
+      }
+
+    }
+  };
+}