From 808dfeced48f30d5033b54b8be6840518cf7301e Mon Sep 17 00:00:00 2001
From: chris48s <chris.shaw480@gmail.com>
Date: Mon, 3 Oct 2022 21:32:53 +0100
Subject: [PATCH 1/4] switch from github workflows to github actions workflows

---
 .../github-actions-workflow-status.service.js |  85 ++++++++++++++
 .../github-actions-workflow-status.tester.js  |  43 +++++++
 .../github/github-workflow-status.service.js  | 107 ++----------------
 .../github/github-workflow-status.tester.js   |  33 +++---
 4 files changed, 153 insertions(+), 115 deletions(-)
 create mode 100644 services/github/github-actions-workflow-status.service.js
 create mode 100644 services/github/github-actions-workflow-status.tester.js

diff --git a/services/github/github-actions-workflow-status.service.js b/services/github/github-actions-workflow-status.service.js
new file mode 100644
index 0000000000000..609fc7aa4e388
--- /dev/null
+++ b/services/github/github-actions-workflow-status.service.js
@@ -0,0 +1,85 @@
+import Joi from 'joi'
+import { isBuildStatus, renderBuildStatusBadge } from '../build-status.js'
+import { BaseSvgScrapingService } from '../index.js'
+import { documentation } from './github-helpers.js'
+
+const schema = Joi.object({
+  message: Joi.alternatives()
+    .try(isBuildStatus, Joi.equal('no status'))
+    .required(),
+}).required()
+
+const queryParamSchema = Joi.object({
+  event: Joi.string(),
+  branch: Joi.string(),
+}).required()
+
+const keywords = ['action', 'actions']
+
+export default class GithubActionsWorkflowStatus extends BaseSvgScrapingService {
+  static category = 'build'
+
+  static route = {
+    base: 'github/actions/workflow/status',
+    pattern: ':user/:repo/:workflow+',
+    queryParamSchema,
+  }
+
+  static examples = [
+    {
+      title: 'GitHub Workflow Status',
+      namedParams: {
+        user: 'actions',
+        repo: 'toolkit',
+        workflow: 'unit-tests.yml',
+      },
+      staticPreview: renderBuildStatusBadge({
+        status: 'passing',
+      }),
+      documentation,
+      keywords,
+    },
+    {
+      title: 'GitHub Workflow Status (branch and event)',
+      namedParams: {
+        user: 'actions',
+        repo: 'toolkit',
+        workflow: 'unit-tests.yml',
+      },
+      queryParams: {
+        event: 'push',
+        branch: 'main',
+      },
+      staticPreview: renderBuildStatusBadge({
+        status: 'passing',
+      }),
+      documentation,
+      keywords,
+    },
+  ]
+
+  static defaultBadgeData = {
+    label: 'build',
+  }
+
+  async fetch({ user, repo, workflow, branch, event }) {
+    const { message: status } = await this._requestSvg({
+      schema,
+      url: `https://github.com/${user}/${repo}/actions/workflows/${encodeURIComponent(
+        workflow
+      )}/badge.svg`,
+      options: { searchParams: { branch, event } },
+      valueMatcher: />([^<>]+)<\/tspan><\/text><\/g><path/,
+      errorMessages: {
+        404: 'repo, branch, or workflow not found',
+      },
+    })
+
+    return { status }
+  }
+
+  async handle({ user, repo, workflow }, { branch, event }) {
+    const { status } = await this.fetch({ user, repo, workflow, branch, event })
+    return renderBuildStatusBadge({ status })
+  }
+}
diff --git a/services/github/github-actions-workflow-status.tester.js b/services/github/github-actions-workflow-status.tester.js
new file mode 100644
index 0000000000000..ad9d4f405270e
--- /dev/null
+++ b/services/github/github-actions-workflow-status.tester.js
@@ -0,0 +1,43 @@
+import Joi from 'joi'
+import { isBuildStatus } from '../build-status.js'
+import { createServiceTester } from '../tester.js'
+export const t = await createServiceTester()
+
+const isWorkflowStatus = Joi.alternatives()
+  .try(isBuildStatus, Joi.equal('no status'))
+  .required()
+
+t.create('nonexistent repo')
+  .get('/badges/shields-fakeness/fake.yml.json')
+  .expectBadge({
+    label: 'build',
+    message: 'repo, branch, or workflow not found',
+  })
+
+t.create('nonexistent workflow')
+  .get('/actions/toolkit/not-a-real-workflow.yml.json')
+  .expectBadge({
+    label: 'build',
+    message: 'repo, branch, or workflow not found',
+  })
+
+t.create('valid workflow')
+  .get('/actions/toolkit/unit-tests.yml.json')
+  .expectBadge({
+    label: 'build',
+    message: isWorkflowStatus,
+  })
+
+t.create('valid workflow (branch)')
+  .get('/actions/toolkit/unit-tests.yml.json?branch=master.json')
+  .expectBadge({
+    label: 'build',
+    message: isWorkflowStatus,
+  })
+
+t.create('valid workflow (event)')
+  .get('/actions/toolkit/unit-tests.yml.json?event=push')
+  .expectBadge({
+    label: 'build',
+    message: isWorkflowStatus,
+  })
diff --git a/services/github/github-workflow-status.service.js b/services/github/github-workflow-status.service.js
index d1d47ca0bb634..7afee29a01b58 100644
--- a/services/github/github-workflow-status.service.js
+++ b/services/github/github-workflow-status.service.js
@@ -1,100 +1,11 @@
-import Joi from 'joi'
-import { isBuildStatus, renderBuildStatusBadge } from '../build-status.js'
-import { BaseSvgScrapingService } from '../index.js'
-import { documentation } from './github-helpers.js'
+import { deprecatedService } from '../index.js'
 
