Shields.io unable to retrieve Discourse statistics API

Arkshine · November 15, 2023, 7:41pm

Related to:

github.com/discourse/discourse

DEV: Ability to collect stats without exposing them via API

discourse:main ← discourse:dev/ability-to-collect-stats-without-public-exposing

opened 06:37PM - 13 Oct 23 UTC

AndrewPrigorshnev

+228 -119

This adds the ability to collect stats without exposing them among other stats v…ia API. The most important thing I wanted to achieve is to provide an API where stats are not exposed by default, and a developer has to explicitly specify that they should be exposed (`expose_via_api: true`). Implementing an opposite solution would be simpler, but that's less safe in terms of potential security issues. When working on this, I had to refactor the current solution. I would go even further with the refactoring, but the next steps seem to be going too far in changing the solution we have, and that would also take more time. Two things that can be improved in the future: 1. Data structures for holding stats can be further improved 2. Core stats are hard-coded in the About template (it's hard to fix it without correcting data structures first, see point 1): https://github.com/discourse/discourse/blob/63a0700d45f755d0f432a9075ae7afbed9cd6ab0/app/views/about/index.html.erb#L61-L101 The most significant refactorings are: 1. Introducing the `Stat` model 2. Aligning the way the core and the plugin stats' are registered

It’s because a few fields have been renamed in their plural form.

topic_count → topics_count
post_count → posts_count
user_count → users_count
like_count → likes_count

Someone will need to modify the code here to fallback to the plural form:

github.com

badges/shields/blob/master/services/discourse/discourse.service.js

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 schema = Joi.object({
  topic_count: nonNegativeInteger,
  user_count: nonNegativeInteger,
  post_count: nonNegativeInteger,
  like_count: nonNegativeInteger,
}).required()

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

class DiscourseBase extends BaseJsonService {
  static category = 'chat'

This file has been truncated. show original

Topic		Replies	Views
Is there a nice GH badges (ala shields.io images) design to put in README to link from GitHub to our hosted discourse? feature docs-welcome	17	4844	September 13, 2019
Problem linking Discourse forum to WP Discourse wordpress	24	3605	May 4, 2021
Plugin causing errors during rebuild installation	21	1543	November 10, 2022
Twitter, Github and normal username and password logins not working after upgrade installation unsupported-install	35	7045	October 22, 2016
Discourse offline after failed upgrade "bootstrap failed with exit code 5" installation	24	1010	February 22, 2024

Shields.io unable to retrieve Discourse statistics API

Related Topics