Add thread support for GitLab

source/commands/ci/runner.ts

@@ -71,6 +71,7 @@ export const runRunner = async (app: SharedCLI, config?: Partial<RunnerConfig>)
         ignoreOutOfDiffComments: app.ignoreOutOfDiffComments,
         newComment: app.newComment || false,
         removePreviousComments: app.removePreviousComments || false,
+        useThread: app.useThread || false
       }
 
       const processName = (app.process && addSubprocessCallAguments(app.process.split(" "))) || undefined

source/commands/utils/sharedDangerfileArgs.ts

@@ -33,6 +33,8 @@ export interface SharedCLI extends program.CommanderStatic {
   newComment?: boolean
   /** Removes all previous comment and create a new one in the end of the list */
   removePreviousComments?: boolean
+  /** Use thread instance of notes */
+  useThread?: boolean
 }
 
 export default (command: any) =>
@@ -51,6 +53,7 @@ export default (command: any) =>
     .option("--use-github-checks", "Use GitHub Checks", false)
     .option("--ignoreOutOfDiffComments", "Ignore inline-comments that are in lines which were not changed", false)
     .option("--newComment", "Makes Danger post a new comment instead of editing its previous one", false)
+    .option("--useThread", "Makes Danger post a thread instead of note", false)
     .option(
       "--removePreviousComments",
       "Removes all previous comment and create a new one in the end of the list",

source/dsl/GitLabDSL.ts

@@ -292,3 +292,23 @@ export interface GitLabApproval {
       }[]
     | GitLabUser[]
 }
+
+export interface GitLabDiscussionAuthor {
+  id: number
+  name: string
+  username: string
+  state: boolean
+}
+
+export interface GitLabDiscussionNote {
+  id: number
+  type: string | null
+  body: string
+  author: GitLabDiscussionAuthor
+}
+
+export interface GitLabDiscussion {
+  id: number,
+  individual_note: boolean,
+  notes: GitLabDiscussionNote[]
+}

source/platforms/BitBucketCloud.ts

@@ -67,6 +67,14 @@ export class BitBucketCloud implements Platform {
     return true
   }
 
