Section with conflicts (#17)

* conflicts section

* refactor

Co-authored-by: Alexander <153199358+alexander-baz@users.noreply.github.com>

* config setting for check conflicts

* refactor check conflict setting

* refactor

* add check conflicts setting to docs

* refactor

---------

Co-authored-by: Alexander <153199358+alexander-baz@users.noreply.github.com>

Author: KirIgor

README.md

@@ -79,8 +79,9 @@ unapproved:                            # Config for `unapproved` command
     onThreadsOpen: false               # Whether to tag thread authors and PR author when threads are present
     onConflict: false                  # Whether to tag PR author if there are conflicts
   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
+  splitByReviewProgress: false         # Whether to split the requests into those completely without review, those that under review and those with conflicts
   requestsPerMessage: 15               # Merge requests count per message
+  checkConflicts: false                # Whether to check PR conflicts
 ```
 
 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/GitLab.js

@@ -1,3 +1,4 @@
+const _ = require("lodash")
 const url = require("../utils/url")
 const network = require("../utils/network")
 
@@ -19,14 +20,14 @@ class GitLab {
 
   project = id => this.__get(this.__getUrl("projects", id))
 
-  requests = project => {
+  requests = (project, { withMergeStatusRecheck }) => {
     const query = {
       sort: "asc",
       per_page: 100,
       state: "opened",
       scope: "all",
       wip: "no",
-      with_merge_status_recheck: true,
+      with_merge_status_recheck: withMergeStatusRecheck,
     }
 
     const uri = this.__getUrl("projects", project, "merge_requests")

gbot.example.yml

@@ -38,3 +38,4 @@ unapproved:
   diffs: false
   splitByReviewProgress: false
   requestsPerMessage: 15
+  checkConflicts: false

package.json

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

tasks/Unapproved.js

@@ -11,7 +11,7 @@ const { NetworkError } = require("../utils/errors")
 class Unapproved extends BaseCommand {
   perform = () => {
     return this.projects
-      .then(projects => Promise.all(projects.map(this.__getUnapprovedRequests)))
+      .then(projects => Promise.all(projects.map(this.__getApplicableRequests)))
       .then(this.__sortRequests)
       .then(this.__buildMessages)
       .then(this.__logMessages)
@@ -69,7 +69,7 @@ class Unapproved extends BaseCommand {
       return this.__buildByReviewProgressMessages(requests, markup)
     }
 
-    return this.__buildGeneralRequestsMessages(requests, markup)
+    return this.__buildGeneralRequestsMessages("unapproved", requests, markup)
   }
 
   __buildEmptyListMessage = markup => {
@@ -84,36 +84,50 @@ class Unapproved extends BaseCommand {
 
   __buildByReviewProgressMessages = (requests, markup) => {
     const messages = []
-    const [toReviewRequests, underReviewRequests] = _.partition(requests, req => (
-      req.approvals_left > 0 && !this.__isRequestUnderReview(req)
-    ))
+    const [toReviewRequests, underReviewRequests, reviewedWithConflicts] = _.values(
+      _.groupBy(requests, req => {
+        const isUnderReview = this.__isRequestUnderReview(req)
+
+        switch (true) {
+          case req.approvals_left > 0 && !isUnderReview:
+            return 0 // To review
+          case isUnderReview:
+            return 1 // Under review
+          default:
+            return 2 // Reviewed with conflicts
+        }
+      }),
+    )
 
     const makeSection = _.flow(
       markup.makeBold,
       markup.makeText,
       markup.makePrimaryInfo,
     )
 
-    const toReviewSection = makeSection("Unapproved")
-    const underReviewSection = makeSection("Under review")
-
-    const toReviewMessages = this.__buildGeneralRequestsMessages(toReviewRequests, markup)
-    const underReviewMessages = this.__buildGeneralRequestsMessages(underReviewRequests, markup)
+    const sections = [
+      { type: "unapproved", name: "Unapproved", requests: toReviewRequests },
+      { type: "under_review", name: "Under review", requests: underReviewRequests },
+      { type: "conflicts", name: "With conflicts", requests: reviewedWithConflicts },
+    ]
 
-    toReviewMessages.forEach((chunk, idx) => {
-      messages.push(idx === 0 ? [toReviewSection, ...chunk] : chunk)
-    })
+    sections.forEach(settings => {
+      const section = makeSection(settings.name)
+      const sectionMessages = this.__buildGeneralRequestsMessages(
+        settings.type, settings.requests, markup,
+      )
 
-    underReviewMessages.forEach((chunk, idx) => {
-      messages.push(idx === 0 ? [underReviewSection, ...chunk] : chunk)
+      sectionMessages.forEach((chunk, idx) => {
+        messages.push(idx === 0 ? [section, ...chunk] : chunk)
+      })
     })
 
     return messages
   }
 
-  __buildGeneralRequestsMessages = (requests, markup) => (
+  __buildGeneralRequestsMessages = (type, requests, markup) => (
     this.__chunkRequests(requests).map(chunk => (
-      chunk.map(this.__buildRequestDescription).map(markup.addDivider)
+      chunk.map(request => this.__buildRequestDescription(type, request)).map(markup.addDivider)
     ))
   )
 
@@ -123,21 +137,25 @@ class Unapproved extends BaseCommand {
     return _.chunk(requests, requestsPerMessage)
   }
 
-  __buildRequestDescription = request =>
-    new UnapprovedRequestDescription(request, this.config).build()
+  __buildRequestDescription = (type, request) =>
+    new UnapprovedRequestDescription(type, request, this.config).build()
 
   __sortRequests = requests => requests
     .flat().sort((a, b) => new Date(a.updated_at) - new Date(b.updated_at))
 
-  __getUnapprovedRequests = project => this.__getExtendedRequests(project.id)
+  __getApplicableRequests = project => this.__getExtendedRequests(project.id)
     .then(requests => requests.filter(req => {
       const isCompleted = !req.work_in_progress
       const isUnapproved = req.approvals_left > 0
       const isUnderReview = this.__isRequestUnderReview(req)
       const hasPathsChanges = this.__hasPathsChanges(req.changes, project.paths)
+      const checkConflicts = this.__getConfigSetting("unapproved.checkConflicts", false)
       const hasConflicts = req.has_conflicts
+      const isApplicable = checkConflicts
+        ? isUnapproved || isUnderReview || hasConflicts
+        : isUnapproved || isUnderReview
 
-      return isCompleted && hasPathsChanges && (isUnapproved || isUnderReview || hasConflicts)
+      return isCompleted && hasPathsChanges && isApplicable
     }))
 
   __isRequestUnderReview = req => req.discussions
@@ -156,12 +174,19 @@ class Unapproved extends BaseCommand {
     ))
   }
 
-  __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)
-    }))
+  __getExtendedRequests = projectId => {
+    const checkConflicts = this.__getConfigSetting("unapproved.checkConflicts", false)
+
+    return this.gitlab
+      .project(projectId)
+      .then(project => this.gitlab
+        .requests(project.id, { withMergeStatusRecheck: checkConflicts })
+        .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))

tasks/unapproved/UnapprovedRequestDescription.js

@@ -5,16 +5,18 @@ const stringUtils = require("../../utils/strings")
 const markupUtils = require("../../utils/markup")
 
 class UnapprovedRequestDescription {
-  constructor (request, config) {
-    this.config = config
+  constructor (type, request, config) {
+    this.type = type
     this.request = request
+    this.config = config
   }
 
   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 tagOnConflict = this.__getConfigSetting("unapproved.tag.onConflict", false)
+    const checkConflicts = this.__getConfigSetting("unapproved.checkConflicts", false)
 
     const { author } = this.request
 
@@ -23,8 +25,11 @@ class UnapprovedRequestDescription {
     const projectLink = markup.makeLink(this.request.project.name, this.request.project.web_url)
     const unresolvedAuthors = this.__unresolvedAuthorsString(markup)
     const tagAuthorOnThread = tagOnThreadsOpen && unresolvedAuthors.length > 0
+    const tagAuthorInPrimaryMessage = this.type === "conflicts"
+      ? tagOnConflict
+      : tagAuthor || tagAuthorOnThread
     const authorString = this.__authorString(
-      markup, author.username, { tag: tagAuthor || tagAuthorOnThread },
+      markup, author.username, { tag: tagAuthorInPrimaryMessage },
     )
     const approvedBy = this.__approvedByString(markup)
     const optionalDiff = this.__optionalDiffString()
@@ -39,7 +44,10 @@ class UnapprovedRequestDescription {
     ]
     const requestMessageText = _.compact(requestMessageParts).join(" ")
     const primaryMessage = markup.makePrimaryInfo(
-      markup.makeText(requestMessageText, { withMentions: false }),
+      markup.makeText(
+        requestMessageText,
+        { withMentions: this.type === "conflicts" && tagOnConflict },
+      ),
     )
     const secondaryMessageParts = []
 
@@ -57,14 +65,17 @@ class UnapprovedRequestDescription {
       secondaryMessageParts.push(msg)
     }
 
-    if (hasConflicts) {
+    if (checkConflicts && hasConflicts) {
+      const authorString = this.__authorString(markup, author.username, { tag: tagOnConflict })
       const text = `conflicts: ${authorString}`
       const msg = markup.makeText(text, { withMentions: tagOnConflict })
 
       secondaryMessageParts.push(msg)
     }
 
-    const secondaryMessage = markup.makeAdditionalInfo(secondaryMessageParts)
+    const secondaryMessage = markup.makeAdditionalInfo(
+      this.type === "conflicts" ? [] : secondaryMessageParts,
+    )
     return markup.composeBody(primaryMessage, secondaryMessage)
   }