shields/services/bugzilla/bugzilla.service.js

'use strict'

const Joi = require('@hapi/joi')
const { optionalUrl } = require('../validators')
const { BaseJsonService } = require('..')

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

const schema = Joi.object({
  bugs: Joi.array()
    .items(
      Joi.object({
        status: Joi.string().required(),
        resolution: Joi.string()
          .allow('')
          .required(),
      }).required()
    )
    .min(1)
    .required(),
}).required()

const documentation = `
<p>
  If your Bugzilla badge errors, it might be because you are trying to load a private bug.
</p>
`

module.exports = class Bugzilla extends BaseJsonService {
  static get category() {
    return 'issue-tracking'
  }

  static get route() {
    return {
      base: 'bugzilla',
      pattern: ':bugNumber',
      queryParamSchema,
    }
  }

  static get examples() {
    return [
      {
        title: 'Bugzilla bug status (Mozilla)',
        namedParams: {
          bugNumber: '996038',
        },
        staticPreview: this.render({
          bugNumber: 996038,
          status: 'FIXED',
          resolution: '',
        }),
        documentation,
      },
      {
        title: 'Bugzilla bug status (non-Mozilla)',
        namedParams: {
          bugNumber: '545424',
        },
        queryParams: { baseUrl: 'https://bugs.eclipse.org/bugs' },
        staticPreview: this.render({
          bugNumber: 545424,
          status: 'RESOLVED',
          resolution: 'FIXED',
        }),
        documentation,
      },
    ]
  }

  static get defaultBadgeData() {
    return { label: 'bugzilla' }
  }

  static getDisplayStatus({ status, resolution }) {
    let displayStatus =
      status === 'RESOLVED' ? resolution.toLowerCase() : status.toLowerCase()
    if (displayStatus === 'worksforme') {
      displayStatus = 'works for me'
    }
    if (displayStatus === 'wontfix') {
      displayStatus = "won't fix"
    }
    return displayStatus
  }

  static getColor({ displayStatus }) {
    const colorMap = {
      unconfirmed: 'blue',
      new: 'blue',
      assigned: 'green',
      fixed: 'brightgreen',
      invalid: 'yellow',
      "won't fix": 'orange',
      duplicate: 'lightgrey',
      'works for me': 'yellowgreen',
      incomplete: 'red',
    }
    if (displayStatus in colorMap) {
      return colorMap[displayStatus]
    }
    return 'lightgrey'
  }

  static render({ bugNumber, status, resolution }) {
    const displayStatus = this.getDisplayStatus({ status, resolution })
    const color = this.getColor({ displayStatus })
    return {
      label: `bug ${bugNumber}`,
      message: displayStatus,
      color,
    }
  }

  async fetch({ bugNumber, baseUrl }) {
    return this._requestJson({
      schema,
      url: `${baseUrl}/rest/bug/${bugNumber}`,
    })
  }

  async handle({ bugNumber }, { baseUrl = 'https://bugzilla.mozilla.org' }) {
    const data = await this.fetch({ bugNumber, baseUrl })
    return this.constructor.render({
      bugNumber,
      status: data.bugs[0].status,
      resolution: data.bugs[0].resolution,
    })
  }
}