Feature: Allow to split message by merge requests count (#14)

* dev

* dev

* dev

* dev

* dev

* dev

* dev

* dev

* dev

* dev

* dev

* dev

* dev

* dev

* dev

* dev

* revu

* revu

---------

Co-authored-by: alexander.baz <alexander.baz@okwork.io>

Author: alexander-baz

README.md

@@ -38,7 +38,8 @@ Example of the config file:
 
 ```yml
 messenger:
-  webhook: "<WEBHOOK URL>"             # Mattermost / Slack webhook
+  url: "<chat.postMessage URL>"        # Slack chat.postMessage endpoint
+  token: "<TOKEN>"                     # Slack token with chat:write scope
   channel: "<CHANNEL>"                 # Mattermost / Slack channel where will be messages sent
   markup: "slack"                      # Messenger markup (default - "markdown").
                                        # Possible values:
@@ -47,6 +48,9 @@ messenger:
   sender:
     username: "@umbrellio/gbot"        # Sender's display name
     icon: "<icon url>"                 # Sender's icon url
+  slack:
+    usernameMapping:
+      pavel: "U020DSB741G"             # Mapping of Gitlab username to Slack ID
 gitlab:
   token: "<TOKEN>"                     # GitLab Private Access Token
   url: "<gitlab api url>"              # Gitlab API base url
@@ -72,8 +76,10 @@ unapproved:                            # Config for `unapproved` command
     approvers: false                   # Tag approvers or not (default - false)
     author: false                      # Tag author of PR or not (default - false)
     commenters: false                  # Tag thread commenters or not (default - false)
+    onThreadsOpen: false               # Whether to tag thread authors and PR author when threads are present
   diffs: false                         # Show changed lines count or not (default - false)
   splitByReviewProgress: false         # Whether to split the requests into those completely without review and those that under review
+  requestsPerMessage: 15               # Merge requests count per message
 ```
 
 Groups in the config are [Gitlab project groups](https://docs.gitlab.com/ee/user/group/). You must specify the group or the project, or both.

api/Messenger.js

@@ -3,21 +3,29 @@ const network = require("../utils/network")
 
 class Messenger {
   constructor ({ messenger }) {
+    this.url = _.get(messenger, "url")
+    this.token = _.get(messenger, "token")
+    this.headers = { Authorization: `Bearer ${this.token}` }
     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 = content => {
-    const message = {
-      ...content,
+  send = message => {
+    const content = {
+      ...message,
       channel: this.channel,
       username: this.username,
       icon_url: this.icon,
     }
 
-    return network.post(this.webhook, message)
+    return network.post(this.url, content, this.headers)
+  }
+
+  sendMany = messages => {
+    _.castArray(messages).forEach((message, idx) => {
+      _.delay(() => this.send(message), 100 * idx)
+    })
   }
 }
 

gbot.example.yml

@@ -1,10 +1,14 @@
 messenger:
-  webhook: "<WEBHOOK URL>"
+  url: https://slack.com/api/chat.postMessage
+  token: "<TOKEN>"
   channel: "<CHANNEL>"
   markup: slack
   sender:
     username: "@ubmrellio/gbot"
     icon: "<icon url>"
+  slack:
+    usernameMapping:
+      pavel: U020DSB741G
 gitlab:
   token: "<TOKEN>"
   url: "<gitlab api url>"
@@ -29,5 +33,7 @@ unapproved:
     approvers: false
     author: false
     commenters: false
+    onThreadsOpen: false
   diffs: false
   splitByReviewProgress: false
+  requestsPerMessage: 15

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@umbrellio/gbot",
-  "version": "1.8.0",
+  "version": "2.0.0",
   "bin": "gbot",
   "repository": "git@github.com:umbrellio/gbot.git",
   "author": "Aleksei Bespalov <nulldefiner@gmail.com>",

tasks/Unapproved.js

@@ -13,13 +13,9 @@ class Unapproved extends BaseCommand {
     return this.projects
       .then(projects => Promise.all(projects.map(this.__getUnapprovedRequests)))
       .then(this.__sortRequests)
-      .then(this.__buildMessage)
-      .then(message => {
-        this.logger.info("Sending message")
-        this.logger.info(JSON.stringify(message))
-        return message
-      })
-      .then(this.messenger.send)
+      .then(this.__buildMessages)
+      .then(this.__logMessages)
+      .then(this.messenger.sendMany)
       .catch(err => {
         if (err instanceof NetworkError) {
           logger.error(err)
@@ -31,35 +27,49 @@ class Unapproved extends BaseCommand {
       })
   }
 
-  __buildMessage = requests => {
+  __buildMessages = requests => {
     const markup = markupUtils[this.__getConfigSetting("messenger.markup")]
 
     if (requests.length) {
-      return this.__buildListMessage(requests, markup)
+      return this.__buildListMessages(requests, markup)
     } else {
-      return this.__buildEmptyListMessage(requests, markup)
+      return this.__buildEmptyListMessage(markup)
     }
   }
 
-  __buildListMessage = (requests, markup) => {
-    const headText = "Hey, there are a couple of requests waiting for your review"
-    const list = this.__buildRequestsMessage(requests, markup)
+  __logMessages = messages => {
+    this.logger.info("Sending messages")
+    this.logger.info(JSON.stringify(messages))
+    return messages
+  }
 
+  __buildListMessages = (requests, markup) => {
+    const headText = "Hey, there are a couple of requests waiting for your review"
+    const messages = this.__buildRequestsMessages(requests, markup)
     const header = markup.makeHeader(headText)
-    const bodyParts = markup.flatten(list)
 
-    return markup.composeMsg(header, bodyParts)
+    return messages.map((message, idx) => {
+      const parts = markup.flatten(message)
+
+      if (idx === 0) {
+        return markup.composeMsg(
+          markup.withHeader(header, parts),
+        )
+      }
+
+      return markup.composeMsg(parts)
+    })
   }
 
-  __buildRequestsMessage = (requests, markup) => {
+  __buildRequestsMessages = (requests, markup) => {
     const splitByReviewProgress =
       this.__getConfigSetting("unapproved.splitByReviewProgress")
 
     if (splitByReviewProgress) {
-      return this.__buildByReviewProgressMessage(requests, markup)
+      return this.__buildByReviewProgressMessages(requests, markup)
     }
 
-    return this.__buildGeneralRequestsMessage(requests, markup)
+    return this.__buildGeneralRequestsMessages(requests, markup)
   }
 
   __buildEmptyListMessage = markup => {
@@ -69,13 +79,10 @@ class Unapproved extends BaseCommand {
     const header = markup.makeHeader(headText)
     const body = markup.makePrimaryInfo(markup.makeText(bodyText))
 
-    return markup.composeMsg(header, body)
+    return markup.composeMsg(markup.withHeader(header, body))
   }
 
-  __buildGeneralRequestsMessage = (requests, markup) => requests
-    .map(this.__buildRequestDescription).map(markup.addDivider)
-
-  __buildByReviewProgressMessage = (requests, markup) => {
+  __buildByReviewProgressMessages = (requests, markup) => {
     const messages = []
     const [toReviewRequests, underReviewRequests] = _.partition(requests, req => (
       req.approvals_left > 0 && !this.__isRequestUnderReview(req)
@@ -90,15 +97,33 @@ class Unapproved extends BaseCommand {
     const toReviewSection = makeSection("Unapproved")
     const underReviewSection = makeSection("Under review")
 
-    const toReviewMessage = this.__buildGeneralRequestsMessage(toReviewRequests, markup)
-    const underReviewMessage = this.__buildGeneralRequestsMessage(underReviewRequests, markup)
+    const toReviewMessages = this.__buildGeneralRequestsMessages(toReviewRequests, markup)
+    const underReviewMessages = this.__buildGeneralRequestsMessages(underReviewRequests, markup)
+
+    toReviewMessages.forEach((chunk, idx) => {
+      messages.push(idx === 0 ? [toReviewSection, ...chunk] : chunk)
+    })
 
-    toReviewMessage.length && messages.push(toReviewSection, ...toReviewMessage)
-    underReviewMessage.length && messages.push(underReviewSection, ...underReviewMessage)
+    underReviewMessages.forEach((chunk, idx) => {
+      messages.push(idx === 0 ? [underReviewSection, ...chunk] : chunk)
+    })
 
     return messages
   }
 
+  __buildGeneralRequestsMessages = (requests, markup) => (
+    this.__chunkRequests(requests).map(chunk => (
+      chunk.map(this.__buildRequestDescription).map(markup.addDivider)
+    ))
+  )
+
+  __chunkRequests = requests => {
+    const requestsPerMessage = this.__getConfigSetting("unapproved.requestsPerMessage")
+    if (!requestsPerMessage) return [requests]
+
+    return _.chunk(requests, requestsPerMessage)
+  }
+
   __buildRequestDescription = request =>
     new UnapprovedRequestDescription(request, this.config).build()
 

tasks/unapproved/UnapprovedRequestDescription.js

@@ -12,23 +12,28 @@ class UnapprovedRequestDescription {
 
   build = () => {
     const markup = markupUtils[this.config.messenger.markup]
+    const tagAuthor = this.__getConfigSetting("unapproved.tag.author", false)
+    const tagOnThreadsOpen = this.__getConfigSetting("unapproved.tag.onThreadsOpen", false)
 
-    const updated = new Date(this.request.updated_at)
+    const { author, updated } = this.request
 
-    const reaction = this.__getEmoji(updated)
+    const reaction = this.__getEmoji(new Date(updated))
     const link = markup.makeLink(this.request.title, this.request.web_url)
-    const author = this.__authorString()
     const projectLink = markup.makeLink(this.request.project.name, this.request.project.web_url)
-    const unresolvedAuthors = this.__unresolvedAuthorsString()
-    const approvedBy = this.__approvedByString()
+    const unresolvedAuthors = this.__unresolvedAuthorsString(markup)
+    const tagAuthorOnThread = tagOnThreadsOpen && unresolvedAuthors.length > 0
+    const authorString = this.__authorString(
+      markup, author.username, { tag: tagAuthor || tagAuthorOnThread },
+    )
+    const approvedBy = this.__approvedByString(markup)
     const optionalDiff = this.__optionalDiffString()
 
     const requestMessageParts = [
       reaction,
       markup.makeBold(link),
       `(${projectLink})`,
       optionalDiff,
-      `by ${markup.makeBold(author)}`,
+      `by ${authorString}`,
     ]
     const requestMessageText = _.compact(requestMessageParts).join(" ")
     const primaryMessage = markup.makePrimaryInfo(
@@ -38,10 +43,11 @@ class UnapprovedRequestDescription {
 
     if (unresolvedAuthors.length > 0) {
       const text = `unresolved threads by: ${unresolvedAuthors}`
-      const msg = markup.makeText(text, { withMentions: true })
+      const msg = markup.makeText(text, { withMentions: tagOnThreadsOpen })
 
       secondaryMessageParts.push(msg)
     }
+
     if (approvedBy.length > 0) {
       const text = `already approved by: ${approvedBy}`
       const msg = markup.makeText(text, { withMentions: false })
@@ -50,9 +56,7 @@ class UnapprovedRequestDescription {
     }
 
     const secondaryMessage = markup.makeAdditionalInfo(secondaryMessageParts)
-    const message = markup.composeBody(primaryMessage, secondaryMessage)
-
-    return message
+    return markup.composeBody(primaryMessage, secondaryMessage)
   }
 
   __getConfigSetting = (settingName, defaultValue = null) => {
@@ -74,43 +78,38 @@ class UnapprovedRequestDescription {
     return findEmoji(emoji) || emoji.default || ""
   }
 
-  __unresolvedAuthorsString = () => {
-    return this.__unresolvedAuthorsFor(this.request).map(author => {
-      return `@${author.username}`
-    }).join(", ")
+  __unresolvedAuthorsString = (markup) => {
+    return this.__unresolvedAuthorsFor(this.request).map(author => (
+      this.__authorString(markup, author.username, { tag: true })
+    )).join(", ")
   }
 
-  __approvedByString = () => {
-    const tagApprovers = this.__getConfigSetting("unapproved.tag.approvers", false)
+  __approvedByString = markup => {
+    const tag = this.__getConfigSetting("unapproved.tag.approvers", false)
 
-    return this.request.approved_by.map(approve => {
-      const { user } = approve
-      let message = `@${user.username}`
+    return this.request.approved_by.map(approve => (
+      this.__authorString(markup, approve.user.username, { tag })
+    )).join(", ")
+  }
 
-      if (!tagApprovers) {
-        message = stringUtils.wrapString(message)
-      }
+  __authorString = (markup, username, { tag = false } = {}) => {
+    if (tag) {
+      return this.__getMentionString(markup, username)
+    }
 
-      return message
-    }).join(", ")
+    return stringUtils.wrapString(`@${username}`)
   }
 
-  __authorString = () => {
-    const tagAuthor = this.__getConfigSetting("unapproved.tag.author", false)
-    let message = `@${this.request.author.username}`
-
-    if (!tagAuthor) {
-      message = stringUtils.wrapString(message)
-    }
-    return message
+  __getMentionString = (markup, username) => {
+    const mapping = this.__getConfigSetting(`messenger.${markup.type}.usernameMapping`, {})
+    return markup.mention(username, mapping)
   }
 
   __optionalDiffString = () => {
     const showDiff = this.__getConfigSetting("unapproved.diffs", false)
 
     if (showDiff) {
       const [ insertions, deletions ] = this.__getTotalDiff()
-
       return stringUtils.wrapString(`+${insertions} -${deletions}`)
     }
 
@@ -119,12 +118,10 @@ class UnapprovedRequestDescription {
 
   __unresolvedAuthorsFor = () => {
     const tagCommenters = this.__getConfigSetting("unapproved.tag.commenters", false)
-
     const { discussions } = this.request
 
     const selectNotes = discussion => {
       const [issueNote, ...comments] = discussion.notes
-
       return tagCommenters ? [issueNote, ...comments] : [issueNote]
     }