f6e40a600e
* Discourse: Update schema to use plural keys
(e.g. topic_count -> topics_countN)
* Revert "Discourse: Update schema to use plural keys"
This reverts commit 4073a17aaa.
* `discourse.service.js`: Add `Joi.alternatives` plural schema
* `discourse.service.js`: Update func to be plural-agnostic
Previously, for e.g. 'topic', the call to the `DiscourseMetricIntegrationFactory` function supplied both 'topics' and 'topic_count'. And, we now need to check for 'topics_count' as well. To cover all three string variations, why not supply only 'topic' to the function, then selectively add the 's' on a case-by-case basis.
((Note: I've preserved the old metricName variable as to minimize the diff here and make my changes clearer.))
* `discourse.tester.js`: Add second `data` case
* Address Prettier linting warnings
124 lines
3.2 KiB
JavaScript
124 lines
3.2 KiB
JavaScript
import camelcase from 'camelcase'
|
|
import Joi from 'joi'
|
|
import { metric } from '../text-formatters.js'
|
|
import { nonNegativeInteger, optionalUrl } from '../validators.js'
|
|
import { BaseJsonService } from '../index.js'
|
|
|
|
const schemaSingular = Joi.object({
|
|
topic_count: nonNegativeInteger,
|
|
user_count: nonNegativeInteger,
|
|
post_count: nonNegativeInteger,
|
|
like_count: nonNegativeInteger,
|
|
}).required()
|
|
|
|
const schemaPlural = Joi.object({
|
|
topics_count: nonNegativeInteger,
|
|
users_count: nonNegativeInteger,
|
|
posts_count: nonNegativeInteger,
|
|
likes_count: nonNegativeInteger,
|
|
})
|
|
|
|
const schema = Joi.alternatives(schemaSingular, schemaPlural)
|
|
|
|
const queryParamSchema = Joi.object({
|
|
server: optionalUrl.required(),
|
|
}).required()
|
|
|
|
class DiscourseBase extends BaseJsonService {
|
|
static category = 'chat'
|
|
|
|
static buildRoute(metric) {
|
|
return {
|
|
base: 'discourse',
|
|
pattern: metric,
|
|
queryParamSchema,
|
|
}
|
|
}
|
|
|
|
static defaultBadgeData = { label: 'discourse' }
|
|
|
|
async fetch({ server }) {
|
|
return this._requestJson({
|
|
schema,
|
|
url: `${server}/site/statistics.json`,
|
|
})
|
|
}
|
|
}
|
|
|
|
function DiscourseMetricIntegrationFactory({ metricType }) {
|
|
// We supply the singular form to more easily check against both schemas.
|
|
// But, we use the plural form as the metric name for grammatical reasons.
|
|
const metricName = `${metricType}s`
|
|
return class DiscourseMetric extends DiscourseBase {
|
|
// The space is needed so we get 'DiscourseTopics' rather than
|
|
// 'Discoursetopics'. `camelcase()` removes it.
|
|
static name = camelcase(`Discourse ${metricName}`, { pascalCase: true })
|
|
static route = this.buildRoute(metricName)
|
|
|
|
static examples = [
|
|
{
|
|
title: `Discourse ${metricName}`,
|
|
namedParams: {},
|
|
queryParams: {
|
|
server: 'https://meta.discourse.org',
|
|
},
|
|
staticPreview: this.render({ stat: 100 }),
|
|
},
|
|
]
|
|
|
|
static render({ stat }) {
|
|
return {
|
|
message: `${metric(stat)} ${metricName}`,
|
|
color: 'brightgreen',
|
|
}
|
|
}
|
|
|
|
async handle(_routeParams, { server }) {
|
|
const data = await this.fetch({ server })
|
|
// e.g. metricType == 'topic' --> try 'topic_count' then 'topics_count'
|
|
let stat = data[`${metricType}_count`]
|
|
if (stat === undefined) {
|
|
stat = data[`${metricType}s_count`]
|
|
}
|
|
return this.constructor.render({ stat })
|
|
}
|
|
}
|
|
}
|
|
|
|
class DiscourseStatus extends DiscourseBase {
|
|
static route = this.buildRoute('status')
|
|
static examples = [
|
|
{
|
|
title: 'Discourse status',
|
|
namedParams: {},
|
|
queryParams: {
|
|
server: 'https://meta.discourse.org',
|
|
},
|
|
staticPreview: this.render(),
|
|
},
|
|
]
|
|
|
|
static render() {
|
|
return {
|
|
message: 'online',
|
|
color: 'brightgreen',
|
|
}
|
|
}
|
|
|
|
async handle(_routeParams, { server }) {
|
|
await this.fetch({ server })
|
|
// if fetch() worked, the server is up
|
|
// if it failed, we'll show an error e.g: 'inaccessible'
|
|
return this.constructor.render()
|
|
}
|
|
}
|
|
|
|
const metricIntegrations = [
|
|
{ metricType: 'topic' },
|
|
{ metricType: 'user' },
|
|
{ metricType: 'post' },
|
|
{ metricType: 'like' },
|
|
].map(DiscourseMetricIntegrationFactory)
|
|
|
|
export default [...metricIntegrations, DiscourseStatus]
|