refactor: API get to fetch

Author: Codex-

src/api.spec.ts

@@ -14,8 +14,8 @@ import type { ActionConfig } from "./action.ts";
 import {
   dispatchWorkflow,
   fetchWorkflowId,
-  getWorkflowRunIds,
-  getWorkflowRunJobSteps,
+  fetchWorkflowRunIds,
+  fetchWorkflowRunJobSteps,
   fetchWorkflowRunUrl,
   init,
   retryOrTimeout,
@@ -249,14 +249,14 @@ describe("API", () => {
 
       // Behaviour
       await expect(fetchWorkflowId("implode")).rejects.toThrow(
-        `Failed to get workflows, expected 200 but received ${errorStatus}`,
+        `Failed to fetch workflows, expected 200 but received ${errorStatus}`,
       );
 
       // Logging
       assertOnlyCalled(coreErrorLogMock, coreDebugLogMock);
       expect(coreErrorLogMock).toHaveBeenCalledOnce();
       expect(coreErrorLogMock.mock.calls[0]?.[0]).toMatchInlineSnapshot(
-        `"fetchWorkflowId: An unexpected error has occurred: Failed to get workflows, expected 200 but received 401"`,
+        `"fetchWorkflowId: An unexpected error has occurred: Failed to fetch workflows, expected 200 but received 401"`,
       );
     });
 
@@ -283,7 +283,7 @@ describe("API", () => {
     });
   });
 
