@toptal/davinci-workflow 1.9.0 → 1.10.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @toptal/davinci-workflow
 
+## 1.10.0
+
+### Minor Changes
+
+- [#1341](https://github.com/toptal/davinci/pull/1341) [`2d5479da`](https://github.com/toptal/davinci/commit/2d5479dab2cedf0133da1a47e91b2bde5b6b019d) Thanks [@OndrejTuma](https://github.com/OndrejTuma)! - ### new-workflow integration-tests
+
+  - collects additional information during generation and updates the workflow
+
+### Patch Changes
+
+- Updated dependencies [[`2d5479da`](https://github.com/toptal/davinci/commit/2d5479dab2cedf0133da1a47e91b2bde5b6b019d), [`5410a3b7`](https://github.com/toptal/davinci/commit/5410a3b73e3dbbc96ad8dbeca0bdde03d8d2d676)]:
+  - @toptal/davinci-monorepo@6.6.0
+  - @toptal/davinci-skeleton@7.1.1
+
 ## 1.9.0
 
 ### Minor Changes

package/bin/davinci-workflow.js

@@ -1,9 +1,12 @@
 #!/usr/bin/env node
-
+const inquirer = require('inquirer')
 const cliEngine = require('@toptal/davinci-cli-shared')
 
 const newWorkflowCommandCreator = require('../src/commands/new-workflow')
 
+// register 'table' prompt type https://npmjs.com/package/inquirer-table-prompt
+inquirer.registerPrompt('table', require('inquirer-table-prompt'))
+
 cliEngine.loadCommands([newWorkflowCommandCreator])
 
 cliEngine.bootstrap()

package/dist-package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-workflow",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "description": "GH Workflow generator package for frontend applications",
   "publishConfig": {
     "access": "public"
@@ -31,10 +31,13 @@
   },
   "dependencies": {
     "@toptal/davinci-cli-shared": "1.5.2",
-    "@toptal/davinci-monorepo": "^6.5.0",
-    "@toptal/davinci-skeleton": "7.1.0",
+    "@toptal/davinci-monorepo": "^6.6.0",
+    "@toptal/davinci-skeleton": "7.1.1",
     "chalk": "^4.1.2",
+    "cosmiconfig": "^7.0.1",
     "fs-extra": "^9.0.1",
+    "inquirer": "^8.2.4",
+    "inquirer-table-prompt": "^0.2.1",
     "js-yaml": "^4.1.0",
     "lodash.kebabcase": "^4.1.1",
     "ora": "^5.4.1"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-workflow",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "description": "GH Workflow generator package for frontend applications",
   "publishConfig": {
     "access": "public"
@@ -31,10 +31,13 @@
   },
   "dependencies": {
     "@toptal/davinci-cli-shared": "1.5.2",
-    "@toptal/davinci-monorepo": "^6.5.0",
-    "@toptal/davinci-skeleton": "7.1.0",
+    "@toptal/davinci-monorepo": "^6.6.0",
+    "@toptal/davinci-skeleton": "7.1.1",
     "chalk": "^4.1.2",
+    "cosmiconfig": "^7.0.1",
     "fs-extra": "^9.0.1",
+    "inquirer": "^8.2.4",
+    "inquirer-table-prompt": "^0.2.1",
     "js-yaml": "^4.1.0",
     "lodash.kebabcase": "^4.1.1",
     "ora": "^5.4.1"

package/src/commands/new-workflow.js

@@ -1,4 +1,7 @@
 const { print } = require('@toptal/davinci-cli-shared')
+const {
+  utils: { checkIfMonorepo },
+} = require('@toptal/davinci-monorepo')
 const path = require('path')
 const fs = require('fs-extra')
 const ora = require('ora')
@@ -74,10 +77,10 @@ const getWorkflowFilename = workflowName => {
 }
 
 const getWorkflowPostBuildFilename = workflowName => {
-  return kebabCase(workflowName) + '.js'
+  return path.join(kebabCase(workflowName), 'index.js')
 }
 
-const performPostBuildProcedure = async (filename, destDir) => {
+const performPostBuildProcedure = async (filename, destDir, workflowName) => {
   const postBuildFilePathname = path.join(
     require.resolve('@toptal/davinci-workflow'),
     '../',
@@ -96,9 +99,13 @@ const performPostBuildProcedure = async (filename, destDir) => {
     throw new Error('post build file must export a function')
   }
 
+  const isMonorepo = checkIfMonorepo()
+
   await executePostBuild({
     print,
     destDir,
+    workflowName,
+    isMonorepo,
   })
 }
 
@@ -129,7 +136,8 @@ const createCommand = async workflowName => {
     // execute a possible post-build procedure
     await performPostBuildProcedure(
       getWorkflowPostBuildFilename(workflowName),
-      workflowsDir
+      workflowsDir,
+      fileName
     )
     // read and print mandatory ENV secrets that must be installed beforehand
     await printMandatorySecretsList(fileName)

package/src/post-build/{alpha-package.js → alpha-package/alpha-package.js}

@@ -1,7 +1,7 @@
 const chalk = require('chalk')
 const path = require('path')
 
-const skeleton = require('../utils/skeleton')
+const skeleton = require('../../utils/skeleton')
 const yellowBoldText = chalk.yellow.bold
 const logText = chalk.red.bold
 

package/src/post-build/alpha-package/index.js

@@ -0,0 +1 @@
+module.exports = require('./alpha-package')

package/src/post-build/{deploy.js → deploy/deploy.js}

@@ -1,7 +1,7 @@
 const chalk = require('chalk')
 const path = require('path')
 
-const skeleton = require('../utils/skeleton')
+const skeleton = require('../../utils/skeleton')
 const logText = chalk.red.bold
 const yellowBoldText = chalk.yellow.bold
 const deployWorkflows = [

package/src/post-build/deploy/index.js

@@ -0,0 +1 @@
+module.exports = require('./deploy')

package/src/post-build/{deploy-temploy.js → deploy-temploy/deploy-temploy.js}

@@ -1,7 +1,7 @@
 const chalk = require('chalk')
 const path = require('path')
 
-const skeleton = require('../utils/skeleton')
+const skeleton = require('../../utils/skeleton')
 const yellowBoldText = chalk.yellow.bold
 
 const executePostBuild = ({ destDir }) => {

package/src/post-build/deploy-temploy/index.js

@@ -0,0 +1 @@
+module.exports = require('./deploy-temploy')

package/src/post-build/integration-tests/index.js

@@ -0,0 +1 @@
+module.exports = require('./integration-tests')

package/src/post-build/integration-tests/integration-tests.js

@@ -0,0 +1,126 @@
+const fs = require('fs')
+const chalk = require('chalk')
+const path = require('path')
+const {
+  utils: { getPackages },
+} = require('@toptal/davinci-monorepo')
+
+const filterPackagesByCommands = require('../../utils/filter-packages-by-commands')
+const setRootEnv = require('../../utils/set-root-env')
+const { readPackageJson } = require('../../utils/skeleton')
+const {
+  promptCodeCoverage,
+  promptParallelWorkersForMonorepo,
+  promptParallelWorkersForSPA,
+} = require('./prompts')
+const { getCoverageReportDir } = require('./nyc')
+
+const CONFLUENCE_PAGE =
+  'https://toptal-core.atlassian.net/l/c/qtXKBzvs#Generated-IT-Workflow'
+const yellowBoldText = chalk.yellow.bold
+
+const getEnvForMonorepo = async (rootDir, commands) => {
+  const packages = getPackages(rootDir)
+
+  const filteredWorkspaces = filterPackagesByCommands(
+    rootDir,
+    packages,
+    commands
+  )
+
+  if (filteredWorkspaces.length === 0) {
+    throw new Error(
+      `There are no packages to run integration tests in. Following commands were not found: ${JSON.stringify(
+        commands
+      )}`
+    )
+  }
+
+  const parallelMatrix = JSON.stringify(
+    await promptParallelWorkersForMonorepo(filteredWorkspaces)
+  )
+
+  const { command, location } = filteredWorkspaces[0]
+
+  const coverageReportDir = await getCoverageReportDir(
+    path.join(rootDir, location)
+  )
+
+  return {
+    PARALLEL_MATRIX: parallelMatrix,
+    COMMAND: command,
+    COVERAGE_REPORT_DIR: coverageReportDir,
+  }
+}
+
+const getEnvForSPA = async (rootDir, commands) => {
+  const pkg = readPackageJson(rootDir)
+  const command = Object.keys(pkg.scripts).find(script =>
+    commands.includes(script)
+  )
+
+  if (!command) {
+    throw new Error(
+      `No command for integration tests was found. Searched for: ${JSON.stringify(
+        commands
+      )}`
+    )
+  }
+
+  const parallelGroups = await promptParallelWorkersForSPA()
+  const coverageReportDir = await getCoverageReportDir(rootDir)
+
+  return {
+    PARALLEL_GROUPS: parallelGroups,
+    COMMAND: command,
+    COVERAGE_REPORT_DIR: coverageReportDir,
+  }
+}
+
+const executePostBuild = async ({ destDir, workflowName, isMonorepo }) => {
+  const workflowPath = path.join(destDir, workflowName)
+  const rootDir = path.resolve(destDir, '../../')
+  // to support backward compatibility
+  const supportedCommands = ['test:integration:ci', 'test:ui:ci', 'test:e2e:ci']
+
+  try {
+    const dynamicEnv = isMonorepo
+      ? await getEnvForMonorepo(rootDir, supportedCommands)
+      : await getEnvForSPA(rootDir, supportedCommands)
+
+    const printCoverage = await promptCodeCoverage()
+
+    setRootEnv(
+      {
+        ...dynamicEnv,
+        PRINT_COVERAGE: printCoverage,
+      },
+      workflowPath
+    )
+
+    console.log(chalk.green('\nWorkflow has been updated.'))
+  } catch (e) {
+    fs.unlinkSync(workflowPath)
+    console.error(e.stack)
+    throw new Error(`Workflow failed to be generated: ${e.message}`)
+  }
+
+  console.log(
+    [
+      chalk.green(
+        '\nIntegration tests (integration-tests) GH Workflow has been generated! \n\n'
+      ),
+      'Workflow is located in ',
+      chalk.green.bold('.github/workflows/davinci-integration-tests.yml'),
+      '\n',
+      "But it likely won't work out of the box and will ",
+      yellowBoldText('require little bit of adjusting'),
+      ' to make it work in your CI\n',
+      'Read more about customization here ',
+      chalk.grey.bold(CONFLUENCE_PAGE),
+      '\n',
+    ].join('')
+  )
+}
+
+module.exports = executePostBuild

package/src/post-build/integration-tests/nyc.js

@@ -0,0 +1,22 @@
+const getProgramConfig = require('../../utils/get-program-config')
+
+/**
+ * @param {string} root
+ * @return {Promise<string>}
+ */
+const getCoverageReportDir = async root => {
+  const config = await getCoverageConfig(root)
+
+  return config?.['report-dir'] ?? 'coverage'
+}
+
+/**
+ * @param {string} root
+ * @return {Promise<Object<string, any>>}
+ */
+const getCoverageConfig = root => getProgramConfig('nyc', root)
+
+module.exports = {
+  getCoverageConfig,
+  getCoverageReportDir,
+}

package/src/post-build/integration-tests/prompts.js

@@ -0,0 +1,82 @@
+const {
+  promptTable,
+  promptNumber,
+  promptConfirm,
+} = require('../../utils/prompts')
+
+/**
+ * Return custom message for parallel workers prompt
+ * @param {string} [customMessage]
+ * @return {string}
+ * @private
+ */
+const getMessageForParallelWorkers = customMessage => {
+  const message = customMessage ? [customMessage] : []
+
+  message.push(
+    'Here are packages that support integration tests. Select how many parallel workers you want in which package.'
+  )
+  message.push(
+    "If you don't choose anything, package won't be included in integration testing"
+  )
+
+  return message.join('\n')
+}
+
+/**
+ * Show table prompt with selection of parallel workers for each package
+ * @param {Array<{ name: string, location: string }>} packages
+ * @param {string} [customMessage]
+ * @return {Promise<Array<{ pkg: string, location: string, parallelGroups: number }>>}
+ */
+const promptParallelWorkersForMonorepo = async (
+  packages,
+  customMessage = ''
+) => {
+  const message = getMessageForParallelWorkers(customMessage)
+  const columns = Array.from({ length: 10 }, (_, index) => index + 1)
+  const rows = packages.map(({ name }) => name)
+
+  const parallelWorkers = await promptTable(message, {
+    columns,
+    rows,
+  })
+
+  // At least one package needs to be selected for integration tests
+  // so if none is selected, show the prompt again
+  if (!parallelWorkers.some(Boolean)) {
+    return promptParallelWorkersForMonorepo(
+      packages,
+      'At least one package needs to be selected for integration tests!'
+    )
+  }
+
+  return packages
+    .map(({ name, location }, index) => ({
+      pkg: name,
+      location,
+      parallelGroups: parallelWorkers[index],
+    }))
+    .filter(({ parallelGroups }) => parallelGroups)
+}
+
+const promptParallelWorkersForSPA = () =>
+  promptNumber(
+    'Input how many parallel workers you want for integration tests',
+    {
+      validate: input => input > 0 || 'Please provide a number > 0',
+      filter: input => (Number.isNaN(input) || Number(input) <= 0 ? '' : input),
+    }
+  )
+
+const promptCodeCoverage = () =>
+  promptConfirm(
+    'Do you want to print code coverage info in your PR? \nYour project must support code-coverage generation',
+    false
+  )
+
+module.exports = {
+  promptCodeCoverage,
+  promptParallelWorkersForMonorepo,
+  promptParallelWorkersForSPA,
+}

package/src/utils/filter-packages-by-commands.js

@@ -0,0 +1,29 @@
+const path = require('path')
+
+/**
+ * Return workspace packages that have specified
+ * command(s) in their package.json scripts
+ * @param {string} rootDir
+ * @param {Array<{ name: string, location: string }>} packages
+ * @param {Array<string>} commands
+ * @return {Array<{ name: string, location: string, command: string }>}
+ */
+const filterPackagesByCommands = (rootDir, packages, commands) => {
+  return packages
+    .map(({ name, location }) => {
+      const packageJsonPath = path.join(rootDir, location, 'package.json')
+
+      const pkg = require(packageJsonPath)
+
+      return {
+        name,
+        location,
+        command: Object.keys(pkg.scripts).find(script =>
+          commands.includes(script)
+        ),
+      }
+    })
+    .filter(({ command }) => command)
+}
+
+module.exports = filterPackagesByCommands

package/src/utils/get-program-config.js

@@ -0,0 +1,42 @@
+const path = require('path')
+const { cosmiconfig } = require('cosmiconfig')
+
+/**
+ * Searches for and loads configuration for your program
+ * Looks for:
+ *   - a package.json property
+ *   - a JSON or YAML, extensionless "rc file"
+ *   - an "rc file" with the extensions .json, .yaml, .yml, .js, or .cjs
+ *   - a .config.js or .config.cjs CommonJS module
+ * @param program
+ * @param [defaultDir] - search up the directory tree from this folder
+ * @return {Promise<any|{extends}>}
+ */
+const getProgramConfig = async (program, defaultDir) => {
+  const explorer = cosmiconfig(program)
+
+  const defaultConfig = await explorer.search(defaultDir)
+
+  if (!defaultConfig) {
+    return
+  }
+
+  if (!defaultConfig.config.extends) {
+    return defaultConfig.config
+  }
+
+  const extendedConfig = await explorer.load(
+    path.join(defaultDir, defaultConfig.config.extends)
+  )
+
+  if (!extendedConfig) {
+    return defaultConfig.config
+  }
+
+  return {
+    ...defaultConfig.config,
+    ...extendedConfig.config,
+  }
+}
+
+module.exports = getProgramConfig

package/src/utils/prompts.js

@@ -0,0 +1,74 @@
+const inquirer = require('inquirer')
+
+/**
+ * @typedef Choices
+ * @type {object}
+ * @property {string} name
+ * @property {string|Object<string, any>} [value]
+ */
+
+/**
+ * Show table prompt
+ * @param {string} message
+ * @param {Object} additionalProps
+ * @param {Array<string | Choices>} additionalProps.columns
+ * @param {Array<string | Choices>} additionalProps.rows
+ * @return {Promise<Array<any|undefined>>}
+ */
+const promptTable = async (message, { columns, rows }) => {
+  const { result } = await inquirer.prompt([
+    {
+      type: 'table',
+      name: 'result',
+      message,
+      columns,
+      rows,
+    },
+  ])
+
+  return result
+}
+
+/**
+ * Show number prompts
+ * @param {string} message
+ * @param {Object} [additionalProps]
+ * @return {Promise<number>}
+ */
+const promptNumber = async (message, additionalProps) => {
+  const { numberValue } = await inquirer.prompt([
+    {
+      type: 'number',
+      name: 'numberValue',
+      message,
+      ...additionalProps,
+    },
+  ])
+
+  return numberValue
+}
+
+/**
+ * Show confirmation prompt
+ * @param {string} message
+ * @param {boolean} [defaultValue]
+ * @return {Promise<boolean>}
+ */
+const promptConfirm = async (message, defaultValue) => {
+  const { confirmValue } = await inquirer.prompt([
+    {
+      type: 'confirm',
+      name: 'confirmValue',
+      message,
+      default: defaultValue,
+    },
+  ])
+
+  return confirmValue
+}
+
+module.exports = {
+  promptTable,
+  promptNumber,
+  promptConfirm,
+}

package/src/utils/set-root-env.js

@@ -0,0 +1,17 @@
+const yaml = require('js-yaml')
+const fs = require('fs')
+
+/**
+ * Set/replace root ENV variables in the workflow
+ * @param {Object<string, any>} env
+ * @param {string} workflowPath
+ */
+const setRootEnv = (env, workflowPath) => {
+  const workflow = yaml.load(fs.readFileSync(workflowPath, 'utf8'))
+
+  Object.assign(workflow.env, env)
+
+  fs.writeFileSync(workflowPath, yaml.dump(workflow))
+}
+
+module.exports = setRootEnv

package/src/post-build/integration-tests.js

@@ -1,26 +0,0 @@
-const chalk = require('chalk')
-
-const CONFLUENCE_PAGE =
-  'https://toptal-core.atlassian.net/l/c/qtXKBzvs#Generated-IT-Workflow'
-const yellowBoldText = chalk.yellow.bold
-
-const executePostBuild = () => {
-  console.log(
-    [
-      chalk.green(
-        '\nIntegration tests (integration-tests) GH Workflow has been generated! \n\n'
-      ),
-      'Workflow is located in ',
-      chalk.green.bold('.github/workflows/davinci-integration-tests.yml'),
-      '\n',
-      "But it likely won't work out of the box and will ",
-      yellowBoldText('require little bit of adjusting'),
-      ' to make it work in your CI\n',
-      'Read more about customization here ',
-      chalk.grey.bold(CONFLUENCE_PAGE),
-      '\n',
-    ].join('')
-  )
-}
-
-module.exports = executePostBuild