+  supportsThreads() {
+    return false;
+  }
+
+  updateOrCreateThread = async (): Promise<undefined> => {
+    return undefined;
+  }
+
   /**
    * Returns the response for the new comment
    *

source/platforms/BitBucketServer.ts

@@ -117,6 +117,14 @@ export class BitBucketServer implements Platform {
     return true
   }
 
+  supportsThreads() {
+    return false;
+  }
+
+  updateOrCreateThread = async (): Promise<undefined> => {
+    return undefined;
+  }
+
   /**
    * Returns the response for the new comment
    *

source/platforms/FakePlatform.ts

@@ -56,6 +56,14 @@ export class FakePlatform implements Platform {
     return true
   }
 
+  supportsThreads() {
+    return false;
+  }
+
+  updateOrCreateThread = async (): Promise<undefined> => {
+    return undefined;
+  }
+
   async updateOrCreateComment(_dangerID: string, _newComment: string): Promise<string> {
     return "https://github.com/orta/github-pages-with-jekyll/pull/5#issuecomment-383402256"
   }

source/platforms/GitHub.ts

@@ -75,6 +75,14 @@ export function GitHub(api: GitHubAPI) {
 
     getFileContents: api.fileContents,
     executeRuntimeEnvironment,
+
+    supportsThreads() {
+      return false;
+    },
+
+    async updateOrCreateThread(): Promise<undefined> {
+      return undefined;
+    }
   } as GitHubType
 }
 

source/platforms/GitLab.ts

@@ -2,7 +2,7 @@ import GitLabAPI from "./gitlab/GitLabAPI"
 import { Platform, Comment } from "./platform"
 import { GitDSL, GitJSONDSL } from "../dsl/GitDSL"
 import { GitCommit } from "../dsl/Commit"
-import { GitLabDSL, GitLabJSONDSL, GitLabNote } from "../dsl/GitLabDSL"
+import { GitLabDiscussion, GitLabDSL, GitLabJSONDSL, GitLabNote } from "../dsl/GitLabDSL"
 
 import { debug } from "../debug"
 import { dangerIDToString } from "../runner/templates/githubIssueTemplate"
@@ -92,6 +92,23 @@ class GitLab implements Platform {
     return true
   }
 
+  supportsThreads() {
+    return true;
+  }
+
+  updateOrCreateThread = async (dangerID: string, newComment: string): Promise<string> => {
+    const threads = await this.getDangerThreads(dangerID);
+
+    if (threads.length) {
+      await this.api.updateMergeRequestDiscussion(threads[0].id, threads[0].notes[0].id, newComment);
+      return `${this.api.mergeRequestURL}#note_${threads[0].notes[0].id}`;
+    } else {
+      const thread = await this.api.createMergeRequestDiscussion(newComment);
+
+      return `${this.api.mergeRequestURL}#note_${thread.notes[0].id}`;
+    }
+  }
+
   updateOrCreateComment = async (dangerID: string, newComment: string): Promise<string> => {
     d("updateOrCreateComment", { dangerID, newComment })
 
@@ -131,7 +148,7 @@ class GitLab implements Platform {
 
     const mr = await this.api.getMergeRequestInfo()
 
-    return this.api.createMergeRequestDiscussion(comment, {
+    const thread = await this.api.createMergeRequestDiscussion(comment, {
       position_type: "text",
       base_sha: mr.diff_refs.base_sha,
       start_sha: mr.diff_refs.start_sha,
@@ -141,6 +158,8 @@ class GitLab implements Platform {
       new_path: path,
       new_line: line,
     })
+
+    return `${this.api.mergeRequestURL}#note_${thread.notes[0].id}`;
   }
 
   updateInlineComment = async (comment: string, id: string): Promise<GitLabNote> => {
@@ -178,6 +197,17 @@ class GitLab implements Platform {
     )
   }
 
+  getDangerThreads = async (dangerID: string) => {
+    const { id: dangerUserId } = await this.api.getUser()
+    const threads = await this.api.getMergeRequestThreads();
+
+    return threads.filter(
+      (discussion: GitLabDiscussion) => {
+        return discussion.notes[0].author.id === dangerUserId && discussion.notes[0].body.includes(dangerIDToString(dangerID));
+      }
+    )
+  }
+
   updateStatus = async (): Promise<boolean> => {
     d("updateStatus", {})
     return true

source/platforms/LocalGit.ts

@@ -71,6 +71,14 @@ export class LocalGit implements Platform {
     return true
   }
 
+  supportsThreads() {
+    return false;
+  }
+
+  updateOrCreateThread = async (): Promise<undefined> => {
+    return undefined;
+  }
+
   async updateOrCreateComment(_dangerID: string, _newComment: string): Promise<string | undefined> {
     return undefined
   }

source/platforms/gitlab/GitLabAPI.ts

@@ -1,17 +1,18 @@
 import { RepoMetaData } from "../../dsl/BitBucketServerDSL"
 import { api as fetch } from "../../api/fetch"
 import {
+  GitLabApproval,
+  GitLabDiscussion,
   GitLabDiscussionTextPosition,
   GitLabInlineNote,
   GitLabMR,
   GitLabMRChange,
   GitLabMRChanges,
   GitLabMRCommit,
   GitLabNote,
-  GitLabUserProfile,
-  GitLabRepositoryFile,
   GitLabRepositoryCompare,
-  GitLabApproval,
+  GitLabRepositoryFile,
+  GitLabUserProfile,
 } from "../../dsl/GitLabDSL"
 
 import { Gitlab } from "gitlab"
@@ -136,7 +137,7 @@ class GitLabAPI {
     return inlineNotes
   }
 
-  createMergeRequestDiscussion = async (content: string, position: GitLabDiscussionTextPosition): Promise<string> => {
+  createMergeRequestDiscussion = async (content: string, position?: GitLabDiscussionTextPosition): Promise<GitLabDiscussion> => {
     this.d(
       "createMergeRequestDiscussion",
       this.repoMetadata.repoSlug,
@@ -146,11 +147,15 @@ class GitLabAPI {
     )
     const api = this.api.MergeRequestDiscussions
 
+    const options: any = {};
+
+    if (position) {
+      options.position = position;
+    }
+
     try {
       // @ts-ignore
-      const result: string = await api.create(this.repoMetadata.repoSlug, this.repoMetadata.pullRequestID, content, {
-        position: position,
-      })
+      const result = await api.create(this.repoMetadata.repoSlug, this.repoMetadata.pullRequestID, content, options) as GitLabDiscussion;
       this.d("createMergeRequestDiscussion", result)
       return result
     } catch (e) {
@@ -159,6 +164,26 @@ class GitLabAPI {
     }
   }
 
+  updateMergeRequestDiscussion = async (discussionId: number, noteId: number, body: string): Promise<GitLabDiscussion> => {
+    this.d(
+      "updateMergeRequestDiscussion",
+      this.repoMetadata.repoSlug,
+      this.repoMetadata.pullRequestID,
+      discussionId,
+      noteId,
+      body,
+    )
+
+    return await this.api.MergeRequestDiscussions.editNote(
+      this.repoMetadata.repoSlug,
+      this.repoMetadata.pullRequestID,
+      discussionId,
+      noteId,
+      // @ts-ignore
+      body
+    ) as GitLabDiscussion;
+  }
+
   createMergeRequestNote = async (body: string): Promise<GitLabNote> => {
     this.d("createMergeRequestNote", this.repoMetadata.repoSlug, this.repoMetadata.pullRequestID, body)
     const api = this.api.MergeRequestNotes
@@ -239,6 +264,11 @@ class GitLabAPI {
     const compare = (await api.compare(projectId, base, head)) as GitLabRepositoryCompare
     return compare.diffs
   }
+  async getMergeRequestThreads(): Promise<GitLabDiscussion[]> {
+    this.d('getMergeRequestThreads');
+
+    return await this.api.MergeRequestDiscussions.all(this.repoMetadata.repoSlug, this.repoMetadata.pullRequestID) as GitLabDiscussion[];
+  }
 }
 
 export default GitLabAPI

source/platforms/platform.ts

@@ -69,6 +69,8 @@ export interface PlatformCommunicator {
   supportsCommenting: () => boolean
   /** Does the platform support inline comments? */
   supportsInlineComments: () => boolean
