add generic [GithubIssuesSearch] badges (#5976)

Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>

services/github/github-issues-search.service.js

@@ -0,0 +1,112 @@
+'use strict'
+
+const gql = require('graphql-tag')
+const Joi = require('joi')
+const { metric } = require('../text-formatters')
+const { nonNegativeInteger } = require('../validators')
+const { GithubAuthV4Service } = require('./github-auth-service')
+const { documentation, transformErrors } = require('./github-helpers')
+
+const issueCountSchema = Joi.object({
+  data: Joi.object({
+    search: Joi.object({
+      issueCount: nonNegativeInteger,
+    }).required(),
+  }).required(),
+}).required()
+
+const queryParamSchema = Joi.object({
+  query: Joi.string().required(),
+}).required()
+
+class BaseGithubIssuesSearch extends GithubAuthV4Service {
+  static category = 'issue-tracking'
+  static defaultBadgeData = { label: 'query', color: 'informational' }
+
+  static render({ issueCount }) {
+    return { message: metric(issueCount) }
+  }
+
+  async fetch({ query }) {
+    const data = await this._requestGraphql({
+      query: gql`
+        query($query: String!) {
+          search(query: $query, type: ISSUE) {
+            issueCount
+          }
+        }
+      `,
+      variables: { query },
+      schema: issueCountSchema,
+      transformErrors,
+    })
+    return data.data.search.issueCount
+  }
+}
+
+class GithubIssuesSearch extends BaseGithubIssuesSearch {
+  static route = {
+    base: 'github',
+    pattern: 'issues-search',
+    queryParamSchema,
+  }
+
+  static examples = [
+    {
+      title: 'GitHub issue custom search',
+      namedParams: {},
+      queryParams: {
+        query: 'repo:badges/shields is:closed label:bug author:app/sentry-io',
+      },
+      staticPreview: {
+        label: 'query',
+        message: '10',
+        color: 'blue',
+      },
+      documentation,
+    },
+  ]
+
+  async handle(namedParams, { query }) {
+    const issueCount = await this.fetch({ query })
+    return this.constructor.render({ issueCount })
+  }
+}
+
+class GithubRepoIssuesSearch extends BaseGithubIssuesSearch {
+  static route = {
+    base: 'github',
+    pattern: 'issues-search/:user/:repo',
+    queryParamSchema,
+  }
+
+  static examples = [
+    {
+      title: 'GitHub issue custom search in repo',
+      namedParams: {
+        user: 'badges',
+        repo: 'shields',
+      },
+      queryParams: {
+        query: 'is:closed label:bug author:app/sentry-io',
+      },
+      staticPreview: {
+        label: 'query',
+        message: '10',
+        color: 'blue',
+      },
+      documentation,
+    },
+  ]
+
+  async handle({ user, repo }, { query }) {
+    query = `repo:${user}/${repo} ${query}`
+    const issueCount = await this.fetch({ query })
+    return this.constructor.render({ issueCount })
+  }
+}
+
+module.exports = {
+  GithubIssuesSearch,
+  GithubRepoIssuesSearch,
+}

services/github/github-issues-search.tester.js

@@ -0,0 +1,50 @@
+'use strict'
+
+const { isMetric } = require('../test-validators')
+const { ServiceTester } = require('../tester')
+const t = (module.exports = new ServiceTester({
+  id: 'GithubIssuesSearch',
+  title: 'Github Issues Search',
+  pathPrefix: '/github',
+}))
+
+t.create('GitHub issue search (valid query string)')
+  .get(
+    '/issues-search.json?query=repo%3Abadges%2Fshields%20is%3Aclosed%20label%3Ablocker%20'
+  )
+  .expectBadge({
+    label: 'query',
+    message: isMetric,
+  })
+
+t.create('GitHub issue search (invalid query string)')
+  .get('/issues-search.json?query=')
+  .expectBadge({
+    label: 'query',
+    message: 'invalid query parameter: query',
+  })
+
+t.create('GitHub Repo issue search (valid query string)')
+  .get(
+    '/issues-search/badges/shields.json?query=is%3Aclosed%20label%3Ablocker%20'
+  )
+  .expectBadge({
+    label: 'query',
+    message: isMetric,
+  })
+
+t.create('GitHub Repo issue search (invalid query string)')
+  .get('/issues-search/badges/shields.json?query=')
+  .expectBadge({
+    label: 'query',
+    message: 'invalid query parameter: query',
+  })
+
+t.create('GitHub Repo issue search (invalid repo)')
+  .get(
+    '/issues-search/badges/helmets.json?query=is%3Aclosed%20label%3Ablocker%20'
+  )
+  .expectBadge({
+    label: 'query',
+    message: '0',
+  })