@toptal/davinci-ci 1.14.6-alpha-feature-comm-833-reusing-graphql-fragments-bc6ed661.22 → 1.14.6-alpha-feature-comm-833-reusing-graphql-fragments-7830a568.23

package/LICENSE.MD

@@ -0,0 +1,4 @@
+/* Copyright (C) Toptal LLC - All Rights Reserved
+ * Unauthorized copying of this file, via any medium is strictly prohibited
+ * Proprietary and confidential
+ */

package/README.md

@@ -0,0 +1,83 @@
+# `@toptal/davinci-ci`
+
+Holds Jenkins jobs definitions and Docker files supporting frontend applications.
+
+## Demo
+
+Watch [this video](https://drive.google.com/file/d/1C5ApkATYCXZ8kTn2LeG5FkM4AveLxAd8/view?usp=sharing) for a demo of how to set up a davinci-ci Jenkins jobs for a project or check the [How to start a new application](https://toptal-core.atlassian.net/wiki/spaces/ENG/pages/1120831396/How+to+start+a+new+application) guide.
+
+## Installation
+
+Use it by installing `yarn add @toptal/davinci-ci` in your project.
+
+## Usage
+
+### Commands
+
+- `davinci-ci danger` - checks if the PR title and and commit messages comply with [Toptal's standards](https://toptal-core.atlassian.net/wiki/spaces/ENG/pages/210665897/Commit+Message+Quality)
+
+- `davinci-ci danger --conventionalCommits` - checks if the PR title and and commit messages comply with [ConventionalCommits](https://www.conventionalcommits.org/en/v1.0.0/)
+
+To check commit message quality locally just add `--local` argument
+
+`davinci-ci danger --local`
+
+Using husky, you can check the commit message before pushing files changes.
+
+```js
+"husky": {
+    "hooks": {
+      "pre-push": "yarn davinci-ci danger --local"
+    }
+  },
+```
+
+### Configuration
+
+You can specify which scenarios you want to be performed both for PR and master branch updates by creating a davinci.yaml file in the root of your project with the following structure.
+
+(by default each config option is set to `false`)
+
+```yaml
+pr:
+  contract_testing: false
+
+master:
+  publish_as_package: false
+  deploy_staging: false
+  deploy_storybook_staging: false
+  deploy: false
+  conventional_commits: false # danger check will require each commit to follow convential commits
+  require_assignee: false # danger check will require each PR to have assignee
+  require_assignee_whitelist: ['dependabot-preview[bot]', 'dependabot[bot]']
+
+# Customize Slack channel where the notifications will get posted
+slack_channel: 'custom-slack-channel'
+is_progressive_web_app: true
+```
+
+### Commands you can use in GitHub PRs
+
+`@toptal-bot run tests` - to re-run `pr-tests` job
+
+`@toptal-bot run package:alpha-release` - to run `publish-alpha-package` job, which is publishing alpha release of the package to npm (temploy for npm package)
+
+### How to setup cypress in CI
+
+In order to enable cypress tests on CI jobs (both pr-tests and master-main) enable it on your project `davinci.yaml` file, like in the example below:
+
+```yaml
+pr:
+  cypress: true
+master:
+  cypress: true
+```
+
+If you have it set as false or if this config is not present in your project `davinci.yaml` file, cypress step will be skipped.
+
+### IDE Tooling
+
+This package can be used directly in your IDE through these extensions
+
+- [IntelliJ Suite (WebStorm, RubyMine, IDEA)](https://github.com/zaguiini/intellij-davinci-plugin)
+- [VSCode](https://github.com/borisyordanov/vscode-supercharge-react)

package/bin/davinci-ci.js

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+
+const cliEngine = require('@toptal/davinci-cli-shared')
+
+const { commands } = require('../src')
+
+cliEngine.loadCommands(commands, 'davinci-ci')
+cliEngine.bootstrap()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-ci",
-  "version": "1.14.6-alpha-feature-comm-833-reusing-graphql-fragments-bc6ed661.22+bc6ed661",
+  "version": "1.14.6-alpha-feature-comm-833-reusing-graphql-fragments-7830a568.23+7830a568",
   "description": "Continuos integrations tools for frontend projects",
   "publishConfig": {
     "access": "public"
@@ -16,25 +16,27 @@
   "bin": {
     "davinci-ci": "./bin/davinci-ci.js"
   },
-  "main": "./src/index.js",
+  "main": "src/index.js",
+  "files": [
+    "src",
+    "CHANGELOG.md"
+  ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/toptal/davinci.git"
   },
   "scripts": {
-    "build:package": "../../bin/build-package.js",
-    "prepublishOnly": "../../bin/prepublish.js",
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
   "bugs": {
     "url": "https://github.com/toptal/davinci/issues"
   },
   "dependencies": {
-    "@commitlint/cli": "^17.0.2",
+    "@commitlint/cli": "^17.4.0",
     "@commitlint/config-conventional": "^17.1.0",
-    "@toptal/davinci-cli-shared": "1.5.2-alpha-feature-comm-833-reusing-graphql-fragments-bc6ed661.22+bc6ed661",
+    "@toptal/davinci-cli-shared": "1.5.2-alpha-feature-comm-833-reusing-graphql-fragments-7830a568.23+7830a568",
     "danger": "^11.0.7",
     "markdown-table": "^2.0.0"
   },
-  "gitHead": "bc6ed661d4338880043ba32ac9c4d6acbc796cb0"
+  "gitHead": "7830a568c3d58e9114ca7d7d4c164bb7a60f3596"
 }

package/src/commands/danger.js

@@ -0,0 +1,67 @@
+const {
+  davinciProjectConfig,
+  runSync,
+  print,
+  convertToCLIParameters,
+  files,
+} = require('@toptal/davinci-cli-shared')
+
+const commandOptions = [
+  {
+    label: 'check only, without fixing the code',
+    name: '--check',
+  },
+  {
+    label: 'checks commit message quality locally',
+    name: '--local',
+  },
+  {
+    label: 'specify custom danger file',
+    name: '--dangerfile <dangerfile>',
+  },
+]
+
+const dangerCommand = ({ options }) => {
+  print.green('Running danger check...')
+
+  const { local, dangerfile, ...rest } = options
+
+  const conventionalCommitsDangerfilePath = files.getPackageFilePath(
+    '@toptal/davinci-ci',
+    'src/configs/danger/conventional-commits/dangerfile.js'
+  )
+  const toptalCommitsDangerfilePath = files.getPackageFilePath(
+    '@toptal/davinci-ci',
+    'src/configs/danger/toptal/dangerfile.js'
+  )
+
+  let dangerfilePath = dangerfile
+
+  if (!dangerfilePath) {
+    dangerfilePath = davinciProjectConfig.master.conventionalCommits
+      ? conventionalCommitsDangerfilePath
+      : toptalCommitsDangerfilePath
+  }
+
+  runSync(
+    'yarn',
+    [
+      'danger',
+      local ? 'local' : 'ci',
+      local ? '--failOnErrors' : undefined,
+      '--dangerfile',
+      `${dangerfilePath}`,
+      ...convertToCLIParameters(rest),
+    ].filter(Boolean)
+  )
+}
+
+const dangerCommandCreator = {
+  action: dangerCommand,
+  allowUnknownOptions: true,
+  command: 'danger',
+  description: 'Run danger check',
+  options: commandOptions,
+}
+
+module.exports = dangerCommandCreator

package/src/configs/danger/conventional-commits/dangerfile.js

@@ -0,0 +1,17 @@
+const { schedule } = require('danger')
+const { davinciProjectConfig } = require('@toptal/davinci-cli-shared')
+
+const { conventionalCommits } = require('./plugins/conventional-commits')
+const { conventionalPRTitle } = require('./plugins/conventional-pr-title')
+const { checkAssigneeExist } = require('../plugins/empty-assignee')
+
+schedule(conventionalCommits)
+schedule(conventionalPRTitle)
+
+const {
+  master: { requireAssignee },
+} = davinciProjectConfig
+
+if (requireAssignee) {
+  schedule(checkAssigneeExist)
+}

package/src/configs/danger/conventional-commits/plugins/conventional-commits/index.js

@@ -0,0 +1,52 @@
+/* globals danger, fail */
+/* eslint-disable import/no-extraneous-dependencies */
+const { default: load } = require('@commitlint/load')
+const { default: lint } = require('@commitlint/lint')
+/* eslint-enable */
+const table = require('markdown-table')
+
+const { WHITELISTED_USERS } = require('../../../toptal/config')
+
+const conventionalCommits = async () => {
+  if (
+    danger.github &&
+    WHITELISTED_USERS.includes(danger.github.pr.user.login)
+  ) {
+    return
+  }
+
+  const { commits } = danger.git
+  const { rules, parserPreset } = await load({
+    extends: ['@commitlint/config-conventional'],
+  })
+
+  commits.forEach(async commit => {
+    const result = await lint(
+      commit.message,
+      rules,
+      parserPreset ? { parserOpts: parserPreset.parserOpts } : {}
+    )
+
+    if (!result.valid) {
+      if (result.errors.length > 0) {
+        let message = `The commit - ${commit.sha.trim()} doesn't conform the conventional commit guidelines. \n\n**Errors**:\n\n`
+
+        message += table([
+          ['Message'],
+          ...result.errors.map(error => [error.message]),
+        ])
+
+        message +=
+          '\n\n💡 For a guidance on how to fix this problem please refer to [https://www.conventionalcommits.org](https://www.conventionalcommits.org)'
+        message +=
+          '\n\n💡 Or you can check our [documentation](https://github.com/toptal/picasso/blob/master/docs/contribution/github-workflow.md#general-commit-message-pattern)'
+
+        fail(message)
+      }
+    }
+  })
+}
+
+module.exports = {
+  conventionalCommits,
+}

package/src/configs/danger/conventional-commits/plugins/conventional-pr-title/index.js

@@ -0,0 +1,53 @@
+/// <reference types="danger" />
+/* globals danger, fail */
+/* eslint-disable import/no-extraneous-dependencies */
+const { default: load } = require('@commitlint/load')
+const { default: lint } = require('@commitlint/lint')
+/* eslint-enable */
+const table = require('markdown-table')
+
+const { WHITELISTED_USERS } = require('../../../toptal/config')
+
+const conventionalPRTitle = async () => {
+  if (!danger.github) {
+    return
+  }
+
+  if (WHITELISTED_USERS.includes(danger.github.pr.user.login)) {
+    return
+  }
+
+  const { rules, parserPreset } = await load({
+    extends: ['@commitlint/config-conventional'],
+  })
+  const { title } = danger.github.pr
+
+  const result = await lint(
+    title,
+    rules,
+    parserPreset ? { parserOpts: parserPreset.parserOpts } : {}
+  )
+
+  if (!result.valid) {
+    if (result.errors.length > 0) {
+      let message =
+        "PR title doesn't conform the conventional commit guidelines. \n\n**Errors**:\n\n"
+
+      message += table([
+        ['Message'],
+        ...result.errors.map(error => [error.message]),
+      ])
+
+      message +=
+        '\n\n💡 For a guidance on how to fix this problem please refer to [https://www.conventionalcommits.org](https://www.conventionalcommits.org)'
+      message +=
+        '\n\n💡 Or you can check our [documentation](https://github.com/toptal/picasso/blob/master/docs/contribution/github-workflow.md#general-commit-message-pattern)'
+
+      fail(message)
+    }
+  }
+}
+
+module.exports = {
+  conventionalPRTitle,
+}

package/src/configs/danger/conventional-commits/plugins/index.js

@@ -0,0 +1,7 @@
+const { conventionalCommits } = require('./conventional-commits')
+const { conventionalPRTitle } = require('./conventional-pr-title')
+
+module.exports = {
+  conventionalCommits,
+  conventionalPRTitle,
+}

package/src/configs/danger/plugins/empty-assignee.js

@@ -0,0 +1,24 @@
+/// <reference types="danger" />
+/* globals danger, fail */
+const { davinciProjectConfig } = require('@toptal/davinci-cli-shared')
+
+const {
+  master: { requireAssigneeWhiteList = [] },
+} = davinciProjectConfig
+
+const WHITELISTED_USERS = requireAssigneeWhiteList
+const checkAssigneeExist = () => {
+  const isLocalRun = !danger.github
+
+  if (isLocalRun || WHITELISTED_USERS.includes(danger.github.pr.user.login)) {
+    return
+  }
+
+  if (!danger.github.pr.assignee || danger.github.pr.assignees.length === 0) {
+    fail('Please assign someone to this PR before merging.')
+  }
+}
+
+module.exports = {
+  checkAssigneeExist,
+}

package/src/configs/danger/toptal/config.js

@@ -0,0 +1,30 @@
+const WHITELISTED_USERS = [
+  'dependabot-preview[bot]',
+  'dependabot[bot]',
+  'toptal-devbot',
+]
+const VALID_PR_CODE_REGEX = /\[[A-Z]{1,5}-.*]\s/
+// Valid commit titles:
+// "Regular commit message"
+// "Commit with sentence. But does not end with a full-stop"
+// "[FOO-1234] Commit with prefix"
+// "[FOO] Prefix numbers can be omitted"
+// "[FOO][BAR] Prefixes can couple"
+const VALID_COMMIT_TITLE_REGEX = /^((\[[A-Z]+(-\d+)?])+ )?[A-Z]\w[^\n]*[^.]$/
+const MAX_COMMIT_LINE_LENGTH = 79
+const ENGINEERING_DOCS_LINK =
+  'https://toptal-core.atlassian.net/wiki/spaces/ENG/pages/210665897/Commit+Message+Quality'
+
+const DEFAULT_PR_TITLE_ERROR_MESSAGE = `The pull request title doesn't conform to Toptal's engineering practices. For guidance on how to fix this problem please refer [here](${ENGINEERING_DOCS_LINK})`
+const MISSING_TICKET_CODE_ERROR_MESSAGE =
+  "The pull request title is missing a Jira issue code. Correct format '[ASD-123] Add a cool feature'. If you're working without a Jira issue then add a 'no-jira' label to your pull request."
+
+module.exports = {
+  DEFAULT_PR_TITLE_ERROR_MESSAGE,
+  ENGINEERING_DOCS_LINK,
+  MAX_COMMIT_LINE_LENGTH,
+  MISSING_TICKET_CODE_ERROR_MESSAGE,
+  VALID_COMMIT_TITLE_REGEX,
+  VALID_PR_CODE_REGEX,
+  WHITELISTED_USERS,
+}

package/src/configs/danger/toptal/dangerfile.js

@@ -0,0 +1,17 @@
+const { schedule } = require('danger')
+const { davinciProjectConfig } = require('@toptal/davinci-cli-shared')
+
+const { toptalCommits } = require('./plugins/toptal-commits')
+const { toptalPRTitle } = require('./plugins/toptal-pr-title')
+const { checkAssigneeExist } = require('../plugins/empty-assignee')
+
+schedule(toptalCommits)
+schedule(toptalPRTitle)
+
+const {
+  master: { requireAssignee },
+} = davinciProjectConfig
+
+if (requireAssignee) {
+  schedule(checkAssigneeExist)
+}

package/src/configs/danger/toptal/plugins/index.js

@@ -0,0 +1,7 @@
+const { toptalCommits } = require('./toptal-commits')
+const { toptalPRTitle } = require('./toptal-pr-title')
+
+module.exports = {
+  toptalCommits,
+  toptalPRTitle,
+}

package/src/configs/danger/toptal/plugins/toptal-commits/index.js

@@ -0,0 +1,73 @@
+/* globals danger, fail */
+const {
+  MAX_COMMIT_LINE_LENGTH,
+  VALID_COMMIT_TITLE_REGEX,
+  WHITELISTED_USERS,
+} = require('../../config')
+
+const validateCommitMessage = message => {
+  const errors = []
+  const [title = '', body = ''] = message.split(/\n\n/)
+  const bodyLines = body.split(/\n/)
+  const isTitleFormatValid = VALID_COMMIT_TITLE_REGEX.test(title)
+  const isTitleLengthValid = title.length <= MAX_COMMIT_LINE_LENGTH
+  const isBodyLinesLengthValid = bodyLines.every(
+    line => line.length <= MAX_COMMIT_LINE_LENGTH
+  )
+
+  if (!isTitleFormatValid) {
+    errors.push(`- format of commit title is not correct ([read more](https://toptal-core.atlassian.net/wiki/spaces/ENG/pages/210665897/Commit+Message+Quality)): 
+  - Title should start with capital letter
+  - Title should not end with a full-stop (i.e .)\n
+  Example of a valid commit title:
+    - Regular commit message
+    - [FOO-1234] Commit with prefix
+    - [FOO][BAR] Coupled prefixes`)
+  }
+
+  if (!isTitleLengthValid) {
+    errors.push(
+      `- title is too long (max ${MAX_COMMIT_LINE_LENGTH} characters)`
+    )
+  }
+
+  if (!isBodyLinesLengthValid) {
+    errors.push(
+      `- body lines must not exceed ${MAX_COMMIT_LINE_LENGTH} characters`
+    )
+  }
+
+  return errors
+}
+
+const toptalCommits = () => {
+  if (
+    danger.github &&
+    WHITELISTED_USERS.includes(danger.github.pr.user.login)
+  ) {
+    return
+  }
+
+  const { commits } = danger.git
+
+  commits.forEach(commit => {
+    if (commit.author && WHITELISTED_USERS.includes(commit.author.name)) {
+      return
+    }
+
+    const validationErrors = validateCommitMessage(commit.message)
+
+    if (validationErrors.length) {
+      fail(
+        [
+          `Commit ${commit.sha.trim()} does not meet requirements of [Commit Message Quality](https://toptal-core.atlassian.net/wiki/spaces/ENG/pages/210665897/Commit+Message+Quality):`,
+          ...validationErrors,
+        ].join('\n')
+      )
+    }
+  })
+}
+
+module.exports = {
+  toptalCommits,
+}

package/src/configs/danger/toptal/plugins/toptal-commits/toptal-commits.test.js

@@ -0,0 +1,128 @@
+const { toptalCommits } = require('.')
+
+const prepareCommitsWithMessages = (messages = []) => ({
+  commits: messages.map(message => ({
+    message,
+    sha: '123',
+  })),
+})
+
+describe('commit danger plugin', () => {
+  beforeEach(() => {
+    global.fail = jest.fn()
+    global.danger = {
+      github: {
+        pr: {
+          user: {
+            login: 'user',
+          },
+        },
+      },
+    }
+  })
+
+  afterEach(() => {
+    global.fail = undefined
+    global.danger = undefined
+  })
+
+  it('commit with title only', () => {
+    global.danger.git = prepareCommitsWithMessages(['Hello world'])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(0)
+  })
+
+  it('commit with title and body', () => {
+    global.danger.git = prepareCommitsWithMessages([
+      'Hello world\n\nSome commit body here.',
+    ])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(0)
+  })
+
+  it('commit with multi-line body', () => {
+    global.danger.git = prepareCommitsWithMessages([
+      'Hello world\n\nFirst line of commit body\nSecond line of commit body',
+    ])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(0)
+  })
+
+  it('commit with title longer than allowed', () => {
+    global.danger.git = prepareCommitsWithMessages([
+      'This commit message is a teeny tiny bit longer than allowed length of 79 characters',
+    ])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(1)
+  })
+
+  it('commit with body lines longer than allowed', () => {
+    global.danger.git = prepareCommitsWithMessages([
+      'Short commit title\n\nBut this body line commit message is a bit longer than allowed length of 79 characters\nAnd this one is fine again.',
+    ])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(1)
+  })
+
+  it('commit message not starting with an uppercase letter', () => {
+    global.danger.git = prepareCommitsWithMessages([
+      '23432 starts with a number',
+      'starts with a lowercase letter',
+      '* starts with a symbol',
+      ' starts with a space',
+    ])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(4)
+  })
+
+  it('commit message ending with a period in title', () => {
+    global.danger.git = prepareCommitsWithMessages([
+      'Commit title ending with period.',
+    ])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(1)
+  })
+
+  it('commit without a blank line between title and body', () => {
+    global.danger.git = prepareCommitsWithMessages([
+      'Commit title\nBody without a blank line after title',
+    ])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(1)
+  })
+
+  it('valid commit titles', () => {
+    global.danger.git = prepareCommitsWithMessages([
+      'Regular commit title',
+      'Commit with sentence. But does not end with a full-stop',
+      '[FOO-1234] Commit with prefix',
+      '[FOO] Prefix numbers can be omitted',
+      '[FOO][BAR] Prefixes can couple',
+      '[FOO-1234][BAR] Mixed prefixes',
+      '[FOO-1234][BAR-123][BAZ] Everything. Together',
+    ])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(0)
+  })
+
+  it('invalid commit title prefixes', () => {
+    global.danger.git = prepareCommitsWithMessages([
+      '[FOO-1234] commit with lowercase',
+      '[FOO-BAR] Prefix with letter after dash',
+      '[FOO] [BAR] Prefixes with space between',
+      '[FOO]Prefix without space',
+    ])
+    toptalCommits()
+
+    expect(global.fail).toHaveBeenCalledTimes(4)
+  })
+})

package/src/configs/danger/toptal/plugins/toptal-pr-title/index.js

@@ -0,0 +1,62 @@
+/* globals danger, fail */
+const {
+  VALID_COMMIT_TITLE_REGEX,
+  VALID_PR_CODE_REGEX,
+  WHITELISTED_USERS,
+  DEFAULT_PR_TITLE_ERROR_MESSAGE,
+  MISSING_TICKET_CODE_ERROR_MESSAGE,
+} = require('../../config')
+
+const getTicketCode = text => {
+  const ticketCode = text.match(VALID_PR_CODE_REGEX)
+
+  if (!ticketCode) {
+    return
+  }
+
+  return ticketCode[0]
+}
+
+const showError = (error = DEFAULT_PR_TITLE_ERROR_MESSAGE) => {
+  fail(error)
+}
+
+const toptalPRTitle = () => {
+  if (!danger.github) {
+    return
+  }
+
+  if (WHITELISTED_USERS.includes(danger.github.pr.user.login)) {
+    return
+  }
+
+  const { title } = danger.github.pr
+  const labelNames = danger.github.issue.labels.map(({ name }) => name)
+
+  const ticketCode = getTicketCode(title)
+
+  if (!ticketCode && !labelNames.includes('no-jira')) {
+    showError(MISSING_TICKET_CODE_ERROR_MESSAGE)
+
+    return
+  }
+
+  const splitTitle = title.split(ticketCode)
+
+  if (!splitTitle.length) {
+    showError()
+
+    return
+  }
+
+  const titleText = splitTitle[splitTitle.length - 1]
+  const isTitleFormatValid = VALID_COMMIT_TITLE_REGEX.test(titleText)
+
+  if (!isTitleFormatValid) {
+    showError()
+  }
+}
+
+module.exports = {
+  toptalPRTitle,
+}