Update postGithubComments for new bot flow (#132)

Author: jakebailey

azure-pipelines-userTests.yml

@@ -23,6 +23,9 @@ parameters:
     displayName: Old head reference
     type: string
     default: main
+  - name: DISTINCT_ID
+    displayName: Distinct ID
+    type: string
   - name: REQUESTING_USER
     displayName: User to tag when the results are ready
     type: string
@@ -119,7 +122,7 @@ jobs:
   - script: |
       npm ci
       npm run build
-      node dist/postGithubComments ${{ parameters.REQUESTING_USER }} ${{ parameters.SOURCE_ISSUE }} ${{ parameters.STATUS_COMMENT }} ${{ parameters.TOP_REPOS }} '$(Pipeline.Workspace)' '$(System.TeamFoundationCollectionUri)$(System.TeamProject)/_build/results?buildId=$(Build.BuildId)&view=artifacts&type=publishedArtifacts' ${{ parameters.POST_RESULT }}
+      node dist/postGithubComments ${{ parameters.REQUESTING_USER }} ${{ parameters.SOURCE_ISSUE }} ${{ parameters.STATUS_COMMENT }} ${{ parameters.DISTINCT_ID }} ${{ parameters.TOP_REPOS }} '$(Pipeline.Workspace)' '$(System.TeamFoundationCollectionUri)$(System.TeamProject)/_build/results?buildId=$(Build.BuildId)&view=artifacts&type=publishedArtifacts' ${{ parameters.POST_RESULT }}
     displayName: 'Update PR comment with new errors'
     env:
       GITHUB_PAT: $(GITHUB_PAT)

src/postGithubComments.ts

@@ -7,11 +7,11 @@ import pu = require("./utils/packageUtils");
 const { argv } = process;
 
 if (argv.length !== 9) {
-    console.error(`Usage: ${path.basename(argv[0])} ${path.basename(argv[1])} <user_to_tag> <pr_number> <comment_number> <is_top_repos_run> <result_dir_path> <artifacts_uri> <post_result>`);
+    console.error(`Usage: ${path.basename(argv[0])} ${path.basename(argv[1])} <user_to_tag> <pr_number> <comment_number> <distinct_id> <is_top_repos_run> <result_dir_path> <artifacts_uri> <post_result>`);
     process.exit(-1);
 }
 
-const [, , userToTag, prNumber, commentNumber, isTop, resultDirPath, artifactsUri, post] = argv;
+const [, , userToTag, prNumber, commentNumber, distinctId, isTop, resultDirPath, artifactsUri, post] = argv;
 const isTopReposRun = isTop.toLowerCase() === "true";
 const postResult = post.toLowerCase() === "true";
 
@@ -78,7 +78,7 @@ let header = `@${userToTag} Here are the results of running the ${suiteDescripti
 ${summary.join("\n")}`;
 
 if (!outputs.length) {
-    git.createComment(+prNumber, +commentNumber, postResult, [header]);
+    git.createComment(+prNumber, +commentNumber, distinctId, postResult, [header], true);
 }
 else {
     const oldErrorHeader = `<h2>:warning: Old server errors :warning:</h2>`;
@@ -117,5 +117,5 @@ else {
         console.log(`Chunk of size ${chunk.length}`);
     }
 
-    git.createComment(+prNumber, +commentNumber, postResult, bodyChunks);
+    git.createComment(+prNumber, +commentNumber, distinctId, postResult, bodyChunks, somethingChanged);
 }

src/utils/gitUtils.ts

@@ -149,7 +149,7 @@ export async function createIssue(postResult: boolean, title: string, bodyChunks
     }
 }
 
-export async function createComment(prNumber: number, statusComment: number, postResult: boolean, bodyChunks: readonly string[]): Promise<void> {
+export async function createComment(prNumber: number, statusComment: number, distinctId: string, postResult: boolean, bodyChunks: readonly string[], somethingChanged: boolean): Promise<void> {
     const newComments = bodyChunks.map(body => ({
         ...repoProperties,
         issue_number: prNumber,
@@ -181,26 +181,41 @@ export async function createComment(prNumber: number, statusComment: number, pos
         newCommentUrls.push(newCommentUrl);
     }
 
-    // Update typescript-bot comment
-    const comment = await kit.issues.getComment({
-        ...repoProperties,
-        comment_id: statusComment
-    });
 
-    let newBody = `${comment.data.body}\n\n`;
-    if (newCommentUrls.length === 1) {
-        newBody += `Update: [The results are in!](${newCommentUrls[0]})`;
-    }
-    else {
-        newBody += `Update: The results are in! `;
-        newBody += newCommentUrls.map((url, i) => `[Part ${i + 1}](${url})`).join(", ");
-    }
+    const emoji = !somethingChanged ? "✅" : "👀";
 
-    await kit.issues.updateComment({
-        ...repoProperties,
-        comment_id: statusComment,
-        body: newBody
-    });
+    const toReplace = `<!--result-${distinctId}-->`;
+    let posted = false;
+    for (let i = 0; i < 5; i++) {
+        // Get status comment contents
+        const statusCommentResp = await kit.issues.getComment({
+            comment_id: statusComment,
+            owner: "Microsoft",
+            repo: "TypeScript",
+        });
+
+        const oldComment = statusCommentResp.data.body;
+        if (!oldComment?.includes(toReplace)) {
+            posted = true;
+            break;
+        }
+
+        const newComment = oldComment.replace(
+            toReplace,
+            `[${emoji} Results](${newCommentUrls[0]})`,
+        );
+
+        // Update status comment
+        await kit.issues.updateComment({
+            comment_id: statusComment,
+            owner: "Microsoft",
+            repo: "TypeScript",
+            body: newComment,
+        });
+
+        // Repeat; someone may have edited the comment at the same time.
+        await new Promise(resolve => setTimeout(resolve, 1000));
+    }
 }
 
 export async function checkout(cwd: string, branch: string) {