chore(pr): Some adjustments after merge of PRs

Author: aurelien-baudet

README.md

@@ -34,7 +34,7 @@ All values must be strings (even if they are used as booleans or numbers in the
 ### `repo`
 **Optional.** The default behavior is to trigger workflows in the same repo as the triggering workflow, if you wish to trigger in another GitHub repo "externally", then provide the owner + repo name with slash between them e.g. `microsoft/vscode`
 
-### `run-name`
+### `run-name` (since 3.0.0)
 **Optional.** The default behavior is to get the remote run ID based on the latest workflow name and date, if you have multiple of the same workflow running at the same time it can point to an incorrect run id.
 You can specify the run name to fetch the run ID based on the actual run name.
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "workflow-dispatch-and-wait",
-  "version": "2.1.1",
+  "version": "3.0.0",
   "description": "Trigger running GitHub Actions workflows and wait for result",
   "main": "dist/index.js",
   "scripts": {

src/debug.ts

@@ -3,7 +3,12 @@ import * as core from '@actions/core'
 export function debug(title: string, content: any) {
   if (core.isDebug()) {
     core.info(`::group::${title}`)
-    core.debug(JSON.stringify(content, null, 3));
+    try {
+      core.debug(JSON.stringify(content, null, 3));      
+    } catch(e) {
+      core.debug(`Failed to serialize object, trying toString. Cause: ${e}`)
+      core.debug(content?.toString());    
+    }
     core.info('::endgroup::')
   }
 }

src/utils.ts

@@ -8,7 +8,7 @@ enum TimeUnit {
 }
 
 function toMilliseconds(timeWithUnit: string): number {
-  const unitStr = timeWithUnit.substr(timeWithUnit.length-1);
+  const unitStr = timeWithUnit.substring(timeWithUnit.length-1);
   const unit = TimeUnit[unitStr.toUpperCase() as keyof typeof TimeUnit];
   if (!unit) {
     throw new Error('Unknown time unit '+unitStr);
@@ -17,6 +17,16 @@ function toMilliseconds(timeWithUnit: string): number {
   return time * unit;
 }
 
+function parse(inputsJson: string) {
+  if(inputsJson) {
+    try {
+      return JSON.parse(inputsJson);
+    } catch(e) {
+      throw new Error(`Failed to parse 'inputs' parameter. Muse be a valid JSON.\nCause: ${e}`)
+    }
+  }
+  return {}
+}
 export function getArgs() {
   // Required inputs
   const token = core.getInput('token');
@@ -28,11 +38,7 @@ export function getArgs() {
     : [github.context.repo.owner, github.context.repo.repo];
 
   // Decode inputs, this MUST be a valid JSON string
-  let inputs = {};
-  const inputsJson = core.getInput('inputs');
-  if(inputsJson) {
-    inputs = JSON.parse(inputsJson);
-  }
+  let inputs = parse(core.getInput('inputs'));
 
   const displayWorkflowUrlStr = core.getInput('display-workflow-run-url');
   const displayWorkflowUrl = displayWorkflowUrlStr && displayWorkflowUrlStr === 'true';

src/workflow-handler.ts

@@ -127,48 +127,9 @@ export class WorkflowHandler {
     try {
       core.debug('Get workflow run id');
       if (this.runName) {
-
-        const result = await this.octokit.rest.checks.listForRef({
-          check_name: this.runName,
-          owner: this.owner,
-          repo: this.repo,
-          ref: this.ref,
-          filter: 'latest'
-        })
-
-        if (result.length == 0) {
-          throw new Error('Run not found');
-        }
-
-        this.workflowRunId = result.check_runs[0].id as number;
-      }
-      else {
-        const workflowId = await this.getWorkflowId();
-
-        const response = await this.octokit.actions.listWorkflowRuns({
-          owner: this.owner,
-          repo: this.repo,
-          workflow_id: workflowId,
-          event: 'workflow_dispatch'
-        });
-
-        debug('List Workflow Runs', response);
-        const runs = response.data.workflow_runs
-            .filter((r: any) => new Date(r.created_at).setMilliseconds(0) >= this.triggerDate);
-        debug(`Filtered Workflow Runs (after trigger date: ${new Date(this.triggerDate).toISOString()})`, runs.map((r: any) => ({
-          id: r.id,
-          name: r.name,
-          created_at: r.creatd_at,
-          triggerDate: new Date(this.triggerDate).toISOString(),
-          created_at_ts: new Date(r.created_at).valueOf(),
-          triggerDateTs: this.triggerDate
-        })));
-
-        if (runs.length == 0) {
-          throw new Error('Run not found');
-        }
-
-        this.workflowRunId = runs[0].id as number;
+        this.workflowRunId = await this.findWorklowRunIdFromRunName(this.runName);
+      } else {
+        this.workflowRunId = await this.findWorkflowRunIdFromFirstRunOfSameWorkflowId();
       }
 
       return this.workflowRunId;
@@ -179,6 +140,51 @@ export class WorkflowHandler {
 
   }
 
+  private async findWorkflowRunIdFromFirstRunOfSameWorkflowId(): Promise<number> {
+    const workflowId = await this.getWorkflowId();
+
+    const response = await this.octokit.actions.listWorkflowRuns({
+      owner: this.owner,
+      repo: this.repo,
+      workflow_id: workflowId,
+      event: 'workflow_dispatch'
+    });
+
+    debug('List Workflow Runs', response);
+    const runs = response.data.workflow_runs
+      .filter((r: any) => new Date(r.created_at).setMilliseconds(0) >= this.triggerDate);
+    debug(`Filtered Workflow Runs (after trigger date: ${new Date(this.triggerDate).toISOString()})`, runs.map((r: any) => ({
+      id: r.id,
+      name: r.name,
+      created_at: r.creatd_at,
+      triggerDate: new Date(this.triggerDate).toISOString(),
+      created_at_ts: new Date(r.created_at).valueOf(),
+      triggerDateTs: this.triggerDate
+    })));
+
+    if (runs.length == 0) {
+      throw new Error('Run not found');
+    }
+
+    return runs[0].id as number;
+  }
+
+  private async findWorklowRunIdFromRunName(runName: string): Promise<number> {
+    const result = await this.octokit.rest.checks.listForRef({
+      check_name: runName,
+      owner: this.owner,
+      repo: this.repo,
+      ref: this.ref,
+      filter: 'latest'
+    });
+
+    if (result.length == 0) {
+      throw new Error('Run not found');
+    }
+
+    return result.check_runs[0].id as number;
+  }
+
   private async getWorkflowId(): Promise<number | string> {
     if (this.workflowId) {
       return this.workflowId;