fix(ci): ignore superseded GitHub Actions runs

A commit can have multiple check suites for the same workflow and event
when a branch is force-pushed away from and then back to the same SHA.

Select the suite with the highest workflow run number and request only
the latest check runs to avoid reporting superseded CI failures.

Signed-off-by: Archkon <180910180+Archkon@users.noreply.github.com>

Author: Archkon

lib/pr_checker.js

@@ -29,6 +29,30 @@ const FAST_TRACK_RE = /^Fast-track has been requested by @(.+?)\. Please 👍 to
 const FAST_TRACK_MIN_APPROVALS = 2;
 const GIT_CONFIG_GUIDE_URL = 'https://github.com/nodejs/node/blob/99b1ada/doc/guides/contributing/pull-requests.md#step-1-fork';
 
+function getLatestGitHubActionsCheckSuites(checkSuites) {
+  const latestByWorkflow = new Map();
+
+  for (const suite of checkSuites) {
+    const { app, workflowRun } = suite;
+
+    if (app?.slug !== 'github-actions') {
+      continue;
+    }
+
+    // Runs triggered by different events are independent and must not
+    // supersede one another.
+    const key = `${workflowRun.workflow.id}:${workflowRun.event}`;
+    const current = latestByWorkflow.get(key);
+
+    if (!current ||
+        workflowRun.runNumber > current.workflowRun.runNumber) {
+      latestByWorkflow.set(key, suite);
+    }
+  }
+
+  return [...latestByWorkflow.values()];
+}
+
 export const PR_CHECK_REASON_CODES = Object.freeze({
   CANCELLED_GITHUB_CI: 'cancelled-github-ci',
   CLOSED: 'closed',
@@ -459,14 +483,9 @@ export default class PRChecker {
     const pendingJobs = [];
 
     // GitHub new Check API
-    for (const { status, conclusion, app, checkRuns } of checkSuites.nodes) {
-      if (app.slug !== 'github-actions') {
-        // Ignore all non-github check suites, such as Dependabot and Codecov.
-        // They are expected to show up on PRs whose head branch is not on a
-        // fork and never complete.
-        continue;
-      }
-
+    const latestCheckSuites =
+      getLatestGitHubActionsCheckSuites(checkSuites.nodes);
+    for (const { status, conclusion, app, checkRuns } of latestCheckSuites) {
       if (status !== 'COMPLETED') {
         pendingJobs.push({ app: app.slug, status, conclusion });
         continue;

lib/queries/PR.gql

@@ -36,7 +36,14 @@ query PR($prid: Int!, $owner: String!, $repo: String!) {
                 }
                 conclusion,
                 status,
-                checkRuns(first: 40) {
+                workflowRun {
+                  event
+                  runNumber
+                  workflow {
+                    id
+                  }
+                }
+                checkRuns(first: 40, filterBy: { checkType: LATEST }) {
                   nodes {
                     name
                     status

test/fixtures/github-ci/both-apis-failure.json

@@ -14,6 +14,7 @@
         "nodes": [
           {
             "app": { "slug": "github-actions" },
+            "workflowRun": { "event": "pull_request", "runNumber": 1, "workflow": { "id": "workflow-1" } },
             "status": "COMPLETED",
             "conclusion": "FAILURE"
           }
@@ -22,4 +23,3 @@
     }
   }
 ]
-

test/fixtures/github-ci/both-apis-success.json

@@ -14,6 +14,7 @@
         "nodes": [
           {
             "app": { "slug": "github-actions" },
+            "workflowRun": { "event": "pull_request", "runNumber": 1, "workflow": { "id": "workflow-1" } },
             "status": "COMPLETED",
             "conclusion": "SUCCESS"
           }
@@ -22,4 +23,3 @@
     }
   }
 ]
-

test/fixtures/github-ci/check-suite-cancelled.json

@@ -11,6 +11,7 @@
         "nodes": [
           {
             "app": { "slug": "github-actions" },
+            "workflowRun": { "event": "pull_request", "runNumber": 1, "workflow": { "id": "workflow-1" } },
             "status": "COMPLETED",
             "conclusion": "CANCELLED",
             "checkRuns": {

test/fixtures/github-ci/check-suite-failure.json

@@ -11,6 +11,7 @@
         "nodes": [
           {
             "app": { "slug": "github-actions" },
+            "workflowRun": { "event": "pull_request", "runNumber": 1, "workflow": { "id": "workflow-1" } },
             "status": "COMPLETED",
             "conclusion": "FAILURE",
             "checkRuns": {

test/fixtures/github-ci/check-suite-pending.json

@@ -11,11 +11,11 @@
         "nodes": [
           {
             "app": { "slug": "github-actions" },
+            "workflowRun": { "event": "pull_request", "runNumber": 1, "workflow": { "id": "workflow-1" } },
             "status": "IN_PROGRESS"
           }
         ]
       }
     }
   }
 ]
-

test/fixtures/github-ci/check-suite-skipped.json

@@ -11,6 +11,7 @@
         "nodes": [
           {
             "app": { "slug": "github-actions" },
+            "workflowRun": { "event": "pull_request", "runNumber": 1, "workflow": { "id": "workflow-1" } },
             "status": "COMPLETED",
             "conclusion": "SKIPPED"
           }

test/fixtures/github-ci/check-suite-success.json

@@ -11,6 +11,7 @@
         "nodes": [
           {
             "app": { "slug": "github-actions" },
+            "workflowRun": { "event": "pull_request", "runNumber": 1, "workflow": { "id": "workflow-1" } },
             "status": "COMPLETED",
             "conclusion": "SUCCESS"
           }

test/fixtures/github-ci/status-failure-check-suite-succeed.json

@@ -14,6 +14,7 @@
         "nodes": [
           {
             "app": { "slug": "github-actions" },
+            "workflowRun": { "event": "pull_request", "runNumber": 1, "workflow": { "id": "workflow-1" } },
             "status": "COMPLETED",
             "conclusion": "SUCCESS"
           }
@@ -22,4 +23,3 @@
     }
   }
 ]
-