Apply suggestions from code review

Author: jablko

src/comments.ts

@@ -112,4 +112,4 @@ I'll bump it to the DT maintainer queue. Thank you for your patience, @${author}
 // Introduction to the review when config files diverge from the
 // required form
 export const Suggestions = (user: string) =>
-    `@${user} I noticed these differences from the required form. If you can revise your changes to avoid them, so much the better! Otherwise please reply with explanations why they're needed (unless it's obvious) and a maintainer will take a look. Thanks!`;
+    `@${user} I noticed these differences from the required form. If you can revise your changes to avoid them, so much the better! Otherwise please reply with explanations why they're needed and a maintainer will take a look. Thanks!`;

src/execute-pr-actions.ts

@@ -111,17 +111,18 @@ function getMutationsForCommentRemovals(actions: Actions, botComments: ParsedCom
 }
 
 function getMutationsForSuggestions(actions: Actions, pr: PR_repository_pullRequest) {
+    // Suggestions will be empty if we already reviewed this head
     if (actions.suggestions.length === 0) return [];
-    if (!pr.author) throw new Error("Internal Error: no author is a bot error");
+    if (!pr.author) throw new Error("Internal Error: expected to be checked");
     return [
-        ...actions.suggestions.map(({ path, startLine, endLine, body }) =>
+        ...actions.suggestions.map(({ path, startLine, endLine, text }) =>
             createMutation(addPullRequestReviewThread, {
                 input: {
                     pullRequestId: pr.id,
                     path,
                     startLine: startLine === endLine ? undefined : startLine,
                     line: endLine,
-                    body: "```suggestion\n" + body,
+                    body: "```suggestion\n" + text + "```",
                 }
             })
         ),
@@ -135,22 +136,19 @@ function getMutationsForSuggestions(actions: Actions, pr: PR_repository_pullRequ
     ];
 }
 
-function getMutationsForChangingPRState(actions: Actions, pr: PR_repository_pullRequest) {
-    return [
-        actions.shouldMerge
-            ? createMutation(mergePr, {
-                input: {
-                    commitHeadline: `🤖 Merge PR #${pr.number} ${pr.title} by @${pr.author?.login ?? "(ghost)"}`,
-                    expectedHeadOid: pr.headRefOid,
-                    mergeMethod: "SQUASH",
-                    pullRequestId: pr.id,
-                },
-            })
-            : null,
-        actions.shouldClose
-            ? createMutation(closePr, { input: { pullRequestId: pr.id } })
-            : null
-    ];
+function* getMutationsForChangingPRState(actions: Actions, pr: PR_repository_pullRequest) {
+    if (actions.shouldMerge) {
+        if (!pr.author) throw new Error("Internal Error: expected to be checked");
+        yield createMutation(mergePr, {
+            input: {
+                commitHeadline: `🤖 Merge PR #${pr.number} ${pr.title} by @${pr.author.login}`,
+                expectedHeadOid: pr.headRefOid,
+                mergeMethod: "SQUASH",
+                pullRequestId: pr.id,
+            },
+        });
+    }
+    if (actions.shouldClose) yield createMutation(closePr, { input: { pullRequestId: pr.id } });
 }
 
 async function getProjectBoardColumnIdByName(name: string): Promise<string> {

src/pr-info.ts

@@ -80,7 +80,7 @@ export type FileInfo = {
 export interface Suggestion {
     readonly startLine: number;
     readonly endLine: number;
-    readonly body: string;
+    readonly text: string;
 }
 
 export type ReviewInfo = {
@@ -235,6 +235,7 @@ export async function deriveStateForPR(
     const refs = {
         head: headCommit.oid,
         master: "master",
+        // Exclude existing suggestions from subsequent reviews
         latestSuggestions: prInfo.reviews?.nodes?.reduce((latest, review) =>
             review && !authorNotBot(review) && (
                 !latest?.submittedAt || review.submittedAt && new Date (review.submittedAt) > new Date(latest.submittedAt))
@@ -448,8 +449,8 @@ function makeJsonCheckerFromCore(requiredForm: any, ignoredKeys: string[]) {
         const vsMaster = await ignoreExistingDiffs("master");
         if (!vsMaster) return undefined;
         if (vsMaster.done) return { suspect: vsMaster.suspect };
-        // whereas getting closer relative to existing suggestions makes
-        // no further suggestions
+        // whereas getting closer relative to existing suggestions means
+        // no new suggestions
         if (!await ignoreExistingDiffs("latestSuggestions")) return { suspect: vsMaster.suspect };
         jsonDiff.applyPatch(suggestion, jsonDiff.compare(newJson, towardsIt));
         return {
@@ -501,7 +502,7 @@ function makeJsonCheckerFromCore(requiredForm: any, ignoredKeys: string[]) {
             return {
                 startLine,
                 endLine,
-                body: suggestionLines.join(""),
+                text: suggestionLines.join(""),
             };
         }
     };