FEATURE: Add plugin API to register About stat group (#17442)

This commit introduces a new plugin API to register
a group of stats that will be included in about.json
and also conditionally in the site about UI at /about.

The usage is like this:

```ruby
register_about_stat_group("chat_messages", show_in_ui: true) do
  {
    last_day: 1,
    "7_days" => 10,
    "30_days" => 100,
    count: 1000,
    previous_30_days: 120
  }
end
```

In reality the stats will be generated any way the implementer
chooses within the plugin. The `last_day`, `7_days`, `30_days,` and `count`
keys must be present but apart from that additional stats may be added.
Only those core 4 stat keys will be shown in the UI, but everything will be shown
in about.json.

The stat group name is used to prefix the stats in about.json like so:

```json
"chat_messages_last_day": 2322,
"chat_messages_7_days": 2322,
"chat_messages_30_days": 2322,
"chat_messages_count": 2322,
```

The `show_in_ui` option (default false) is used to determine whether the
group of stats is shown on the site About page in the Site Statistics
table. Some stats may be needed purely for reporting purposes and thus
do not need to be shown in the UI to admins/users. An extension to the Site
serializer, `displayed_about_plugin_stat_groups`, has been added so this
can be inspected on the client-side.
This commit is contained in:
Martin Brennan
2022-07-15 13:16:00 +10:00
committed by GitHub
parent 8dad778fcc
commit 098ab29d41
12 changed files with 249 additions and 11 deletions

View File

@ -499,11 +499,11 @@ describe Plugin::Instance do
describe '#register_reviewable_types' do
it 'Overrides the existing Reviewable types adding new ones' do
current_types = Reviewable.types
new_type_class = Class
new_type_class = Class
Plugin::Instance.new.register_reviewable_type new_type_class
Plugin::Instance.new.register_reviewable_type new_type_class
expect(Reviewable.types).to match_array(current_types << new_type_class.name)
expect(Reviewable.types).to match_array(current_types << new_type_class.name)
end
end
@ -742,4 +742,35 @@ describe Plugin::Instance do
expect(UnsubscribeKey.get_unsubscribe_strategy_for(key).class).to eq(CustomUnsubscriber)
end
end
describe "#register_about_stat_group" do
let(:plugin) { Plugin::Instance.new }
after do
About.clear_plugin_stat_groups
end
it "registers an about stat group correctly" do
stats = { last_day: 1, "7_days" => 10, "30_days" => 100, count: 1000 }
plugin.register_about_stat_group("some_group", show_in_ui: true) do
stats
end
expect(About.new.plugin_stats.with_indifferent_access).to match(
hash_including(
some_group_last_day: 1,
some_group_7_days: 10,
some_group_30_days: 100,
some_group_count: 1000,
)
)
end
it "hides the stat group from the UI by default" do
stats = { last_day: 1, "7_days" => 10, "30_days" => 100, count: 1000 }
plugin.register_about_stat_group("some_group") do
stats
end
expect(About.displayed_plugin_stat_groups).to eq([])
end
end
end