feat: improve workflow filtering by adding created filter

Author: jamagalhaes

dist/index.mjs

@@ -370,6 +370,7 @@ describe("API", () => {
         "Fetched Workflow Runs:
           Repository: owner/repository
           Branch Filter: true (feature_branch)
+          Created Filter: 
           Workflow ID: 0
           Runs Fetched: [0, 1, 2]"
       `,
@@ -427,6 +428,7 @@ describe("API", () => {
         "Fetched Workflow Runs:
           Repository: owner/repository
           Branch Filter: true (feature_branch)
+          Created Filter: 
           Workflow ID: 0
           Runs Fetched: []"
       `,
@@ -464,6 +466,7 @@ describe("API", () => {
         "Fetched Workflow Runs:
           Repository: owner/repository
           Branch Filter: true (master)
+          Created Filter: 
           Workflow ID: 0
           Runs Fetched: []"
       `,
@@ -501,6 +504,7 @@ describe("API", () => {
         "Fetched Workflow Runs:
           Repository: owner/repository
           Branch Filter: false (/refs/tags/1.5.0)
+          Created Filter: 
           Workflow ID: 0
           Runs Fetched: []"
       `,
@@ -538,6 +542,7 @@ describe("API", () => {
         "Fetched Workflow Runs:
           Repository: owner/repository
           Branch Filter: false (/refs/cake)
+          Created Filter: 
           Workflow ID: 0
           Runs Fetched: []"
       `,

src/api.spec.ts

@@ -158,6 +158,7 @@ export async function fetchWorkflowRunUrl(runId: number): Promise<string> {
 export async function fetchWorkflowRunIds(
   workflowId: number,
   branch: BranchNameResult,
+  created: Date | undefined = undefined,
 ): Promise<number[]> {
   try {
     const useBranchFilter =
@@ -170,6 +171,7 @@ export async function fetchWorkflowRunIds(
       owner: config.owner,
       repo: config.repo,
       workflow_id: workflowId,
+      ...(created ? {created: `>=${created.toISOString()}`} : {}),
       ...(useBranchFilter
         ? {
             branch: branch.branchName,
@@ -198,6 +200,7 @@ export async function fetchWorkflowRunIds(
       "Fetched Workflow Runs:\n" +
         `  Repository: ${config.owner}/${config.repo}\n` +
         `  Branch Filter: ${branchMsg}\n` +
+        `  Created Filter: ${created?.toISOString() ?? ""}\n` +
         `  Workflow ID: ${workflowId}\n` +
         `  Runs Fetched: [${runIds.join(", ")}]`,
     );

src/api.ts

@@ -169,7 +169,7 @@ describe("main", () => {
     // Get run ID
     expect(returnDispatchGetRunIdAndUrlMock).toHaveBeenCalledOnce();
     expect(returnDispatchGetRunIdAndUrlMock).toHaveBeenCalledWith({
-      startTime: Date.now(),
+      startTime: new Date(),
       branch: testBranch,
       distinctIdRegex: distinctIdRegex,
       workflowId: 0,

src/main.spec.ts

@@ -16,7 +16,7 @@ import {
 
 export async function main(): Promise<void> {
   try {
-    const startTime = Date.now();
+    const startTime = new Date();
 
     const config = getConfig();
     api.init(config);
@@ -48,10 +48,10 @@ export async function main(): Promise<void> {
     });
     if (result.success) {
       handleActionSuccess(result.value.id, result.value.url);
-      core.debug(`Completed (${Date.now() - startTime}ms)`);
+      core.debug(`Completed (${Date.now() - startTime.getTime()}ms)`);
     } else {
       handleActionFail();
-      core.debug(`Timed out (${Date.now() - startTime}ms)`);
+      core.debug(`Timed out (${Date.now() - startTime.getTime()}ms)`);
     }
   } catch (error) {
     if (error instanceof Error) {

src/main.ts

@@ -475,7 +475,7 @@ describe("return-dispatch", () => {
       branchName: "main",
     });
     const defaultOpts: GetRunIdAndUrlOpts = {
-      startTime: Date.now(),
+      startTime: new Date(),
       branch: branch,
       distinctIdRegex: distinctIdRegex,
       workflowId: workflowId,
@@ -837,7 +837,7 @@ describe("return-dispatch", () => {
       expect(coreDebugLogMock.mock.calls[0]?.[0]).toMatchSnapshot();
 
       expect(utilSleepMock).toHaveBeenCalledTimes(3);
-      const elapsedTime = Date.now() - defaultOpts.startTime; // `waitTime` should be using `workflowTimeoutMs` at this point
+      const elapsedTime = Date.now() - defaultOpts.startTime.getTime(); // `waitTime` should be using `workflowTimeoutMs` at this point
       expect(utilSleepMock.mock.lastCall?.[0]).approximately(
         timeoutMs - elapsedTime,
         5,

src/return-dispatch.spec.ts

@@ -124,7 +124,7 @@ export function handleActionFail(): void {
 }
 
 export interface GetRunIdAndUrlOpts {
-  startTime: number;
+  startTime: Date;
   branch: BranchNameResult;
   distinctIdRegex: RegExp;
   workflowId: number;
@@ -145,18 +145,18 @@ export async function getRunIdAndUrl({
   );
 
   let attemptNo = 0;
-  let elapsedTime = Date.now() - startTime;
+  let elapsedTime = Date.now() - startTime.getTime();
   while (elapsedTime < workflowTimeoutMs) {
     attemptNo++;
 
     // Get all runs for a given workflow ID
     const fetchWorkflowRunIds = await api.retryOrTimeout(
-      () => api.fetchWorkflowRunIds(workflowId, branch),
+      () => api.fetchWorkflowRunIds(workflowId, branch, startTime),
       retryTimeout,
     );
     if (!fetchWorkflowRunIds.success) {
       core.debug(
-        `Timed out while attempting to fetch Workflow Run IDs, waited ${Date.now() - startTime}ms`,
+        `Timed out while attempting to fetch Workflow Run IDs, waited ${Date.now() - startTime.getTime()}ms`,
       );
       break;
     }
@@ -188,7 +188,7 @@ export async function getRunIdAndUrl({
     core.info(`Waiting for ${waitTime}ms before the next attempt...`);
     await sleep(waitTime);
 
-    elapsedTime = Date.now() - startTime;
+    elapsedTime = Date.now() - startTime.getTime();
   }
 
   return { success: false, reason: "timeout" };