@toptal/davinci-cli-shared 1.5.2-alpha-fx-2755-codebase-specific-workflows.131 → 1.5.2-alpha-feature-comm-833-reusing-graphql-fragments-2d4dd9c0.9

package/CHANGELOG.md

@@ -1,5 +1,69 @@
 # Change Log
 
+## 1.9.0
+
+### Minor Changes
+
+- [#1731](https://github.com/toptal/davinci/pull/1731) [`1c422aae`](https://github.com/toptal/davinci/commit/1c422aae676d25cd2216c8a24af4b7e208728931) Thanks [@separatio](https://github.com/separatio)! - ---
+
+  - added data collection to Davinci commands
+
+## 1.8.1
+
+### Patch Changes
+
+- [#1634](https://github.com/toptal/davinci/pull/1634) [`b12d1d19`](https://github.com/toptal/davinci/commit/b12d1d19af02104b9076a53b6e516198e6cda141) Thanks [@OndrejTuma](https://github.com/OndrejTuma)! - ---
+
+  ### checkPrerequirement()
+
+  - add coersion to semver check of package version
+
+## 1.8.0
+
+### Minor Changes
+
+- [#1578](https://github.com/toptal/davinci/pull/1578) [`e602ae7e`](https://github.com/toptal/davinci/commit/e602ae7edc7d075a4192052d6c04868f08fea0a7) Thanks [@augustobmoura](https://github.com/augustobmoura)! - ---
+
+  - add cyan command to print
+
+## 1.7.0
+
+### Minor Changes
+
+- [#1543](https://github.com/toptal/davinci/pull/1543) [`9b67beb3`](https://github.com/toptal/davinci/commit/9b67beb3aaf0e24193b2deaba3126c41e3ec9280) Thanks [@denieler](https://github.com/denieler)! - ---
+  - add package utils to check package prerequisites (peer dependencies packages to be installed)
+  - add yarn list command adapter
+
+* [#1542](https://github.com/toptal/davinci/pull/1542) [`04fe7ffa`](https://github.com/toptal/davinci/commit/04fe7ffa161027d081c6ae870716bb06a2fcf73f) Thanks [@LashaJini](https://github.com/LashaJini)! - - Add `getDirectories` function to list directories relative to path
+  - Add `getPackageDirectories` function to list davinci package directories
+
+## 1.6.0
+
+### Minor Changes
+
+- [#1517](https://github.com/toptal/davinci/pull/1517) [`fa3423f1`](https://github.com/toptal/davinci/commit/fa3423f1f9211b4d8899064aa4afdf5ca2198483) Thanks [@LashaJini](https://github.com/LashaJini)! - ---
+
+  - Do not load Jest related eslint rules if project is not using Jest
+  - [BREAKING CHANGE] Rename `.eslintrc` to `.eslintrc.js`
+
+## 1.5.4
+
+### Patch Changes
+
+- [#1344](https://github.com/toptal/davinci/pull/1344) [`64c000c2`](https://github.com/toptal/davinci/commit/64c000c25d97df2c8853a6cf80b7ca81461dae24) Thanks [@dmaklygin](https://github.com/dmaklygin)! - - implement workflow documentation generator
+
+## 1.5.3
+
+### Patch Changes
+
+- [#1378](https://github.com/toptal/davinci/pull/1378) [`3013b76d`](https://github.com/toptal/davinci/commit/3013b76d7f957924885f3e5933f5227ff42a09e1) Thanks [@augustobmoura](https://github.com/augustobmoura)! - - fix support for boolean options in convertToCLIParameters
+
+## 1.5.2
+
+### Patch Changes
+
+- [#1343](https://github.com/toptal/davinci/pull/1343) [`1212e098`](https://github.com/toptal/davinci/commit/1212e098c668fc1c87ee9b1824edf0bc80509bc4) Thanks [@dmaklygin](https://github.com/dmaklygin)! - - implement custom helper for davinci workflow package
+
 ## 1.5.1
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-cli-shared",
-  "version": "1.5.2-alpha-fx-2755-codebase-specific-workflows.131+b2bc74b6",
+  "version": "1.5.2-alpha-feature-comm-833-reusing-graphql-fragments-2d4dd9c0.9+2d4dd9c0",
   "description": "Shared CLI code and CLI engine for davinci",
   "publishConfig": {
     "access": "public"
@@ -14,11 +14,16 @@
   "author": "Toptal",
   "license": "ISC",
   "dependencies": {
+    "analytics-node": "^6.2.0",
     "chalk": "^4.1.2",
     "execa": "^5.1.1",
+    "find-yarn-workspace-root": "^2.0.0",
     "inquirer": "^8.2.0",
     "js-yaml": "^4.1.0",
+    "read-pkg-up": "7.0.1",
+    "semver": "^7.3.7",
+    "uuid": "^9.0.0",
     "vorpal": "^1.12.0"
   },
-  "gitHead": "b2bc74b6947156d1489a42f820be1832f53b870d"
+  "gitHead": "2d4dd9c0609199490b7112909eb97cbe1b037717"
 }

package/src/commands.loader.js

@@ -1,6 +1,20 @@
+const metrics = require('./utils/metrics/metrics')
+const { gatherUsageData } = require('./utils/metrics/usage-data')
 const toVorpalArgs = require('./utils/to-vorpal-args')
 
-const commandsLoader = (commandCreators, vorpalInstance) => {
+const sendMetrics = async (commandIdentifier, packageCommand) => {
+  try {
+    // Run identify and metrics in parallel
+    await Promise.all([
+      metrics.identify(),
+      gatherUsageData(commandIdentifier, packageCommand).then(metrics.track),
+    ])
+  } catch (err) {
+    // Metrics can fail, we still need to continue the execution
+  }
+}
+
+const commandsLoader = (commandCreators, vorpalInstance, packageCommand) => {
   commandCreators.forEach(commandCreator => {
     const {
       command,
@@ -8,7 +22,7 @@ const commandsLoader = (commandCreators, vorpalInstance) => {
       options = [],
       allowUnknownOptions = false,
       action,
-      help
+      help,
     } = commandCreator
 
     const commandInstance = vorpalInstance
@@ -27,7 +41,15 @@ const commandsLoader = (commandCreators, vorpalInstance) => {
       commandInstance.allowUnknownOptions()
     }
 
-    commandInstance.description(description).action(action)
+    commandInstance.description(description).action(async (...args) => {
+      // Run metrics and the action in parallel
+      const [result] = await Promise.all([
+        action(...args),
+        sendMetrics(command, packageCommand),
+      ])
+
+      return result
+    })
   })
 }
 

package/src/index.js

@@ -1,13 +1,15 @@
 const vorpal = require('vorpal')
 
+const { identify, track } = require('../src/utils/metrics/metrics')
 const print = require('../src/utils/print')
 const { run, runSync } = require('../src/utils/run')
 const prompt = require('../src/utils/prompt')
 const {
-  convertToCLIParameters
+  convertToCLIParameters,
 } = require('../src/utils/convert-to-cli-parameters')
 const davinciProjectConfig = require('./utils/davinci-project-config')
 const files = require('./utils/files')
+const packageUtils = require('./utils/package')
 
 const vorpalInstance = vorpal()
 
@@ -32,10 +34,10 @@ const catchErrorCommand = callback => {
     })
 }
 
-const loadCommands = commandCreators => {
+const loadCommands = (commandCreators, packageCommand) => {
   const commandsLoader = require('./commands.loader')
 
-  commandsLoader(commandCreators, vorpalInstance)
+  commandsLoader(commandCreators, vorpalInstance, packageCommand)
 }
 
 module.exports = {
@@ -50,5 +52,10 @@ module.exports = {
   convertToCLIParameters,
   execCommand,
   catchErrorCommand,
-  help
+  help,
+  packageUtils,
+  metrics: {
+    identify,
+    track,
+  },
 }

package/src/utils/convert-to-cli-parameters.js

@@ -1,16 +1,10 @@
-const convertToCLIParameters = options => {
-  const result = []
+const convertToCLIParameters = options =>
+  Object.entries(options).flatMap(([option, value]) => {
+    if (typeof value === 'boolean') {
+      return [`--${!value ? 'no-' : ''}${option}`]
+    }
 
-  Object.keys(options).forEach(key => {
-    result.push(`--${key}`)
-
-    const hasTrueValue = options[key] === true
-    const optionValue = hasTrueValue ? '' : String(options[key])
-
-    result.push(optionValue)
+    return [`--${option}`, String(value)]
   })
 
-  return result
-}
-
 module.exports = { convertToCLIParameters }

package/src/utils/davinci-project-config.js

@@ -14,14 +14,14 @@ const davinciProjectConfig = {
     conventionalCommits: resolve('master', 'conventional_commits'),
     deploy: resolve('master', 'deploy'),
     deployStaging: resolve('master', 'deploy_staging'),
-    publishAsPackage: resolve('master', 'publish_as_package')
+    publishAsPackage: resolve('master', 'publish_as_package'),
   },
   pr: {
-    contractTesting: resolve('pr', 'contract_testing')
+    contractTesting: resolve('pr', 'contract_testing'),
   },
   isProgressiveWebApp: Boolean(resolveKey(data, 'is_progressive_web_app')),
   serviceWorkerFileName: resolveKey(data, 'service_worker_filename'),
-  safetyWorkers: resolveKey(data, 'safety_workers')
+  safetyWorkers: resolveKey(data, 'safety_workers'),
 }
 
 module.exports = davinciProjectConfig

package/src/utils/files.js

@@ -1,4 +1,5 @@
 const path = require('path')
+const { readdirSync } = require('fs')
 
 const getPackageFileContent = (davinciPackageName, filename) =>
   require(getPackageFilePath(davinciPackageName, filename))
@@ -19,9 +20,26 @@ const getProjectRootFilePath = filename => {
   return path.join(currentRunningDir, filename)
 }
 
+const projectHasPackage = pkg => {
+  try {
+    require.resolve(pkg)
+
+    return true
+  } catch {
+    return false
+  }
+}
+
+const getDirectories = source =>
+  readdirSync(source, { withFileTypes: true })
+    .filter(dirent => dirent.isDirectory())
+    .map(dirent => dirent.name)
+
 module.exports = {
   getPackageFileContent,
   getPackageFilePath,
   getProjectRootFilePath,
-  getProjectRootFileContent
+  getProjectRootFileContent,
+  projectHasPackage,
+  getDirectories,
 }

package/src/utils/metrics/id-config.js

@@ -0,0 +1,63 @@
+const os = require('os')
+const path = require('path')
+const fs = require('fs')
+const yaml = require('js-yaml')
+const { v1: uuid } = require('uuid')
+
+const homeDir = os.homedir()
+const configDir = path.join(homeDir, '.davinci-metrics')
+const configFile = path.join(configDir, 'auth.yml')
+const DEFAULT_FILE_CONTENT = 'allow_tracking: "yes"'
+
+const readConfig = () => {
+  let configFileContent = DEFAULT_FILE_CONTENT
+
+  try {
+    configFileContent = fs.readFileSync(configFile)
+  } catch (error) {
+    if (error.code === 'ENOENT') {
+      // File doesn't exist, lets create a new one automatically
+      fs.mkdirSync(configDir, { recursive: true })
+      fs.writeFileSync(configFile, configFileContent)
+    }
+  }
+
+  return yaml.load(configFileContent)
+}
+
+const updateConfig = config => {
+  const originalConfig = readConfig()
+  const newConfig = {
+    ...originalConfig,
+    ...config,
+  }
+
+  fs.writeFileSync(configFile, yaml.dump(newConfig))
+}
+
+const isTrackingEnabled = () => {
+  const config = readConfig()
+
+  return config.allow_tracking !== 'no' && !process.env.CI
+}
+
+const getDeviceId = () => {
+  const config = readConfig()
+
+  if (config && typeof config.uuid === 'string') {
+    return config.uuid
+  }
+
+  const id = uuid()
+
+  updateConfig({
+    uuid: id,
+  })
+
+  return id
+}
+
+module.exports = {
+  getDeviceId,
+  isTrackingEnabled,
+}

package/src/utils/metrics/metrics.js

@@ -0,0 +1,37 @@
+const Analytics = require('analytics-node')
+
+const { getDeviceId, isTrackingEnabled } = require('./id-config')
+const SEGMENT_WRITE_KEY = 'cwNYguEVVqdxFj5NyTKOhlrvaNQjlsXV'
+const anonymousId = getDeviceId()
+
+const analytics = new Analytics(SEGMENT_WRITE_KEY, {
+  enable: process.env.DAVINCI_SKIP_ANALYTICS !== 'true' && isTrackingEnabled(),
+  flushAt: 1,
+})
+
+const identify = () =>
+  new Promise((resolve, reject) => {
+    analytics.identify(
+      {
+        anonymousId,
+      },
+      err => (err ? reject(err) : resolve())
+    )
+  })
+
+const track = properties =>
+  new Promise((resolve, reject) => {
+    analytics.track(
+      {
+        anonymousId,
+        event: 'davinci-command',
+        properties,
+      },
+      err => (err ? reject(err) : resolve())
+    )
+  })
+
+module.exports = {
+  identify,
+  track,
+}

package/src/utils/metrics/usage-data.js

@@ -0,0 +1,126 @@
+const path = require('path')
+const os = require('os')
+const fs = require('fs')
+const execa = require('execa')
+const readPackageUp = require('read-pkg-up')
+const findYarnWorkspaceRoot = require('find-yarn-workspace-root')
+
+const TOPTAL_SSH_REPO_URL_REGEX =
+  /^git@github\.com:\/?toptal\/([A-Za-z0-9_.-]+)\.git$/
+
+const TOPTAL_HTTPS_REPO_URL_REGEX =
+  /^https:\/\/github\.com\/toptal\/([A-Za-z0-9_.-]+)\.git$/
+
+const UNKNOWN = '<unknown>'
+
+const getProjectName = async () => {
+  const gitProcess = await execa('git', ['remote', 'get-url', 'origin'])
+  const repoOriginUrl = gitProcess.stdout
+
+  // Not matching with a pattern means that either:
+  // 1. Project is not from toptal, so not relevant information
+  // 2. Project is not on github, unlikely for toptal
+  // 3. User is using an ssh alias, in this case we cannot catch it in a sane way otherwise
+  const toptalRepoFound = [
+    TOPTAL_SSH_REPO_URL_REGEX,
+    TOPTAL_HTTPS_REPO_URL_REGEX,
+  ]
+    .map(pattern => repoOriginUrl.match(pattern))
+    .find(Boolean)
+
+  return toptalRepoFound?.[1] ?? UNKNOWN
+}
+
+const getGitBranch = async () => {
+  const gitProcess = await execa('git', ['rev-parse', '--abbrev-ref', 'HEAD'])
+
+  return gitProcess.stdout
+}
+
+const getOsInfo = () => [os.platform(), os.release(), os.arch()].join(' ')
+
+const getPackageManagerFromLockfiles = () => {
+  const lockFiles = {
+    npm: 'package-lock.json',
+    yarn: 'yarn.lock',
+    pnpm: 'pnpm-lock.yaml',
+  }
+
+  const workspaceRoot = findYarnWorkspaceRoot() ?? process.cwd()
+
+  for (const [packageManager, lockFile] of Object.entries(lockFiles)) {
+    if (fs.existsSync(path.resolve(workspaceRoot, lockFile))) {
+      return packageManager
+    }
+  }
+
+  return UNKNOWN
+}
+
+const getPackageManager = () => {
+  const userAgent = process.env.npm_config_user_agent ?? ''
+  const possiblePackageManagers = ['pnpm', 'yarn', 'npm']
+
+  // Should find a package manager when executed as a package.json script
+  const foundPackageManager = possiblePackageManagers.find(packageManager =>
+    userAgent.includes(packageManager)
+  )
+
+  return foundPackageManager ?? getPackageManagerFromLockfiles() ?? UNKNOWN
+}
+
+const hideSensitiveInformation = data => ({
+  ...data,
+  projectName: UNKNOWN,
+  packageName: UNKNOWN,
+  packageVersion: UNKNOWN,
+  gitBranch: UNKNOWN,
+})
+
+const sanitizeCommandDefinition = commandStr =>
+  commandStr
+    .replace(/\[[^\]]*\]/g, '') // Remove optional extra arguments (Eg. [foo...])
+    .replace(/<[^>]*>/g, '') // Remove required extra arguments (Eg. <foo>)
+    .replace(/  +/g, ' ') // Replace multiple spaces to a single space
+    .trim()
+    .replace(/ /g, '_')
+
+const gatherUsageData = async (commandIdentifier, davinciCommand) => {
+  const [projectName, gitBranch, packageInfo] = await Promise.all([
+    getProjectName(),
+    getGitBranch(),
+    readPackageUp(),
+  ])
+
+  const {
+    packageJson: { name: packageName, version: packageVersion },
+  } = packageInfo
+  const osInfo = getOsInfo()
+  const packageManager = getPackageManager()
+  const nodeVersion = process.version
+  const commandName = sanitizeCommandDefinition(
+    `${davinciCommand}_${commandIdentifier}`
+  )
+
+  const data = {
+    commandName,
+    projectName,
+    packageName,
+    packageVersion,
+    gitBranch,
+    osInfo,
+    packageManager,
+    nodeVersion,
+    davinciPackage: davinciCommand,
+  }
+
+  if (projectName === UNKNOWN) {
+    // If the project is unknown we are probably dealing with an external user
+    // Hiding sensitive information
+    return hideSensitiveInformation(data)
+  }
+
+  return data
+}
+
+module.exports = { gatherUsageData }

package/src/utils/package.js

@@ -0,0 +1,41 @@
+const semver = require('semver')
+const readPkgUp = require('read-pkg-up')
+
+const yarnAdapter = require('./yarn-adapter')
+
+const getPackagePackageJson = cwd => {
+  return readPkgUp.sync({ cwd }).packageJson
+}
+
+const getInstalledPackageVersion = packageName => {
+  const packageInfoList = yarnAdapter.list(packageName)
+
+  if (!packageInfoList.size) {
+    return null
+  }
+
+  return packageInfoList.get(packageName)
+}
+
+const checkPrerequirement = ({ dependencies, packageName }) => {
+  const validVersionOrRange = dependencies[packageName]
+
+  const installedVersion = getInstalledPackageVersion(packageName)
+
+  if (!installedVersion) {
+    return `Cannot find module '${packageName}'.`
+  }
+
+  if (semver.satisfies(semver.coerce(installedVersion), validVersionOrRange)) {
+    return null
+  }
+
+  return `Invalid version of package ${packageName} is installed.
+Installed version: ${installedVersion}
+Should be: ${validVersionOrRange}`
+}
+
+module.exports = {
+  getPackagePackageJson,
+  checkPrerequirement,
+}

package/src/utils/print.js

@@ -5,11 +5,15 @@ const isObject = obj => typeof obj === 'object'
 const inspectObject = obj =>
   util.inspect(obj, {
     colors: false,
-    depth: null
+    depth: null,
   })
 const prettifyObjectIfExist = args =>
   args.map(arg => (isObject(arg) ? inspectObject(arg) : arg))
 
+const cyan = (...args) => {
+  console.log(chalk.cyan(...prettifyObjectIfExist(args)))
+}
+
 const green = (...args) => {
   console.log(chalk.green(...prettifyObjectIfExist(args)))
 }
@@ -59,9 +63,10 @@ const prettifyCommands = commands => {
 
 module.exports = {
   green,
+  cyan,
   yellow,
   red,
   grey,
   generatePadding,
-  prettifyCommands
+  prettifyCommands,
 }

package/src/utils/prompt.js

@@ -5,8 +5,8 @@ const confirm = async (name, message) => {
     {
       type: 'confirm',
       name,
-      message
-    }
+      message,
+    },
   ])
 
   return result[name]
@@ -18,8 +18,8 @@ const input = async (name, message, validate) => {
       type: 'input',
       name,
       message,
-      validate
-    }
+      validate,
+    },
   ])
 
   return result[name]
@@ -31,8 +31,8 @@ const password = async (name, message, validate) => {
       type: 'password',
       name,
       message,
-      validate
-    }
+      validate,
+    },
   ])
 
   return result[name]
@@ -41,5 +41,5 @@ const password = async (name, message, validate) => {
 module.exports = {
   confirm,
   input,
-  password
+  password,
 }

package/src/utils/run.js

@@ -8,7 +8,7 @@ const runSync = (command, args, options) => {
 
     const result = execa.sync(command, args, {
       stdio: 'inherit',
-      ...options
+      ...options,
     })
 
     console.log('Done.')
@@ -35,5 +35,5 @@ const run = async (command, args, options) => {
 
 module.exports = {
   run,
-  runSync
+  runSync,
 }

package/src/utils/yarn-adapter.js

@@ -0,0 +1,44 @@
+const { runSync } = require('./run')
+
+/**
+ *
+ * @param {string} treeName
+ * @example '@toptal/davinci-engine@7.5.2'
+ * @returns {Array} Pair package name and version, ex. ['@toptal/davinci-engine', '16.0.2']
+ */
+const splitNameAndVersion = treeName => {
+  const atPos = treeName.lastIndexOf('@')
+
+  return [treeName.slice(0, atPos), treeName.slice(atPos + 1)]
+}
+
+const list = packageName => {
+  const { stdout } = runSync(
+    'yarn',
+    [
+      'list',
+      '--json',
+      '--no-progress',
+      '--non-interactive',
+      '--depth=0',
+      '--pattern',
+      packageName,
+    ],
+    {
+      stdio: undefined,
+    }
+  )
+
+  const listInfo = JSON.parse(stdout)
+  const packagesFound = listInfo?.data?.trees || []
+
+  if (packagesFound.length <= 0) {
+    return new Map()
+  }
+
+  return new Map(packagesFound.map(pkg => splitNameAndVersion(pkg.name)))
+}
+
+module.exports = {
+  list,
+}