fix(get-latest-workflow-artifact): suggested fixes (#1026)

... from #1022

Author: zerok

actions/get-latest-workflow-artifact/bun.lock

@@ -9,6 +9,7 @@
         "@actions/github": "^6.0.1",
       },
       "devDependencies": {
+        "@octokit/openapi-types": "^25.1.0",
         "@types/bun": "latest",
         "@types/node": "^22.15.18",
       },
@@ -63,7 +64,7 @@
 
     "@octokit/graphql": ["@octokit/[email protected]", "", { "dependencies": { "@octokit/request": "^5.6.0", "@octokit/types": "^6.0.3", "universal-user-agent": "^6.0.0" } }, "sha512-0gv+qLSBLKF0z8TKaSKTsS39scVKF9dbMxJpj3U0vC7wjNWFuIpL/z76Qe2fiuCbDRcJSavkXsVtMS6/dtQQsg=="],
 
-    "@octokit/openapi-types": ["@octokit/openapi-types@12.11.0", "", {}, "sha512-VsXyi8peyRq9PqIz/tpqiL2w3w80OgVMwBHltTml3LmVvXiphgeqmY9mvBw9Wu7e0QWk/fqD37ux8yP5uVekyQ=="],
+    "@octokit/openapi-types": ["@octokit/openapi-types@25.1.0", "", {}, "sha512-idsIggNXUKkk0+BExUn1dQ92sfysJrje03Q0bv0e+KPLrvyqZF8MnBpFz8UNfYDwB3Ie7Z0TByjWfzxt7vseaA=="],
 
     "@octokit/plugin-paginate-rest": ["@octokit/[email protected]", "", { "dependencies": { "@octokit/types": "^12.6.0" }, "peerDependencies": { "@octokit/core": "5" } }, "sha512-u3KYkGF7GcZnSD/3UP0S7K5XUFT2FkOQdcfXZGZQPGv3lm4F2Xbf71lvjldr8c1H3nNbF+33cLEkWYbokGWqiQ=="],
 
@@ -315,6 +316,8 @@
 
     "@octokit/request-error/@octokit/types": ["@octokit/[email protected]", "", { "dependencies": { "@octokit/openapi-types": "^24.2.0" } }, "sha512-ifLaO34EbbPj0Xgro4G5lP5asESjwHracYJvVaPIyXMuiuXLlhic3S47cBdTb+jfODkTE5YtGCLt3Ay3+J97sA=="],
 
+    "@octokit/types/@octokit/openapi-types": ["@octokit/[email protected]", "", {}, "sha512-VsXyi8peyRq9PqIz/tpqiL2w3w80OgVMwBHltTml3LmVvXiphgeqmY9mvBw9Wu7e0QWk/fqD37ux8yP5uVekyQ=="],
+
     "glob/minimatch": ["[email protected]", "", { "dependencies": { "brace-expansion": "^2.0.1" } }, "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow=="],
 
     "lazystream/readable-stream": ["[email protected]", "", { "dependencies": { "core-util-is": "~1.0.0", "inherits": "~2.0.3", "isarray": "~1.0.0", "process-nextick-args": "~2.0.0", "safe-buffer": "~5.1.1", "string_decoder": "~1.1.1", "util-deprecate": "~1.0.1" } }, "sha512-8p0AUk4XODgIewSi0l8Epjs+EVnWiK7NoDIEGU0HhE7+ZyY8D1IMY7odu5lRrFXGg71L15KG8QrPmum45RTtdA=="],

actions/get-latest-workflow-artifact/package.json

@@ -13,6 +13,7 @@
     "@actions/github": "^6.0.1"
   },
   "devDependencies": {
+    "@octokit/openapi-types": "^25.1.0",
     "@types/bun": "latest",
     "@types/node": "^22.15.18"
   },

actions/get-latest-workflow-artifact/src/main.ts

@@ -1,8 +1,19 @@
 import * as core from "@actions/core";
