update/recreate comments instead of creating new

Author: delanni

.buildkite/package-lock.json

@@ -15,12 +15,14 @@
     "globby": "^11.1.0",
     "js-yaml": "^4.1.0",
     "minimatch": "^5.0.1",
+    "minimist": "^1.2.8",
     "tslib": "*"
   },
   "devDependencies": {
     "@types/chai": "^4.3.3",
     "@types/js-yaml": "^4.0.5",
     "@types/minimatch": "^3.0.5",
+    "@types/minimist": "^1.2.5",
     "@types/mocha": "^10.0.1",
     "@types/node": "^15.12.2",
     "chai": "^4.3.10",

.buildkite/package.json

@@ -9,6 +9,8 @@
 
 import { Octokit, RestEndpointMethodTypes } from '@octokit/rest';
 
+export const KIBANA_COMMENT_SIGIL = 'kbn-message-context';
+
 const github = new Octokit({
   auth: process.env.GITHUB_TOKEN,
 });
@@ -113,6 +115,56 @@ export function addComment(
   });
 }
 
+export async function upsertComment(
+  messageOpts: {
+    commentBody: string;
+    commentContext: string;
+    clearPrevious: boolean;
+  },
+  owner = process.env.GITHUB_PR_BASE_OWNER,
+  repo = process.env.GITHUB_PR_BASE_REPO,
+  prNumber: undefined | string | number = process.env.GITHUB_PR_NUMBER
+) {
+  const { commentBody, commentContext, clearPrevious } = messageOpts;
+  if (!owner || !repo || !prNumber) {
+    throw Error(
+      "Couldn't retrieve Github PR info from environment variables in order to add a comment"
+    );
+  }
+  if (!commentContext) {
+    throw Error('Comment context is required when updating a comment');
+  }
+
+  const commentMarker = `<!-- ${KIBANA_COMMENT_SIGIL}:${commentContext} -->`;
+  const body = `${commentMarker}${commentBody}`;
+
+  const existingComment = (
+    await github.paginate(github.issues.listComments, {
+      owner,
+      repo,
+      issue_number: typeof prNumber === 'number' ? prNumber : parseInt(prNumber, 10),
+    })
+  ).find((comment) => comment.body?.includes(commentMarker));
+
+  if (!existingComment) {
+    return addComment(body, owner, repo, prNumber);
+  } else if (clearPrevious) {
+    await github.issues.deleteComment({
+      owner,
+      repo,
+      comment_id: existingComment.id,
+    });
+    return addComment(body, owner, repo, prNumber);
+  } else {
+    return github.issues.updateComment({
+      owner,
+      repo,
+      comment_id: existingComment.id,
+      body,
+    });
+  }
+}
+
 export function getGithubClient() {
   return github;
 }

.buildkite/pipeline-utils/github/github.ts

@@ -22,7 +22,10 @@ steps:
               limit: 1
 
       - command: |
-          ts-node .buildkite/scripts/lifecycle/comment_on_pr.ts "PR Cloud deployment started at: $BUILDKITE_BUILD_URL"
+          ts-node .buildkite/scripts/lifecycle/comment_on_pr.ts \
+            --message "PR Cloud deployment started at: $BUILDKITE_BUILD_URL" \
+            --context "cloud-deploy-job" \
+            --clear-previous
         label: Comment with job URL
         agents:
           provider: gcp
@@ -66,7 +69,10 @@ steps:
       - wait: ~
 
       - command: |
-          ts-node .buildkite/scripts/lifecycle/comment_on_pr.ts "Cloud deployment initiated, see credentials at: $BUILDKITE_BUILD_URL"
+          ts-node .buildkite/scripts/lifecycle/comment_on_pr.ts \
+            --message "Cloud deployment initiated, see credentials at: $BUILDKITE_BUILD_URL" \
+            --context "cloud-deploy-job" \
+            --clear-previous
         label: Comment with job URL
         agents:
           provider: gcp

.buildkite/pipelines/build_pr_and_deploy_cloud.yml

