Add Starboard support #881

java-coding-prodigy · 2023-09-10T17:09:55Z

This feature adds a Starboard.
Certain emojis which when added as a reaction to a message in a channel which everyone has permissions to, will be sent as an embed in the starboard channel.
Both the emojis and the channel are customizable through config.json

Zabuzard · 2023-09-11T07:32:34Z

application/config.json.template

@@ -95,4 +95,8 @@
        "rateLimitWindowSeconds": 10,
        "rateLimitRequestsInWindow": 3
    }
+    "starboard": {
+        "emojiNames" : ["star"],
+        "channelName": "starboard"


channelNamePattern please (and in the code Pattern.compile(...) then, matching the channel)

In that case, I would only have one pattern and not an array right? The design you are referring to I presume is the one where if the user wants multiple emojis they would need to seperate it by a pipe?

the emoij names can stay non-pattern like that. but the channel name should be a pattern, so that we have some flexibility in naming it.

Zabuzard · 2023-09-11T07:33:19Z

application/src/main/java/org/togetherjava/tjbot/config/Config.java

+     * Gets the config for the Starboard Contains the List of emoji names recognized by the
+     * starboard as well as the name of the channel with the starboard.


these details are outdated extremely quick, cause people editing the config wont notice that its duplicated here. get rid of that. instead, describe what a starboard is.

Zabuzard · 2023-09-11T07:33:44Z

application/src/main/java/org/togetherjava/tjbot/config/StarboardConfig.java

+import java.util.Objects;
+
+@JsonRootName("starboard")
+public final class StarboardConfig {


missing javadoc

Zabuzard · 2023-09-11T07:33:48Z

application/src/main/java/org/togetherjava/tjbot/config/StarboardConfig.java

+    private final String channelName;
+
+    @JsonCreator(mode = JsonCreator.Mode.PROPERTIES)
+    public StarboardConfig(


missing javadoc

Zabuzard · 2023-09-11T07:34:41Z

application/src/main/java/org/togetherjava/tjbot/config/StarboardConfig.java

+     * Gets the name of the channel with the starboard Deactivate by using a non-existent channel
+     * name
+     * 
+     * @return the name of the channel with the starboard
+     */
+    public String getChannelName() {
+        return channelName;
+    }


(pattern, see earlier)
missing dot in the first and second sentence.

Zabuzard · 2023-09-11T07:38:00Z

application/src/main/java/org/togetherjava/tjbot/features/basic/Starboard.java

+        if (database.read(context -> context.selectFrom(STARBOARD_MESSAGES)
+            .fetch("message_id")
+            .contains(event.getMessageIdLong()))) {


too complex for a if, put it into a helper method

Zabuzard · 2023-09-11T07:39:10Z

application/src/main/java/org/togetherjava/tjbot/features/basic/Starboard.java

+            .queue();
+    }
+
+    private boolean ignoreMessage(String emojiName, Guild guild, GuildChannel channel) {


bad method name. its missing a shouldXXX, otherwise it sounds as if this method, when called, will ignore the message

Zabuzard · 2023-09-11T07:40:20Z

application/src/main/java/org/togetherjava/tjbot/features/basic/Starboard.java

+        User author = message.getAuthor();
+        return new EmbedBuilder().setAuthor(author.getName(), null, author.getAvatarUrl())
+            .setDescription(message.getContentDisplay())
+            .build(); // TODO make footer with link and reacted emojis


TODO (dont forget)

Sonar and CodeQL won't let me forget it. :)

Zabuzard · 2023-09-11T07:40:31Z

application/src/main/resources/db/V14__Add_Starboard.sql

+CREATE TABLE starboard_messages
+(message_id BIGINT NOT NULL PRIMARY KEY
+)


formatting looks a bit weird with the (

Zabuzard · 2023-09-11T07:42:30Z

application/src/main/java/org/togetherjava/tjbot/features/basic/Starboard.java

+        if (database.read(context -> context.selectFrom(STARBOARD_MESSAGES)
+            .fetch("message_id")
+            .contains(event.getMessageIdLong()))) {
+            database.write(context -> context.newRecord(STARBOARD_MESSAGES)
+                .setMessageId(event.getMessageIdLong()));
+        }


whats the point of the database entry? its not used anywhere right now. id guess u want to check whether it exists to not duplicate-post? but that check seems to be missing right now.

also, u will have to additionally put an in-memory cache as layer above the DB to prevent checking the DB a million times in 5 seconds when someone posts an announcement. u can look in some of the other classes for that, search for Caffeine(cache).

The database is being used for the check, that is what the if is for. However the current approach seems to be insanely slow as I fetch the entire list of entries.

I'll look into it.

i think your missing my point on the question. what is the point of the database entry? it does not control any logic right now.
you have:

if (database doesnt contain it) { put it into database }

but thats it. what point does it serve, sitting in the db? theres nothing in ur code that would control anything based on it.

u likely intended to stop transfering the message if its contained in the db, i.e.

if (database does not contain it) { copy message to starboard }

but u dont have that. you always copy the message to the starboard, regardless of database

Oh oops. Ur right mb 😅

java-coding-prodigy · 2023-10-06T13:06:31Z

Uh oh.
I did something wrong apparently.
Well what happened was I just reset my state softly to the first commit. Then cherry-picked #902 ‘s commit and applied all the changes of the stash.
But now even the changes of those commits which have been merged into develop from other branches are showing up in the diff which makes no sense to me.

java-coding-prodigy · 2023-10-06T13:34:01Z

Issue seems to be resolved after fixing merge conflicts. Weird but I’ll take it.

Taz03 · 2023-10-08T18:26:15Z

application/src/main/java/org/togetherjava/tjbot/features/basic/Starboard.java

+    private static MessageEmbed formEmbed(Message message) {
+        User author = message.getAuthor();
+        return new EmbedBuilder().setAuthor(author.getName(), null, author.getAvatarUrl())
+            .setDescription(message.getContentDisplay())
+            .appendDescription(" [Link](%s)".formatted(message.getJumpUrl()))
+            .build();
+    }


can u also check for attachments and add that in the embed

I set the image of the embed as the first image file in the attachments, if any.

sonarcloud · 2023-11-05T12:14:22Z

SonarCloud Quality Gate failed.

0 Bugs
0 Vulnerabilities
0 Security Hotspots
5 Code Smells

0.0% Coverage
0.0% Duplication

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

sonarcloud · 2024-04-01T06:25:47Z

Quality Gate failed

Failed conditions
2 New Major Issues (required ≤ 0)
2 New Critical Issues (required ≤ 0)

See analysis details on SonarCloud

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

sonarcloud · 2024-05-07T17:06:14Z

Quality Gate failed

Failed conditions
2 New Critical Issues (required ≤ 0)
2 New Major Issues (required ≤ 0)

See analysis details on SonarCloud

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

java-coding-prodigy requested review from a team as code owners September 10, 2023 17:09

java-coding-prodigy marked this pull request as draft September 10, 2023 17:23

Zabuzard assigned java-coding-prodigy Sep 11, 2023

Zabuzard added enhancement New feature or request priority: normal labels Sep 11, 2023

Zabuzard requested changes Sep 11, 2023

View reviewed changes

java-coding-prodigy marked this pull request as ready for review October 1, 2023 17:33

java-coding-prodigy requested a review from Zabuzard October 2, 2023 09:02

java-coding-prodigy force-pushed the oofs_and_lmaos branch from 5267e3f to 9e129af Compare October 6, 2023 12:58

Taz03 requested changes Oct 8, 2023

View reviewed changes

ankitsmt211 mentioned this pull request Feb 21, 2024

Cool messages board feature #1027

Open

java-coding-prodigy force-pushed the oofs_and_lmaos branch from aef2361 to 9a43a3a Compare April 1, 2024 06:03

java-coding-prodigy added 9 commits May 7, 2024 13:06

Set up config and create reaction listener

a018539

squashed everything(kinda)

fdd7bce

oops

1aa16c6

uh do stuff that need to be done

e165c8c

some necessary stuff

eda96c5

started working

5d4770b

Added negative effect, bit spaghetti rn

4417dd1

some scrambling unsrcambled

6de1451

fix template

2127d4f

java-coding-prodigy force-pushed the oofs_and_lmaos branch from 39d1e71 to 2127d4f Compare May 7, 2024 16:58

update...

59dc7be

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Starboard support #881

Add Starboard support #881

java-coding-prodigy commented Sep 10, 2023

Zabuzard Sep 11, 2023

java-coding-prodigy Sep 13, 2023 •

edited

Loading

Zabuzard Sep 13, 2023

Zabuzard Sep 11, 2023

Zabuzard Sep 11, 2023

Zabuzard Sep 11, 2023

Zabuzard Sep 11, 2023

Zabuzard Sep 11, 2023

Zabuzard Sep 11, 2023

Zabuzard Sep 11, 2023

java-coding-prodigy Sep 13, 2023

Zabuzard Sep 11, 2023

Zabuzard Sep 11, 2023

java-coding-prodigy Sep 13, 2023

Zabuzard Sep 13, 2023

java-coding-prodigy Sep 15, 2023

java-coding-prodigy commented Oct 6, 2023

java-coding-prodigy commented Oct 6, 2023

Taz03 Oct 8, 2023

java-coding-prodigy Oct 16, 2023

sonarcloud bot commented Nov 5, 2023

sonarcloud bot commented Apr 1, 2024

sonarcloud bot commented May 7, 2024

		* Gets the config for the Starboard Contains the List of emoji names recognized by the
		* starboard as well as the name of the channel with the starboard.

Add Starboard support #881

Are you sure you want to change the base?

Add Starboard support #881

Conversation

java-coding-prodigy commented Sep 10, 2023

Choose a reason for hiding this comment

java-coding-prodigy Sep 13, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

java-coding-prodigy commented Oct 6, 2023

java-coding-prodigy commented Oct 6, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarcloud bot commented Nov 5, 2023

sonarcloud bot commented Apr 1, 2024

Quality Gate failed

sonarcloud bot commented May 7, 2024

Quality Gate failed

java-coding-prodigy Sep 13, 2023 •

edited

Loading