-const schema = Joi.object({
-  message: Joi.alternatives()
-    .try(isBuildStatus, Joi.equal('no status'))
-    .required(),
-}).required()
-
-const queryParamSchema = Joi.object({
-  event: Joi.string(),
-}).required()
-
-const keywords = ['action', 'actions']
-
-export default class GithubWorkflowStatus extends BaseSvgScrapingService {
-  static category = 'build'
-
-  static route = {
+export default deprecatedService({
+  category: 'build',
+  route: {
     base: 'github/workflow/status',
-    pattern: ':user/:repo/:workflow/:branch*',
-    queryParamSchema,
-  }
-
-  static examples = [
-    {
-      title: 'GitHub Workflow Status',
-      pattern: ':user/:repo/:workflow',
-      namedParams: {
-        user: 'actions',
-        repo: 'toolkit',
-        workflow: 'toolkit-unit-tests',
-      },
-      staticPreview: renderBuildStatusBadge({
-        status: 'passing',
-      }),
-      documentation,
-      keywords,
-    },
-    {
-      title: 'GitHub Workflow Status (branch)',
-      pattern: ':user/:repo/:workflow/:branch',
-      namedParams: {
-        user: 'actions',
-        repo: 'toolkit',
-        workflow: 'toolkit-unit-tests',
-        branch: 'master',
-      },
-      staticPreview: renderBuildStatusBadge({
-        status: 'passing',
-      }),
-      documentation,
-      keywords,
-    },
-    {
-      title: 'GitHub Workflow Status (event)',
-      pattern: ':user/:repo/:workflow',
-      namedParams: {
-        user: 'actions',
-        repo: 'toolkit',
-        workflow: 'toolkit-unit-tests',
-      },
-      queryParams: {
-        event: 'push',
-      },
-      staticPreview: renderBuildStatusBadge({
-        status: 'passing',
-      }),
-      documentation,
-      keywords,
-    },
-  ]
-
-  static defaultBadgeData = {
-    label: 'build',
-  }
-
-  async fetch({ user, repo, workflow, branch, event }) {
-    const { message: status } = await this._requestSvg({
-      schema,
-      url: `https://github.com/${user}/${repo}/workflows/${encodeURIComponent(
-        workflow
-      )}/badge.svg`,
-      options: { searchParams: { branch, event } },
-      valueMatcher: />([^<>]+)<\/tspan><\/text><\/g><path/,
-      errorMessages: {
-        404: 'repo, branch, or workflow not found',
-      },
-    })
-
-    return { status }
-  }
-
-  async handle({ user, repo, workflow, branch }, { event }) {
-    const { status } = await this.fetch({ user, repo, workflow, branch, event })
-    return renderBuildStatusBadge({ status })
-  }
-}
+    pattern: ':various+',
+  },
+  label: 'build',
+  dateAdded: new Date('2022-10-03'),
+})
diff --git a/services/github/github-workflow-status.tester.js b/services/github/github-workflow-status.tester.js
index 573a16e7b18f1..3100476f738e4 100644
--- a/services/github/github-workflow-status.tester.js
+++ b/services/github/github-workflow-status.tester.js
@@ -1,43 +1,42 @@
-import Joi from 'joi'
-import { isBuildStatus } from '../build-status.js'
-import { createServiceTester } from '../tester.js'
-export const t = await createServiceTester()
+import { ServiceTester } from '../tester.js'
 
