Merge pull request #366 from danthe1st/fix-duplicate-state-listener

make sure that StateListener is not registered twice

Author: jasonlessenich

src/main/java/net/javadiscord/javabot/Bot.java

@@ -30,8 +30,9 @@
 import net.dv8tion.jda.api.entities.Message;
 import net.dv8tion.jda.api.hooks.ListenerAdapter;
 import net.dv8tion.jda.api.utils.messages.MessageRequest;
+import net.javadiscord.javabot.annotations.AutoDetectableComponentHandler;
+import net.javadiscord.javabot.annotations.PreRegisteredListener;
 import net.javadiscord.javabot.data.config.BotConfig;
-import net.javadiscord.javabot.systems.AutoDetectableComponentHandler;
 import net.javadiscord.javabot.tasks.PresenceUpdater;
 import net.javadiscord.javabot.util.ExceptionLogger;
 
@@ -57,7 +58,9 @@ public class Bot {
 
 	private void addEventListeners(final List<ListenerAdapter> listeners) {
 		for (ListenerAdapter listener : listeners) {
-			dih4jda.getJDA().addEventListener(listener);
+			if(!(listener.getClass().isAnnotationPresent(PreRegisteredListener.class))) {
+				dih4jda.getJDA().addEventListener(listener);
+			}
 		}
 		dih4jda.getJDA().addEventListener(dih4jda);
 	}

src/main/java/net/javadiscord/javabot/SpringConfig.java

@@ -1,12 +1,14 @@
 package net.javadiscord.javabot;
 
 import java.nio.file.Path;
+import java.util.Collection;
 import java.util.concurrent.Executors;
 import java.util.concurrent.ScheduledExecutorService;
 
 import javax.security.auth.login.LoginException;
 import javax.sql.DataSource;
 
+import org.springframework.context.ApplicationContext;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
@@ -24,10 +26,10 @@
 import net.dv8tion.jda.api.utils.ChunkingFilter;
 import net.dv8tion.jda.api.utils.MemberCachePolicy;
 import net.dv8tion.jda.api.utils.cache.CacheFlag;
+import net.javadiscord.javabot.annotations.PreRegisteredListener;
 import net.javadiscord.javabot.data.config.BotConfig;
 import net.javadiscord.javabot.data.config.SystemsConfig;
 import net.javadiscord.javabot.data.h2db.DbHelper;
-import net.javadiscord.javabot.listener.StateListener;
 import net.javadiscord.javabot.tasks.PresenceUpdater;
 
 /**
@@ -64,19 +66,20 @@ public SystemsConfig systemsConfig(BotConfig botConfig) {
 	/**
 	 * Initializes the {@link JDA} instances.
 	 * @param botConfig the main configuration of the bot
-	 * @param stateListener The {@link StateListener} which is listening for JDA lifecycle events and needs to be added before JDA is fully initialized
+	 * @param ctx the Spring application context used for obtaining all listeners
 	 * @return the initialized {@link JDA} object
 	 * @throws LoginException if the token is invalid
 	 */
 	@Bean
-	public JDA jda(BotConfig botConfig, StateListener stateListener) throws LoginException {
+	public JDA jda(BotConfig botConfig, ApplicationContext ctx) throws LoginException {
+		Collection<Object> listeners = ctx.getBeansWithAnnotation(PreRegisteredListener.class).values();
 		return JDABuilder.createDefault(botConfig.getSystems().getJdaBotToken())
 			.setStatus(OnlineStatus.DO_NOT_DISTURB)
 			.setChunkingFilter(ChunkingFilter.ALL)
 			.setMemberCachePolicy(MemberCachePolicy.ALL)
 			.enableCache(CacheFlag.ACTIVITY)
 			.enableIntents(GatewayIntent.GUILD_MEMBERS, GatewayIntent.GUILD_PRESENCES, GatewayIntent.MESSAGE_CONTENT)
-			.addEventListeners(stateListener)
+			.addEventListeners(listeners.toArray())
 			.build();
 	}
 

…tems/AutoDetectableComponentHandler.java …ions/AutoDetectableComponentHandler.javasrc/main/java/net/javadiscord/javabot/systems/AutoDetectableComponentHandler.java renamed to src/main/java/net/javadiscord/javabot/annotations/AutoDetectableComponentHandler.java src/main/java/net/javadiscord/javabot/systems/AutoDetectableComponentHandler.java renamed to src/main/java/net/javadiscord/javabot/annotations/AutoDetectableComponentHandler.java

@@ -1,4 +1,4 @@
-package net.javadiscord.javabot.systems;
+package net.javadiscord.javabot.annotations;
 
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;

src/main/java/net/javadiscord/javabot/annotations/PreRegisteredListener.java

@@ -0,0 +1,19 @@
+package net.javadiscord.javabot.annotations;
+
+import static java.lang.annotation.ElementType.TYPE;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+/**
+ * Marks JDA listeners to be registered before JDA is initialized.
+ *
+ * Only {@link net.dv8tion.jda.api.hooks.EventListener EventListener}s should be annoted with this annotation.
+ * All listeners overriding {@link net.dv8tion.jda.api.hooks.EventListener#onReady(net.dv8tion.jda.api.events.session.ReadyEvent) onReady} should be annotated with this annotation.
+ */
+@Retention(RUNTIME)
+@Target(TYPE)
+public @interface PreRegisteredListener {
+
+}

src/main/java/net/javadiscord/javabot/data/h2db/commands/QuickMigrateSubcommand.java

@@ -12,8 +12,8 @@
 import net.dv8tion.jda.api.interactions.components.text.TextInput;
 import net.dv8tion.jda.api.interactions.components.text.TextInputStyle;
 import net.dv8tion.jda.api.interactions.modals.ModalMapping;
+import net.javadiscord.javabot.annotations.AutoDetectableComponentHandler;
 import net.javadiscord.javabot.data.config.SystemsConfig;
-import net.javadiscord.javabot.systems.AutoDetectableComponentHandler;
 import net.javadiscord.javabot.util.ExceptionLogger;
 import net.javadiscord.javabot.util.Responses;
 import org.jetbrains.annotations.NotNull;

src/main/java/net/javadiscord/javabot/listener/StateListener.java

@@ -10,6 +10,7 @@
 import net.dv8tion.jda.api.events.session.SessionRecreateEvent;
 import net.dv8tion.jda.api.events.session.ShutdownEvent;
 import net.dv8tion.jda.api.hooks.ListenerAdapter;
+import net.javadiscord.javabot.annotations.PreRegisteredListener;
 import net.javadiscord.javabot.data.config.BotConfig;
 import net.javadiscord.javabot.data.config.guild.HelpConfig;
 import net.javadiscord.javabot.data.h2db.DbActions;
@@ -34,6 +35,7 @@
  */
 @Slf4j
 @RequiredArgsConstructor
+@PreRegisteredListener
 public class StateListener extends ListenerAdapter {
 	private final NotificationService notificationService;
 	private final CustomTagManager customTagManager;

src/main/java/net/javadiscord/javabot/systems/help/HelpChannelInteractionManager.java

@@ -9,10 +9,10 @@
 import net.dv8tion.jda.api.entities.channel.concrete.TextChannel;
 import net.dv8tion.jda.api.events.interaction.component.ButtonInteractionEvent;
 import net.dv8tion.jda.api.interactions.components.buttons.Button;
+import net.javadiscord.javabot.annotations.AutoDetectableComponentHandler;
 import net.javadiscord.javabot.data.config.BotConfig;
 import net.javadiscord.javabot.data.config.guild.HelpConfig;
 import net.javadiscord.javabot.data.h2db.DbActions;
-import net.javadiscord.javabot.systems.AutoDetectableComponentHandler;
 import net.javadiscord.javabot.systems.help.model.ChannelReservation;
 import net.javadiscord.javabot.systems.help.model.HelpTransactionMessage;
 import net.javadiscord.javabot.util.ExceptionLogger;

src/main/java/net/javadiscord/javabot/systems/help/forum/ForumHelpListener.java

@@ -19,11 +19,11 @@
 import net.dv8tion.jda.api.interactions.components.ActionComponent;
 import net.dv8tion.jda.api.interactions.components.ActionRow;
 import net.dv8tion.jda.api.interactions.components.buttons.Button;
+import net.javadiscord.javabot.annotations.AutoDetectableComponentHandler;
 import net.javadiscord.javabot.data.config.BotConfig;
 import net.javadiscord.javabot.data.config.guild.HelpConfig;
 import net.javadiscord.javabot.data.h2db.DbActions;
 import net.javadiscord.javabot.data.config.guild.HelpForumConfig;
-import net.javadiscord.javabot.systems.AutoDetectableComponentHandler;
 import net.javadiscord.javabot.systems.help.HelpChannelManager;
 import net.javadiscord.javabot.systems.help.HelpExperienceService;
 import net.javadiscord.javabot.systems.help.dao.HelpAccountRepository;

src/main/java/net/javadiscord/javabot/systems/moderation/report/ReportManager.java

@@ -22,11 +22,11 @@
 import net.dv8tion.jda.api.interactions.components.text.TextInput;
 import net.dv8tion.jda.api.interactions.components.text.TextInputStyle;
 import net.dv8tion.jda.api.interactions.modals.ModalMapping;
+import net.javadiscord.javabot.annotations.AutoDetectableComponentHandler;
 import net.javadiscord.javabot.data.config.BotConfig;
 import net.dv8tion.jda.api.requests.restaction.WebhookMessageCreateAction;
 import net.javadiscord.javabot.data.config.GuildConfig;
 import net.javadiscord.javabot.data.config.guild.ModerationConfig;
-import net.javadiscord.javabot.systems.AutoDetectableComponentHandler;
 import net.javadiscord.javabot.util.InteractionUtils;
 import net.javadiscord.javabot.util.Responses;
 import org.jetbrains.annotations.NotNull;

src/main/java/net/javadiscord/javabot/systems/qotw/commands/questions_queue/AddQuestionSubcommand.java

@@ -10,7 +10,7 @@
 import net.dv8tion.jda.api.interactions.components.text.TextInputStyle;
 import net.dv8tion.jda.api.interactions.modals.ModalMapping;
 import net.dv8tion.jda.api.requests.restaction.interactions.InteractionCallbackAction;
-import net.javadiscord.javabot.systems.AutoDetectableComponentHandler;
+import net.javadiscord.javabot.annotations.AutoDetectableComponentHandler;
 import net.javadiscord.javabot.systems.qotw.commands.QOTWSubcommand;
 import net.javadiscord.javabot.systems.qotw.dao.QuestionQueueRepository;
 import net.javadiscord.javabot.systems.qotw.model.QOTWQuestion;