Improve bot (#8)

* handle gitlab error requests

* update deps and fix linter issues

* improve markup

* update requests handling

* update slack markup

* handle network errors

* fix empty line

* update version

Author: tysky

.eslintrc.json

@@ -1,12 +1,16 @@
 {
   "env": {
     "node": true,
-    "es6": true
+    "es2021": true
   },
-  "parser": "babel-eslint",
+  "parser": "@babel/eslint-parser",
+  "extends": [
+    "umbrellio"
+  ],
   "plugins": ["promise"],
   "parserOptions": {
-    "ecmaVersion": 2018
+    "ecmaVersion": 2021,
+    "requireConfigFile": false
   },
   "rules": {
     "no-unused-vars": ["error", { "varsIgnorePattern": "^_", "argsIgnorePattern": "^_" }],

README.md

@@ -40,6 +40,10 @@ Example of the config file:
 messenger:
   webhook: "<WEBHOOK URL>"             # Mattermost / Slack webhook
   channel: "<CHANNEL>"                 # Mattermost / Slack channel where will be messages sent
+  markup: "slack"                      # Messenger markup (default - "markdown").
+                                       # Possible values:
+                                       # - "markdown" (for Mattermost)
+                                       # - "slack" (for Slack)
   sender:
     username: "@ubmrellio/gbot"        # Sender's display name
     icon: "<icon url>"                 # Sender's icon url

api/GitLab.js

@@ -2,7 +2,7 @@ const url = require("../utils/url")
 const network = require("../utils/network")
 
 class GitLab {
-  constructor({ gitlab }) {
+  constructor ({ gitlab }) {
     this.baseUrl = gitlab.url
     this.token = gitlab.token
     this.projects = gitlab.projects
@@ -47,7 +47,7 @@ class GitLab {
   __getPaginated = (uri, query = {}) => {
     return this.__get(uri, query).then(async results => {
       const { headers } = results
-      const totalPages = parseInt(headers["x-total-pages"]) || 1
+      const totalPages = parseInt(headers["x-total-pages"], 10) || 1
 
       let page = 1
       let allResults = results

api/Messenger.js

@@ -2,19 +2,19 @@ const _ = require("lodash")
 const network = require("../utils/network")
 
 class Messenger {
-  constructor({ messenger }) {
+  constructor ({ messenger }) {
     this.channel = _.get(messenger, "channel")
     this.webhook = _.get(messenger, "webhook")
     this.username = _.get(messenger, "sender.username", "Gbot")
     this.icon = _.get(messenger, "sender.icon", null)
   }
 
-  send = text => {
+  send = content => {
     const message = {
-      text,
+      ...content,
       channel: this.channel,
       username: this.username,
-      icon_url: this.icon
+      icon_url: this.icon,
     }
 
     return network.post(this.webhook, message)

gbot

@@ -7,13 +7,15 @@ const configUtils = require("./utils/config")
 
 const Unapproved = require("./tasks/Unapproved")
 
-const runCommand = klass => argv => {
+const runCommand = Klass => argv => {
   const config = configUtils.load(argv.config)
-   return new klass(config).perform()
+  return new Klass(config).perform()
 }
 
-yargs
-  .command("unapproved", "sends unapproved requests to Mattermost / Slack", {}, runCommand(Unapproved))
+yargs // eslint-disable-line no-unused-expressions
+  .command(
+    "unapproved", "sends unapproved requests to Mattermost / Slack", {}, runCommand(Unapproved),
+  )
   .demandCommand(1, "must provide a valid command")
   .options({
     config: {

gbot.example.yml

@@ -1,6 +1,7 @@
 messenger:
   webhook: "<WEBHOOK URL>"
   channel: "<CHANNEL>"
+  markup: slack
   sender:
     username: "@ubmrellio/gbot"
     icon: "<icon url>"

package.json

@@ -1,23 +1,29 @@
 {
   "name": "@umbrellio/gbot",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "bin": "gbot",
   "repository": "git@github.com:umbrellio/gbot.git",
   "author": "Aleksei Bespalov <nulldefiner@gmail.com>",
   "homepage": "https://github.com/umbrellio/gbot",
   "license": "MIT",
   "scripts": {
-    "lint": "eslint ."
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix"
   },
   "dependencies": {
-    "js-yaml": "^3.14.0",
-    "lodash": "^4.17.20",
+    "js-yaml": "^4.1.0",
+    "lodash": "^4.17.21",
     "winston": "^3.3.3",
-    "yargs": "^15.4.1"
+    "yargs": "^17.2.1"
   },
   "devDependencies": {
-    "babel-eslint": "^10.1.0",
-    "eslint": "^7.7.0",
-    "eslint-plugin-promise": "^4.2.1"
+    "@babel/core": "^7.14.6",
+    "@babel/eslint-parser": "^7.16.0",
+    "eslint": "^8.1.0",
+    "eslint-config-umbrellio": "^5.0.1",
+    "eslint-plugin-import": "^2.25.2",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prefer-object-spread": "^1.2.1",
+    "eslint-plugin-promise": "^5.1.1"
   }
 }

tasks/BaseCommand.js

@@ -6,7 +6,7 @@ const GitLab = require("../api/GitLab")
 const Messenger = require("../api/Messenger")
 
 class BaseCommand {
-  constructor(config) {
+  constructor (config) {
     this.config = config
     this.logger = logger
     this.gitlab = new GitLab(config)

tasks/Unapproved.js

@@ -3,6 +3,10 @@ const _ = require("lodash")
 const BaseCommand = require("./BaseCommand")
 const UnapprovedRequestDescription = require("./unapproved/UnapprovedRequestDescription")
 
+const logger = require("../utils/logger")
+const markupUtils = require("../utils/markup")
+const { NetworkError } = require("../utils/errors")
+
 class Unapproved extends BaseCommand {
   perform = () => {
     const promises = this.projects.map(this.__getUnapprovedRequests)
@@ -13,23 +17,41 @@ class Unapproved extends BaseCommand {
       .then(this.__buildMessage)
       .then(message => {
         this.logger.info("Sending message")
-        this.logger.info(message)
+        this.logger.info(JSON.stringify(message))
         return message
       })
       .then(this.messenger.send)
+      .catch(err => {
+        if (err instanceof NetworkError) {
+          logger.error(err)
+        } else {
+          console.error(err) // eslint-disable-line no-console
+        }
+
+        process.exit(1)
+      })
   }
 
   __buildMessage = requests => {
+    const markup = markupUtils[this.config.messenger.markup]
+
     if (requests.length) {
-      const list = requests.map(this.__buildRequestDescription).join("\n")
-      const head = "#### Hey, there are a couple of requests waiting for your review"
+      const list = requests.map(this.__buildRequestDescription).map(markup.addDivider)
+      const headText = "Hey, there are a couple of requests waiting for your review"
+
+      const header = markup.makeHeader(headText)
+      const bodyParts = markup.flatten(list)
 
-      return `${head}\n\n${list}`
+      const message = markup.composeMsg(header, bodyParts)
+      return message
     } else {
-      return [
-        "#### Hey, there is a couple of nothing",
-        "There are no pending requests! Let's do a new one!"
-      ].join("\n\n")
+      const headText = "Hey, there is a couple of nothing"
+      const bodyText = "There are no pending requests! Let's do a new one!"
+
+      const header = markup.makeHeader(headText)
+      const body = markup.makePrimaryInfo(markup.makeText(bodyText))
+      const message = markup.composeMsg(header, body)
+      return message
     }
   }
 

tasks/unapproved/UnapprovedRequestDescription.js

@@ -2,36 +2,57 @@ const _ = require("lodash")
 const gitUtils = require("../../utils/git")
 const timeUtils = require("../../utils/time")
 const stringUtils = require("../../utils/strings")
+const markupUtils = require("../../utils/markup")
 
 class UnapprovedRequestDescription {
-  constructor(request, config) {
+  constructor (request, config) {
     this.config = config
     this.request = request
   }
 
   build = () => {
+    const markup = markupUtils[this.config.messenger.markup]
+
     const updated = new Date(this.request.updated_at)
-    const reaction = this.__getEmoji(updated)
 
-    const link = `[${this.request.title}](${this.request.web_url})`
+    const reaction = this.__getEmoji(updated)
+    const link = markup.makeLink(this.request.title, this.request.web_url)
     const author = this.__authorString()
-    const project = `[${this.request.project.name}](${this.request.project.web_url})`
+    const projectLink = markup.makeLink(this.request.project.name, this.request.project.web_url)
     const unresolvedAuthors = this.__unresolvedAuthorsString()
     const approvedBy = this.__approvedByString()
     const optionalDiff = this.__optionalDiffString()
 
-    const parts = [reaction, `**${link}**`, optionalDiff, `(${project})`, `by **${author}**`]
-
-    let message = [_.compact(parts).join(" ")]
+    const requestMessageParts = [
+      reaction,
+      markup.makeBold(link),
+      optionalDiff,
+      `(${projectLink})`,
+      `by ${markup.makeBold(author)}`,
+    ]
+    const requestMessageText = _.compact(requestMessageParts).join(" ")
+    const primaryMessage = markup.makePrimaryInfo(
+      markup.makeText(requestMessageText, { withMentions: false }),
+    )
+    const secondaryMessageParts = []
 
     if (unresolvedAuthors.length > 0) {
-      message.push(`unresolved threads by: ${unresolvedAuthors}`)
+      const text = `unresolved threads by: ${unresolvedAuthors}`
+      const msg = markup.makeText(text, { withMentions: true })
+
+      secondaryMessageParts.push(msg)
     }
     if (approvedBy.length > 0) {
-      message.push(`already approved by: ${approvedBy}`)
+      const text = `already approved by: ${approvedBy}`
+      const msg = markup.makeText(text, { withMentions: false })
+
+      secondaryMessageParts.push(msg)
     }
 
-    return message.join("\n")
+    const secondaryMessage = markup.makeAdditionalInfo(secondaryMessageParts)
+    const message = markup.composeBody(primaryMessage, secondaryMessage)
+
+    return message
   }
 
   __getConfigSetting = (settingName, defaultValue = null) => {
@@ -111,18 +132,18 @@ class UnapprovedRequestDescription {
       _.partialRight(
         _.filter,
         discussion => discussion.notes.some(
-          note => note.resolvable && !note.resolved
-        )
+          note => note.resolvable && !note.resolved,
+        ),
       ),
       _.partialRight(_.map, selectNotes),
       _.partialRight(
         _.map,
-        notes => notes.map(note => note.author)
+        notes => notes.map(note => note.author),
       ),
       _.partialRight(_.flatten),
       _.partialRight(
         _.uniqBy,
-        author => author.username
+        author => author.username,
       ),
     )
 

utils/config.js

@@ -5,6 +5,12 @@ const yaml = require("js-yaml")
 
 const PREFIX_REGEX = /^GBOT_/
 
+const defaultConfig = {
+  messenger: {
+    markup: "markdown",
+  },
+}
+
 const parseEnvValue = value => {
   try {
     return JSON.parse(value)
@@ -20,7 +26,7 @@ const parseEnvKey = key => {
 const getFileConfig = filePath => {
   const configPath = path.resolve(filePath)
   const content = fs.readFileSync(configPath)
-  return yaml.safeLoad(content)
+  return yaml.load(content)
 }
 
 const getEnvConfig = () => Object
@@ -36,7 +42,7 @@ const load = filePath => {
   const fileConfig = getFileConfig(filePath)
   const envConfig = getEnvConfig()
 
-  return _.merge(fileConfig, envConfig)
+  return _.merge(defaultConfig, fileConfig, envConfig)
 }
 
 module.exports = { load }

utils/errors.js

@@ -0,0 +1,11 @@
+class NetworkError extends Error {
+  constructor (message, status) {
+    super(message)
+    this.name = "NetworkError"
+    this.status = status
+  }
+}
+
+module.exports = {
+  NetworkError,
+}

utils/git.js

@@ -4,7 +4,7 @@ const DIFF_DELETION_REGEXP = /^-/
 const diffToNumericMap = diff => {
   const [, ...lines] = diff.split("\n")
 
-  const numericMatch = (str, re) => str.match(re) ? 1 : 0
+  const numericMatch = (str, re) => (str.match(re) ? 1 : 0)
 
   return lines.map(line => {
     const isInsertion = numericMatch(line, DIFF_INSERTION_REGEXP)

utils/logger.js

@@ -13,4 +13,4 @@ module.exports = winston.createLogger({
   format: winston.format.combine(winston.format.timestamp(), format),
   exceptionHandlers: transports,
   transports,
-});
+})