@applitools/eyes-storybook/src/validateAndPopulateConfig.js

'use strict';
const chalk = require('chalk');
const fs = require('fs');
const detect = require('detect-port');
const {version: packageVersion} = require('../package.json');
const {
  missingApiKeyFailMsg,
  missingAppNameAndPackageJsonFailMsg,
  missingAppNameInPackageJsonFailMsg,
  startStorybookFailMsg,
} = require('./errMessages');
const startStorybookServer = require('./startStorybookServer');
const {isIE} = require('./shouldRenderIE');
const {makeLogger} = require('@applitools/logger');
const determineStorybookVersion = require('./utils/determineStorybookVersion');

async function validateAndPopulateConfig({config, packagePath = '', logger = makeLogger()}) {
  if (!config.apiKey) {
    throw new Error(missingApiKeyFailMsg);
  }

  const packageJsonPath = `${packagePath}/package.json`;
  const packageJson = fs.existsSync(packageJsonPath) ? require(packageJsonPath) : undefined;

  if (!config.appName) {
    if (!packageJson) {
      throw new Error(missingAppNameAndPackageJsonFailMsg);
    }

    if (!packageJson.name) {
      throw new Error(missingAppNameInPackageJsonFailMsg);
    }

    config.appName = packageJson.name;
  }

  if (!config.storybookUrl) {
    try {
      config.storybookPort = await detect(config.storybookPort);
    } catch (ex) {
      console.log(chalk.red(`couldn't find available port around`, config.storybookPort));
    }

    const {storybookPath, sbVersion, sbArg} = await determineStorybookVersion({
      packagePath,
      isWindows: process.platform.startsWith('win'),
    });
    logger.log(
      `[validateAndPopulateConfig] storybookPath=${storybookPath} sbVersion=${sbVersion} sbArg=${sbArg}`,
    );

    config.storybookUrl = await startStorybookServer(
      Object.assign({packagePath, logger, storybookPath, sbArg, sbVersion}, config),
    );

    // NOTE (Amit): I don't understand why this condition is here. It shouldn't happen. I might have been the one to put it here, but it seems like a mistake. We should take a thorough look and remove it.
    if (!config.storybookUrl) {
      console.log(startStorybookFailMsg);
      process.exit(1);
    }
  }

  config.agentId = `eyes-storybook/${packageVersion}`;

  if (config.runInDocker) {
    config.puppeteerOptions = config.puppeteerOptions || {};
    config.puppeteerOptions.args = config.puppeteerOptions.args || [];
    if (!config.puppeteerOptions.args.includes('--disable-dev-shm-usage')) {
      config.puppeteerOptions.args.push('--disable-dev-shm-usage');
    }
  }

  if (config.fakeIE && !config.environments.find(isIE)) {
    console.log(
      chalk.yellow(
        `\u26A0 fakeIE flag was set, but no IE browsers were found in the configuration`,
      ),
    );
  }
}
module.exports = validateAndPopulateConfig;