Remove BotCommands-method-accessors-classfile from core dependencies

Gradle complains about it needing Java 24

Author: freya022

BotCommands-core/build.gradle.kts

@@ -35,7 +35,6 @@ dependencies {
 
     api(projects.botCommandsMethodAccessors.core) // API due to opt-in annotation
     implementation(projects.botCommandsMethodAccessors.kotlinReflect)
-    implementation(projects.botCommandsMethodAccessors.classfile)
 
     // -------------------- GLOBAL DEPENDENCIES --------------------
 
@@ -123,6 +122,8 @@ dependencies {
     // but we need to make sure the main module works without it
     testImplementation(libs.spring.boot)
     testImplementation(libs.spring.boot.autoconfigure)
+
+    testImplementation(projects.botCommandsMethodAccessors.classfile)
 }
 
 val generateInfo by tasks.registering(GenerateBCInfoTask::class) {

BotCommands-core/src/main/kotlin/io/github/freya022/botcommands/api/core/BotCommands.kt

@@ -35,7 +35,8 @@ object BotCommands {
      * - No [InvocationTargetExceptions][java.lang.reflect.InvocationTargetException]
      * - Better performance
      *
-     * This feature requires *running* on Java 24+, if your bot doesn't, this method has no effect.
+     * This feature requires adding the `BotCommands-method-accessors-classfile` dependency
+     * and *running* on Java 24+, if your bot doesn't fulfill these conditions, this method has no effect.
      */
     @ExperimentalMethodAccessorsApi
     @get:JvmStatic
@@ -49,7 +50,8 @@ object BotCommands {
      * - No [InvocationTargetExceptions][java.lang.reflect.InvocationTargetException]
      * - Better performance
      *
-     * This feature requires *running* on Java 24+, if your bot doesn't, this method has no effect.
+     * This feature requires adding the `BotCommands-method-accessors-classfile` dependency
+     * and *running* on Java 24+, if your bot doesn't fulfill these conditions, this method has no effect.
      */
     @JvmStatic
     @ExperimentalMethodAccessorsApi

BotCommands-core/src/main/kotlin/io/github/freya022/botcommands/internal/core/method/accessors/MethodAccessorFactoryProvider.kt

@@ -1,7 +1,6 @@
 package io.github.freya022.botcommands.internal.core.method.accessors
 
 import dev.freya02.botcommands.method.accessors.api.annotations.ExperimentalMethodAccessorsApi
-import dev.freya02.botcommands.method.accessors.internal.ClassFileMethodAccessorFactory
 import dev.freya02.botcommands.method.accessors.internal.KotlinReflectMethodAccessorFactory
 import dev.freya02.botcommands.method.accessors.internal.MethodAccessor
 import dev.freya02.botcommands.method.accessors.internal.MethodAccessorFactory
@@ -11,37 +10,53 @@ import kotlin.reflect.KFunction
 
 internal object MethodAccessorFactoryProvider {
 
-    private var logged = false
+    private lateinit var accessorFactory: MethodAccessorFactory
+    private val staticAccessors: MutableMap<KFunction<*>, MethodAccessor<*>> = hashMapOf()
+
+    internal fun getAccessorFactory(): MethodAccessorFactory {
+        if (::accessorFactory.isInitialized) return accessorFactory
+
+        synchronized(this) {
+            if (::accessorFactory.isInitialized) return accessorFactory
 
-    private val kotlinReflectAccessorFactory: MethodAccessorFactory = KotlinReflectMethodAccessorFactory()
-    private val classFileAccessorFactory by lazy<MethodAccessorFactory?> {
-        if (Runtime.version().feature() >= 24) {
-            ClassFileMethodAccessorFactory()
-        } else {
-            null
+            accessorFactory = loadAccessorFactory()
         }
-    }
 
-    private val staticAccessors: MutableMap<KFunction<*>, MethodAccessor<*>> = hashMapOf()
+        return accessorFactory
+    }
 
     @OptIn(ExperimentalMethodAccessorsApi::class)
-    internal fun getAccessorFactory(): MethodAccessorFactory {
-        fun logUsage(msg: String) {
-            if (logged) return
-            synchronized(this) {
-                if (logged) return
-                logged = true
-            }
-            KotlinLogging.logger { }.info { msg }
+    private fun loadAccessorFactory(): MethodAccessorFactory {
+        if (BotCommands.preferClassFileAccessors) {
+            val accessorFactory = tryLoadClassFileAccessor()
+            if (accessorFactory != null) return accessorFactory
         }
 
-        return if (BotCommands.preferClassFileAccessors && classFileAccessorFactory != null) {
-            logUsage("Using ClassFile-based method accessor factory")
-            classFileAccessorFactory!!
-        } else {
-            logUsage("Using kotlin-reflect method accessor factory")
-            kotlinReflectAccessorFactory
+        val logger = KotlinLogging.logger { }
+        logger.debug { "Using kotlin-reflect method accessors" }
+        return KotlinReflectMethodAccessorFactory()
+    }
+
+    private fun tryLoadClassFileAccessor(): MethodAccessorFactory? {
+        val logger = KotlinLogging.logger { }
+
+        val runtimeFeature = Runtime.version().feature()
+        if (runtimeFeature < 24) {
+            logger.debug { "Cannot use ClassFile-based method accessors as this feature requires Java 24+, currently running on Java $runtimeFeature" }
+            return null
         }
+
+        val accessorFactory = try {
+            Class.forName("dev.freya02.botcommands.method.accessors.internal.ClassFileMethodAccessorFactory")
+                .getDeclaredConstructor()
+                .newInstance() as MethodAccessorFactory
+        } catch (e: ClassNotFoundException) {
+            logger.debug(e) { "Cannot use ClassFile-based method accessors as the 'BotCommands-method-accessors-classfile' dependency is missing" }
+            return null
+        }
+
+        logger.debug { "Using ClassFile-based method accessors" }
+        return accessorFactory
     }
 
     internal fun <R> getStaticAccessor(function: KFunction<R>): MethodAccessor<R> = synchronized(this) {

BotCommands-method-accessors/README.md

@@ -1,5 +1,39 @@
+[bc-module-maven-central-shield]: https://img.shields.io/maven-central/v/io.github.freya022/BotCommands-method-accessors-classfile?label=Maven%20central&logo=apachemaven&versionPrefix=3
+[bc-module-maven-central-link]: https://central.sonatype.com/artifact/io.github.freya022/BotCommands-method-accessors-classfile
+
 # BotCommands module - Method accessors
-This module provides abstractions to call user methods, it should not be included manually.
+This module provides abstractions to call user methods.
+
+## Installation
+[![BotCommands-method-accessors-classfile on maven central][bc-module-maven-central-shield] ][bc-module-maven-central-link]
+
+You can optionally install this dependency,
+it requires Java 24+ and can be enabled with `BotCommand.preferClassFileAccessors()`.
+
+### Maven
+```xml
+<dependencies>
+  <dependency>
+    <groupId>io.github.freya022</groupId>
+    <artifactId>BotCommands-method-accessors-classfile</artifactId>
+    <version>VERSION</version>
+  </dependency>
+</dependencies>
+```
+
+### Gradle
+```gradle
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation("io.github.freya022:BotCommands-method-accessors-classfile:VERSION")
+}
+```
+
+Alternatively, you can use Jitpack to use **snapshot** versions,
+you can refer to [the JDA wiki](https://jda.wiki/using-jda/using-new-features/) for more information.
 
 ## Implementations
 
@@ -13,9 +47,6 @@ which, for each function, generates a hidden class with instructions optimized t
 
 This allows for shorter stack traces in exceptions and the debugger, no `InvocationTargetException`s, and better performance.
 
-This can be enabled before starting your bot, by calling `BotCommands.preferClassFileAccessors()`,
-note that this will only have an effect if your bot runs on Java 24+.
-
 ### Stack trace comparison
 
 #### kotlin-reflect

README.md

@@ -174,6 +174,7 @@ The base `BotCommands` artifact will include modules often used, while others ar
 
 ### Optional modules
 - [`BotCommands-spring`](./BotCommands-spring): Support for Spring Boot
+- [`BotCommands-method-accessors-classfile`](./BotCommands-method-accessors): Improved alternative for this framework to call your functions
 
 ## Sample usage
 Here is how you would create a slash command that sends a message in a specified channel.