feat: Comment on PR and auto update comment

.github/workflows/ci-results-repo.yml

@@ -3,9 +3,9 @@ on:
   push:
     branches:
       - master
-  pull_request:
-    branches:
-      - master
+#  pull_request:
+#    branches:
+#      - master
 
 jobs:
   benchmarkdotnet-framework:

.github/workflows/ci.yml

@@ -7,6 +7,9 @@ on:
     branches:
       - master
 
+permissions:
+  pull-requests: write
+
 jobs:
   benchmarkdotnet-framework:
     name: Run Benchmark.Net .Net Benchmark Framework example
@@ -39,6 +42,8 @@ jobs:
           skip-fetch-gh-pages: true
           fail-on-alert: true
           summary-always: true
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          comment-always: true
       - run: node ./dist/scripts/ci_validate_modification.js before_data.js 'Benchmark.Net Benchmark'
 
   benchmarkjs:
@@ -69,6 +74,8 @@ jobs:
           skip-fetch-gh-pages: true
           fail-on-alert: true
           summary-always: true
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          comment-always: true
       - run: node ./dist/scripts/ci_validate_modification.js before_data.js 'Benchmark.js Benchmark'
 
   catch2-framework:
@@ -104,6 +111,8 @@ jobs:
           skip-fetch-gh-pages: true
           fail-on-alert: true
           summary-always: true
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          comment-always: true
       - run: node ./dist/scripts/ci_validate_modification.js before_data.js 'Catch2 Benchmark'
 
   cpp-framework:
@@ -141,6 +150,8 @@ jobs:
           skip-fetch-gh-pages: true
           fail-on-alert: true
           summary-always: true
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          comment-always: true
       - run: node ./dist/scripts/ci_validate_modification.js before_data.js 'C++ Benchmark'
 
   go:
@@ -174,6 +185,8 @@ jobs:
           skip-fetch-gh-pages: true
           fail-on-alert: true
           summary-always: true
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          comment-always: true
       - run: node ./dist/scripts/ci_validate_modification.js before_data.js 'Go Benchmark'
 
   java-jmh:
@@ -211,6 +224,8 @@ jobs:
           skip-fetch-gh-pages: true
           fail-on-alert: true
           summary-always: true
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          comment-always: true
       - run: node ./dist/scripts/ci_validate_modification.js before_data.js 'JMH Benchmark'
 
   julia-benchmark:
@@ -250,6 +265,8 @@ jobs:
           skip-fetch-gh-pages: true
           fail-on-alert: true
           summary-always: true
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          comment-always: true
       - run: node ./dist/scripts/ci_validate_modification.js before_data.js 'Julia benchmark'
 
   pytest-benchmark:
@@ -286,6 +303,8 @@ jobs:
           skip-fetch-gh-pages: true
           fail-on-alert: true
           summary-always: true
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          comment-always: true
       - run: node ./dist/scripts/ci_validate_modification.js before_data.js 'Python Benchmark with pytest-benchmark'
 
   rust:
@@ -316,6 +335,8 @@ jobs:
           output-file-path: examples/rust/output.txt
           fail-on-alert: true
           summary-always: true
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          comment-always: true
       - run: node ./dist/scripts/ci_validate_modification.js before_data.js 'Rust Benchmark'
 
   rust-criterion-rs-framework:
@@ -346,6 +367,8 @@ jobs:
           output-file-path: examples/criterion-rs/output.txt
           fail-on-alert: true
           summary-always: true
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          comment-always: true
       - run: node ./dist/scripts/ci_validate_modification.js before_data.js 'Criterion.rs Benchmark'
 
   only-alert-with-cache:

src/comment/benchmarkCommentTags.ts

@@ -0,0 +1,13 @@
+const BENCHMARK_COMMENT_TAG = 'github-benchmark-action-comment';
+
+export function benchmarkStartTag(commentId: string) {
+    return `<!-- ${BENCHMARK_COMMENT_TAG}(start): ${commentId} -->`;
+}
+
+export function benchmarkEndTag(commentId: string) {
+    return `<!-- ${BENCHMARK_COMMENT_TAG}(end): ${commentId} -->`;
+}
+
+export function wrapBodyWithBenchmarkTags(commentId: string, body: string) {
+    return `${benchmarkStartTag(commentId)}\n${body}\n${benchmarkEndTag(commentId)}`;
+}

