refactor: rename getRunId to getRunIdAndUrl

Author: Codex-

src/main.spec.ts

@@ -59,7 +59,9 @@ describe("main", () => {
   >;
 
   // Return Dispatch
-  let returnDispatchGetRunIdMock: MockInstance<typeof returnDispatch.getRunId>;
+  let returnDispatchGetRunIdAndUrlMock: MockInstance<
+    typeof returnDispatch.getRunIdAndUrl
+  >;
   let returnDispatchGetWorkflowIdMock: MockInstance<
     typeof returnDispatch.getWorkflowId
   >;
@@ -92,7 +94,7 @@ describe("main", () => {
       "logInfoForBranchNameResult",
     );
 
-    returnDispatchGetRunIdMock = vi.spyOn(returnDispatch, "getRunId");
+    returnDispatchGetRunIdAndUrlMock = vi.spyOn(returnDispatch, "getRunIdAndUrl");
     returnDispatchGetWorkflowIdMock = vi
       .spyOn(returnDispatch, "getWorkflowId")
       .mockResolvedValue(0);
@@ -119,7 +121,9 @@ describe("main", () => {
 
     utilsGetBranchNameMock.mockReturnValue(testBranch);
     returnDispatchGetWorkflowIdMock.mockResolvedValue(0);
-    returnDispatchGetRunIdMock.mockResolvedValue(returnDispatchSuccessResult);
+    returnDispatchGetRunIdAndUrlMock.mockResolvedValue(
+      returnDispatchSuccessResult,
+    );
 
     await main();
 
@@ -149,8 +153,8 @@ describe("main", () => {
     );
 
     // Get run ID
-    expect(returnDispatchGetRunIdMock).toHaveBeenCalledOnce();
-    expect(returnDispatchGetRunIdMock).toHaveBeenCalledWith({
+    expect(returnDispatchGetRunIdAndUrlMock).toHaveBeenCalledOnce();
+    expect(returnDispatchGetRunIdAndUrlMock).toHaveBeenCalledWith({
       startTime: Date.now(),
       branch: testBranch,
       distinctId: testCfg.distinctId,
@@ -196,7 +200,7 @@ describe("main", () => {
     expect(apiDispatchWorkflowMock).not.toHaveBeenCalled();
     expect(utilsGetBranchNameMock).not.toHaveBeenCalled();
     expect(utilsLogInfoForBranchNameResult).not.toHaveBeenCalled();
-    expect(returnDispatchGetRunIdMock).not.toHaveBeenCalled();
+    expect(returnDispatchGetRunIdAndUrlMock).not.toHaveBeenCalled();
     expect(returnDispatchHandleFailMock).not.toHaveBeenCalled();
     expect(returnDispatchHandleSuccessMock).not.toHaveBeenCalled();
 
@@ -232,7 +236,7 @@ describe("main", () => {
     expect(apiDispatchWorkflowMock).not.toHaveBeenCalled();
     expect(utilsGetBranchNameMock).not.toHaveBeenCalled();
     expect(utilsLogInfoForBranchNameResult).not.toHaveBeenCalled();
-    expect(returnDispatchGetRunIdMock).not.toHaveBeenCalled();
+    expect(returnDispatchGetRunIdAndUrlMock).not.toHaveBeenCalled();
     expect(returnDispatchHandleFailMock).not.toHaveBeenCalled();
     expect(returnDispatchHandleSuccessMock).not.toHaveBeenCalled();
 

src/main.ts

@@ -6,7 +6,7 @@ import {
   getWorkflowId,
   handleActionFail,
   handleActionSuccess,
-  getRunId,
+  getRunIdAndUrl,
 } from "./return-dispatch.ts";
 import { getBranchName, logInfoForBranchNameResult } from "./utils.ts";
 
@@ -27,7 +27,7 @@ export async function main(): Promise<void> {
     const branch = getBranchName(config.ref);
     logInfoForBranchNameResult(branch, config.ref);
 
-    const result = await getRunId({
+    const result = await getRunIdAndUrl({
       startTime,
       branch,
       distinctId: config.distinctId,

src/return-dispatch.ts

@@ -116,22 +116,22 @@ export function handleActionFail(): void {
   core.setFailed("Timeout exceeded while attempting to get Run ID");
 }
 
-interface GetRunIdOpts {
+export interface GetRunIdAndUrlOpts {
   startTime: number;
   branch: BranchNameResult;
   distinctId: string;
   workflow: string | number;
   workflowId: number;
   workflowTimeoutMs: number;
 }
-export async function getRunId({
+export async function getRunIdAndUrl({
   startTime,
   branch,
   distinctId,
   workflow,
   workflowId,
   workflowTimeoutMs,
-}: GetRunIdOpts): Promise<Result<{ id: number; url: string }>> {
+}: GetRunIdAndUrlOpts): Promise<Result<{ id: number; url: string }>> {
   const distinctIdRegex = new RegExp(distinctId);
 
   core.info("Attempt to identify run ID from steps...");