shields/services/symfony/symfony-insight-base.js

import Joi from 'joi'
import { BaseXmlService, NotFound } from '../index.js'

const violationSchema = Joi.object({
  severity: Joi.equal('info', 'minor', 'major', 'critical').required(),
}).required()

const schema = Joi.object({
  project: Joi.object({
    'last-analysis': Joi.object({
      status: Joi.equal(
        'ordered',
        'running',
        'measured',
        'analyzed',
        'finished',
      )
        .allow('')
        .required(),
      grade: Joi.equal('platinum', 'gold', 'silver', 'bronze', 'none'),
      violations: Joi.object({
        // RE: https://github.com/NaturalIntelligence/fast-xml-parser/issues/68
        // The BaseXmlService uses the fast-xml-parser which doesn't support forcing
        // the xml nodes to always be parsed as an array. Currently, if the response
        // only contains a single violation then it will be parsed as an object,
        // otherwise it will be parsed as an array.
        violation: Joi.array().items(violationSchema).single().required(),
      }),
    }),
  }).required(),
}).required()

const description =
  'SymfonyInsight (formerly SensioLabs) is a code analysis service'

const gradeColors = {
  none: 'red',
  bronze: '#c88f6a',
  silver: '#c0c0c0',
  gold: '#ebc760',
  platinum: '#e5e4e2',
}

class SymfonyInsightBase extends BaseXmlService {
  static category = 'analysis'

  static auth = {
    userKey: 'sl_insight_userUuid',
    passKey: 'sl_insight_apiToken',
    authorizedOrigins: ['https://insight.symfony.com'],
    isRequired: true,
  }

  static defaultBadgeData = {
    label: 'symfony insight',
  }

  async fetch({ projectUuid }) {
    return this._requestXml(
      this.authHelper.withBasicAuth({
        schema,
        url: `https://insight.symfony.com/api/projects/${projectUuid}`,
        options: {
          headers: { Accept: 'application/vnd.com.sensiolabs.insight+xml' },
        },
        httpErrors: {
          401: 'not authorized to access project',
          404: 'project not found',
        },
        parserOptions: {
          attributeNamePrefix: '',
          ignoreAttributes: false,
        },
      }),
    )
  }

  transform({ data }) {
    const lastAnalysis = data.project['last-analysis']

    if (!lastAnalysis) {
      throw new NotFound({ prettyMessage: 'no analyses found' })
    }

    let numViolations = 0
    let numCriticalViolations = 0
    let numMajorViolations = 0
    let numMinorViolations = 0
    let numInfoViolations = 0

    const violationContainer = lastAnalysis.violations
    if (violationContainer && violationContainer.violation) {
      let violations = []
      // See above note on schema RE: https://github.com/NaturalIntelligence/fast-xml-parser/issues/68
      // This covers the scenario of multiple violations which are parsed as an array and single
      // violations which is parsed as a single object.
      if (Array.isArray(violationContainer.violation)) {
        violations = violationContainer.violation
      } else {
        violations.push(violationContainer.violation)
      }
      numViolations = violations.length
      violations.forEach(violation => {
        if (violation.severity === 'critical') {
          numCriticalViolations++
        } else if (violation.severity === 'major') {
          numMajorViolations++
        } else if (violation.severity === 'minor') {
          numMinorViolations++
        } else {
          numInfoViolations++
        }
      })
    }

    return {
      status: lastAnalysis.status,
      grade: lastAnalysis.grade,
      numViolations,
      numCriticalViolations,
      numMajorViolations,
      numMinorViolations,
      numInfoViolations,
    }
  }
}

export { SymfonyInsightBase, description, gradeColors }