fix: exit early when no active runs found + plenty of debugging

closes #1

Author: ahmadnassri

action/lib/deduplicate.js

@@ -1,37 +1,46 @@
 /* eslint-disable camelcase */
 
+// node modules
+import { inspect } from 'util'
+
+// packages
 import core from '@actions/core'
 import github from '@actions/github'
 
-export default async function (octokit) {
-  // extract sha
-  const { sha, runId: run_id } = github.context
-
-  // get workflow id from run id
-  const { data: { workflow_id } } = await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}', {
+export default async function ({ octokit, workflow_id, run_id, sha }) {
+  // get current run of this workflow
+  const { data: { workflow_runs } } = await octokit.request('GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs', {
     ...github.context.repo,
-    run_id
+    workflow_id
   })
 
-  // get current run of this workflow
-  const { data: { workflow_runs } } = await octokit.request('GET /repos/{owner}/{repo}/actions/runs', {
-    ...github.context.repo
-  })
+  core.debug(`found ${workflow_runs.length} runs of workflow ${workflow_id}`)
+  core.debug(inspect(workflow_runs))
 
-  // find any instances of the same workflow
+  // filter and sort
   const cancellable = workflow_runs
     // filter to relevant runs
-    .filter(run => ['in_progress', 'queued'].includes(run.status) && run.workflow_id === workflow_id && run.head_sha === sha)
+    .filter(run => ['in_progress', 'queued'].includes(run.status))
+    // filter to only runs for the same commit
+    .filter(run => run.head_sha === sha)
+    // exclude this one
+    .filter(run => run.id !== run_id)
     // pick relevant properties
     .map(run => ({ id: run.id, name: run.name, created_at: run.created_at }))
     // sort
     .sort((a, b) => new Date(b.created_at) - new Date(a.created_at))
 
-  // remove last one
-  cancellable.pop()
+  core.debug(`found ${cancellable.length} cancellable runs of workflow ${workflow_id}`)
+  core.debug(inspect(cancellable))
+
+  // exclude last one (i.e. the first running instance)
+  const prime = cancellable.pop()
+
+  core.debug(`determined ${prime.id} to be the prime run of this workflow`)
+  core.debug(inspect(prime))
 
   for (const run of cancellable) {
-    core.info(`${run.id}: ${run.name} => cancel`)
+    core.info(`${run.id}: ${run.name} => canceling`)
 
     await octokit.request('POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel', {
       ...github.context.repo,

action/lib/index.js

@@ -1,3 +1,5 @@
+/* eslint-disable camelcase */
+
 // packages
 import core from '@actions/core'
 import github from '@actions/github'
@@ -15,13 +17,34 @@ export default async function ({ token, delay, timeout }) {
   // init octokit
   const octokit = github.getOctokit(token)
 
-  await deduplicate(octokit)
+  // extract sha
+  const { sha, ref, runId: run_id } = github.context
+
+  core.debug(`sha: ${sha}`)
+  core.debug(`run.id: ${run_id}`)
+
+  // get workflow id from run id
+  const { data: { workflow_id } } = await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}', {
+    ...github.context.repo,
+    run_id
+  })
+
+  core.debug(`workflow_id: ${workflow_id}`)
 
-  const dependencies = await workflows(octokit)
+  // don't run this workflow twice for the same commit
+  await deduplicate({ octokit, workflow_id, run_id, sha })
+
+  // find all the dependencies
+  const dependencies = await workflows({ octokit, ref, workflow_id })
 
   // check runs
   let result = await runs(octokit, dependencies)
 
+  if (result.length === 0) {
+    core.info('no runs found for this workflow\'s dependencies')
+    process.exit(1)
+  }
+
   while (result.find(run => run.conclusion !== 'success')) {
     // exit early
     const failed = result.find(run => run.conclusion === 'failure')

action/lib/runs.js

@@ -1,3 +1,8 @@
+// node modules
+import { inspect } from 'util'
+
+// packages
+import core from '@actions/core'
 import github from '@actions/github'
 
 export default async function (octokit, dependencies) {
@@ -8,9 +13,14 @@ export default async function (octokit, dependencies) {
     ...github.context.repo
   })
 
-  return workflow_runs
+  const runs = workflow_runs
     // filter to relevant runs
     .filter(run => dependencies.includes(run.name) && run.head_sha === sha)
     // pick properties
     .map(run => ({ id: run.id, name: run.name, conclusion: run.conclusion }))
+
+  core.debug(`found ${runs.length} workflow runs of ${inspect(dependencies)}`)
+  core.debug(inspect(runs))
+
+  return runs
 }

action/lib/workflows.js

@@ -1,30 +1,31 @@
+/* eslint-disable camelcase */
+
+// packages
 import yaml from 'yaml'
 import github from '@actions/github'
+import core from '@actions/core'
 
-export default async function (octokit) {
-  // extract sha
-  const { ref, runId: run_id } = github.context // eslint-disable-line camelcase
-
-  // get workflow id from run id
-  const { data: { workflow_id } } = await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}', { // eslint-disable-line camelcase
-    ...github.context.repo,
-    run_id
-  })
-
+export default async function ({ octokit, ref, workflow_id }) {
   // get the file name from the workflow
   const { data: { path } } = await octokit.request('GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}', {
     ...github.context.repo,
     workflow_id
   })
 
+  core.debug(`workflow.path: ${path}`)
+
   // get the workflow content
   const { data: { content } } = await octokit.request('GET /repos/{owner}/{repo}/contents/{path}', {
     ...github.context.repo,
     path,
     ref
   })
 
+  core.debug(`workflow content: ${content.length} bytes`)
+
   const { on: { workflow_run: { workflows } } } = yaml.parse(Buffer.from(content, 'base64').toString())
 
+  core.debug(`workflow dependencies: ${workflows}`)
+
   return workflows
 }