-const isWorkflowStatus = Joi.alternatives()
-  .try(isBuildStatus, Joi.equal('no status'))
-  .required()
+export const t = new ServiceTester({
+  id: 'GithubWorkflowStatus',
+  title: 'Github Workflow Status',
+  pathPrefix: '/github/workflow/status',
+})
 
-t.create('nonexistent repo')
+t.create('no longer available (previously nonexistent repo)')
   .get('/badges/shields-fakeness/fake.json')
   .expectBadge({
     label: 'build',
-    message: 'repo, branch, or workflow not found',
+    message: 'no longer available',
   })
 
-t.create('nonexistent workflow')
+t.create('no longer available (previously nonexistent workflow)')
   .get('/actions/toolkit/not-a-real-workflow.json')
   .expectBadge({
     label: 'build',
-    message: 'repo, branch, or workflow not found',
+    message: 'no longer available',
   })
 
-t.create('valid workflow')
+t.create('no longer available (previously valid workflow)')
   .get('/actions/toolkit/toolkit-unit-tests.json')
   .expectBadge({
     label: 'build',
-    message: isWorkflowStatus,
+    message: 'no longer available',
   })
 
-t.create('valid workflow (branch)')
+t.create('no longer available (previously valid workflow - branch)')
   .get('/actions/toolkit/toolkit-unit-tests/master.json')
   .expectBadge({
     label: 'build',
-    message: isWorkflowStatus,
+    message: 'no longer available',
   })
 
-t.create('valid workflow (event)')
+t.create('no longer available (previously valid workflow - event)')
   .get('/actions/toolkit/toolkit-unit-tests.json?event=push')
   .expectBadge({
     label: 'build',
-    message: isWorkflowStatus,
+    message: 'no longer available',
   })

From 7ea7cf5167c0ea957646253fe332c15bbe074746 Mon Sep 17 00:00:00 2001
From: chris48s <chris.shaw480@gmail.com>
Date: Mon, 17 Oct 2022 16:14:26 +0100
Subject: [PATCH 2/4] update github actions workflow badge to use api

---
 .../github-actions-workflow-status.service.js | 56 ++++++++++++-------
 .../github-actions-workflow-status.tester.js  | 31 ++++++----
 2 files changed, 56 insertions(+), 31 deletions(-)

diff --git a/services/github/github-actions-workflow-status.service.js b/services/github/github-actions-workflow-status.service.js
index 609fc7aa4e388..2f1896589510d 100644
--- a/services/github/github-actions-workflow-status.service.js
+++ b/services/github/github-actions-workflow-status.service.js
@@ -1,22 +1,31 @@
 import Joi from 'joi'
 import { isBuildStatus, renderBuildStatusBadge } from '../build-status.js'
-import { BaseSvgScrapingService } from '../index.js'
-import { documentation } from './github-helpers.js'
+import { NotFound } from '../index.js'
+import { GithubAuthV3Service } from './github-auth-service.js'
+import { documentation, errorMessagesFor } from './github-helpers.js'
 
 const schema = Joi.object({
-  message: Joi.alternatives()
-    .try(isBuildStatus, Joi.equal('no status'))
-    .required(),
+  workflow_runs: Joi.array()
+    .items(
+      Joi.object({
+        conclusion: Joi.alternatives()
+          .try(isBuildStatus, Joi.equal('no status'))
+          .required(),
+      })
+    )
+    .required()
+    .min(0)
+    .max(1),
 }).required()
 
 const queryParamSchema = Joi.object({
   event: Joi.string(),
-  branch: Joi.string(),
+  branch: Joi.string().required(),
 }).required()
 
 const keywords = ['action', 'actions']
 
