feat(get-latest-workflow-artifact): consider in-progress runs (#1022)

In some situations a workflow might get triggered that depends on an
artifact while the producing workflow is still in-progress.

There might even be the case that the artifact hasn't been uploaded yet
and so this scenario also allows for 5 retries taking place.

The action now also returns the status of the used workflow as output.

Author: zerok

actions/get-latest-workflow-artifact/README.md

@@ -8,17 +8,19 @@ Required permissions:
 - `pull-requests: read`
 - `actions: read`
 
-| Input           | Description                        | Required | Default                                   |
-| --------------- | ---------------------------------- | -------- | ----------------------------------------- |
-| `workflow-id`   | ID or filename of the workflow     | yes      |                                           |
-| `artifact-name` | Name of the artifact to download   | yes      |                                           |
-| `repository`    | Owner/Name                         | no       | `${{ github.repository }}`                |
-| `pr-number`     | Number of the PR to consider       | no       | `${{ github.event.pull_request.number }}` |
-| `path`          | Directory to store the artifact in | no       | `${{ github.workspace }}`                 |
-| `github-token`  | GitHub token                       | no       | `${{ github.token }}`                     |
+| Input                 | Description                                                    | Required | Default                                   |
+| --------------------- | -------------------------------------------------------------- | -------- | ----------------------------------------- |
+| `workflow-id`         | ID or filename of the workflow                                 | yes      |                                           |
+| `artifact-name`       | Name of the artifact to download                               | yes      |                                           |
+| `repository`          | Owner/Name                                                     | no       | `${{ github.repository }}`                |
+| `pr-number`           | Number of the PR to consider                                   | no       | `${{ github.event.pull_request.number }}` |
+| `path`                | Directory to store the artifact in                             | no       | `${{ github.workspace }}`                 |
+| `github-token`        | GitHub token                                                   | no       | `${{ github.token }}`                     |
+| `consider-inprogress` | Not only consider completed but also in-progress workflow runs | no       | `false`                                   |
 
-| Output                   | Description                            |
-| ------------------------ | -------------------------------------- |
-| `artifact-download-path` | Path where the artifact was downloaded |
-| `artifact-id`            | ID of the artifact that was downloaded |
-| `workflow-run-id`        | ID of the Workflow Run                 |
+| Output                   | Description                                            |
+| ------------------------ | ------------------------------------------------------ |
+| `artifact-download-path` | Path where the artifact was downloaded                 |
+| `artifact-id`            | ID of the artifact that was downloaded                 |
+| `workflow-run-id`        | ID of the Workflow Run                                 |
+| `workflow-run-status`    | Status of the found run (`in_progress` or `completed`) |

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

@@ -11,6 +11,7 @@ async function main() {
     .split("/");
   const prNumber = parseInt(core.getInput("pr-number", { required: true }), 10);
   const artifactName = core.getInput("artifact-name", { required: true });
+  const considerInProgress = core.getInput("consider-inprogress") === "true";
   let path = core.getInput("path", { required: false });
 
   if (!path) {
@@ -32,50 +33,96 @@ async function main() {
   });
 
   const headSha = data.head.sha;
-  // Now let's get all workflows associated with this sha.
-  const { data: runs } = await client.rest.actions.listWorkflowRuns({
-    repo: repoName,
-    owner: repoOwner,
-    head_sha: headSha,
-    workflow_id: workflowId,
-    status: "completed",
-  });
 
-  if (runs.workflow_runs.length <= 0) {
-    throw new Error(`No workflow runs found for sha ${headSha}`);
-  }
+  // 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;
 
-  const latestRun = runs.workflow_runs[0];
-  core.info(`Latest run: ${latestRun.id} <${latestRun.html_url}>`);
+  if (considerInProgress) {
+    found = await getLatestArtifact(
+      client,
+      repoOwner,
+      repoName,
+      workflowId,
+      headSha,
+      "in_progress",
+      artifactName,
+    );
+    core.setOutput("workflow-run-status", "in_progress");
+  }
 
-  // Now that we have the run we can get a list of all artifacts there:
-  const { data: artifacts } =
-    await client.rest.actions.listWorkflowRunArtifacts({
-      owner: repoOwner,
-      repo: repoName,
-      run_id: latestRun.id,
-    });
+  if (!found) {
+    found = await getLatestArtifact(
+      client,
+      repoOwner,
+      repoName,
+      workflowId,
+      headSha,
+      "completed",
+      artifactName,
+    );
+    core.setOutput("workflow-run-status", "completed");
+  }
 
-  const artifact = new DefaultArtifactClient();
-  const candidates = artifacts.artifacts.filter(
-    (artifact) => artifact.name == artifactName,
-  );
-  if (candidates.length <= 0) {
+  if (!found) {
     throw new Error(`No artifacts found with name ${artifactName}`);
   }
-
-  const response = await artifact.downloadArtifact(candidates[0].id, {
+  const { artifact: foundArtifact, run } = found;
+  const artifact = new DefaultArtifactClient();
+  const response = await artifact.downloadArtifact(foundArtifact.id, {
     path: path,
     findBy: {
       repositoryName: repoName,
       repositoryOwner: repoOwner,
-      workflowRunId: latestRun.id,
+      workflowRunId: run.id,
       token: ghToken,
     },
   });
   core.setOutput("artifact-download-path", response.downloadPath);
-  core.setOutput("artifact-id", candidates[0].id);
-  core.setOutput("workflow-run-id", latestRun.id);
+  core.setOutput("artifact-id", foundArtifact.id);
+  core.setOutput("workflow-run-id", run.id);
 }
 
+async function getLatestArtifact(
+  client,
+  repoOwner,
+  repoName,
+  workflowId,
+  headSha: string,
+  status: string,
+  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) {
+    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 } =
+      await client.rest.actions.listWorkflowRunArtifacts({
+        owner: repoOwner,
+        repo: repoName,
+        run_id: run.id,
+      });
+    const artifact = artifacts.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);
+    });
+  }
+}
 main();