fix: disambiguate project name in comment title (#225)

* fix: disambiguate project name in comment title

* fix

* lint

---------

Co-authored-by: meorphis <eric@stainless.com>

Author: meorphis

dist/build.js

@@ -1,7 +1,7 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
 exports[`printComment > should print comment 1`] = `
-"<h3>✱ Stainless preview builds</h3>
+"<h3>✱ Stainless preview builds for test-project</h3>
 
 This PR will update the <code>test-project</code> SDKs with the following commit message.
 

dist/merge.js

@@ -17,8 +17,9 @@ describe("printComment", () => {
   });
 
   it("should print no changes comment", () => {
-    expect(printComment({ noChanges: true })).toMatchInlineSnapshot(`
-      "<h3>✱ Stainless preview builds</h3>
+    expect(printComment({ noChanges: true, projectName: "fake project" }))
+      .toMatchInlineSnapshot(`
+      "<h3>✱ Stainless preview builds for fake project</h3>
 
       No changes were made to the SDKs.
 

dist/preview.js

@@ -11,9 +11,10 @@ import {
   sortDiagnostics,
 } from "./outcomes";
 
-const COMMENT_TITLE = MD.Heading(
-  `${MD.Symbol.HeavyAsterisk} Stainless preview builds`,
-);
+const COMMENT_TITLE = (projectName: string | null) =>
+  MD.Heading(
+    `${MD.Symbol.HeavyAsterisk} Stainless preview builds${projectName ? ` for ${projectName}` : ""}`,
+  );
 
 const COMMENT_FOOTER_DIVIDER = MD.Comment("stainless-preview-footer");
 
@@ -41,8 +42,11 @@ export function printComment({
   outcomes,
 }:
   | ({ noChanges?: never } & Omit<PrintCommentOptions, "noChanges">)
-  | ({ noChanges: true } & {
-      [K in keyof Omit<PrintCommentOptions, "noChanges">]?: never;
+  | ({ noChanges: true; projectName: string } & {
+      [K in keyof Omit<
+        Omit<PrintCommentOptions, "noChanges">,
+        "projectName"
+      >]?: never;
     })) {
   const Blocks = (() => {
     if (noChanges) {
@@ -84,7 +88,7 @@ export function printComment({
     .replace(/\.\d+Z$/, " UTC");
 
   const fullComment = MD.Dedent`
-    ${COMMENT_TITLE}
+    ${COMMENT_TITLE(projectName)}
 
     ${Blocks}
 
@@ -564,11 +568,16 @@ export function parseCommitMessages(body?: string | null): {
     : {};
 }
 
-export async function retrieveComment(prNumber: number) {
+export async function retrieveComment(prNumber: number, projectName: string) {
   const comments = await api().listComments(prNumber);
 
-  const existingComment = comments.find((comment) =>
-    comment.body?.includes(COMMENT_TITLE),
+  const existingComment = comments.find(
+    (comment) =>
+      comment.body?.includes(COMMENT_TITLE(projectName)) ||
+      // backwards compatibility for comments that don't include the project name
+      // TODO: remove this fallback eventually
+      (!comment.body?.includes(COMMENT_TITLE(null) + " for") &&
+        comment.body?.includes(COMMENT_TITLE(null))),
   );
 
   if (!existingComment) {

src/__snapshots__/comment.test.ts.snap

@@ -117,7 +117,9 @@ export async function runMerge(
   }
 
   const comment =
-    makeComment && prNumber ? await retrieveComment(prNumber) : null;
+    makeComment && prNumber
+      ? await retrieveComment(prNumber, projectName)
+      : null;
   const commitMessage =
     comment?.commitMessage ??
     makeCommitMessageConventional(defaultCommitMessage);

src/comment.test.ts

@@ -139,7 +139,7 @@ export async function runPreview(
     if (makeComment) {
       logger.group("Updating comment");
 
-      const commentBody = printComment({ noChanges: true });
+      const commentBody = printComment({ noChanges: true, projectName });
 
       await upsertComment(prNumber, {
         body: commentBody,
@@ -163,7 +163,9 @@ export async function runPreview(
 
   logger.groupEnd();
 
-  const initialComment = makeComment ? await retrieveComment(prNumber) : null;
+  const initialComment = makeComment
+    ? await retrieveComment(prNumber, projectName)
+    : null;
   let commitMessage =
     initialComment?.commitMessage ??
     makeCommitMessageConventional(defaultCommitMessage);
@@ -215,7 +217,7 @@ export async function runPreview(
       const { outcomes, baseOutcomes } = latestRun;
 
       // In case the comment was updated between polls:
-      const comment = await retrieveComment(prNumber);
+      const comment = await retrieveComment(prNumber, projectName);
       commitMessage = comment?.commitMessage ?? commitMessage;
       targetCommitMessages =
         comment?.targetCommitMessages ?? targetCommitMessages;