Update to state of PR

Author: danieljurek

.github/workflows/_reusable-verify-run-status.yaml

@@ -19,7 +19,10 @@ permissions:
 
 jobs:
   check-run-status:
-    if: ${{ (github.event_name == 'workflow_run') || (github.event_name == 'check_suite' && github.event.check_suite.app.name == 'openapi-pipeline-app') || (github.event_name == 'check_run' && github.event.check_run.name == inputs.check_run_name) }}
+    if: |
+      (github.event_name == 'workflow_run') || 
+      (github.event_name == 'check_suite' && github.event.check_suite.app.name == 'openapi-pipeline-app') || 
+      (github.event_name == 'check_run' && github.event.check_run.name == inputs.check_run_name)
     runs-on: ubuntu-24.04
 
     steps:

.github/workflows/src/verify-run-status.js

@@ -1,12 +1,15 @@
 import { extractInputs } from "./context.js";
 import { PER_PAGE_MAX } from "./github.js";
 
+const SUPPORTED_EVENTS = ["workflow_run", "check_run", "check_suite"];
+
 /**
  * @typedef {import('@octokit/plugin-rest-endpoint-methods').RestEndpointMethodTypes} RestEndpointMethodTypes
- * @typedef {RestEndpointMethodTypes["checks"]["listForRef"]["response"]["data"]["check_runs"][number]} CheckRun
- * @typedef {RestEndpointMethodTypes["actions"]["listWorkflowRunsForRepo"]["response"]["data"]["workflow_runs"][number]} WorkflowRun
+ * @typedef {RestEndpointMethodTypes["checks"]["listForRef"]["response"]["data"]["check_runs"]} CheckRuns
+ * @typedef {RestEndpointMethodTypes["actions"]["listWorkflowRunsForRepo"]["response"]["data"]["workflow_runs"]} WorkflowRuns
  */
 
