Merge pull request #19 from getappmap/feat/create-pr-summary-comment

Create PR summary comment

package.json

@@ -19,11 +19,13 @@
     "@types/glob": "^8.1.0",
     "@types/jest": "^29.5.0",
     "@types/node": "^18.15.11",
+    "@types/sinon": "^10.0.15",
     "@vercel/ncc": "^0.36.1",
     "glob": "^9.3.4",
     "jest": "^29.5.0",
     "openapi-diff": "^0.23.6",
     "prettier": "^2.8.7",
+    "sinon": "^15.2.0",
     "ts-jest": "^29.0.5",
     "ts-node": "^10.9.1",
     "typescript": "^5.0.2"

src/Commenter.ts

@@ -0,0 +1,62 @@
+import * as github from '@actions/github';
+import { GetResponseDataTypeFromEndpointMethod } from '@octokit/types';
+
+import assert from 'assert';
+import fs from 'fs';
+
+export default class Commenter {
+  // TODO: don't use "any" type
+  private readonly octokit: any;
+  public static readonly COMMENT_TAG_PATTERN = '<!-- "appmap" -->';
+
+  constructor(private readonly filePath: string, private readonly githubToken: string) {
+    this.octokit = github.getOctokit(this.githubToken);
+  }
+
+  public async comment() {
+    const { context } = github;
+    const { octokit } = this;
+
+    const issue_number = context.payload.pull_request?.number || context.payload.issue?.number;
+    assert(issue_number);
+
+    const content = fs.readFileSync(this.filePath, 'utf8');
+    const body = `${content}\n${Commenter.COMMENT_TAG_PATTERN}`;
+    const comment = await this.getAppMapComment(issue_number);
+
+    if (comment) {
+      await octokit.rest.issues.updateComment({
+        ...context.repo,
+        comment_id: comment.id,
+        body,
+      });
+    } else {
+      await octokit.rest.issues.createComment({
+        ...context.repo,
+        issue_number,
+        body,
+      });
+    }
+  }
+
+  public async getAppMapComment(issue_number: number): Promise<any> {
+    const { context } = github;
+    const { octokit } = this;
+
+    type ListCommentsResponseDataType = GetResponseDataTypeFromEndpointMethod<
+      typeof octokit.rest.issues.listComments
+    >;
+
+    let comment: ListCommentsResponseDataType[0] | undefined;
+    for await (const { data: comments } of octokit.paginate.iterator(octokit.rest.issues.listComments, {
+      ...context.repo,
+      issue_number,
+    })) {
+      // TODO: don't use "any" type
+      comment = comments.find((comment: any) => comment?.body?.includes(Commenter.COMMENT_TAG_PATTERN));
+      if (comment) break;
+    }
+
+    return comment;
+  }
+}

src/preflight.ts

@@ -11,6 +11,7 @@ import {cp} from 'fs/promises';
 import {inspect} from 'util';
 import ReportOptions from './ReportOptions';
 import CompareOptions from './CompareOptions';
+import Commenter from './Commenter';
 
 async function runInGitHub(): Promise<void> {
   verbose(core.getBooleanInput('verbose'));
@@ -75,6 +76,9 @@ async function runInGitHub(): Promise<void> {
   const compareResult = await compare(new GitHubArtifactStore(), compareOptions);
   const reportResult = await summarizeChanges(compareResult.reportDir, reportOptions);
 
+  const commenter = new Commenter(reportResult.reportFile, githubToken);
+  await commenter.comment();
+
   core.setOutput('report-dir', compareResult.reportDir);
   if (process.env.GITHUB_STEP_SUMMARY) {
     await cp(reportResult.reportFile, process.env.GITHUB_STEP_SUMMARY);