src/comment/findExistingPRReviewId.ts

@@ -0,0 +1,28 @@
+import * as github from '@actions/github';
+import { benchmarkStartTag } from './benchmarkCommentTags';
+import * as core from '@actions/core';
+
+export async function findExistingPRReviewId(
+    repoOwner: string,
+    repoName: string,
+    pullRequestNumber: number,
+    benchName: string,
+    token: string,
+) {
+    core.debug('findExistingPRReviewId start');
+    const client = github.getOctokit(token);
+
+    const existingReviewsResponse = await client.rest.pulls.listReviews({
+        owner: repoOwner,
+        repo: repoName,
+        // eslint-disable-next-line @typescript-eslint/naming-convention
+        pull_number: pullRequestNumber,
+    });
+
+    const existingReview = existingReviewsResponse.data.find((review) =>
+        review.body.startsWith(benchmarkStartTag(benchName)),
+    );
+
+    core.debug('findExistingPRReviewId start');
+    return existingReview?.id;
+}

src/comment/leaveCommitComment.ts

@@ -0,0 +1,25 @@
+import * as github from '@actions/github';
+import * as core from '@actions/core';
+import { wrapBodyWithBenchmarkTags } from './benchmarkCommentTags';
+
+export async function leaveCommitComment(
+    repoOwner: string,
+    repoName: string,
+    commitId: string,
+    body: string,
+    commentId: string,
+    token: string,
+) {
+    core.debug('leaveCommitComment start');
+    const client = github.getOctokit(token);
+    const response = await client.rest.repos.createCommitComment({
+        owner: repoOwner,
+        repo: repoName,
+        // eslint-disable-next-line @typescript-eslint/naming-convention
+        commit_sha: commitId,
+        body: wrapBodyWithBenchmarkTags(commentId, body),
+    });
+    console.log(`Comment was sent to ${response.url}. Response:`, response.status, response.data);
+    core.debug('leaveCommitComment end');
+    return response;
+}

src/comment/leavePRComment.ts

@@ -0,0 +1,72 @@
+import * as github from '@actions/github';
+import { wrapBodyWithBenchmarkTags } from './benchmarkCommentTags';
+import { findExistingPRReviewId } from './findExistingPRReviewId';
+import * as core from '@actions/core';
+
+export async function leavePRComment(
+    repoOwner: string,
+    repoName: string,
+    pullRequestNumber: number,
+    body: string,
+    commentId: string,
+    token: string,
+) {
+    try {
+        core.debug('leavePRComment start');
+        const client = github.getOctokit(token);
+
+        const bodyWithTags = wrapBodyWithBenchmarkTags(commentId, body);
+
+        const existingCommentId = await findExistingPRReviewId(
+            repoOwner,
+            repoName,
+            pullRequestNumber,
+            commentId,
+            token,
+        );
+
+        if (!existingCommentId) {
+            core.debug('creating new pr comment');
+            const createReviewResponse = await client.rest.pulls.createReview({
+                owner: repoOwner,
+                repo: repoName,
+                // eslint-disable-next-line @typescript-eslint/naming-convention
+                pull_number: pullRequestNumber,
+                event: 'COMMENT',
+                body: bodyWithTags,
+            });
+
+            console.log(
+                `Comment was created via ${createReviewResponse.url}. Response:`,
+                createReviewResponse.status,
+                createReviewResponse.data,
+            );
+
+            core.debug('leavePRComment end');
+            return createReviewResponse;
+        }
+
+        core.debug('updating existing pr comment');
+        const updateReviewResponse = await client.rest.pulls.updateReview({
+            owner: repoOwner,
+            repo: repoName,
+            // eslint-disable-next-line @typescript-eslint/naming-convention
+            pull_number: pullRequestNumber,
+            // eslint-disable-next-line @typescript-eslint/naming-convention
+            review_id: existingCommentId,
+            body: bodyWithTags,
+        });
+
+        console.log(
+            `Comment was updated via ${updateReviewResponse.url}. Response:`,
+            updateReviewResponse.status,
+            updateReviewResponse.data,
+        );
+        core.debug('leavePRComment end');
+
+        return updateReviewResponse;
+    } catch (err) {
+        console.log('error', err);
+        throw err;
+    }
+}

