@colrealpro/react-luau-doctor 0.18.0 → 0.18.1

package/dist/cli.js

@@ -11,7 +11,7 @@ var package_default = {
   publishConfig: {
     access: "public"
   },
-  version: "0.18.0",
+  version: "0.18.1",
   description: "Static analysis for React-Luau hooks, effects, rendering, and performance.",
   license: "MIT",
   type: "module",
@@ -9904,7 +9904,6 @@ var GITLAB_WORKFLOW = ".gitlab-ci.yml";
 var SUMMARY_MARKER = "<!-- react-luau-doctor:summary -->";
 var REVIEW_MARKER = "<!-- react-luau-doctor:review -->";
 var MAX_REVIEW_COMMENTS = 20;
-var MAX_RESOLVE_THREADS_PER_REQUEST = 100;
 var MAX_GITHUB_RETRIES = 2;
 var MAX_RATE_LIMIT_WAIT_MS = 60000;
 var PACKAGE_SPEC = `${package_default.name}@${package_default.version}`;
@@ -9920,10 +9919,8 @@ on:
     branches: [main]
 
 permissions:
-  # GitHub currently requires Contents: write for the resolveReviewThread GraphQL mutation.
-  contents: ${settings.reviewComments ? "write" : "read"}
+  contents: read
   pull-requests: write
-  issues: write
   statuses: write
 
 concurrency:
@@ -10332,23 +10329,6 @@ async function githubApi(repo, endpoint, options = {}) {
   const apiBase = (process.env.GITHUB_API_URL ?? "https://api.github.com").replace(/\/$/, "");
   return githubRequest(`${apiBase}/repos/${repo}${endpoint}`, options);
 }
-function githubGraphQLUrl() {
-  if (process.env.GITHUB_GRAPHQL_URL)
-    return process.env.GITHUB_GRAPHQL_URL;
-  const apiBase = (process.env.GITHUB_API_URL ?? "https://api.github.com").replace(/\/$/, "");
-  return apiBase.endsWith("/api/v3") ? `${apiBase.slice(0, -"/v3".length)}/graphql` : `${apiBase}/graphql`;
-}
-async function githubGraphQL(query, variables) {
-  const response = await githubRequest(githubGraphQLUrl(), {
-    method: "POST",
-    body: { query, variables }
-  });
-  if (response.errors?.length)
-    throw new Error(`GitHub GraphQL: ${response.errors.map((error) => error.message ?? "unknown error").join("; ")}`);
-  if (!response.data)
-    throw new Error("GitHub GraphQL returned no data");
-  return response.data;
-}
 function repoRelativeDiagnosticPath(directory, diagnosticFile) {
   const absoluteDirectory = path11.resolve(directory);
   const repoRoot = findGitRoot(absoluteDirectory);
@@ -10458,54 +10438,32 @@ ${diagnostic.message}${diagnostic.help ? `
 
 ${diagnostic.help}` : ""}`;
 }
-async function listReviewThreads(repo, pullNumber) {
-  const separator = repo.indexOf("/");
-  if (separator < 1 || separator === repo.length - 1)
-    throw new Error(`Invalid GitHub repository name: ${repo}`);
-  const owner = repo.slice(0, separator);
-  const name = repo.slice(separator + 1);
-  const threads = [];
-  let cursor = null;
-  for (;; ) {
-    const data = await githubGraphQL(`
-      query DoctorReviewThreads($owner: String!, $name: String!, $pull: Int!, $cursor: String) {
-        repository(owner: $owner, name: $name) {
-          pullRequest(number: $pull) {
-            reviewThreads(first: 100, after: $cursor) {
-              nodes {
-                id
-                isResolved
-                isOutdated
-                path
-                comments(first: 1) {
-                  nodes {
-                    body
-                    author { __typename }
-                  }
-                }
-              }
-              pageInfo { hasNextPage endCursor }
-            }
-          }
-        }
-      }
-    `, { owner, name, pull: pullNumber, cursor });
-    const connection = data.repository?.pullRequest?.reviewThreads;
-    if (!connection)
-      throw new Error(`Could not load review threads for pull request ${pullNumber}`);
-    threads.push(...connection.nodes);
-    if (!connection.pageInfo.hasNextPage)
-      return threads;
-    cursor = connection.pageInfo.endCursor;
-    if (!cursor)
-      throw new Error("GitHub review thread pagination returned no cursor");
-  }
-}
-function doctorThreadFingerprint(thread) {
-  const comment = thread.comments.nodes[0];
-  if (comment?.author?.__typename !== "Bot" || !comment.body.startsWith(REVIEW_MARKER))
+var ARCHIVED_REVIEW_BODY = "\u2705 React-Luau Doctor: findings from this review are no longer current. Active findings, if any, are shown in newer reviews.";
+async function listReviewComments(repo, pullNumber) {
+  const comments = [];
+  for (let page = 1;; page += 1) {
+    const batch = await githubApi(repo, `/pulls/${pullNumber}/comments?per_page=100&page=${page}`);
+    comments.push(...batch);
+    if (batch.length < 100)
+      return comments;
+  }
+}
+async function listReviews(repo, pullNumber) {
+  const reviews = [];
+  for (let page = 1;; page += 1) {
+    const batch = await githubApi(repo, `/pulls/${pullNumber}/reviews?per_page=100&page=${page}`);
+    reviews.push(...batch);
+    if (batch.length < 100)
+      return reviews;
+  }
+}
+function isDoctorReview(review) {
+  return review.user?.type === "Bot" && (review.body?.includes("React-Luau Doctor") ?? false);
+}
+function doctorReviewCommentFingerprint(comment) {
+  if (comment.user?.type !== "Bot" || !comment.body.startsWith(REVIEW_MARKER))
     return null;
-  return fingerprintFromReviewBody(comment.body, thread.path);
+  return fingerprintFromReviewBody(comment.body, comment.path);
 }
 function takeCount(counts, key) {
   const count = counts.get(key) ?? 0;
@@ -10514,58 +10472,64 @@ function takeCount(counts, key) {
   counts.set(key, count - 1);
   return true;
 }
-async function resolveReviewThreads(threadIds) {
-  for (let offset = 0;offset < threadIds.length; offset += MAX_RESOLVE_THREADS_PER_REQUEST) {
-    const batch = threadIds.slice(offset, offset + MAX_RESOLVE_THREADS_PER_REQUEST);
-    const declarations = batch.map((_, index) => `$thread${index}: ID!`).join(", ");
-    const mutations = batch.map((_, index) => `thread${index}: resolveReviewThread(input: { threadId: $thread${index} }) { thread { id isResolved } }`).join(`
-`);
-    const variables = Object.fromEntries(batch.map((id, index) => [`thread${index}`, id]));
-    await githubGraphQL(`mutation ResolveDoctorThreads(${declarations}) { ${mutations} }`, variables);
-    if (offset + batch.length < threadIds.length)
-      await wait(1000);
-  }
+function incrementCount(counts, key) {
+  counts.set(key, (counts.get(key) ?? 0) + 1);
 }
-async function manageReviewComments(repo, pullNumber, currentReport, newDiagnostics, directory, newBase) {
-  const threads = await listReviewThreads(repo, pullNumber);
+async function manageReviewComments(repo, pullNumber, currentReport, newDiagnostics, directory, newBase, pullBase) {
+  const [allReviewComments, reviews] = await Promise.all([
+    listReviewComments(repo, pullNumber),
+    listReviews(repo, pullNumber)
+  ]);
+  const reviewComments = allReviewComments.map((comment) => ({ comment, fingerprint: doctorReviewCommentFingerprint(comment) })).filter((entry) => entry.fingerprint !== null);
   const activeCounts = new Map;
-  for (const diagnostic of currentReport.diagnostics) {
-    const fingerprint = diagnosticReviewFingerprint(directory, diagnostic);
-    activeCounts.set(fingerprint, (activeCounts.get(fingerprint) ?? 0) + 1);
-  }
+  for (const diagnostic of currentReport.diagnostics)
+    incrementCount(activeCounts, diagnosticReviewFingerprint(directory, diagnostic));
   const newCounts = new Map;
-  for (const diagnostic of newDiagnostics) {
-    const fingerprint = diagnosticReviewFingerprint(directory, diagnostic);
-    newCounts.set(fingerprint, (newCounts.get(fingerprint) ?? 0) + 1);
-  }
-  const resolvedThreadIds = [];
-  for (const thread of threads) {
-    if (thread.isResolved)
-      continue;
-    const fingerprint = doctorThreadFingerprint(thread);
-    if (!fingerprint)
-      continue;
-    if (thread.isOutdated && (newCounts.get(fingerprint) ?? 0) > 0) {
-      resolvedThreadIds.push(thread.id);
+  for (const diagnostic of newDiagnostics)
+    incrementCount(newCounts, diagnosticReviewFingerprint(directory, diagnostic));
+  const replacementCounts = new Map;
+  const staleComments = [];
+  const orderedComments = reviewComments.slice().sort((left, right) => Number(left.comment.position === null) - Number(right.comment.position === null));
+  for (const { comment, fingerprint } of orderedComments) {
+    if (comment.position !== null && takeCount(activeCounts, fingerprint)) {
+      takeCount(newCounts, fingerprint);
       continue;
     }
-    if (takeCount(activeCounts, fingerprint)) {
+    const needsReplacement = takeCount(activeCounts, fingerprint);
+    if (needsReplacement) {
+      incrementCount(replacementCounts, fingerprint);
       takeCount(newCounts, fingerprint);
-      continue;
     }
-    resolvedThreadIds.push(thread.id);
+    staleComments.push({ comment, fingerprint, needsReplacement });
+  }
+  const newLineMap = changedLineMap(directory, newBase);
+  const pullLineMap = newBase === pullBase ? newLineMap : changedLineMap(directory, pullBase);
+  const candidates = [];
+  for (const diagnostic of newDiagnostics) {
+    if (!touchesChangedLine(diagnostic, newLineMap.get(diagnostic.file) ?? []))
+      continue;
+    const fingerprint = diagnosticReviewFingerprint(directory, diagnostic);
+    if (!takeCount(newCounts, fingerprint))
+      continue;
+    candidates.push({ diagnostic, replacement: false });
   }
-  const lineMap = changedLineMap(directory, newBase);
-  const comments = newDiagnostics.filter((diagnostic) => touchesChangedLine(diagnostic, lineMap.get(diagnostic.file) ?? [])).filter((diagnostic) => {
+  for (const diagnostic of currentReport.diagnostics) {
+    if (!touchesChangedLine(diagnostic, pullLineMap.get(diagnostic.file) ?? []))
+      continue;
     const fingerprint = diagnosticReviewFingerprint(directory, diagnostic);
-    return takeCount(newCounts, fingerprint);
-  }).slice(0, MAX_REVIEW_COMMENTS).map((diagnostic) => ({
+    if (!takeCount(replacementCounts, fingerprint))
+      continue;
+    candidates.push({ diagnostic, replacement: true });
+  }
+  const selected = candidates.slice(0, MAX_REVIEW_COMMENTS);
+  const comments = selected.map(({ diagnostic }) => ({
     path: repoRelativeDiagnosticPath(directory, diagnostic.file),
     line: diagnostic.location.line,
     side: "RIGHT",
     body: reviewCommentBody(directory, diagnostic)
   }));
   const failures = [];
+  let postedNewComments = true;
   if (comments.length > 0) {
     try {
       await githubApi(repo, `/pulls/${pullNumber}/reviews`, {
@@ -10573,14 +10537,45 @@ async function manageReviewComments(repo, pullNumber, currentReport, newDiagnost
         body: { event: "COMMENT", body: "React-Luau Doctor found new issues", comments }
       });
     } catch (error) {
+      postedNewComments = false;
       failures.push(`could not create new review comments: ${errorMessage(error)}`);
     }
   }
-  if (resolvedThreadIds.length > 0) {
-    try {
-      await resolveReviewThreads(resolvedThreadIds);
-    } catch (error) {
-      failures.push(`could not resolve fixed review threads: ${errorMessage(error)}`);
+  if (postedNewComments) {
+    const postedReplacementCounts = new Map;
+    for (const candidate of selected) {
+      if (candidate.replacement)
+        incrementCount(postedReplacementCounts, diagnosticReviewFingerprint(directory, candidate.diagnostic));
+    }
+    const remainingByReview = new Map;
+    for (const { comment } of reviewComments) {
+      remainingByReview.set(comment.pull_request_review_id, (remainingByReview.get(comment.pull_request_review_id) ?? 0) + 1);
+    }
+    for (const stale of staleComments) {
+      if (stale.needsReplacement && !takeCount(postedReplacementCounts, stale.fingerprint))
+        continue;
+      try {
+        await githubApi(repo, `/pulls/comments/${stale.comment.id}`, { method: "DELETE" });
+        const reviewId = stale.comment.pull_request_review_id;
+        const remaining = Math.max(0, (remainingByReview.get(reviewId) ?? 1) - 1);
+        remainingByReview.set(reviewId, remaining);
+      } catch (error) {
+        failures.push(`could not delete stale review comment ${stale.comment.id}: ${errorMessage(error)}`);
+      }
+    }
+    for (const review of reviews) {
+      if (!isDoctorReview(review) || review.body === ARCHIVED_REVIEW_BODY)
+        continue;
+      if ((remainingByReview.get(review.id) ?? 0) > 0)
+        continue;
+      try {
+        await githubApi(repo, `/pulls/${pullNumber}/reviews/${review.id}`, {
+          method: "PUT",
+          body: { body: ARCHIVED_REVIEW_BODY }
+        });
+      } catch (error) {
+        failures.push(`could not archive empty review ${review.id}: ${errorMessage(error)}`);
+      }
     }
   }
   if (failures.length > 0)
@@ -10672,7 +10667,7 @@ async function runCiJob(argv) {
     }
     if (settings.reviewComments && base) {
       try {
-        await manageReviewComments(repo, pullNumber, report, reviewChanges.diagnostics, path11.resolve(settings.directory), reviewChanges.base ?? base);
+        await manageReviewComments(repo, pullNumber, report, reviewChanges.diagnostics, path11.resolve(settings.directory), reviewChanges.base ?? base, base);
       } catch (error) {
         process.stderr.write(`react-luau-doctor: could not update inline review comments: ${errorMessage(error)}
 `);
@@ -12479,5 +12474,5 @@ ${os2.release()}
 }
 main();
 
-//# debugId=77F2455CC417160A64756E2164756E21
+//# debugId=93BE5E0B263571E264756E2164756E21
 //# sourceMappingURL=cli.js.map