@toptal/davinci-monorepo 8.4.0 → 8.5.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @toptal/davinci-monorepo
 
+## 8.5.0
+
+### Minor Changes
+
+- [#2416](https://github.com/toptal/davinci/pull/2416) [`9518893e`](https://github.com/toptal/davinci/commit/9518893ec55a03736bbaa4ec49b8dea2e6d1f46f) Thanks [@dmaklygin](https://github.com/dmaklygin)!
+- add hosts command to davinci-monorepo package. Try it out with `yarn davinci-monorepo hosts`
+
 ## 8.4.0
 
 ### Minor Changes

package/README.md

@@ -13,3 +13,4 @@ Use it by installing `yarn add @toptal/davinci-monorepo` in your project.
 - [`graph generate`](./docs/graph-generate.md): generate dependency graph into `monorepo-graph.svg` file
 - [`codeowners`](./docs/codeowners.md): show list of tools available for code ownership analysis
 - [`coverage`](./docs/coverage.md): show list of code coverage commands
+- [`hosts`](./docs/hosts.md): get information about hosts in the monorepo

package/docs/hosts.md

@@ -0,0 +1,138 @@
+# Host functions
+
+The `host` functions are used to get information about hosts in the monorepo.
+
+## Filter Valid Hosts Command
+
+This command is used to identify and validate hosts from the input.
+
+### Description
+
+The `davinci-monorepo hosts filter-valid-hosts` command processes an input string to determine existing hosts. It checks the input for valid host names, filters the corresponding packages, and outputs the result either to the console or GitHub.
+
+### Usage
+
+```shell
+davinci-monorepo hosts filter-valid-hosts --hosts="@toptal/test-1-host @toptal/test-2-host"
+```
+
+### Options
+
+- `-h, --hosts [hosts]`
+  - **Description**: Input string to search for hosts in. By default, it is taken from the environment variable `HOSTS_SEQUENCE`.
+  - **Example**: `-h "@toptal/test-1-host @toptal/test-2-host"`
+
+- `--head [head]`
+  - **Description**: HEAD commit hash. By default, it is taken from the environment variable `NX_HEAD`.
+  - **Example**: `--head abc1234`
+
+- `--base [base]`
+  - **Description**: BASE commit hash. By default, it is taken from the environment variable `NX_BASE`.
+  - **Example**: `--base def5678`
+
+- `-o, --output [output]`
+  - **Description**: Supported output destinations are `console` and `github`. The default is `console`.
+  - **Example**: `-o github`
+
+- `--log-level [logLevel]`
+  - **Description**: Sets the log level. Supported values are `debug`, `info`, and `none`. The default is `none`.
+  - **Example**: `--log-level debug`
+
+### Examples
+
+#### Example 1: Specifying Hosts and Output to Console
+
+```bash
+davinci-monorepo hosts filter-valid-hosts --hosts "@toptal/test-1-host @toptal/test-2-host" --output console
+```
+
+#### Example 2: Using Environment Variables and Output to GitHub
+
+```bash
+export HOSTS_SEQUENCE="@toptal/test-1-host @toptal/test-2-host"
+export NX_HEAD="abc1234"
+export NX_BASE="def5678"
+davinci-monorepo hosts filter-valid-hosts --output github
+```
+
+### Environment Variables
+
+- `HOSTS_SEQUENCE`
+  - **Description**: Default input string to search for hosts.
+
+- `NX_HEAD`
+  - **Description**: Default HEAD commit hash.
+
+- `NX_BASE`
+  - **Description**: Default BASE commit hash.
+
+- `LOGGER_LEVEL`
+  - **Description**: Sets the log level. Supported values are `debug`, `info`, and `none`.
+
+### Exit Codes
+
+- `0`: Successful execution.
+- `1`: No hosts found in the input or invalid input format.
+
+
+## Host Attributes Command
+
+This command is used to get the attributes of a host.
+
+### Description
+
+The `davinci-monorepo hosts host-attributes` command retrieves the attributes of a host. It checks the host name for validity and outputs the result either to the console or GitHub. It prints the following information:
+* Host name
+* Host package name
+* Jenkins name for temploy cluster
+* Jenkins name for staging cluster
+* Deploybot name
+
+### Usage
+
+```shell
+davinci-monorepo hosts host-attributes --host="@toptal/test-1-host"
+```
+
+### Options
+
+- `-h, --host [host]`
+  - **Description**: Host name to search for. By default, it is taken from the environment variable `PACKAGE_NAME`.
+  - **Example**: `-h "@toptal/test-1-host"`
+
+- `-o, --output [output]`
+  - **Description**: Supported output destinations are `console` and `github`. The default is `console`.
+  - **Example**: `-o github`
+
+- `--log-level [logLevel]`
+  - **Description**: Sets the log level. Supported values are `debug`, `info`, and `none`. The default is `none`.
+  - **Example**: `--log-level debug`
+
+
+### Environment Variables
+
+- `PACKAGE_NAME`
+  - **Description**: Default host name to search for.
+
+- `LOGGER_LEVEL`
+  - **Description**: Sets the log level. Supported values are `debug`, `info`, and `none`.
+
+### Examples
+
+#### Example 1: Specifying Host and Output to Console
+
+```bash
+davinci-monorepo hosts host-attributes --host "@toptal/test-1-host" --output console
+```
+
+#### Example 2: Using Environment Variables and Output to GitHub
+
+```bash
+export PACKAGE_NAME="@toptal/test-1-host"
+davinci-monorepo hosts host-attributes --output github
+```
+
+### Exit Codes
+
+- `0`: Successful execution.
+- `1`: No hosts found in the input or invalid input format.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-monorepo",
-  "version": "8.4.0",
+  "version": "8.5.0",
   "keywords": [
     "lint"
   ],
@@ -39,6 +39,7 @@
     "ignore": "^5.2.0",
     "is-directory": "^0.3.1",
     "lodash": "^4.17.21",
+    "nx": "^19.2.3",
     "ora": "^5.4.1",
     "ramda": "^0.28.0",
     "true-case-path": "^1.0.3"

package/src/commands/hosts/filter-valid-hosts.js

@@ -0,0 +1,87 @@
+import { print } from '@toptal/davinci-cli-shared'
+
+import { getPackages } from '../../utils/get-packages.js'
+import { validateHost, writeToGithubOutput } from '../../utils/index.js'
+
+const filterValidHostsCommand = async ({
+  hosts,
+  output,
+  head,
+  base,
+  logLevel,
+}) => {
+  process.env.LOGGER_LEVEL = logLevel || process.env.LOGGER_LEVEL
+  const verbose = process.env.LOGGER_LEVEL !== 'none'
+
+  if (verbose) {
+    print.header('Get specified hosts in the input')
+  }
+
+  const hostsSequence = (hosts || process.env.HOSTS_SEQUENCE || '')
+    .toString()
+    .split(' ')
+    .filter(validateHost)
+
+  if (hostsSequence.length === 0) {
+    console.error(
+      'No hosts found in the input. Please, specify the hosts sequence using the --hosts option or the HOSTS_SEQUENCE environment variable.'
+    )
+    console.error(
+      'Make sure that host names are separated by spaces and have the correct format (e.g., "@toptal/%HOST_NAME%-host").'
+    )
+    process.exit(1)
+  }
+
+  const hostPackages = await getPackages({
+    type: 'app',
+    onlyAffected: false,
+    head: head || process.env.NX_HEAD,
+    base: base || process.env.NX_BASE,
+  })
+
+  const filteredHosts = hostPackages.filter(host =>
+    hostsSequence.includes(host)
+  )
+
+  switch (output) {
+    case 'github':
+      writeToGithubOutput(
+        'hosts',
+        filteredHosts.length ? JSON.stringify(filteredHosts) : ''
+      )
+      break
+    case 'console':
+    default:
+      console.log(filteredHosts.length ? JSON.stringify(filteredHosts) : '')
+  }
+
+  if (verbose) {
+    print.success('Done')
+  }
+  process.exit(0)
+}
+
+export const createFilterValidHostsCommand = program => {
+  return program
+    .createCommand('filter-valid-hosts')
+    .description('Gets the input and determines existing hosts in the input')
+    .action(filterValidHostsCommand)
+    .option(
+      '-h, --hosts [hosts]',
+      'Input string to search for hosts in. By default, it is taken from the environment variable HOSTS_SEQUENCE'
+    )
+    .option(
+      '--head [head]',
+      'HEAD commit hash. By default, it is taken from the environment variable NX_HEAD'
+    )
+    .option(
+      '--base [base]',
+      'BASE commit hash. By default, it is taken from the environment variable NX_BASE'
+    )
+    .option(
+      '-o, --output [hosts]',
+      'Supported output: console, github',
+      'console'
+    )
+    .option('--log-level [logLevel]', 'log level: debug, info, none', 'none')
+}

package/src/commands/hosts/host-attributes.js

@@ -0,0 +1,76 @@
+import { print } from '@toptal/davinci-cli-shared'
+
+import {
+  writeToGithubOutput,
+  getHostNameFromPackageName,
+  validateHost,
+} from '../../utils/index.js'
+
+const hostAttributesCommand = ({ host, output, logLevel }) => {
+  process.env.LOGGER_LEVEL = logLevel || process.env.LOGGER_LEVEL
+  const verbose = process.env.LOGGER_LEVEL !== 'none'
+
+  if (verbose) {
+    print.header('Prints host attributes')
+  }
+
+  const packageName = (host || process.env.PACKAGE_NAME || '').toString()
+
+  if (!validateHost(packageName)) {
+    console.error(
+      'No host found in the input. Please, specify the host using the --host option or the PACKAGE_NAME environment variable.'
+    )
+    console.error(
+      'Make sure that the host name has the correct format (e.g., "@toptal/%HOST_NAME%-host").'
+    )
+    process.exit(1)
+  }
+
+  const hostName = getHostNameFromPackageName(packageName)
+  const jenkinsTemployJobName = `${hostName}-temploy-helm-run`
+  const jenkinsStagingJobName =
+    hostName === 'client-portal'
+      ? 'portal-staging-deployment'
+      : `${hostName}-portal-staging-deployment`
+  // In order to deploy to the portal, we need to replace the "host" with "portal"
+  // e.g. hire-global-client-host -> hire-global-client-portal
+  const deploybotName =
+    hostName === 'client-portal' ? 'portal' : `${hostName}-portal`
+
+  const result = JSON.stringify({
+    packageName,
+    hostName,
+    jenkinsTemployJobName,
+    jenkinsStagingJobName,
+    deploybotName,
+    sentryProject: hostName,
+  })
+
+  switch (output) {
+    case 'github':
+      writeToGithubOutput('attributes', result)
+      break
+    case 'console':
+    default:
+      console.log(result)
+  }
+
+  process.exit(0)
+}
+
+export const createHostAttributesCommand = program => {
+  return program
+    .createCommand('host-attributes')
+    .description('Prints host attributes')
+    .action(hostAttributesCommand)
+    .option(
+      '-h, --host <packageName>',
+      'Package name of the host. By default, it is taken from the environment variable PACKAGE_NAME'
+    )
+    .option(
+      '-o, --output <output>',
+      'Supported output: console, github',
+      'console'
+    )
+    .option('--log-level [logLevel]', 'log level: debug, info, none', 'none')
+}

package/src/commands/hosts/index.js

@@ -0,0 +1,13 @@
+import { createFilterValidHostsCommand } from './filter-valid-hosts.js'
+import { createHostAttributesCommand } from './host-attributes.js'
+
+export const hostsCommandFactory = program => {
+  return program
+    .createCommand('hosts')
+    .addCommand(createFilterValidHostsCommand(program))
+    .addCommand(createHostAttributesCommand(program))
+}
+
+export default {
+  hostsCommandFactory,
+}

package/src/index.js

@@ -3,6 +3,7 @@ import { createMetricsCommand } from './commands/metrics.js'
 import { createGraphGenerateCommand } from './commands/graph-generate.js'
 import { createCodeownersCommand } from './commands/codeowners/index.js'
 import { createCoverageCommand } from './commands/coverage-command/index.js'
+import { hostsCommandFactory } from './commands/hosts/index.js'
 import checkIfMonorepo from './utils/check-if-monorepo.js'
 import getPackages from './utils/get-packages.js'
 
@@ -17,6 +18,7 @@ export const commands = [
   createGraphGenerateCommand,
   createCodeownersCommand,
   createCoverageCommand,
+  hostsCommandFactory,
 ]
 
 export default {

package/src/utils/get-changed-files.js

@@ -0,0 +1,85 @@
+import getWorkspaceRoot from 'find-yarn-workspace-root'
+import { execSync } from 'child_process'
+
+import logger from './logger.js'
+
+const workspaceRoot = getWorkspaceRoot()
+
+const hasStashedChanges = () => {
+  try {
+    const stashList = execSync('git stash list', { cwd: workspaceRoot })
+
+    return stashList.toString().trim().length > 0
+  } catch (error) {
+    // eslint-disable-next-line no-console
+    console.error('Error checking stash list:', error)
+
+    return false
+  }
+}
+
+const stashLocalChanges = () => {
+  try {
+    execSync('git stash', { cwd: workspaceRoot })
+  } catch (error) {
+    // eslint-disable-next-line no-console
+    console.error('Error stashing local changes:', error)
+  }
+}
+
+const restoreLocalChanges = () => {
+  if (hasStashedChanges()) {
+    try {
+      execSync('git stash pop', { cwd: workspaceRoot })
+    } catch (error) {
+      // eslint-disable-next-line no-console
+      console.error('Error restoring local changes:', error)
+    }
+  }
+}
+
+/**
+ * Get list of changed files between two commits/branches
+ */
+const getListOfChangedFiles = ({ base = 'origin/master', head = 'HEAD' }) => {
+  const changedFilesCommand = `git diff --name-only ${base} ${head}`
+
+  const result = execSync(changedFilesCommand, { cwd: workspaceRoot })
+
+  return result.toString().split('\n').filter(Boolean)
+}
+
+export const getChangedFiles = ({ base, head }) => {
+  stashLocalChanges()
+
+  const listOfChangedFiles = getListOfChangedFiles({ base, head })
+
+  restoreLocalChanges()
+
+  const rootChangedFiles = listOfChangedFiles.filter(filePath => {
+    // Any change that is not in these folders / files will be considered
+    // as root change and should trigger Jest & Cypress for all packages
+    const pathsWithNonRootChanges = [
+      'libs/',
+      'namespaces/',
+      'hosts/',
+      '.github/CODEOWNERS',
+    ]
+
+    return pathsWithNonRootChanges.every(
+      ignoredPath => !filePath.startsWith(ignoredPath)
+    )
+  })
+
+  if (rootChangedFiles.length > 0) {
+    logger.debug(
+      '[ROOT CHANGED FILES]:',
+      `Root changes detected for ${rootChangedFiles.length} files:`,
+      rootChangedFiles
+    )
+  } else {
+    logger.debug('[ROOT CHANGED FILES]:', 'No root changes detected')
+  }
+
+  return rootChangedFiles
+}

package/src/utils/get-packages.js

@@ -1,6 +1,10 @@
 import path from 'node:path'
 import glob from 'glob'
 import fsSystem from 'fs'
+import { execSync } from 'child_process'
+
+import { getChangedFiles } from './get-changed-files.js'
+import logger from './logger.js'
 
 /**
  * Get information about packages in monorepo
@@ -45,6 +49,76 @@ export const createGetPackages = fs => (root, cwd) => {
   )
 }
 
-const getPackages = createGetPackages(fsSystem)
+const extractPackagesAsArray = packages => {
+  const packagesArray = packages.trim().toString().split('\n').filter(Boolean)
+
+  return packagesArray.length === 0
+    ? []
+    : packagesArray.map(item => item.trim())
+}
+
+export const performPackagesSearch = async (commandArgs = []) => {
+  const command = `npx nx show projects ${commandArgs.join(' ')}`
+
+  // Run the nx command and capture the output
+  logger.debug(`Getting list of interested projects: ${command}`)
+  const output = execSync(command, { encoding: 'utf-8' })
+
+  logger.debug('Packages:', output)
+
+  const packagesArr = extractPackagesAsArray(output)
+
+  logger.log('Number of found packages:', packagesArr.length)
+
+  return packagesArr
+}
+
+export const getPackages = async ({
+  base,
+  head,
+  type,
+  exclude,
+  onlyAffected = false,
+  targetCommand,
+} = {}) => {
+  logger.debug('getPackages: onlyAffected: ', onlyAffected)
+  logger.debug('getPackages: base: ', base)
+  logger.debug('getPackages: head: ', head)
+  logger.debug('getPackages: targetCommand: ', targetCommand)
+  logger.debug('getPackages: type: ', type)
+
+  let rootChangedFiles = []
+
+  if (onlyAffected) {
+    rootChangedFiles = getChangedFiles({ base, head })
+  }
+
+  logger.debug('Root changes detected: ', rootChangedFiles.length > 0)
+
+  const commandArgs = []
+  const affected = rootChangedFiles.length === 0 && onlyAffected
+
+  if (targetCommand) {
+    commandArgs.push('--withTarget', targetCommand)
+  }
+
+  if (type) {
+    commandArgs.push('--type', type)
+  }
+
+  if (exclude) {
+    commandArgs.push('--exclude', exclude)
+  }
+
+  if (affected) {
+    commandArgs.push('--affected')
+    commandArgs.push('--base', base ?? 'remotes/origin/master')
+    commandArgs.push('--head', head ?? 'HEAD')
+  }
+
+  return await performPackagesSearch(commandArgs)
+}
+
+const getPackagesLegacy = createGetPackages(fsSystem)
 
-export default getPackages
+export default getPackagesLegacy

package/src/utils/github/write-to-github-output.js

@@ -0,0 +1,29 @@
+import fs from 'fs'
+import os from 'os'
+
+const writeToGithubOutput = (key, value, multiline = false) => {
+  const outputFilePath = process.env.GITHUB_OUTPUT
+
+  if (!outputFilePath) {
+    throw new Error(
+      'Unable to find environment variable for file command GITHUB_OUTPUT'
+    )
+  }
+
+  if (!fs.existsSync(outputFilePath)) {
+    throw new Error(`Missing file at path: ${outputFilePath}`)
+  }
+
+  const hereDoc = Date.now()
+  const options = { encoding: 'utf8' }
+
+  if (multiline) {
+    fs.appendFileSync(outputFilePath, `${key}<<${hereDoc}${os.EOL}`, options)
+    fs.appendFileSync(outputFilePath, `${value}${os.EOL}`, options)
+    fs.appendFileSync(outputFilePath, `${hereDoc}${os.EOL}`, options)
+  } else {
+    fs.appendFileSync(outputFilePath, `${key}=${value}${os.EOL}`, options)
+  }
+}
+
+export default writeToGithubOutput

package/src/utils/graph/packages.js

@@ -1,6 +1,6 @@
 import execa from 'execa'
 
-import getPackages from '../get-packages.js'
+import getPackagesLegacy from '../get-packages.js'
 
 /**
  * Get Locations of packages in monorepo
@@ -10,7 +10,7 @@ import getPackages from '../get-packages.js'
  * // => ['packages/picasso', 'packages/picasso-lab']
  */
 export const getPackageLocations = () => {
-  const packages = getPackages(process.cwd())
+  const packages = getPackagesLegacy(process.cwd())
 
   if (packages.length === 0) {
     throw new Error('Your project does not seem to be a monorepo.')

package/src/utils/host/get-host-name-from-package-name.js

@@ -0,0 +1,4 @@
+const getHostNameFromPackageName = packageName =>
+  packageName.replace('@toptal/', '').replace('-host', '')
+
+export default getHostNameFromPackageName

package/src/utils/host/print-host-attributes.mjs

@@ -0,0 +1,24 @@
+import { writeToGithubOutput } from './write-to-github-output.js'
+import getHostNameFromPackageName from './get-host-name-from-package-name.mjs'
+
+const printHostAttributes = async () => {
+  const packageName = process.env.PACKAGE_NAME
+  const hostName = getHostNameFromPackageName(packageName)
+  const jenkinsTemployJobName = `${hostName}-temploy-helm-run`
+  const jenkinsStagingJobName = `${hostName}-portal-staging-deployment`
+  const deploybotName = `${hostName}-portal`
+
+  writeToGithubOutput(
+    'attributes',
+    JSON.stringify({
+      packageName,
+      hostName,
+      jenkinsTemployJobName,
+      jenkinsStagingJobName,
+      deploybotName,
+      sentryProject,
+    })
+  )
+}
+
+printHostAttributes()

package/src/utils/host/validate-host.js

@@ -0,0 +1,5 @@
+const validateHost = (hostCandidate = '') => {
+  return hostCandidate.startsWith('@toptal/') && hostCandidate.endsWith('-host')
+}
+
+export default validateHost

package/src/utils/index.js

@@ -4,3 +4,6 @@ export { default as makeWorkspacesGraph } from './make-workspaces-graph.js'
 export { default as getGraphCyclePaths } from './get-graph-cycle-paths.js'
 export { default as getCircularityErrorMessage } from './get-circularity-error-message.js'
 export { default as getLernaGraph } from './get-lerna-graph.js'
+export { default as validateHost } from './host/validate-host.js'
+export { default as getHostNameFromPackageName } from './host/get-host-name-from-package-name.js'
+export { default as writeToGithubOutput } from './github/write-to-github-output.js'

package/src/utils/logger.js

@@ -0,0 +1,24 @@
+/**
+ * Possible log levels: info, debug
+ * @returns log level
+ */
+export const getLoggerLevel = () => process.env.LOGGER_LEVEL || 'info'
+
+export const log = (...args) => {
+  // eslint-disable-next-line no-console
+  if (['debug', 'info'].includes(getLoggerLevel())) {
+    console.log('[INFO]: ', ...args)
+  }
+}
+
+export const debug = (...args) => {
+  // eslint-disable-next-line no-console
+  if (getLoggerLevel() === 'debug') {
+    console.log('[DEBUG]: ', ...args)
+  }
+}
+
+export default {
+  log,
+  debug,
+}