Add cache flags to JDAService

Preparing for discord-jda/JDA#2558
freya022 · Oct 27, 2023 · a5cd08b · a5cd08b
1 parent 6816b91
commit a5cd08b
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 1 deletion.
diff --git a/src/main/kotlin/io/github/freya022/botcommands/api/core/JDAService.kt b/src/main/kotlin/io/github/freya022/botcommands/api/core/JDAService.kt
@@ -12,6 +12,7 @@ import net.dv8tion.jda.api.hooks.IEventManager
 import net.dv8tion.jda.api.requests.GatewayIntent
 import net.dv8tion.jda.api.sharding.DefaultShardManagerBuilder
 import net.dv8tion.jda.api.sharding.ShardManager
+import net.dv8tion.jda.api.utils.cache.CacheFlag
 import java.util.*
 
 /**
@@ -51,6 +52,15 @@ abstract class JDAService {
      */
     abstract val intents: Set<GatewayIntent>
 
+    /**
+     * The cache flags used by your bot,
+     * must at least be a subset of the cache flags your bot will use.
+     *
+     * To make sure JDA uses these flags,
+     * you can pass these to [JDABuilder.enableCache] / [DefaultShardManagerBuilder.enableCache].
+     */
+    abstract val cacheFlags: Set<CacheFlag>
+
     /**
      * Creates a [JDA] or [ShardManager] instance.
      *

diff --git a/src/main/kotlin/io/github/freya022/botcommands/internal/core/JDAServiceMismatchChecker.kt b/src/main/kotlin/io/github/freya022/botcommands/internal/core/JDAServiceMismatchChecker.kt
@@ -28,6 +28,19 @@ internal object JDAServiceMismatchChecker {
                     """.trimIndent()
                 }
             }
+
+            val jdaCacheFlags = event.jda.cacheFlags
+            val jdaServiceCacheFlags = jdaService.cacheFlags
+            if (jdaCacheFlags.containsAll(jdaServiceCacheFlags)) {
+                logger.warn {
+                    """
+                        The cache flags given in JDAService should at least be a subset of the JDA cache flags!
+                        JDA intents: $jdaIntents
+                        JDAService intents: $jdaServiceIntents
+                        Hint: you should pass ${JDAService::cacheFlags.reference} to your builder
+                    """.trimIndent()
+                }
+            }
         }
     }
 }
diff --git a/src/test/kotlin/io/github/freya022/botcommands/test/services/Bot.kt b/src/test/kotlin/io/github/freya022/botcommands/test/services/Bot.kt
@@ -3,6 +3,7 @@ package io.github.freya022.botcommands.test.services
 import io.github.freya022.botcommands.api.core.JDAService
 import io.github.freya022.botcommands.api.core.events.BReadyEvent
 import io.github.freya022.botcommands.api.core.service.annotations.BService
+import io.github.freya022.botcommands.api.core.utils.enumSetOf
 import io.github.freya022.botcommands.test.config.Config
 import net.dv8tion.jda.api.entities.Activity
 import net.dv8tion.jda.api.hooks.IEventManager
@@ -16,9 +17,12 @@ class Bot(private val config: Config) : JDAService() {
     override val intents: Set<GatewayIntent> =
         defaultIntents + GatewayIntent.GUILD_MEMBERS + GatewayIntent.MESSAGE_CONTENT
 
+    override val cacheFlags: Set<CacheFlag>
+        get() = enumSetOf(CacheFlag.FORUM_TAGS, CacheFlag.VOICE_STATE)
+
     override fun createJDA(event: BReadyEvent, eventManager: IEventManager) {
         DefaultShardManagerBuilder.createLight(config.token, intents).apply {
-            enableCache(CacheFlag.FORUM_TAGS, CacheFlag.VOICE_STATE)
+            enableCache(cacheFlags)
             setMemberCachePolicy(MemberCachePolicy.VOICE)
             setActivityProvider { Activity.playing("coroutines go brrr #$it") }
             setEventManagerProvider { eventManager }