[BE] Make DrCI report workflows pending approvals (#7722)

Lots of 1st time contributors are confused by `✅ No Failures` status
when no CI has been run on CI yet
This would replace it with `⚠️  2 Awaiting Approval`

Author: malfet

torchci/pages/api/drci/drci.ts

@@ -212,6 +212,7 @@ export async function updateDrciComments(
         flakyJobs,
         brokenTrunkJobs,
         unstableJobs,
+        awaitingApprovalJobs,
         relatedJobs,
         relatedIssues,
         relatedInfo,
@@ -230,6 +231,7 @@ export async function updateDrciComments(
         FLAKY: flakyJobs,
         BROKEN_TRUNK: brokenTrunkJobs,
         UNSTABLE: unstableJobs,
+        AWAITING_APPROVAL: awaitingApprovalJobs,
       };
 
       const failureInfo = constructResultsComment(
@@ -238,6 +240,7 @@ export async function updateDrciComments(
         flakyJobs,
         brokenTrunkJobs,
         unstableJobs,
+        awaitingApprovalJobs,
         relatedJobs,
         relatedIssues,
         relatedInfo,
@@ -638,6 +641,7 @@ export function constructResultsComment(
   flakyJobs: RecentWorkflowsData[],
   brokenTrunkJobs: RecentWorkflowsData[],
   unstableJobs: RecentWorkflowsData[],
+  awaitingApprovalJobs: RecentWorkflowsData[],
   relatedJobs: Map<number, RecentWorkflowsData>,
   relatedIssues: Map<number, IssueData[]>,
   relatedInfo: Map<number, string>,
@@ -671,6 +675,7 @@ export function constructResultsComment(
   const pendingIcon = `:hourglass_flowing_sand:`;
   const successIcon = `:white_check_mark:`;
   const failuresIcon = `:x:`;
+  const warningIcon = `:warning:`;
   const noneFailing = `No Failures`;
   const significantFailures = `${newFailedJobs.length} New ${pluralize(
     "Failure",
@@ -685,30 +690,37 @@ export function constructResultsComment(
     unrelatedFailureCount
   )}`;
   const pendingJobs = `${pending} Pending`;
+  const awaitingApprovalMsg = `${awaitingApprovalJobs.length} Awaiting Approval`;
 
   const hasAnyFailing = failing > 0;
   const hasSignificantFailures = newFailedJobs.length > 0;
   const hasCancelledFailures = cancelledJobs.length > 0;
   const hasPending = pending > 0;
   const hasUnrelatedFailures = unrelatedFailureCount > 0;
+  const hasAwaitingApproval = awaitingApprovalJobs.length > 0;
 
   let icon = "";
   if (hasSignificantFailures || hasCancelledFailures) {
     icon = failuresIcon;
+  } else if (hasAwaitingApproval) {
+    icon = warningIcon;
   } else if (hasPending) {
     icon = pendingIcon;
   } else {
     icon = successIcon;
   }
 
   let title_messages = [];
+  if (hasAwaitingApproval) {
+    title_messages.push(awaitingApprovalMsg);
+  }
   if (hasSignificantFailures) {
     title_messages.push(significantFailures);
   }
   if (hasCancelledFailures) {
     title_messages.push(cancelledFailures);
   }
-  if (!hasAnyFailing) {
+  if (!hasAnyFailing && !hasAwaitingApproval) {
     title_messages.push(noneFailing);
   }
   if (hasPending) {
@@ -735,10 +747,29 @@ export function constructResultsComment(
   }
   output += ":";
 
-  if (!hasAnyFailing) {
+  if (!hasAnyFailing && !hasAwaitingApproval) {
     output += `\n:green_heart: Looks good so far! There are no failures yet. :green_heart:`;
   }
 
+  if (awaitingApprovalJobs.length) {
+    output += constructResultsJobsSections(
+      hudBaseUrl,
+      owner,
+      repo,
+      prNumber,
+      `AWAITING APPROVAL`,
+      `The following ${
+        awaitingApprovalJobs.length > 1 ? "workflows need" : "workflow needs"
+      } approval before CI can run`,
+      awaitingApprovalJobs,
+      "",
+      false,
+      relatedJobs,
+      relatedIssues,
+      relatedInfo
+    );
+  }
+
   if (newFailedJobs.length) {
     output += constructResultsJobsSections(
       hudBaseUrl,
@@ -897,6 +928,7 @@ export async function getWorkflowJobsStatuses(
   flakyJobs: RecentWorkflowsData[];
   brokenTrunkJobs: RecentWorkflowsData[];
   unstableJobs: RecentWorkflowsData[];
+  awaitingApprovalJobs: RecentWorkflowsData[];
   relatedJobs: Map<number, RecentWorkflowsData>;
   relatedIssues: Map<number, IssueData[]>;
   relatedInfo: Map<number, string>;
@@ -907,6 +939,7 @@ export async function getWorkflowJobsStatuses(
   const brokenTrunkJobs: RecentWorkflowsData[] = [];
   const unstableJobs: RecentWorkflowsData[] = [];
   const failedJobs: RecentWorkflowsData[] = [];
+  const awaitingApprovalJobs: RecentWorkflowsData[] = [];
 
   // This map holds the list of the base failures for broken trunk jobs or the similar
   // failures for flaky jobs
@@ -917,6 +950,15 @@ export async function getWorkflowJobsStatuses(
   const relatedInfo: Map<number, string> = new Map();
 
   for (const job of prInfo.jobs) {
+    // Check for workflows awaiting approval (first-time contributors need maintainer approval)
+    if (
+      job.conclusion === "action_required" ||
+      job.conclusion === "startup_failure"
+    ) {
+      awaitingApprovalJobs.push(job);
+      continue;
+    }
+
     if (isPending(job)) {
       pending++;
       if (isUnstableJob(job as any, unstableIssues)) {
@@ -1114,6 +1156,7 @@ export async function getWorkflowJobsStatuses(
     flakyJobs,
     brokenTrunkJobs,
     unstableJobs,
+    awaitingApprovalJobs,
     relatedJobs,
     relatedIssues,
     relatedInfo,

torchci/test/drci.test.ts

@@ -226,6 +226,20 @@ const unstableB = getDummyJob({
   runnerName: "dummy",
 });
 
+// Workflow awaiting approval from maintainer
+const awaitingApprovalA = getDummyJob({
+  name: "pull / linux-build",
+  conclusion: "action_required",
+  completed_at: "2022-07-13 19:34:03",
+  html_url: "a",
+  head_sha: "abcdefg",
+  id: 1,
+  pr_number: 1001,
+  failure_lines: [],
+  failure_captures: [],
+  runnerName: "",
+});
+
 const sev = genIssueData({
   number: 1,
   state: "open",
@@ -251,6 +265,7 @@ function constructResultsCommentHelper({
   flakyJobs = [],
   brokenTrunkJobs = [],
   unstableJobs = [],
+  awaitingApprovalJobs = [],
   sha = "random sha",
   merge_base = "random_merge_base_sha",
   merge_base_date = "2023-08-08 06:03:21",
@@ -264,6 +279,7 @@ function constructResultsCommentHelper({
   flakyJobs?: RecentWorkflowsData[];
   brokenTrunkJobs?: RecentWorkflowsData[];
   unstableJobs?: RecentWorkflowsData[];
+  awaitingApprovalJobs?: RecentWorkflowsData[];
   sha?: string;
   merge_base?: string;
   merge_base_date?: string;
@@ -278,6 +294,7 @@ function constructResultsCommentHelper({
     flakyJobs,
     brokenTrunkJobs,
     unstableJobs,
+    awaitingApprovalJobs,
     new Map(),
     new Map(),
     new Map(),
@@ -692,6 +709,50 @@ describe("Update Dr. CI Bot Unit Tests", () => {
     ).toBeTruthy();
   });
 
+  test("test awaiting approval workflows show in comment", async () => {
+    const failureInfoComment = constructResultsCommentHelper({
+      pending: 0,
+      awaitingApprovalJobs: [awaitingApprovalA],
+    });
+
+    const expectToContain = [
+      ":warning:",
+      "1 Awaiting Approval",
+      "AWAITING APPROVAL",
+      "workflow needs approval before CI can run",
+      awaitingApprovalA.name,
+    ];
+    const expectNotToContain = ["No Failures", ":green_heart:"];
+
+    expect(
+      expectToContain.every((s) => failureInfoComment.includes(s!))
+    ).toBeTruthy();
+    expect(
+      expectNotToContain.every((s) => !failureInfoComment.includes(s!))
+    ).toBeTruthy();
+  });
+
+  test("test awaiting approval with failures shows both", async () => {
+    const failureInfoComment = constructResultsCommentHelper({
+      pending: 1,
+      failedJobs: [failedA],
+      awaitingApprovalJobs: [awaitingApprovalA],
+    });
+
+    const expectToContain = [
+      "1 Awaiting Approval",
+      "1 New Failure",
+      "1 Pending",
+      "AWAITING APPROVAL",
+      awaitingApprovalA.name,
+      failedA.name,
+    ];
+
+    expect(
+      expectToContain.every((s) => failureInfoComment.includes(s!))
+    ).toBeTruthy();
+  });
+
   test("test merge base time shows up in results comment", async () => {
     const failureInfoComment = constructResultsCommentHelper({
       sha: "sha",