feat: New input parameter job fetch retries with a linear backoff strategy (#267)

* feat: make WORKFLOW_JOB_STEPS_RETRY_MS as an action input parameter and linear backoff strategy for retries

---------

Co-authored-by: Alex Miller <codex.nz@gmail.com>

Author: Yermanaco

.github/workflows/action.yml

@@ -26,6 +26,7 @@ jobs:
           workflow: dispatch.yml
           workflow_inputs: '{"cake":"delicious"}'
           workflow_timeout_seconds: 30
+          workflow_job_steps_retry_seconds: 10
       - name: Evaluate that the Run ID output has been set
         run: |
           if [ "${{ steps.return_dispatch.outputs.run_id }}" == "" ]; then

README.md

@@ -25,6 +25,10 @@ steps:
       workflow: automation-test.yml
       workflow_inputs: '{ "some_input": "value" }' # Optional
       workflow_timeout_seconds: 120 # Default: 300
+      workflow_job_steps_retry_seconds:
+        # Lineal backoff retry attempts are made where the attempt count is
+        # the magnitude and the scaling value is `workflow_job_steps_retry_seconds`
+        10 # Default: 5
       distinct_id: someDistinctId # Optional
 
   - name: Use the output run ID and URL

action.yml

@@ -30,6 +30,11 @@ inputs:
   workflow_timeout_seconds:
     description: Time until giving up waiting for the start of the workflow run.
     default: 300
+  workflow_job_steps_retry_seconds:
+    description: |
+      The interval (in seconds) to wait between retries. A linear backoff strategy is used, where the wait time
+      increases by this value with each attempt (e.g., 1st retry = this value, 2nd retry = 2x this value, etc.).
+    default: 5
   distinct_id:
     description: Specify a static string to use instead of a random distinct ID.
 

src/__snapshots__/return-dispatch.spec.ts.snap

@@ -6,22 +6,30 @@ exports[`return-dispatch > getRunIdAndUrl > should call retryOrTimeout with the
 
 exports[`return-dispatch > getRunIdAndUrl > should retry until an ID is found 1`] = `"No Run IDs found for workflow, attempt 1..."`;
 
-exports[`return-dispatch > getRunIdAndUrl > should retry until an ID is found 2`] = `"No Run IDs found for workflow, attempt 2..."`;
+exports[`return-dispatch > getRunIdAndUrl > should retry until an ID is found 2`] = `"Waiting for 5000ms before the next attempt..."`;
 
-exports[`return-dispatch > getRunIdAndUrl > should retry until an ID is found 3`] = `"Attempting to get step names for Run IDs: [0]"`;
+exports[`return-dispatch > getRunIdAndUrl > should retry until an ID is found 3`] = `"No Run IDs found for workflow, attempt 2..."`;
+
+exports[`return-dispatch > getRunIdAndUrl > should retry until an ID is found 4`] = `"Waiting for 10000ms before the next attempt..."`;
+
+exports[`return-dispatch > getRunIdAndUrl > should retry until an ID is found 5`] = `"Attempting to get step names for Run IDs: [0]"`;
 
 exports[`return-dispatch > getRunIdAndUrl > should return the ID when found 1`] = `"Attempting to get step names for Run IDs: [0]"`;
 
 exports[`return-dispatch > getRunIdAndUrl > should return the ID when found 2`] = `undefined`;
 
 exports[`return-dispatch > getRunIdAndUrl > should timeout when unable to find over time 1`] = `"Exhausted searching IDs in known runs, attempt 1..."`;
 
-exports[`return-dispatch > getRunIdAndUrl > should timeout when unable to find over time 2`] = `"Attempting to get step names for Run IDs: [0]"`;
+exports[`return-dispatch > getRunIdAndUrl > should timeout when unable to find over time 2`] = `"Waiting for 3000ms before the next attempt..."`;
 
-exports[`return-dispatch > getRunIdAndUrl > should timeout when unable to find over time 3`] = `"Exhausted searching IDs in known runs, attempt 2..."`;
+exports[`return-dispatch > getRunIdAndUrl > should timeout when unable to find over time 3`] = `"Attempting to get step names for Run IDs: [0]"`;
 
-exports[`return-dispatch > getRunIdAndUrl > should timeout when unable to find over time 4`] = `"Attempting to get step names for Run IDs: [0]"`;
+exports[`return-dispatch > getRunIdAndUrl > should timeout when unable to find over time 4`] = `"Exhausted searching IDs in known runs, attempt 2..."`;
 
-exports[`return-dispatch > getRunIdAndUrl > should timeout when unable to find over time 5`] = `"Exhausted searching IDs in known runs, attempt 3..."`;
+exports[`return-dispatch > getRunIdAndUrl > should timeout when unable to find over time 5`] = `"Waiting for 6000ms before the next attempt..."`;
 
 exports[`return-dispatch > getRunIdAndUrl > should timeout when unable to find over time 6`] = `"Attempting to get step names for Run IDs: [0]"`;
+
+exports[`return-dispatch > getRunIdAndUrl > should timeout when unable to find over time 7`] = `"Exhausted searching IDs in known runs, attempt 3..."`;
+
+exports[`return-dispatch > getRunIdAndUrl > should timeout when unable to find over time 8`] = `"Attempting to get step names for Run IDs: [0]"`;

src/action.spec.ts

@@ -28,6 +28,7 @@ describe("Action", () => {
         workflow: "workflow_name",
         workflow_inputs: JSON.stringify(workflowInputs),
         workflow_timeout_seconds: "60",
+        workflow_job_steps_retry_seconds: "3",
         distinct_id: "distinct_id",
       };
 
@@ -48,6 +49,8 @@ describe("Action", () => {
             return mockEnvConfig.workflow_inputs;
           case "workflow_timeout_seconds":
             return mockEnvConfig.workflow_timeout_seconds;
+          case "workflow_job_steps_retry_seconds":
+            return mockEnvConfig.workflow_job_steps_retry_seconds;
           case "distinct_id":
             return mockEnvConfig.distinct_id;
           default:
@@ -72,6 +75,7 @@ describe("Action", () => {
       expect(config.workflow).toStrictEqual("workflow_name");
       expect(config.workflowInputs).toStrictEqual(workflowInputs);
       expect(config.workflowTimeoutSeconds).toStrictEqual(60);
+      expect(config.workflowJobStepsRetrySeconds).toStrictEqual(3);
       expect(config.distinctId).toStrictEqual("distinct_id");
     });
 
@@ -89,6 +93,13 @@ describe("Action", () => {
       expect(config.workflowTimeoutSeconds).toStrictEqual(300);
     });
 
+    it("should provide a default workflow job step retry if none is supplied", () => {
+      mockEnvConfig.workflow_job_steps_retry_seconds = "";
+      const config: ActionConfig = getConfig();
+
+      expect(config.workflowJobStepsRetrySeconds).toStrictEqual(5);
+    });
+
     it("should handle no inputs being provided", () => {
       mockEnvConfig.workflow_inputs = "";
       const config: ActionConfig = getConfig();

src/action.ts

@@ -3,6 +3,7 @@ import { randomUUID } from "node:crypto";
 import * as core from "@actions/core";
 
 const WORKFLOW_TIMEOUT_SECONDS = 5 * 60;
+const WORKFLOW_JOB_STEPS_RETRY_SECONDS = 5;
 
 /**
  * action.yaml definition.
@@ -43,6 +44,11 @@ export interface ActionConfig {
    */
   workflowTimeoutSeconds: number;
 
+  /**
+   * Time in retries for identifying the Run ID.
+   */
+  workflowJobStepsRetrySeconds: number;
+
   /**
    * Specify a static ID to use instead of a distinct ID.
    */
@@ -69,6 +75,9 @@ export function getConfig(): ActionConfig {
     workflowTimeoutSeconds:
       getNumberFromValue(core.getInput("workflow_timeout_seconds")) ??
       WORKFLOW_TIMEOUT_SECONDS,
+    workflowJobStepsRetrySeconds:
+      getNumberFromValue(core.getInput("workflow_job_steps_retry_seconds")) ??
+      WORKFLOW_JOB_STEPS_RETRY_SECONDS,
     distinctId:
       getOptionalWorkflowValue(core.getInput("distinct_id")) ?? randomUUID(),
   };

src/api.spec.ts

@@ -95,6 +95,8 @@ describe("API", () => {
           return JSON.stringify({ testInput: "test" });
         case "workflow_timeout_seconds":
           return "30";
+        case "workflow_job_steps_retry_seconds":
+          return "5";
         default:
           return "";
       }
@@ -332,6 +334,7 @@ describe("API", () => {
       workflow: "workflow_name",
       workflowInputs: { testInput: "test" },
       workflowTimeoutSeconds: 60,
+      workflowJobStepsRetrySeconds: 3,
       distinctId: "test-uuid",
     };
 

src/constants.ts

@@ -1,6 +1,5 @@
 /* eslint-disable @typescript-eslint/no-inferrable-types */
 
 export const WORKFLOW_FETCH_TIMEOUT_MS: number = 60 * 1000;
-export const WORKFLOW_JOB_STEPS_RETRY_MS: number = 5000;
 export const WORKFLOW_JOB_STEPS_SERVER_ERROR_RETRY_MAX: number = 3;
 export const WORKFLOW_JOB_STEPS_SERVER_ERROR_RETRY_MS: number = 500;

src/main.spec.ts

@@ -35,6 +35,7 @@ describe("main", () => {
     ref: "test-ref",
     workflow: "test-workflow",
     workflowTimeoutSeconds: 0,
+    workflowJobStepsRetrySeconds: 0,
   } satisfies Partial<action.ActionConfig> as action.ActionConfig;
   const testBranch: utils.BranchNameResult = {
     branchName: "test-branch",
@@ -173,6 +174,7 @@ describe("main", () => {
       distinctIdRegex: distinctIdRegex,
       workflowId: 0,
       workflowTimeoutMs: testCfg.workflowTimeoutSeconds * 1000,
+      workflowJobStepsRetryMs: testCfg.workflowJobStepsRetrySeconds * 1000,
     });
 
     // Result

src/main.ts

@@ -44,6 +44,7 @@ export async function main(): Promise<void> {
       distinctIdRegex,
       workflowId,
       workflowTimeoutMs: config.workflowTimeoutSeconds * 1000,
+      workflowJobStepsRetryMs: config.workflowJobStepsRetrySeconds * 1000,
     });
     if (result.success) {
       handleActionSuccess(result.value.id, result.value.url);