Add caching for the Discord models and Dynamic Event Handlers (#70)

Caching and annotation processing

Author: surajkumar

.github/ISSUE_TEMPLATE/feature_request.md

@@ -12,17 +12,17 @@ assignees: ''
 <!-- Description of what you want to be able to do -->
 
 ## So that...
-<-- Description of why you want this -->
+<!-- Description of why you want this -->
 
 ## Context
-<-- Add context and details on this request  -->
+<!-- Add context and details on this request  -->
 
 ## Acceptance Criteria
 
 <!-- 
 EXAMPLE:
 
-As a discord moderator I wan to...
+As a discord moderator I want to...
 be able to send messages to a text channel
 So that...
 I can send informative messages to our users. 

build.gradle

@@ -35,6 +35,8 @@ dependencies {
     testImplementation "io.gatehill.imposter:imposter-server:3.38.2"
     testImplementation "io.gatehill.imposter:config-dynamic:3.38.2"
     testImplementation "io.gatehill.imposter:mock-openapi:3.38.2"
+
+    testImplementation 'org.mockito:mockito-core:5.11.0'
 }
 
 spotless {
@@ -86,7 +88,7 @@ test {
 sourceSets {
     test {
         java {
-            srcDirs 'src/test/integration'
+            srcDirs 'src/test/integration', 'src/test/unit'
         }
     }
 }

src/main/java/com/javadiscord/example/ExampleListener.java

@@ -1,14 +1,24 @@
 package com.javadiscord.jdi.core;
 
+import java.io.File;
+import java.lang.reflect.Constructor;
 import java.net.URI;
 import java.net.http.HttpClient;
 import java.net.http.HttpRequest;
 import java.net.http.HttpResponse;
+import java.util.ArrayList;
 import java.util.List;
 import java.util.concurrent.Executor;
 import java.util.concurrent.Executors;
 
+import com.javadiscord.jdi.core.annotations.EventListener;
+import com.javadiscord.jdi.core.cache.Cache;
+import com.javadiscord.jdi.core.cache.CacheType;
+import com.javadiscord.jdi.core.processor.ClassFileUtil;
+import com.javadiscord.jdi.core.processor.EventListenerValidator;
+import com.javadiscord.jdi.internal.api.DiscordRequest;
 import com.javadiscord.jdi.internal.api.DiscordRequestDispatcher;
+import com.javadiscord.jdi.internal.api.DiscordResponseFuture;
 import com.javadiscord.jdi.internal.gateway.*;
 import com.javadiscord.jdi.internal.gateway.identify.IdentifyRequest;
 
@@ -18,18 +28,20 @@
 
 public class Discord {
     private static final Logger LOGGER = LogManager.getLogger();
-    private static final Executor EXECUTOR = Executors.newSingleThreadExecutor();
+    private static final Executor EXECUTOR = Executors.newCachedThreadPool();
     private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();
     private static final String WEBSITE = "https://javadiscord.com/";
     private static final String BASE_URL = System.getProperty("DISCORD_BASE_URL") != null
         ? System.getProperty("DISCORD_BASE_URL")
         : "https://discord.com/api";
     private final String botToken;
     private final IdentifyRequest identifyRequest;
-
     private final DiscordRequestDispatcher discordRequestDispatcher;
     private final Gateway gateway;
     private final GatewaySetting gatewaySetting;
+    private final Cache cache;
+    private final List<Object> eventListeners = new ArrayList<>();
+    private final EventListenerValidator eventListenerValidator = new EventListenerValidator();
 
     public Discord(String botToken) {
         this(
@@ -72,14 +84,29 @@ public Discord(String botToken, List<GatewayIntent> intents) {
     }
 
     public Discord(String botToken, IdentifyRequest identifyRequest) {
+        this(botToken, identifyRequest, CacheType.FULL);
+    }
+
+    public Discord(String botToken, IdentifyRequest identifyRequest, CacheType cacheType) {
         this.botToken = botToken;
         this.discordRequestDispatcher = new DiscordRequestDispatcher(botToken);
         this.gateway = getGatewayURL(botToken);
         this.gatewaySetting = new GatewaySetting().setEncoding(GatewayEncoding.JSON).setApiVersion(10);
         this.identifyRequest = identifyRequest;
+        this.cache = new Cache(cacheType);
     }
 
     public void start() {
+        try {
+            loadListeners();
+            if (eventListeners.isEmpty()) {
+                LOGGER.warn("No event listeners have been registered");
+            }
+        } catch (Exception e) {
+            LOGGER.error("Failed to load listeners", e);
+            throw new RuntimeException(e);
+        }
+
         WebSocketManager webSocketManager = new WebSocketManager(
             new GatewaySetting().setApiVersion(10).setEncoding(GatewayEncoding.JSON),
             identifyRequest,
@@ -98,6 +125,47 @@ public void startWithoutGatewayEvents() {
         EXECUTOR.execute(discordRequestDispatcher);
     }
 
+    private void loadListeners() throws Exception {
+        List<File> classes = ClassFileUtil.getClassesInClassPath();
+        for (File classFile : classes) {
+            Class<?> clazz = Class.forName(ClassFileUtil.getClassName(classFile));
+            if (clazz.isAnnotationPresent(EventListener.class)) {
+                if (validateListener(clazz)) {
+                    registerListener(clazz);
+                } else {
+                    LOGGER.error("{} failed validation", clazz.getName());
+                }
+            }
+        }
+    }
+
+    private void registerListener(Class<?> clazz) {
+        try {
+            LOGGER.info("Registered listener {}", clazz.getName());
+            eventListeners.add(getZeroArgConstructor(clazz).newInstance());
+        } catch (Exception e) {
+            LOGGER.error("Failed to create {} instance", clazz.getName(), e);
+        }
+    }
+
+    boolean validateListener(Class<?> clazz) {
+        return eventListenerValidator.validate(clazz);
+    }
+
+    public DiscordResponseFuture sendRequest(DiscordRequest request) {
+        return discordRequestDispatcher.queue(request);
+    }
+
+    static Constructor<?> getZeroArgConstructor(Class<?> clazz) {
+        Constructor<?>[] constructors = clazz.getConstructors();
+        for (Constructor<?> constructor : constructors) {
+            if (constructor.getParameterCount() == 0) {
+                return constructor;
+            }
+        }
+        throw new RuntimeException("No zero arg constructor found for " + clazz.getName());
+    }
+
     private static Gateway getGatewayURL(String authentication) {
         try (HttpClient httpClient = HttpClient.newBuilder().build()) {
             HttpRequest request = HttpRequest.newBuilder()
@@ -120,4 +188,12 @@ public static String getBaseUrl() {
     public DiscordRequestDispatcher getDiscordRequestDispatcher() {
         return discordRequestDispatcher;
     }
+
+    public Cache getCache() {
+        return cache;
+    }
+
+    public List<Object> getEventListeners() {
+        return eventListeners;
+    }
 }

src/main/java/com/javadiscord/example/ExampleSlashCommand.java

@@ -0,0 +1,10 @@
+package com.javadiscord.jdi.core.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.METHOD })
+public @interface AutoModerationRuleCreate {}

src/main/java/com/javadiscord/jdi/core/Discord.java

@@ -0,0 +1,10 @@
+package com.javadiscord.jdi.core.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.METHOD })
+public @interface AutoModerationRuleDelete {}

src/main/java/com/javadiscord/jdi/core/annotations/AutoModerationRuleCreate.java

@@ -0,0 +1,10 @@
+package com.javadiscord.jdi.core.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.METHOD })
+public @interface AutoModerationRuleExecution {}

src/main/java/com/javadiscord/jdi/core/annotations/AutoModerationRuleDelete.java

@@ -0,0 +1,10 @@
+package com.javadiscord.jdi.core.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.METHOD })
+public @interface AutoModerationRuleUpdate {}

src/main/java/com/javadiscord/jdi/core/annotations/AutoModerationRuleExecution.java

@@ -0,0 +1,10 @@
+package com.javadiscord.jdi.core.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.METHOD })
+public @interface ChannelDelete {}