Added milestone property to GitHub issue details service

badges · Apr 20, 2022 · ccd1a4b · ccd1a4b
1 parent 560d267
commit ccd1a4b
Show file tree

Hide file tree

Showing 4 changed files with 89 additions and 1 deletion.
diff --git a/services/github/github-helpers.js b/services/github/github-helpers.js
@@ -31,10 +31,39 @@ function transformErrors(errors, entity = 'repo') {
 
 const commentsColor = colorScale([1, 3, 10, 25], undefined, true)
 
+const randomColors = colorScale(
+  [1, 3, 4, 5, 6, 7, 8, 9, 10],
+  [
+    'firebrick',
+    'forestgreen',
+    'goldenrod',
+    'darkmagenta',
+    'darkslateblue',
+    'indianred',
+    'darkolivegreen',
+    'cornflowerblue',
+    'darkslategray',
+    'lightseagreen',
+  ],
+  false
+)
+
+function hashCode(s) {
+  return s.split('').reduce((hash, character) => {
+    hash = (hash << 5) - hash + character.charCodeAt(0)
+    return hash & hash
+  }, 0)
+}
+
+function colorForString(s) {
+  return randomColors(hashCode(s))
+}
+
 export {
   documentation,
   issueStateColor,
   commentsColor,
   errorMessagesFor,
   transformErrors,
+  colorForString,
 }
diff --git a/services/github/github-issue-detail.service.js b/services/github/github-issue-detail.service.js
@@ -9,6 +9,7 @@ import {
   errorMessagesFor,
   issueStateColor,
   commentsColor,
+  colorForString,
 } from './github-helpers.js'
 
 const commonSchemaFields = {
@@ -140,6 +141,24 @@ const ageUpdateMap = {
   }),
 }
 
+const milestoneMap = {
+  schema: Joi.object({
+    ...commonSchemaFields,
+    milestone: Joi.object({
+      title: Joi.string().required(),
+    }).allow(null),
+  }).required(),
+  transform: ({ json }) => (json.milestone ? json.milestone.title : '---'),
+  render: ({ value }) => {
+    const color = value === '---' ? 'grey' : colorForString(value.milestone)
+    return {
+      label: 'milestone',
+      message: value,
+      color: color,
+    }
+  },
+}
+
 const propertyMap = {
   state: stateMap,
   title: titleMap,
@@ -148,6 +167,7 @@ const propertyMap = {
   comments: commentsMap,
   age: ageUpdateMap,
   'last-update': ageUpdateMap,
+  milestone: milestoneMap,
 }
 
 export default class GithubIssueDetail extends GithubAuthV3Service {
@@ -182,6 +202,7 @@ export default class GithubIssueDetail extends GithubAuthV3Service {
         'comments',
         'age',
         'last update',
+        'milestone',
       ],
       documentation,
     },

diff --git a/services/github/github-issue-detail.spec.js b/services/github/github-issue-detail.spec.js
@@ -4,7 +4,11 @@ import { age } from '../color-formatters.js'
 import { formatDate, metric } from '../text-formatters.js'
 import { InvalidResponse } from '../index.js'
 import GithubIssueDetail from './github-issue-detail.service.js'
-import { issueStateColor, commentsColor } from './github-helpers.js'
+import {
+  issueStateColor,
+  commentsColor,
+  colorForString,
+} from './github-helpers.js'
 
 describe('GithubIssueDetail', function () {
   test(GithubIssueDetail.render, () => {
@@ -90,6 +94,14 @@ describe('GithubIssueDetail', function () {
       message: formatDate('2019-04-02T20:09:31Z'),
       color: age('2019-04-02T20:09:31Z'),
     })
+    given({
+      property: 'milestone',
+      value: 'MS 1',
+    }).expect({
+      label: 'milestone',
+      message: 'MS 1',
+      color: colorForString('MS 1'),
+    })
   })
 
   test(GithubIssueDetail.prototype.transform, () => {
@@ -178,6 +190,18 @@ describe('GithubIssueDetail', function () {
       value: '2019-04-02T20:09:31Z',
       isPR: false,
     })
+    given({
+      property: 'milestone',
+      json: { milestone: { title: 'MS 1' } },
+    }).expect({
+      value: 'MS 1',
+    })
+    given({
+      property: 'milestone',
+      json: { milestone: null },
+    }).expect({
+      value: '---',
+    })
   })
 
   context('transform()', function () {

diff --git a/services/github/github-issue-detail.tester.js b/services/github/github-issue-detail.tester.js
@@ -64,3 +64,17 @@ t.create('github pull request merge state (pull request not found)')
     label: 'issue/pull request',
     message: 'issue, pull request or repo not found',
   })
+
+t.create('github issue milestone')
+  .get('/pulls/detail/milestone/badges/shields/4949.json')
+  .expectBadge({
+    label: 'milestone',
+    message: 'badge-maker v3.4',
+  })
+
+t.create('github issue milestone (without milestone)')
+  .get('/pulls/detail/milestone/badges/shields/979.json')
+  .expectBadge({
+    label: 'milestone',
+    message: '---',
+  })