-  describe("getWorkflowRunIds", () => {
+  describe("fetchWorkflowRunIds", () => {
     const workflowIdCfg: ActionConfig = {
       token: "secret",
       ref: "/refs/heads/feature_branch",
@@ -315,7 +315,7 @@ describe("API", () => {
       );
 
       // Behaviour
-      await expect(getWorkflowRunIds(0, branch)).resolves.toStrictEqual(
+      await expect(fetchWorkflowRunIds(0, branch)).resolves.toStrictEqual(
         mockData.workflow_runs.map((run) => run.id),
       );
 
@@ -346,15 +346,15 @@ describe("API", () => {
       );
 
       // Behaviour
-      await expect(getWorkflowRunIds(0, branch)).rejects.toThrow(
-        `Failed to get Workflow runs, expected 200 but received ${errorStatus}`,
+      await expect(fetchWorkflowRunIds(0, branch)).rejects.toThrow(
+        `Failed to fetch Workflow runs, expected 200 but received ${errorStatus}`,
       );
 
       // Logging
       assertOnlyCalled(coreErrorLogMock, coreDebugLogMock);
       expect(coreErrorLogMock).toHaveBeenCalled();
       expect(coreErrorLogMock.mock.calls[0]?.[0]).toMatchInlineSnapshot(
-        `"getWorkflowRunIds: An unexpected error has occurred: Failed to get Workflow runs, expected 200 but received 401"`,
+        `"fetchWorkflowRunIds: An unexpected error has occurred: Failed to fetch Workflow runs, expected 200 but received 401"`,
       );
     });
 
@@ -374,7 +374,7 @@ describe("API", () => {
       );
 
       // Behaviour
-      await expect(getWorkflowRunIds(0, branch)).resolves.toStrictEqual([]);
+      await expect(fetchWorkflowRunIds(0, branch)).resolves.toStrictEqual([]);
 
       // Logging
       assertOnlyCalled(coreDebugLogMock);
@@ -410,7 +410,7 @@ describe("API", () => {
       );
 
       // Behaviour
-      await expect(getWorkflowRunIds(0, branch)).resolves.not.toThrow();
+      await expect(fetchWorkflowRunIds(0, branch)).resolves.not.toThrow();
       expect(parsedRef).toStrictEqual("master");
 
       // Logging
@@ -447,7 +447,7 @@ describe("API", () => {
       );
 
       // Behaviour
-      await expect(getWorkflowRunIds(0, branch)).resolves.not.toThrow();
+      await expect(fetchWorkflowRunIds(0, branch)).resolves.not.toThrow();
       expect(parsedRef).toBeUndefined();
 
       // Logging
@@ -484,7 +484,7 @@ describe("API", () => {
       );
 
       // Behaviour
-      await expect(getWorkflowRunIds(0, branch)).resolves.not.toThrow();
+      await expect(fetchWorkflowRunIds(0, branch)).resolves.not.toThrow();
       expect(parsedRef).toBeUndefined();
 
       // Logging
@@ -502,7 +502,7 @@ describe("API", () => {
     });
   });
 
-  describe("getWorkflowRunJobSteps", () => {
+  describe("fetchWorkflowRunJobSteps", () => {
     it("should get the step names for a given Workflow Run ID", async () => {
       const mockData = {
         total_count: 1,
@@ -533,7 +533,7 @@ describe("API", () => {
       );
 
       // Behaviour
-      await expect(getWorkflowRunJobSteps(0)).resolves.toStrictEqual([
+      await expect(fetchWorkflowRunJobSteps(0)).resolves.toStrictEqual([
         "Test Step 1",
         "Test Step 2",
       ]);
@@ -565,15 +565,15 @@ describe("API", () => {
       );
 
       // Behaviour
-      await expect(getWorkflowRunJobSteps(0)).rejects.toThrow(
-        `Failed to get Workflow Run Jobs, expected 200 but received ${errorStatus}`,
+      await expect(fetchWorkflowRunJobSteps(0)).rejects.toThrow(
+        `Failed to fetch Workflow Run Jobs, expected 200 but received ${errorStatus}`,
       );
 
       // Logging
       assertOnlyCalled(coreErrorLogMock, coreDebugLogMock);
       expect(coreErrorLogMock).toHaveBeenCalledOnce();
       expect(coreErrorLogMock.mock.calls[0]?.[0]).toMatchInlineSnapshot(
-        `"getWorkflowRunJobSteps: An unexpected error has occurred: Failed to get Workflow Run Jobs, expected 200 but received 401"`,
+        `"fetchWorkflowRunJobSteps: An unexpected error has occurred: Failed to fetch Workflow Run Jobs, expected 200 but received 401"`,
       );
     });
 
@@ -598,7 +598,7 @@ describe("API", () => {
       );
 
       // Behaviour
-      await expect(getWorkflowRunJobSteps(0)).resolves.toStrictEqual([]);
+      await expect(fetchWorkflowRunJobSteps(0)).resolves.toStrictEqual([]);
 
       // Logging
       assertOnlyCalled(coreDebugLogMock);
@@ -642,14 +642,14 @@ describe("API", () => {
 
       // Behaviour
       await expect(fetchWorkflowRunUrl(0)).rejects.toThrow(
-        `Failed to get Workflow Run state, expected 200 but received ${errorStatus}`,
+        `Failed to fetch Workflow Run state, expected 200 but received ${errorStatus}`,
       );
 
       // Logging
       assertOnlyCalled(coreErrorLogMock, coreDebugLogMock);
       expect(coreErrorLogMock).toHaveBeenCalledOnce();
       expect(coreErrorLogMock.mock.calls[0]?.[0]).toMatchInlineSnapshot(
-        `"fetchWorkflowRunUrl: An unexpected error has occurred: Failed to get Workflow Run state, expected 200 but received 401"`,
+        `"fetchWorkflowRunUrl: An unexpected error has occurred: Failed to fetch Workflow Run state, expected 200 but received 401"`,
       );
     });
   });

src/api.ts

@@ -80,7 +80,7 @@ export async function fetchWorkflowId(
       // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
       if (response.status !== 200) {
         throw new Error(
-          `Failed to get workflows, expected 200 but received ${response.status}`,
+          `Failed to fetch workflows, expected 200 but received ${response.status}`,
         );
       }
 
@@ -132,7 +132,7 @@ export async function fetchWorkflowRunUrl(runId: number): Promise<string> {
     // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
     if (response.status !== 200) {
       throw new Error(
-        `Failed to get Workflow Run state, expected 200 but received ${response.status}`,
+        `Failed to fetch Workflow Run state, expected 200 but received ${response.status}`,
       );
     }
 
@@ -155,7 +155,7 @@ export async function fetchWorkflowRunUrl(runId: number): Promise<string> {
   }
 }
 
-export async function getWorkflowRunIds(
+export async function fetchWorkflowRunIds(
   workflowId: number,
   branch: BranchNameResult,
 ): Promise<number[]> {
@@ -183,7 +183,7 @@ export async function getWorkflowRunIds(
     // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
     if (response.status !== 200) {
       throw new Error(
-        `Failed to get Workflow runs, expected 200 but received ${response.status}`,
+        `Failed to fetch Workflow runs, expected 200 but received ${response.status}`,
       );
     }
 
@@ -206,15 +206,17 @@ export async function getWorkflowRunIds(
   } catch (error) {
     if (error instanceof Error) {
       core.error(
-        `getWorkflowRunIds: An unexpected error has occurred: ${error.message}`,
+        `fetchWorkflowRunIds: An unexpected error has occurred: ${error.message}`,
       );
       core.debug(error.stack ?? "");
     }
     throw error;
   }
 }
 
-export async function getWorkflowRunJobSteps(runId: number): Promise<string[]> {
+export async function fetchWorkflowRunJobSteps(
+  runId: number,
+): Promise<string[]> {
   try {
     // https://docs.github.com/en/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run
     const response = await octokit.rest.actions.listJobsForWorkflowRun({
@@ -227,7 +229,7 @@ export async function getWorkflowRunJobSteps(runId: number): Promise<string[]> {
     // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
     if (response.status !== 200) {
       throw new Error(
-        `Failed to get Workflow Run Jobs, expected 200 but received ${response.status}`,
+        `Failed to fetch Workflow Run Jobs, expected 200 but received ${response.status}`,
       );
     }
 
@@ -249,7 +251,7 @@ export async function getWorkflowRunJobSteps(runId: number): Promise<string[]> {
   } catch (error) {
     if (error instanceof Error) {
       core.error(
-        `getWorkflowRunJobSteps: An unexpected error has occurred: ${error.message}`,
+        `fetchWorkflowRunJobSteps: An unexpected error has occurred: ${error.message}`,
       );
       core.debug(error.stack ?? "");
     }

src/main.spec.ts

@@ -156,7 +156,7 @@ describe("main", () => {
       distinctId: testCfg.distinctId,
       workflow: testCfg.workflow,
       workflowId: 0,
-      workflowTimeoutSeconds: testCfg.workflowTimeoutSeconds,
+      workflowTimeoutMs: testCfg.workflowTimeoutSeconds * 1000,
     });
 
     // Result

src/main.ts

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

src/return-dispatch.spec.ts

@@ -165,12 +165,12 @@ describe("return-dispatch", () => {
     const testId = uuid();
 
     let getWorkflowRunJobStepMock: MockInstance<
-      typeof api.getWorkflowRunJobSteps
+      typeof api.fetchWorkflowRunJobSteps
     >;
     let fetchWorkflowRunUrlMock: MockInstance<typeof api.fetchWorkflowRunUrl>;
 
     beforeEach(() => {
-      getWorkflowRunJobStepMock = vi.spyOn(api, "getWorkflowRunJobSteps");
+      getWorkflowRunJobStepMock = vi.spyOn(api, "fetchWorkflowRunJobSteps");
       fetchWorkflowRunUrlMock = vi.spyOn(api, "fetchWorkflowRunUrl");
     });
 

src/return-dispatch.ts

@@ -43,15 +43,15 @@ export async function attemptToFindRunId(
   workflowRunIds: number[],
 ): Promise<Result<{ id: number; url: string }>> {
   let currentWorkflowRunIndex = 0;
-  let currentGetWorkflowRunJobStepsAttempt = 0;
+  let currentFetchWorkflowRunJobStepsAttempt = 0;
   while (currentWorkflowRunIndex < workflowRunIds.length) {
     const id = workflowRunIds[currentWorkflowRunIndex];
     if (id === undefined) {
       break;
     }
 
     try {
-      const steps = await api.getWorkflowRunJobSteps(id);
+      const steps = await api.fetchWorkflowRunJobSteps(id);
 
       for (const step of steps) {
         if (idRegex.test(step)) {
@@ -66,17 +66,17 @@ export async function attemptToFindRunId(
 
       const shouldRetry = shouldRetryOrThrow(
         error,
-        currentGetWorkflowRunJobStepsAttempt,
+        currentFetchWorkflowRunJobStepsAttempt,
       );
       if (shouldRetry) {
-        currentGetWorkflowRunJobStepsAttempt++;
+        currentFetchWorkflowRunJobStepsAttempt++;
         await sleep(constants.WORKFLOW_JOB_STEPS_SERVER_ERROR_RETRY_MS);
         // Continue without increasing the current index to retry the same ID.
         continue;
       }
     }
 
-    currentGetWorkflowRunJobStepsAttempt = 0;
+    currentFetchWorkflowRunJobStepsAttempt = 0;
     currentWorkflowRunIndex++;
   }
 
@@ -122,32 +122,31 @@ interface GetRunIdOpts {
   distinctId: string;
   workflow: string | number;
   workflowId: number;
-  workflowTimeoutSeconds: number;
+  workflowTimeoutMs: number;
 }
 export async function getRunId({
   startTime,
   branch,
   distinctId,
   workflow,
   workflowId,
-  workflowTimeoutSeconds,
+  workflowTimeoutMs,
 }: GetRunIdOpts): Promise<Result<{ id: number; url: string }>> {
-  const timeoutMs = workflowTimeoutSeconds * 1000;
   const distinctIdRegex = new RegExp(distinctId);
 
   core.info("Attempt to identify run ID from steps...");
   core.debug(`Attempting to identify Run ID for ${workflow} (${workflowId})`);
 
   let attemptNo = 0;
   let elapsedTime = Date.now() - startTime;
-  while (elapsedTime < timeoutMs) {
+  while (elapsedTime < workflowTimeoutMs) {
     attemptNo++;
     elapsedTime = Date.now() - startTime;
 
     // Get all runs for a given workflow ID
     const fetchWorkflowRunIds = await api.retryOrTimeout(
-      () => api.getWorkflowRunIds(workflowId, branch),
-      Math.max(constants.WORKFLOW_FETCH_TIMEOUT_MS, timeoutMs),
+      () => api.fetchWorkflowRunIds(workflowId, branch),
+      Math.max(constants.WORKFLOW_FETCH_TIMEOUT_MS, workflowTimeoutMs),
     );
     if (!fetchWorkflowRunIds.success) {
       core.debug(