Add a function to list GitHub workflow runs

This function will be used to determine whether a workflow run is
already queued, to prevent concurrent runs of the upcoming GitHub
workflows that replace GitGitGadget's Azure Pipelines.

Signed-off-by: Johannes Schindelin <[email protected]>

Author: dscho

GitGitGadget/trigger-workflow-dispatch.js

@@ -56,7 +56,34 @@ const triggerWorkflowDispatch = async (context, token, owner, repo, workflow_id,
     return runs[0]
 }
 
+const listWorkflowRuns = async (context, token, owner, repo, workflow_id, branch, status) => {
+    if (token === undefined) {
+        const { getInstallationIdForRepo } = require('./get-installation-id-for-repo')
+        const installationID = await getInstallationIdForRepo(context, owner, repo)
+
+        const { getInstallationAccessToken } = require('./get-installation-access-token')
+        token = await getInstallationAccessToken(context, installationID)
+    }
+
+    const query = [
+        branch && `branch=${branch}`,
+        status && `status=${status}`,
+    ]
+        .filter((e) => e)
+        .map((e, i) => `${i === 0 ? '?' : '&'}${e}`)
+        .join('')
+
+    const result = await gitHubAPIRequest(
+        context,
+        token,
+        'GET',
+        `/repos/${owner}/${repo}/actions/workflows/${workflow_id}/runs${query}`,
+    )
+    return result.workflow_runs
+}
+
 module.exports = {
     triggerWorkflowDispatch,
-    waitForWorkflowRun
+    waitForWorkflowRun,
+    listWorkflowRuns,
 }

__tests__/trigger-workflow-dispatch.test.js

@@ -16,11 +16,19 @@ const mockHTTPSRequest = jest.fn(async (_context, _hostname, method, requestPath
             ]
         }
     }
+    if (method === 'GET' && requestPath === '/repos/hello/world/actions/workflows/the-workflow.yml/runs?branch=main&status=queued') {
+        return {
+            workflow_runs: [
+                { id: 1, head_branch: 'main', status: 'queued' },
+                { id: 2, head_branch: 'main', status: 'queued' },
+            ]
+        }
+    }
     throw new Error(`Unexpected requestPath: ${method} '${requestPath}'`)
 })
 jest.mock('../GitGitGadget/https-request', () => { return { httpsRequest: mockHTTPSRequest } })
 
-const { triggerWorkflowDispatch } = require('../GitGitGadget/trigger-workflow-dispatch')
+const { triggerWorkflowDispatch, listWorkflowRuns } = require('../GitGitGadget/trigger-workflow-dispatch')
 
 const { generateKeyPairSync } = require('crypto')
 
@@ -44,4 +52,10 @@ test('trigger a workflow_dispatch event and wait for workflow run', async () =>
         path: '.github/workflows/the-workflow.yml',
         breadcrumb: true
     })
+})
+
+test('list workflow runs', async () => {
+    const context = {}
+    const runs = await listWorkflowRuns(context, 'my-token', 'hello', 'world', 'the-workflow.yml', 'main', 'queued')
+    expect(runs.length).toEqual(2)
 })