shields/services/bitbucket/bitbucket-pull-request.service.js

'use strict'

const Joi = require('joi')
const serverSecrets = require('../../lib/server-secrets')
const { metric } = require('../../lib/text-formatters')
const { nonNegativeInteger, optionalUrl } = require('../validators')
const { BaseJsonService } = require('..')

const bitbucketPullRequestSchema = Joi.object({
  size: nonNegativeInteger,
}).required()

const queryParamSchema = Joi.object({
  server: optionalUrl,
}).required()

function pullRequestClassGenerator(raw) {
  const routePrefix = raw ? 'pr-raw' : 'pr'
  const badgeSuffix = raw ? '' : ' open'

  return class BitbucketPullRequest extends BaseJsonService {
    async fetchCloud({ args, user, repo }) {
      args.url = `https://bitbucket.org/api/2.0/repositories/${user}/${repo}/pullrequests/`
      args.options = { qs: { state: 'OPEN', limit: 0 } }

      if (
        serverSecrets.bitbucket_username &&
        serverSecrets.bitbucket_password
      ) {
        args.options.auth = {
          user: serverSecrets.bitbucket_username,
          pass: serverSecrets.bitbucket_password,
        }
      }

      return this._requestJson(args)
    }

    // https://docs.atlassian.com/bitbucket-server/rest/5.16.0/bitbucket-rest.html#idm46229602363312
    async fetchServer({ args, server, user, repo }) {
      args.url = `${server}/rest/api/1.0/projects/${user}/repos/${repo}/pull-requests`
      args.options = {
        qs: {
          state: 'OPEN',
          limit: 100,
          withProperties: false,
          withAttributes: false,
        },
      }

      if (
        serverSecrets.bitbucket_server_username &&
        serverSecrets.bitbucket_server_password
      ) {
        args.options.auth = {
          user: serverSecrets.bitbucket_server_username,
          pass: serverSecrets.bitbucket_server_password,
        }
      }

      return this._requestJson(args)
    }

    async fetch({ server, user, repo }) {
      const args = {
        schema: bitbucketPullRequestSchema,
        errorMessages: {
          401: 'invalid credentials',
          403: 'private repo',
          404: 'not found',
        },
      }

      if (server !== undefined) {
        return this.fetchServer({ args, server, user, repo })
      } else {
        return this.fetchCloud({ args, user, repo })
      }
    }

    static render({ prs }) {
      return {
        message: `${metric(prs)}${badgeSuffix}`,
        color: prs ? 'yellow' : 'brightgreen',
      }
    }

    async handle({ user, repo }, { server }) {
      const data = await this.fetch({ server, user, repo })
      return this.constructor.render({ prs: data.size })
    }

    static get category() {
      return 'issue-tracking'
    }

    static get defaultBadgeData() {
      return { label: 'pull requests' }
    }

    static get route() {
      return {
        base: `bitbucket/${routePrefix}`,
        pattern: `:user/:repo`,
        queryParamSchema,
      }
    }

    static get examples() {
      return [
        {
          title: 'Bitbucket open pull requests',
          namedParams: {
            user: 'atlassian',
            repo: 'python-bitbucket',
          },
          staticPreview: this.render({ prs: 22 }),
        },
        {
          title: 'Bitbucket Server open pull requests',
          namedParams: {
            user: 'foo',
            repo: 'bar',
          },
          queryParams: { server: 'https://bitbucket.mydomain.net' },
          staticPreview: this.render({ prs: 42 }),
        },
      ]
    }
  }
}

module.exports = [true, false].map(pullRequestClassGenerator)