@@ -22,7 +22,10 @@ steps:
               limit: 1
 
       - command: |
-          ts-node .buildkite/scripts/lifecycle/comment_on_pr.ts "PR Project deployment started at: $BUILDKITE_BUILD_URL"
+          ts-node .buildkite/scripts/lifecycle/comment_on_pr.ts \
+            --message "PR Project deployment started at: $BUILDKITE_BUILD_URL" \
+            --context "project-deploy-job" \
+            --clear-previous
         label: Comment with job URL
         agents:
           provider: gcp
@@ -62,7 +65,10 @@ steps:
       - wait: ~
 
       - command: |
-          ts-node .buildkite/scripts/lifecycle/comment_on_pr.ts "Project deployed, see credentials at: $BUILDKITE_BUILD_URL"
+          ts-node .buildkite/scripts/lifecycle/comment_on_pr.ts \
+            --message "Project deployed, see credentials at: $BUILDKITE_BUILD_URL" \
+            --context "project-deploy-job" \
+            --clear-previous
         label: Comment with job URL
         agents:
           provider: gcp

.buildkite/pipelines/serverless_deployment/build_pr_and_deploy_project.yml

@@ -7,7 +7,8 @@
  * License v3.0 only", or the "Server Side Public License, v 1".
  */
 
-import { addComment } from '#pipeline-utils';
+import parseArgs from 'minimist';
+import { upsertComment, addComment } from '#pipeline-utils';
 
 const ALLOWED_ENV_VARS = [
   'BUILDKITE_BRANCH',
@@ -31,20 +32,16 @@ const ALLOWED_ENV_VARS = [
   'GITHUB_PR_TRIGGER_USER',
   'GITHUB_PR_USER',
 ];
-const DEFAULT_MESSAGE_TEMPLATE =
-  '🚀 Buildkite job started for PR #${GITHUB_PR_NUMBER}: ${BUILDKITE_BUILD_URL}';
-
-export function commentOnPR() {
-  const messageTemplate =
-    process.argv.slice(2)?.join(' ') ||
-    process.env.JOB_START_COMMENT_TEMPLATE ||
-    DEFAULT_MESSAGE_TEMPLATE;
-  if (messageTemplate === DEFAULT_MESSAGE_TEMPLATE) {
-    console.log('No message template provided, using default message');
-  } else {
-    console.log(`Using message template: ${messageTemplate}`);
-  }
 
+export function commentOnPR({
+  messageTemplate,
+  context,
+  clearPrevious,
+}: {
+  messageTemplate: string;
+  context?: string;
+  clearPrevious: boolean;
+}) {
   const message = messageTemplate.replace(/\${([^}]+)}/g, (_, envVar) => {
     if (ALLOWED_ENV_VARS.includes(envVar)) {
       return process.env[envVar] || '';
@@ -53,11 +50,39 @@ export function commentOnPR() {
     }
   });
 
-  return addComment(message);
+  if (context) {
+    return upsertComment({ commentBody: message, commentContext: context, clearPrevious });
+  } else {
+    return addComment(message);
+  }
 }
 
 if (require.main === module) {
-  commentOnPR().catch((error) => {
+  const args = parseArgs<{
+    context?: string;
+    message: string;
+    'clear-previous'?: boolean | string;
+  }>(process.argv.slice(2), {
+    string: ['message', 'context'],
+    boolean: ['clear-previous'],
+  });
+
+  if (!args.message) {
+    throw new Error(
+      `No message template provided for ${process.argv[1]}, use --message to provide one.`
+    );
+  } else {
+    console.log(`Using message template: ${args.message}`);
+  }
+
+  commentOnPR({
+    messageTemplate: args.message,
+    context: args.context,
+    clearPrevious:
+      typeof args['clear-previous'] === 'string'
+        ? !!args['clear-previous'].match(/(1|true)/i)
+        : !!args['clear-previous'],
+  }).catch((error) => {
     console.error(error);
     process.exit(1);
   });