-import * as github from "@actions/github";
+import { getOctokit } from "@actions/github";
 import { DefaultArtifactClient } from "@actions/artifact";
 import * as filepath from "node:path";
 
+import { components } from "@octokit/openapi-types";
+
+type WorkflowRunStatus = "in_progress" | "completed";
+type Artifact = components["schemas"]["artifact"];
+type GitHubClient = ReturnType<typeof getOctokit>;
+type WorkflowRun = components["schemas"]["workflow-run"];
+type GetLatestArtifactResponse = {
+  artifact: Artifact;
+  run: WorkflowRun;
+} | null;
+
 async function main() {
   const ghToken = core.getInput("github-token", { required: true });
   const workflowId = core.getInput("workflow-id", { required: true });
@@ -24,7 +35,7 @@ async function main() {
 
   path = filepath.join(path, artifactName);
 
-  const client = github.getOctokit(ghToken);
+  const client = getOctokit(ghToken);
 
   const { data } = await client.rest.pulls.get({
     owner: repoOwner,
@@ -36,7 +47,7 @@ async function main() {
 
   // Now let's get all workflows associated with this sha:
   // We start with in-progress ones if those are to be considered.
-  let found = null;
+  let found: GetLatestArtifactResponse = null;
 
   if (considerInProgress) {
     found = await getLatestArtifact(
@@ -84,45 +95,51 @@ async function main() {
 }
 
 async function getLatestArtifact(
-  client,
-  repoOwner,
-  repoName,
-  workflowId,
+  client: GitHubClient,
+  repoOwner: string,
+  repoName: string,
+  workflowId: string,
   headSha: string,
-  status: string,
+  status: WorkflowRunStatus,
   artifactName: string,
-): Promise<{ artifact: any; run: any } | null> {
-  const { data } = await client.rest.actions.listWorkflowRuns({
-    repo: repoName,
-    owner: repoOwner,
-    head_sha: headSha,
-    workflow_id: workflowId,
-    status: status,
-  });
-  if (data.workflow_runs.length === 0) {
+): Promise<GetLatestArtifactResponse> {
+  const {
+    data: { workflow_runs: workflowRuns },
+  }: { data: { workflow_runs: WorkflowRun[] } } =
+    await client.rest.actions.listWorkflowRuns({
+      repo: repoName,
+      owner: repoOwner,
+      head_sha: headSha,
+      workflow_id: workflowId,
+      status: status,
+    });
+  if (workflowRuns.length === 0) {
     console.log(`No ${status} runs found`);
     return null;
   }
-  const run = data.workflow_runs[0];
-  // Since these are pending workflows, the artifact might not be there yet. For this scenario, let's try this a couple of times:
-  for (let attempt = 0; attempt < 5; attempt++) {
-    const { data: artifacts } =
+  const run = workflowRuns[0];
+  // For in-progress workflows the artifact might not be available yet. For this scenario we do a bit of retrying:
+  const maxAttempts = status === "in_progress" ? 5 : 1;
+  for (let attempt = 1; attempt <= maxAttempts; attempt++) {
+    const {
+      data: { artifacts },
+    }: { data: { artifacts: Artifact[] } } =
       await client.rest.actions.listWorkflowRunArtifacts({
         owner: repoOwner,
         repo: repoName,
         run_id: run.id,
       });
-    const artifact = artifacts.artifacts.find(
-      (art) => art.name == artifactName,
-    );
+    const artifact = artifacts.find((art) => art.name == artifactName);
     if (artifact) {
       console.log(`Found ${status} artifact`);
       return { artifact, run };
     }
-    console.log("No artifact found, retrying in 10s");
-    await new Promise((resolve) => {
-      setTimeout(() => resolve(), 10000);
-    });
+    if (attempt < maxAttempts) {
+      console.log("No artifact found, retrying in 10s");
+      await new Promise((resolve) => setTimeout(resolve, 10_000));
+    }
   }
+  console.log("No artifact found");
+  return null;
 }
 main();