+  /** Does the platform supports threads? */
+  supportsThreads: () => boolean
   /** Allows the platform to do whatever it wants, instead of using the default commenting system  */
   handlePostingResults?: (results: DangerResults, options: ExecutorOptions) => void
   /** Gets inline comments for current PR */
@@ -85,6 +87,8 @@ export interface PlatformCommunicator {
   deleteMainComment: (dangerID: string) => Promise<boolean>
   /** Replace the main Danger comment, returning the URL to the issue */
   updateOrCreateComment: (dangerID: string, newComment: string) => Promise<string | undefined>
+  /** Replaces the created thread */
+  updateOrCreateThread: (dangerID: string, newComment: string) => Promise<string | undefined>
   /** Sets the current PR's status */
   updateStatus: (
     passed: boolean | "pending",
@@ -148,7 +152,7 @@ export function getPlatformForEnv(env: Env, source: CISource): Platform {
   // They need to set the token up for GitHub actions to work
   if (env["GITHUB_EVENT_NAME"] && !ghToken) {
     console.error(`You need to add GITHUB_TOKEN to your Danger action in the workflow:
-  
+
     - name: Danger JS
       uses: danger/danger-js@X.Y.Z
       ${chalk.green(`env:

source/runner/Executor.ts

@@ -64,6 +64,8 @@ export interface ExecutorOptions {
   newComment?: boolean
   /** Removes all previous comment and create a new one in the end of the list */
   removePreviousComments?: boolean
+  /** Uses threads instead of notes */
+  useThread?: boolean
 }
 // This is still badly named, maybe it really should just be runner?
 
@@ -314,7 +316,13 @@ export class Executor {
           comment = githubResultsTemplate(dangerID, mergedResults, commitID)
         }
 
-        if (this.options.newComment) {
+        if (this.options.useThread) {
+          if (!this.platform.supportsThreads) {
+            throw new Error(`Platform ${this.platform.name} does not support threads`);
+          }
+
+          issueURL = await this.platform.updateOrCreateThread(dangerID, comment);
+        } else if (this.options.newComment) {
           issueURL = await this.platform.createComment(dangerID, comment)
         } else {
           issueURL = await this.platform.updateOrCreateComment(dangerID, comment)