-export default class GithubActionsWorkflowStatus extends BaseSvgScrapingService {
+export default class GithubActionsWorkflowStatus extends GithubAuthV3Service {
   static category = 'build'
 
   static route = {
@@ -33,6 +42,9 @@ export default class GithubActionsWorkflowStatus extends BaseSvgScrapingService
         repo: 'toolkit',
         workflow: 'unit-tests.yml',
       },
+      queryParams: {
+        branch: 'main',
+      },
       staticPreview: renderBuildStatusBadge({
         status: 'passing',
       }),
@@ -40,7 +52,7 @@ export default class GithubActionsWorkflowStatus extends BaseSvgScrapingService
       keywords,
     },
     {
-      title: 'GitHub Workflow Status (branch and event)',
+      title: 'GitHub Workflow Status (with event)',
       namedParams: {
         user: 'actions',
         repo: 'toolkit',
@@ -63,23 +75,27 @@ export default class GithubActionsWorkflowStatus extends BaseSvgScrapingService
   }
 
   async fetch({ user, repo, workflow, branch, event }) {
-    const { message: status } = await this._requestSvg({
+    return await this._requestJson({
       schema,
-      url: `https://github.com/${user}/${repo}/actions/workflows/${encodeURIComponent(
-        workflow
-      )}/badge.svg`,
-      options: { searchParams: { branch, event } },
-      valueMatcher: />([^<>]+)<\/tspan><\/text><\/g><path/,
-      errorMessages: {
-        404: 'repo, branch, or workflow not found',
+      url: `/repos/${user}/${repo}/actions/workflows/${workflow}/runs`,
+      options: {
+        searchParams: {
+          branch,
+          event,
+          page: '1',
+          per_page: '1',
+          exclude_pull_requests: 'true',
+        },
       },
+      errorMessages: errorMessagesFor('repo or workflow not found'),
     })
-
-    return { status }
   }
 
   async handle({ user, repo, workflow }, { branch, event }) {
-    const { status } = await this.fetch({ user, repo, workflow, branch, event })
-    return renderBuildStatusBadge({ status })
+    const data = await this.fetch({ user, repo, workflow, branch, event })
+    if (data.workflow_runs.length === 0) {
+      throw new NotFound({ prettyMessage: 'branch or event not found' })
+    }
+    return renderBuildStatusBadge({ status: data.workflow_runs[0].conclusion })
   }
 }
diff --git a/services/github/github-actions-workflow-status.tester.js b/services/github/github-actions-workflow-status.tester.js
index ad9d4f405270e..efb320b9b9092 100644
--- a/services/github/github-actions-workflow-status.tester.js
+++ b/services/github/github-actions-workflow-status.tester.js
@@ -8,35 +8,44 @@ const isWorkflowStatus = Joi.alternatives()
   .required()
 
 t.create('nonexistent repo')
-  .get('/badges/shields-fakeness/fake.yml.json')
+  .get('/badges/shields-fakeness/fake.yml.json?branch=main')
   .expectBadge({
     label: 'build',
-    message: 'repo, branch, or workflow not found',
+    message: 'repo or workflow not found',
   })
 
 t.create('nonexistent workflow')
-  .get('/actions/toolkit/not-a-real-workflow.yml.json')
+  .get('/actions/toolkit/not-a-real-workflow.yml.json?branch=main')
   .expectBadge({
     label: 'build',
-    message: 'repo, branch, or workflow not found',
+    message: 'repo or workflow not found',
   })
 
-t.create('valid workflow')
-  .get('/actions/toolkit/unit-tests.yml.json')
+t.create('nonexistent branch')
+  .get('/actions/toolkit/unit-tests.yml.json?branch=not-a-real-branch')
   .expectBadge({
     label: 'build',
-    message: isWorkflowStatus,
+    message: 'branch or event not found',
   })
 
-t.create('valid workflow (branch)')
-  .get('/actions/toolkit/unit-tests.yml.json?branch=master.json')
+t.create('nonexistent event')
+  .get(
+    '/actions/toolkit/unit-tests.yml.json?branch=main&event=not-a-real-event'
+  )
+  .expectBadge({
+    label: 'build',
+    message: 'branch or event not found',
+  })
+
+t.create('valid workflow')
+  .get('/actions/toolkit/unit-tests.yml.json?branch=main')
   .expectBadge({
     label: 'build',
     message: isWorkflowStatus,
   })
 
-t.create('valid workflow (event)')
-  .get('/actions/toolkit/unit-tests.yml.json?event=push')
+t.create('valid workflow (with event)')
+  .get('/actions/toolkit/unit-tests.yml.json?branch=main&event=push')
   .expectBadge({
     label: 'build',
     message: isWorkflowStatus,

From de396172cb8677915eb7e7f5b0a5c3877a0c5b41 Mon Sep 17 00:00:00 2001
From: chris48s <chris.shaw480@gmail.com>
Date: Mon, 17 Oct 2022 16:22:23 +0100
Subject: [PATCH 3/4] add test case for missing branch param

---
 services/github/github-actions-workflow-status.tester.js | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/services/github/github-actions-workflow-status.tester.js b/services/github/github-actions-workflow-status.tester.js
index efb320b9b9092..9ebc19e4a641c 100644
--- a/services/github/github-actions-workflow-status.tester.js
+++ b/services/github/github-actions-workflow-status.tester.js
@@ -7,6 +7,13 @@ const isWorkflowStatus = Joi.alternatives()
   .try(isBuildStatus, Joi.equal('no status'))
   .required()
 
+t.create('missing branch param')
+  .get('/actions/toolkit/unit-tests.yml.json')
+  .expectBadge({
+    label: 'build',
+    message: 'invalid query parameter: branch',
+  })
+
 t.create('nonexistent repo')
   .get('/badges/shields-fakeness/fake.yml.json?branch=main')
   .expectBadge({

From e0b7dbd58cc4e0f7f7a47c51fff5e85c7162512a Mon Sep 17 00:00:00 2001
From: chris48s <git@chris-shaw.dev>
Date: Thu, 1 Dec 2022 19:44:58 +0000
Subject: [PATCH 4/4] custom deprecation message

---
 .../github/github-workflow-status.service.js  | 33 ++++++++++++++-----
 .../github/github-workflow-status.tester.js   | 10 +++---
 2 files changed, 30 insertions(+), 13 deletions(-)

diff --git a/services/github/github-workflow-status.service.js b/services/github/github-workflow-status.service.js
index 7afee29a01b58..69e6e8f286d8d 100644
--- a/services/github/github-workflow-status.service.js
+++ b/services/github/github-workflow-status.service.js
@@ -1,11 +1,28 @@
-import { deprecatedService } from '../index.js'
+import { BaseService } from '../index.js'
 
-export default deprecatedService({
-  category: 'build',
-  route: {
+export default class DeprecatedGithubWorkflowStatus extends BaseService {
+  static category = 'build'
+
+  static route = {
     base: 'github/workflow/status',
     pattern: ':various+',
-  },
-  label: 'build',
-  dateAdded: new Date('2022-10-03'),
-})
+  }
+
+  static examples = []
+
+  static defaultBadgeData = { label: 'build' }
+
+  async handle() {
+    return {
+      label: 'build',
+      message: 'https://github.com/badges/shields/issues/8671',
+      /*
+      This is a 'special' deprecation because we are making a breaking change
+      We've implemented it as a custom class instead of a normal
+      deprecatedService so that we can include link.
+      */
+      link: ['https://github.com/badges/shields/issues/8671'],
+      color: 'red',
+    }
+  }
+}
diff --git a/services/github/github-workflow-status.tester.js b/services/github/github-workflow-status.tester.js
index 3100476f738e4..de27de37aab89 100644
--- a/services/github/github-workflow-status.tester.js
+++ b/services/github/github-workflow-status.tester.js
@@ -10,33 +10,33 @@ t.create('no longer available (previously nonexistent repo)')
   .get('/badges/shields-fakeness/fake.json')
   .expectBadge({
     label: 'build',
-    message: 'no longer available',
+    message: 'https://github.com/badges/shields/issues/8671',
   })
 
 t.create('no longer available (previously nonexistent workflow)')
   .get('/actions/toolkit/not-a-real-workflow.json')
   .expectBadge({
     label: 'build',
-    message: 'no longer available',
+    message: 'https://github.com/badges/shields/issues/8671',
   })
 
 t.create('no longer available (previously valid workflow)')
   .get('/actions/toolkit/toolkit-unit-tests.json')
   .expectBadge({
     label: 'build',
-    message: 'no longer available',
+    message: 'https://github.com/badges/shields/issues/8671',
   })
 
 t.create('no longer available (previously valid workflow - branch)')
   .get('/actions/toolkit/toolkit-unit-tests/master.json')
   .expectBadge({
     label: 'build',
-    message: 'no longer available',
+    message: 'https://github.com/badges/shields/issues/8671',
   })
 
 t.create('no longer available (previously valid workflow - event)')
   .get('/actions/toolkit/toolkit-unit-tests.json?event=push')
   .expectBadge({
     label: 'build',
-    message: 'no longer available',
+    message: 'https://github.com/badges/shields/issues/8671',
   })