Add top-helpers command

[marko-radosavljevic]

Overview

Implements and closes #65. Originally based on #117.

Adds the /top-helpers command that computes and displays the top helpers from the last month.

Also has a fallback message if there is no data in the time range yet:

For now the command has no options but it was designed with optionally picking a time range (start and end) in mind. This can be done once Discord/JDA add date-pickers (currently in progress). A TODO in the class keeps track of this.

Details

The code is divided into three classes:

• TopHelpersCommand - the slash command itself, will read the database, compute the message and display it
• TopHelpersMessageListener - the listener that receives all help messages and adjusts the database accordingly
• TopHelpersPurgeMessagesRoutine - the routine that deletes old messages from the database

Slash command

The TopHelpersCommand class is pretty straightforward:

1. Check author permissions, needs "soft moderation role"
2. Compute the time range (last month, this is properly computed with java.time and not just last 30 days)
3. Fetch the top helpers from the database (some groupBy with count and orderBy, nothing fancy)
4. Extra logic if there is no data in the time range
5. Retrieve Member information about those users async
6. Error handler if it fails
7. Success handler that basically stringifies the user data using an external AsciiTable library

Message listener

The TopHelpersMessageListener class has one simple jobs right now:

1. any incoming message will be added to the database table (just ids and timestamps, no content)

latter should in the near future be replaced with #346 , a TODO keeps track of it already.

Help messages are identified by channel name regex (as per MessageReceiverAdapter), the regex is:

"helpChannelPattern": "([a-zA-Z_]+_)?help(_\\d+)?"

In the future, FreeCommand could be changed to utilize this config entry as well, instead of the channel ids.

Message purging

The class TopHelpersPurgeMessagesRoutine is a simple Routine which is executed once every 4 hours and deletes all top-helper message entries in the database that are older than 90 days.

Database

The database table that supports all the magic is quite simple, its just:

CREATE TABLE help_channel_messages
(
    message_id BIGINT    NOT NULL PRIMARY KEY,
    guild_id   BIGINT    NOT NULL,
    channel_id BIGINT    NOT NULL,
    author_id  BIGINT    NOT NULL,
    sent_at    TIMESTAMP NOT NULL
)

Remarks for release

The config has changed, the following has been added:

"helpChannelPattern": "([a-zA-Z_]+_)?help(_\\d+)?"

(see the config.json.template file in the code diff)

[github-actions]

This pull request is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.

[Zabuzard]

Valid but parked, will be picked up by someone soonish (january maybe).

[Zabuzard]

Will take this over but for the moment blocked by #345.

[Zabuzard]

Revived it. It is working again now:

Will polish it now.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

0.0% Coverage
0.0% Duplication

[Zabuzard]

No changes since a week, merging.