Trigger update-prs and update-mail-to-commit-notes on seen updates

This is part of my ongoing effort to replace GitGitGadget's Azure
Pipelines by GitHub workflows.

Currently, the Azure Pipelines have the upstream Git repository as
"source" (even if they don't check that out), i.e. Azure Pipelines poll
for changes.

In GitHub workflows, such a thing is no longer possible: There is no way
to trigger a GitHub workflow on updates in _another_ repository than the
workflow definition resides (a rather vexing limitation of GitHub
Actions' architecture, to be sure).

In this instance, we can avoid resorting to the ugly, ugly, yet
all-too-common workaround of polling (which we do in
`sync-git-mailing-list-mirror`) but can at least react to the respective
webhook event (at least we _can_, what with the `gitgitgadget-git` app
being installed on `git/git`).

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

Author: dscho

GitGitGadget/index.js

@@ -12,7 +12,7 @@ const { validateGitHubWebHook } = require('./validate-github-webhook');
 
 const { triggerAzurePipeline } = require('./trigger-azure-pipeline');
 
-const { triggerWorkflowDispatch } = require('./trigger-workflow-dispatch')
+const { triggerWorkflowDispatch, listWorkflowRuns } = require('./trigger-workflow-dispatch')
 
 module.exports = async (context, req) => {
     try {
@@ -69,7 +69,16 @@ module.exports = async (context, req) => {
                         ref: req.body.ref
                     }
                 )
-                context.res = { body: `push(${req.body.ref}): triggered ${run.html_url}` }
+                const extra = []
+                if (req.body.ref === 'refs/heads/seen') {
+                    for (const workflow of ['update-prs.yml', 'update-mail-to-commit-notes.yml']) {
+                        if ((await listWorkflowRuns(...a, workflow, 'main', 'queued')).length === 0) {
+                            const run = await triggerWorkflowDispatch(...a, workflow, 'main')
+                            extra.push(` and ${run.html_url}`)
+                        }
+                    }
+                }
+                context.res = { body: `push(${req.body.ref}): triggered ${run.html_url}${extra.join('')}` }
             }
         } else if (eventType === 'issue_comment') {
             const triggerToken = process.env['GITGITGADGET_TRIGGER_TOKEN'];

__tests__/index.test.js

@@ -2,7 +2,17 @@ const mockTriggerWorkflowDispatch = jest.fn(async (_context, _token, _owner, _re
     return { html_url: `<the URL to the workflow ${workflow_id} run on ${ref} with inputs ${JSON.stringify(inputs)}>` }
 })
 jest.mock('../GitGitGadget/trigger-workflow-dispatch', () => ({
-    triggerWorkflowDispatch: mockTriggerWorkflowDispatch
+    triggerWorkflowDispatch: mockTriggerWorkflowDispatch,
+    listWorkflowRuns: jest.fn(async (_context, _token, _owner, _repo, workflow_id, branch, status) => {
+        if (workflow_id === 'update-prs.yml' && branch === 'main' && status === 'queued') {
+            // pretend that `update-prs` is clogged up, for whatever reason
+            return [
+                { id: 1, head_branch: 'main', status: 'queued', html_url: '<the URL to the workflow run>' },
+                { id: 2, head_branch: 'main', status: 'queued', html_url: '<another URL to the workflow run>' }
+            ]
+        }
+        return []
+    })
 }))
 
 const index = require('../GitGitGadget/index')
@@ -206,4 +216,43 @@ testWebhookPayload('react to `next` being pushed to git/git', 'push', {
             ref: 'refs/heads/next'
         }
     ])
+})
+
+testWebhookPayload('react to `seen` being pushed to git/git', 'push', {
+    ref: 'refs/heads/seen',
+    repository: {
+        full_name: 'git/git',
+        owner: {
+            login: 'git'
+        }
+    }
+}, (context) => {
+    expect(context.res).toEqual({
+        body: [
+            'push(refs/heads/seen):',
+            'triggered <the URL to the workflow sync-ref.yml run on main with inputs {"ref":"refs/heads/seen"}>',
+            'and <the URL to the workflow update-mail-to-commit-notes.yml run on main with inputs undefined>'
+        ].join(' ')
+    })
+    // we expect `update-prs` _not_ to be triggered here because we pretend that it is already queued
+    expect(mockTriggerWorkflowDispatch).toHaveBeenCalledTimes(2)
+    expect(mockTriggerWorkflowDispatch.mock.calls[0]).toEqual([
+        context,
+        undefined,
+        'gitgitgadget-workflows',
+        'gitgitgadget-workflows',
+        'sync-ref.yml',
+        'main', {
+            ref: 'refs/heads/seen'
+        }
+    ])
+    expect(mockTriggerWorkflowDispatch.mock.calls[1]).toEqual([
+        context,
+        undefined,
+        'gitgitgadget-workflows',
+        'gitgitgadget-workflows',
+        'update-mail-to-commit-notes.yml',
+        'main',
+        undefined
+    ])
 })