solve comments

Author: Yermanaco

README.md

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

action.yml

@@ -31,7 +31,9 @@ inputs:
     description: Time until giving up waiting for the start of the workflow run.
     default: 300
   workflow_job_steps_retry_seconds:
-    description: Duration to wait between retries while monitoring for the workflow run to start.
+    description: |
+      The interval (in seconds) to wait between retries, each retry uses a linear backoff strategy.
+      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/return-dispatch.spec.ts

@@ -837,7 +837,11 @@ describe("return-dispatch", () => {
       expect(coreDebugLogMock.mock.calls[0]?.[0]).toMatchSnapshot();
 
       expect(utilSleepMock).toHaveBeenCalledTimes(3);
-      expect(utilSleepMock.mock.calls[2]?.[0]).toBeLessThanOrEqual(retryMs * 3);
+      const elapsedTime = Date.now() - defaultOpts.startTime; // `waitTime` should be using `workflowTimeoutMs` at this point
+      expect(utilSleepMock.mock.lastCall?.[0]).approximately(
+        timeoutMs - elapsedTime,
+        5,
+      );
 
       resetLogMocks();
       await vi.advanceTimersByTimeAsync(retryMs * 3);

src/return-dispatch.ts

@@ -146,7 +146,6 @@ export async function getRunIdAndUrl({
 
   let attemptNo = 0;
   let elapsedTime = Date.now() - startTime;
-
   while (elapsedTime < workflowTimeoutMs) {
     attemptNo++;