Files
shields/services/dynamic/dynamic-xml.service.js
Caleb Cartwright ac54dd3ced convert some service classes to static props, run [drone dub dynamic] (#5543)
* refactor(drone): convert to static props

* refactor(dub): convert to static props

* refactor(dynamic): convert to static props
2020-09-15 01:42:57 +00:00

82 lines
2.3 KiB
JavaScript

'use strict'
const { DOMParser } = require('xmldom')
const xpath = require('xpath')
const { MetricNames } = require('../../core/base-service/metric-helper')
const { renderDynamicBadge, errorMessages } = require('../dynamic-common')
const { BaseService, InvalidResponse, InvalidParameter } = require('..')
const { createRoute } = require('./dynamic-helpers')
// This service extends BaseService because it uses a different XML parser
// than BaseXmlService which can be used with xpath.
//
// One way to create a more performant version would be to use the BaseXml
// JSON parser and write the queries in jsonpath instead. Then eventually
// deprecate the old version.
module.exports = class DynamicXml extends BaseService {
static category = 'dynamic'
static enabledMetrics = [MetricNames.SERVICE_RESPONSE_SIZE]
static route = createRoute('xml')
static defaultBadgeData = { label: 'custom badge' }
transform({ pathExpression, buffer }) {
// e.g. //book[2]/@id
const pathIsAttr = (
pathExpression.split('/').slice(-1)[0] || ''
).startsWith('@')
const parsed = new DOMParser().parseFromString(buffer)
let values
try {
values = xpath.select(pathExpression, parsed)
} catch (e) {
throw new InvalidParameter({ prettyMessage: e.message })
}
if (
typeof values === 'string' ||
typeof values === 'number' ||
typeof values === 'boolean'
) {
values = [values]
} else if (Array.isArray(values)) {
values = values.reduce((accum, node) => {
if (pathIsAttr) {
accum.push(node.value)
} else if (node.firstChild) {
accum.push(node.firstChild.data)
} else {
accum.push(node.data)
}
return accum
}, [])
} else {
throw new InvalidResponse({
prettyMessage: 'unsupported query',
})
}
if (!values.length) {
throw new InvalidResponse({ prettyMessage: 'no result' })
}
return { values }
}
async handle(_namedParams, { url, query: pathExpression, prefix, suffix }) {
const { buffer } = await this._request({
url,
options: { headers: { Accept: 'application/xml, text/xml' } },
errorMessages,
})
const { values: value } = this.transform({
pathExpression,
buffer,
})
return renderDynamicBadge({ value, prefix, suffix })
}
}