src/write.ts

@@ -7,6 +7,8 @@
 import { Benchmark, BenchmarkResult } from './extract';
 import { Config, ToolType } from './config';
 import { DEFAULT_INDEX_HTML } from './default_index_html';
+import { leavePRComment } from './comment/leavePRComment';
+import { leaveCommitComment } from './comment/leaveCommitComment';
 
 export type BenchmarkSuites = { [name: string]: Benchmark[] };
 export interface DataJson {
@@ -236,24 +238,15 @@
     return lines.join('\n');
 }
 
-async function leaveComment(commitId: string, body: string, token: string) {
+async function leaveComment(commitId: string, body: string, commentId: string, token: string) {
     core.debug('Sending comment:\n' + body);
 
     const repoMetadata = getCurrentRepoMetadata();
-    const repoUrl = repoMetadata.html_url ?? '';
-    const client = github.getOctokit(token);
-    const res = await client.rest.repos.createCommitComment({
-        owner: repoMetadata.owner.login,
-        repo: repoMetadata.name,
-        // eslint-disable-next-line @typescript-eslint/naming-convention
-        commit_sha: commitId,
-        body,
-    });
-
-    const commitUrl = `${repoUrl}/commit/${commitId}`;
-    console.log(`Comment was sent to ${commitUrl}. Response:`, res.status, res.data);
+    const pr = github.context.payload.pull_request;
 
-    return res;
+    return await (pr?.number
+        ? leavePRComment(repoMetadata.owner.login, repoMetadata.name, pr.number, body, commentId, token)
+        : leaveCommitComment(repoMetadata.owner.login, repoMetadata.name, commitId, body, commentId, token));
 }
 
 async function handleComment(benchName: string, curSuite: Benchmark, prevSuite: Benchmark, config: Config) {
@@ -272,7 +265,7 @@
 
     const body = buildComment(benchName, curSuite, prevSuite);
 
-    await leaveComment(curSuite.commit.id, body, githubToken);
+    await leaveComment(curSuite.commit.id, body, `${benchName} Summary`, githubToken);
 }
 
 async function handleAlert(benchName: string, curSuite: Benchmark, prevSuite: Benchmark, config: Config) {
@@ -298,7 +291,7 @@
         if (!githubToken) {
             throw new Error("'comment-on-alert' input is set but 'github-token' input is not set");
         }
-        const res = await leaveComment(curSuite.commit.id, body, githubToken);
+        const res = await leaveComment(curSuite.commit.id, body, `${benchName} Alert`, githubToken);
         url = res.data.html_url;
         message = body + `\nComment was generated at ${url}`;
     }
@@ -443,7 +436,7 @@
             console.log(
                 `Automatically pushed the generated commit to ${ghPagesBranch} branch since 'auto-push' is set to true`,
             );
         } catch (err: any) {
             if (!isRemoteRejectedError(err)) {
                 throw err;
             }

test/write.spec.ts

@@ -8,6 +8,7 @@ import { Benchmark } from '../src/extract';
 import { DataJson, writeBenchmark } from '../src/write';
 import { expect } from '@jest/globals';
 import { FakedOctokit, fakedRepos } from './fakedOctokit';
+import { wrapBodyWithBenchmarkTags } from '../src/comment/benchmarkCommentTags';
 
 const ok: (x: any, msg?: string) => asserts x = (x, msg) => {
     try {
@@ -771,7 +772,10 @@ describe.each(['https://github.com', 'https://github.enterprise.corp'])('writeBe
                     // Last line is appended only for failure message
                     const messageLines = caughtError.message.split('\n');
                     ok(messageLines.length > 0);
-                    const expectedMessage = messageLines.slice(0, -1).join('\n');
+                    const expectedMessage = wrapBodyWithBenchmarkTags(
+                        'Test benchmark Alert',
+                        messageLines.slice(0, -1).join('\n'),
+                    );
                     ok(
                         fakedRepos.spyOpts.length > 0,
                         `len: ${fakedRepos.spyOpts.length}, caught: ${caughtError.message}`,