initial

Author: nulldef

.eslintignore

@@ -0,0 +1 @@
+node_modules/

.eslintrc.json

@@ -0,0 +1,14 @@
+{
+  "env": {
+    "node": true,
+    "es6": true
+  },
+  "plugins": ["promise"],
+  "parserOptions": {
+    "ecmaVersion": 2018
+  },
+  "rules": {
+    "no-unused-vars": ["error", { "varsIgnorePattern": "^_", "argsIgnorePattern": "^_" }],
+    "promise/always-return": "off"
+  }
+}

.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+logs/*.log

README.md

@@ -0,0 +1,76 @@
+# @umbrellio/gbot
+
+Gitlab bot platform.
+
+## Installation
+
+```sh
+$ yarn add @umbrellio/gbot
+```
+
+or
+
+```sh
+$ npm i @umbrellio/gbot
+```
+
+## Usage
+
+### `unapproved`
+
+Sends unapproved MR to mattermost / slack. MR will be ignored if it has WIP mark.
+
+```sh
+$ gbot unapproved -c /path/to/config/gbot.yaml
+```
+
+## Configuration
+
+Each setting can be set via environment variables.
+Each variable must starts with `GBOT_` prefix. Each double underline will be interpreted as nesting, for example:
+
+```sh
+GBOT_GITLAB_TOKEN=token # { "gitlabToken": "token" }
+GBOT_GITLAB__TOKEN=token # {"gitlab": { "token": "token" } }
+```
+
+Example of the config file:
+
+```yml
+messenger:
+  webhook: "<WEBHOOK URL>"             # Mattermost / Slack webhook
+  channel: "<CHANNEL>"                 # Mattermost / Slack channel where will be messages sent
+  sender:
+    username: "@ubmrellio/gbot"        # Sender's display name
+    icon: "<icon url>"                 # Sender's icon url
+gitlab:
+  token: "<TOKEN>"                     # GitLab Private Access Token
+  url: "<gitlab api url>"              # Gitlab API base url
+  projects:                            # List of your project ids
+  - 42
+
+# tasks config
+unapproved:                            # Config for `unapproved` command
+  emoji:                               # Emoji which will be set for each MR (optional)
+    24h: ":emoji1:"                    # If MR's last update time more than 24 hours
+                                       # Time interval can be set in seconds, minutes,
+                                       # hours and days (30s, 10m, 5h, 2d)
+    12h: ":emoji2:"                    # If MR's last update time more than 12 hours
+    default: ":emoji3:"                # Default emoji (if other ones wasn't matched)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/umbrellio/gbot.
+
+## License
+
+Released under MIT License.
+
+## Authors
+
+Created by [Aleksei Bespalov](https://github.com/nulldef).
+
+<a href="https://github.com/umbrellio/">
+<img style="float: left;" src="https://umbrellio.github.io/Umbrellio/supported_by_umbrellio.svg" alt="Supported by Umbrellio" width="439" height="72">
+</a>

api/Messenger.js

@@ -0,0 +1,25 @@
+const _ = require("lodash")
+const network = require("../utils/network")
+const logger = require("../utils/logger")
+
+class 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 => {
+    const message = {
+      text,
+      channel: this.channel,
+      username: this.username,
+      icon_url: this.icon
+    }
+
+    return network.post(this.webhook, message)
+  }
+}
+
+module.exports = Messenger

api/gitlab.js

@@ -0,0 +1,41 @@
+const url = require("../utils/url")
+const network = require("../utils/network")
+
+class GitLab {
+  constructor({ gitlab }) {
+    this.baseUrl = gitlab.url
+    this.token = gitlab.token
+    this.projects = gitlab.projects
+  }
+
+  approvals = (project, request) => {
+    const uri = this.__getUrl("projects", project, "merge_requests", request, "approvals")
+    return this.__get(uri)
+  }
+
+  project = id => this.__get(this.__getUrl("projects", id))
+
+  requests = project => {
+    const query = {
+      sort: "asc",
+      per_page: 100,
+      state: "opened",
+      scope: "all",
+      wip: "no",
+    }
+
+    const uri = this.__getUrl("projects", project, "merge_requests")
+    return this.__get(uri, query)
+  }
+
+  discussions = (project, request) => {
+    const uri = this.__getUrl("projects", project, "merge_requests", request, "discussions")
+    return this.__get(uri)
+  }
+
+  __getUrl = (...parts) => url.build(this.baseUrl, ...parts)
+
+  __get = (url, query = {}) => network.get(url, query, { "Private-Token": this.token })
+}
+
+module.exports = GitLab

gbot

@@ -0,0 +1,29 @@
+#!/usr/bin/env node
+
+const yargs = require("yargs")
+
+const pkg = require("./package")
+const configUtils = require("./utils/config")
+
+const Unapproved = require("./tasks/Unapproved")
+
+const runCommand = klass => argv => {
+  const config = configUtils.load(argv.config)
+   return new klass(config).perform()
+}
+
+yargs
+  .command("unapproved", "sends unapproved requests to Mattermost / Slack", {}, runCommand(Unapproved))
+  .demandCommand(1, "must provide a valid command")
+  .options({
+    config: {
+      alias: "c",
+      describe: "path to config file",
+      default: "./gbot.yml",
+      type: "string",
+    },
+  })
+  .version(pkg.version)
+  .help()
+  .strict()
+  .argv

gbot.example.yml

@@ -0,0 +1,18 @@
+messenger:
+  webhook: "<WEBHOOK URL>"
+  channel: "<CHANNEL>"
+  sender:
+    username: "@ubmrellio/gbot"
+    icon: "<icon url>"
+gitlab:
+  token: "<TOKEN>"
+  url: "<gitlab api url>"
+  projects:
+  - 42
+
+# tasks config
+unapproved:
+  emoji:
+    24h: ":emoji1:"
+    12h: ":emoji2:"
+    default: ":emoji3:"

package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@umbrellio/gbot",
+  "version": "1.0.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 ."
+  },
+  "dependencies": {
+    "js-yaml": "^3.14.0",
+    "lodash": "^4.17.20",
+    "winston": "^3.3.3",
+    "yargs": "^15.4.1"
+  },
+  "devDependencies": {
+    "eslint": "^7.7.0",
+    "eslint-plugin-promise": "^4.2.1"
+  }
+}

tasks/BaseCommand.js

@@ -0,0 +1,23 @@
+const _ = require("lodash")
+
+const logger = require("../utils/logger")
+
+const GitLab = require("../api/GitLab")
+const Messenger = require("../api/Messenger")
+
+class BaseCommand {
+  constructor(config) {
+    this.config = config
+    this.logger = logger
+    this.gitlab = new GitLab(config)
+    this.messenger = new Messenger(config)
+
+    this.projects = _.get(config, "gitlab.projects")
+  }
+
+  perform = () => {
+    throw new Error("Not implemented")
+  }
+}
+
+module.exports = BaseCommand

tasks/unapproved.js

@@ -0,0 +1,87 @@
+const _ = require("lodash")
+
+const timeUtils = require("../utils/time")
+
+const BaseCommand = require("./BaseCommand")
+
+class Unapproved extends BaseCommand {
+  perform = () => {
+    const promises = this.projects.map(this.__getUnapprovedRequests)
+
+    return Promise.all(promises)
+      .then(_.flatten)
+      .then(requests => requests.sort((a, b) => new Date(a.updated_at) - new Date(b.updated_at)))
+      .then(this.__buildMessage)
+      .then(message => {
+        this.logger.info("Sending message")
+        this.logger.info(message)
+        return message
+      })
+      .then(this.messenger.send)
+  }
+
+  __buildMessage = requests => {
+    const list = requests.map(this.__buildRequestDescription).join("\n")
+    const head = `#### Hey, there is a couple of requests waiting for your review`
+
+    return `${head}\n\n${list}`
+  }
+
+  __buildRequestDescription = request => {
+    const updated = new Date(request.updated_at)
+    const reaction = this.__getEmoji(updated)
+
+    const link = `[${request.title}](${request.web_url})`
+    const author = `@${request.author.username}`
+    const project = `[${request.project.name}](${request.project.web_url})`
+
+    return `${reaction} **${link}** (${project}) by **${author}**`
+  }
+
+  __getEmoji = lastUpdate => {
+    const emoji = _.get(this.config, "unapproved.emoji", {})
+    const interval = new Date().getTime() - lastUpdate.getTime()
+
+    const findEmoji = _.flow(
+      _.partialRight(_.toPairs),
+      _.partialRight(_.map, ([key, value]) => [timeUtils.parseInterval(key), value]),
+      _.partialRight(_.sortBy, ([time]) => -time),
+      _.partialRight(_.find, ([time]) => time < interval),
+      _.partialRight(_.last),
+    )
+
+    return findEmoji(emoji) || emoji.default || ""
+  }
+
+  __getUnapprovedRequests = projectId => this.__getExtendedRequests(projectId)
+    .then(requests => requests.filter(req => {
+      const isCompleted = !req.work_in_progress
+      const isUnapproved = req.approvals_left > 0
+      const hasUnresolvedDiscussions = req.discussions.some(dis => {
+        return dis.notes.some(note => note.resolvable && !note.resolved)
+      })
+      return isCompleted && (isUnapproved || hasUnresolvedDiscussions)
+    }))
+
+  __getExtendedRequests = projectId => this.gitlab
+    .project(projectId)
+    .then(project => this.gitlab.requests(project.id).then(requests => {
+      const promises = requests.map(request => this.__getExtendedRequest(project, request))
+      return Promise.all(promises)
+    }))
+
+  __getExtendedRequest = (project, request) => Promise.resolve(request)
+    .then(req => this.__appendApprovals(project, req))
+    .then(req => this.__appendDiscussions(project, req))
+    .then(req => ({ ...req, project }))
+
+  __appendApprovals = (project, request) => this.gitlab
+    .approvals(project.id, request.iid)
+    .then(approvals => ({ ...approvals, ...request }))
+
+  __appendDiscussions = (project, request) => this.gitlab
+    .discussions(project.id, request.iid)
+    .then(discussions => ({ ...request, discussions }))
+}
+
+module.exports = Unapproved

utils/config.js

@@ -0,0 +1,42 @@
+const _ = require("lodash")
+const path = require("path")
+const fs = require("fs")
+const yaml = require("js-yaml")
+
+const PREFIX_REGEX = /^GBOT_/
+
+const parseEnvValue = value => {
+  try {
+    return JSON.parse(value)
+  } catch (e) {
+    return value
+  }
+}
+
+const parseEnvKey = key => {
+  return key.replace(PREFIX_REGEX, "").split("__").map(_.trim).map(_.camelCase)
+}
+
+const getFileConfig = filePath => {
+  const configPath = path.resolve(filePath)
+  const content = fs.readFileSync(configPath)
+  return yaml.safeLoad(content)
+}
+
+const getEnvConfig = () => Object
+  .entries(process.env)
+  .reduce((mem, [key, value]) => {
+    if (!PREFIX_REGEX.test(key)) return mem
+    const keyPath = parseEnvKey(key)
+    const parsedValue = parseEnvValue(value)
+    return _.set(mem, keyPath, parsedValue)
+  }, {})
+
+const load = filePath => {
+  const fileConfig = getFileConfig(filePath)
+  const envConfig = getEnvConfig()
+
+  return _.merge(fileConfig, envConfig)
+}
+
+module.exports = { load }