+/* v8 ignore start */
 /**
  * Given the name of a completed check run name and a completed workflow, verify 
  * that both have the same conclusion. If conclusions are different, fail the 
@@ -24,41 +27,77 @@ export async function verifyRunStatus({ github, context, core }) {
     throw new Error("WORKFLOW_NAME is not set");
   }
 
-  // Exit early when context is a check_run event and the check run does not
-  // match the checkRunName.
+  if (!SUPPORTED_EVENTS.some((e) => e === context.eventName)) {
+    throw new Error(
+      `Unsupported event: ${context.eventName}. Supported events: ${SUPPORTED_EVENTS.join(", ")}`,
+    );
+  }
+
+  if (context.eventName === "check_suite" && context.payload.check_suite.status !== "completed") { 
+    core.setFailed(`Check suite ${context.payload.check_suite.app.name} is not completed. Cannot evaluate incomplete check suite.`);
+    return;
+  }
+
+  return await verifyRunStatusImpl({ github, context, core , checkRunName, workflowName});
+}
+/* v8 ignore stop */
+
+/**
+ * @param {Object} params
+ * @param {import('github-script').AsyncFunctionArguments["github"]} params.github
+ * @param {import('github-script').AsyncFunctionArguments["context"]} params.context
+ * @param {import('github-script').AsyncFunctionArguments["core"]} params.core
+ * @param {string} params.checkRunName
+ * @param {string} params.workflowName
+ */
+export async function verifyRunStatusImpl({github, context, core, checkRunName, workflowName}) {
   if (context.eventName == "check_run") {
     const contextRunName = context.payload.check_run.name;
     if (contextRunName !== checkRunName) {
-      core.notice(`Check run name (${contextRunName}) does not match input: ${checkRunName}`);
+      core.setFailed(`Check run name (${contextRunName}) does not match input: ${checkRunName}. Ensure job is filtering by github.event.check_run.name.`);
       return;
     }
   }
 
   const { head_sha } = await extractInputs(github, context, core);
 
-  const checkRun =
-    context.eventName == "check_run"
-      ? context.payload.check_run
-      : await getCheckRun(github, context, core, checkRunName, head_sha);
+  let checkRun;
+  if (context.eventName == "check_run") {
+    checkRun = context.payload.check_run;
+  } else {
+    const checkRuns = await getCheckRuns(github, context, checkRunName, head_sha);
+    if (checkRuns.length === 0) {
+      if (context.eventName === "check_suite") { 
+        const message = `Could not locate check run ${checkRunName} in check suite ${context.payload.check_suite.app.name}. Ensure job is filtering by github.event.check_suite.app.name.`;
+        core.setFailed(message);
+        return;
+      }
+
+      core.notice(`No completed check run with name: ${checkRunName}. Not enough information to judge success or failure. Ending with success status.`);
+      return;
+    }
 
-  if (!checkRun) {
-    core.notice(`No completed check run with name: ${checkRunName}`);
-    return;
+    // Use the most recent check run
+    checkRun = checkRuns[0];
   }
 
   core.info(
     `Check run name: ${checkRun.name}, conclusion: ${checkRun.conclusion}, URL: ${checkRun.html_url}`,
   );
   core.debug(`Check run: ${JSON.stringify(checkRun)}`);
 
-  const workflowRun =
-    context.eventName == "workflow_run"
-      ? context.payload.workflow_run
-      : await getWorkflowRun(github, context, core, workflowName, head_sha);
+  let workflowRun;
+  if (context.eventName == "workflow_run") { 
+    workflowRun = context.payload.workflow_run;
+  } else {
+    const workflowRuns = await getWorkflowRuns(github, context, workflowName, head_sha);
+    if (workflowRuns.length === 0) {
+      core.notice(`No completed workflow run with name: ${workflowName}. Not enough information to judge success or failure. Ending with success status.`);
+      return;
+    }
 
-  if (!workflowRun) {
-    core.notice(`No completed workflow run with name: ${workflowName}`);
-    return;
+    // Use the most recent workflow run
+    workflowRun = workflowRuns[0];
   }
 
   core.info(
@@ -80,61 +119,44 @@ export async function verifyRunStatus({ github, context, core }) {
  * Returns the check with the given checkRunName for the given ref.
  * @param {import('github-script').AsyncFunctionArguments['github']} github
  * @param {import('github-script').AsyncFunctionArguments['context']} context
- * @param {import('github-script').AsyncFunctionArguments['core']} core
  * @param {string} checkRunName
  * @param {string} ref
- * @returns {Promise<CheckRun | null>}
+ * @returns {Promise<CheckRuns>}
  */
-export async function getCheckRun(
+export async function getCheckRuns(
   github,
   context,
-  core,
   checkRunName,
   ref,
 ) {
-  const checkRuns = await github.paginate(github.rest.checks.listForRef, {
+  const result = await github.paginate(github.rest.checks.listForRef, {
     ...context.repo,
     ref: ref,
     check_name: checkRunName,
     status: "completed",
     per_page: PER_PAGE_MAX,
   });
 
-  if (checkRuns.length === 0) {
-    return null;
-  }
-
-  if (checkRuns.length > 1) {
-    core.info(`Multiple check runs:`);
-    checkRuns.forEach((cr) => {
-      core.info(`- ${cr.name}: ${cr.conclusion}`);
-    });
-
-    const message = `Multiple completed check runs with name: ${checkRunName}`;
-    core.setFailed(message);
-    throw new Error(message);
-  }
-
-  return checkRuns[0];
+  // a and b will never be null because status is "completed"
+  /* v8 ignore next */
+  return result.sort((a, b) => compareDatesDescending(a.completed_at || '', b.completed_at || ''));
 }
 
 /**
  * Returns the workflow run with the given workflowName for the given ref.
  * @param {import('github-script').AsyncFunctionArguments['github']} github
  * @param {import('github-script').AsyncFunctionArguments['context']} context
- * @param {import('github-script').AsyncFunctionArguments['core']} core
  * @param {string} workflowName
  * @param {string} ref
- * @returns {Promise<WorkflowRun | null>}
+ * @returns {Promise<WorkflowRuns>}
  */
-export async function getWorkflowRun(
+export async function getWorkflowRuns(
   github,
   context,
-  core,
   workflowName,
   ref,
 ) {
-  const workflowRuns = await github.paginate(
+  const result = await github.paginate(
     github.rest.actions.listWorkflowRunsForRepo,
     {
       ...context.repo,
@@ -144,31 +166,15 @@ export async function getWorkflowRun(
     },
   );
 
-  if (workflowRuns.length === 0) {
-    core.info(`No completed workflow runs`);
-    return null;
-  }
-
-  const matches = workflowRuns.filter((run) => run.name === workflowName);
-
-  if (matches.length === 0) {
-    return null;
-  }
-
-  if (matches.length > 1) {
-    core.warning(
-      `Multiple matching workflow runs, selecting the most recent run`,
-    );
-    matches.forEach((wf) =>
-      core.info(`- ${wf.name}: ${wf.conclusion} ${wf.html_url}`),
-    );
-
-    // Sort by "updated_at" descending, so most recent run is at index 0
-    matches.sort(
-      (a, b) =>
-        new Date(b.updated_at).getTime() - new Date(a.updated_at).getTime(),
-    );
-  }
-
-  return matches[0];
+  return result.filter((run) => run.name === workflowName).sort((a, b) => compareDatesDescending(a.updated_at, b.updated_at));
 }
+
+/**
+ * Compares two date strings in descending order.
+ * @param {string} a date string of the form "YYYY-MM-DDTHH:mm:ssZ"
+ * @param {string} b date string of the form "YYYY-MM-DDTHH:mm:ssZ"
+ * @returns 
+ */
+export function compareDatesDescending(a, b) {
+  return new Date(b).getTime() - new Date(a).getTime();
+}