Check and add overloads using Java reflection

Author: freya022

BotCommands-core/src/main/kotlin/io/github/freya022/botcommands/api/commands/application/provider/AbstractApplicationCommandManager.kt

@@ -26,6 +26,7 @@ import io.github.freya022.botcommands.internal.commands.application.context.user
 import io.github.freya022.botcommands.internal.commands.application.context.user.builder.UserCommandBuilderImpl
 import io.github.freya022.botcommands.internal.commands.application.slash.TopLevelSlashCommandInfoImpl
 import io.github.freya022.botcommands.internal.commands.application.slash.builder.TopLevelSlashCommandBuilderImpl
+import io.github.freya022.botcommands.internal.core.annotations.SkipJavaReflectionOverload
 import net.dv8tion.jda.api.entities.Member
 import net.dv8tion.jda.api.entities.Message
 import net.dv8tion.jda.api.entities.User
@@ -75,6 +76,7 @@ sealed class AbstractApplicationCommandManager(val context: BContext) {
      *
      * @see JDASlashCommand @JDASlashCommand
      */
+    @SkipJavaReflectionOverload
     fun slashCommand(name: String, function: KFunction<Any>?, builder: TopLevelSlashCommandBuilder.() -> Unit) {
         TopLevelSlashCommandBuilderImpl(this, name, function)
             .setCallerAsDeclarationSite()
@@ -106,6 +108,7 @@ sealed class AbstractApplicationCommandManager(val context: BContext) {
      *
      * @see JDAUserCommand @JDAUserCommand
      */
+    @SkipJavaReflectionOverload
     fun userCommand(name: String, function: KFunction<Any>, builder: UserCommandBuilder.() -> Unit) {
         UserCommandBuilderImpl(this, name, function)
             .setCallerAsDeclarationSite()
@@ -136,6 +139,7 @@ sealed class AbstractApplicationCommandManager(val context: BContext) {
      *
      * @see JDAMessageCommand @JDAMessageCommand
      */
+    @SkipJavaReflectionOverload
     fun messageCommand(name: String, function: KFunction<Any>, builder: MessageCommandBuilder.() -> Unit) {
         MessageCommandBuilderImpl(this, name, function)
             .setCallerAsDeclarationSite()
@@ -167,4 +171,4 @@ sealed class AbstractApplicationCommandManager(val context: BContext) {
             "${this.javaClass.simpleNestedName} only accepts the following integration types $supportedIntegrationTypes"
         }
     }
-}
+}

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

@@ -1,6 +1,7 @@
 package io.github.freya022.botcommands.api.core
 
 import io.github.freya022.botcommands.api.core.annotations.IgnoreStackFrame
+import io.github.freya022.botcommands.internal.core.annotations.SkipJavaReflectionOverload
 import io.github.freya022.botcommands.internal.utils.shortSignature
 import kotlin.reflect.KFunction
 
@@ -19,11 +20,12 @@ class DeclarationSite private constructor(
 
     companion object {
         @JvmStatic
+        @SkipJavaReflectionOverload("Expected to be supplied with an Executable's function")
         fun fromFunctionSignature(function: KFunction<*>): DeclarationSite {
             return DeclarationSite(function.shortSignature)
         }
 
         @JvmStatic
         fun fromRaw(string: String) = DeclarationSite(string)
     }
-}
+}

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

@@ -6,6 +6,7 @@ import io.github.freya022.botcommands.api.core.service.ServiceSupplier
 import io.github.freya022.botcommands.api.core.service.annotations.*
 import io.github.freya022.botcommands.api.core.utils.toImmutableMap
 import io.github.freya022.botcommands.api.core.utils.unmodifiableView
+import io.github.freya022.botcommands.internal.core.annotations.SkipJavaReflectionOverload
 import io.github.freya022.botcommands.internal.core.config.ConfigDSL
 import kotlin.reflect.KClass
 
@@ -44,7 +45,7 @@ class BServiceConfigBuilder internal constructor() : BServiceConfig {
      * @param annotations     Annotations which should be tied to this service
      * @param supplier        The function supplying the service
      */
-    @JvmOverloads
+    @SkipJavaReflectionOverload
     fun <T : Any> registerServiceSupplier(
         primaryType: KClass<T>,
         name: String = ServiceSupplier.defaultName(primaryType),
@@ -58,6 +59,36 @@ class BServiceConfigBuilder internal constructor() : BServiceConfig {
         _serviceSuppliers[primaryType] = ServiceSupplier(primaryType, name, additionalTypes, isPrimary, isLazy, priority, annotations, supplier)
     }
 
+    /**
+     * Registers a supplier which gets loaded in the same manner as annotated service classes/factories.
+     *
+     * **Note:** The [annotations] passed will not be readable using standard reflection,
+     * they are only read when functions
+     * like [ServiceContainer.findAnnotationOnService] or [ServiceContainer.getServiceNamesForAnnotation] are used.
+     *
+     * @param primaryType     The type as which the service will be *registered* as
+     * @param name            The [name][ServiceName] to register the service as
+     * @param additionalTypes [Additional types][ServiceType] this service can be *retrieved* as
+     * @param isPrimary       Whether this service should be a [primary][Primary] service
+     * @param isLazy          Whether this service should be initialized only [when requested][Lazy]
+     * @param priority        The [priority][ServicePriority] of this service
+     * @param annotations     Annotations which should be tied to this service
+     * @param supplier        The function supplying the service
+     */
+    @JvmOverloads
+    fun <T : Any> registerServiceSupplier(
+        primaryType: Class<T>,
+        name: String = ServiceSupplier.defaultName(primaryType),
+        additionalTypes: Set<Class<in T>> = emptySet(), // Accept superclasses not subclasses
+        isPrimary: Boolean = false,
+        isLazy: Boolean = false,
+        priority: Int = 0,
+        annotations: List<Annotation> = emptyList(),
+        supplier: (BContext) -> T,
+    ) {
+        _serviceSuppliers[primaryType.kotlin] = ServiceSupplier(primaryType.kotlin, name, additionalTypes.mapTo(hashSetOf()) { it.kotlin }, isPrimary, isLazy, priority, annotations, supplier)
+    }
+
     @JvmSynthetic
     internal fun build() = object : BServiceConfig {
         override val debug = this@BServiceConfigBuilder.debug

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

@@ -1,5 +1,6 @@
 package io.github.freya022.botcommands.api.core.reflect
 
+import io.github.freya022.botcommands.internal.core.annotations.SkipJavaReflectionOverload
 import java.lang.reflect.ParameterizedType
 import java.lang.reflect.Type
 import kotlin.reflect.KClass
@@ -117,12 +118,14 @@ open class KotlinTypeToken<T> {
          * this is equivalent to [`clazz.startProjectedType`][KClass.starProjectedType].
          */
         @JvmStatic
+        @SkipJavaReflectionOverload
         fun ofKClass(clazz: KClass<*>) = KotlinTypeToken<Any>(clazz.starProjectedType)
 
         /**
          * Creates a [KotlinTypeToken] with the given [KType], unchanged.
          */
         @JvmStatic
+        @SkipJavaReflectionOverload
         fun ofType(type: KType) = KotlinTypeToken<Any>(type)
     }
-}
+}

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

@@ -1,5 +1,6 @@
 package io.github.freya022.botcommands.api.core.reflect
 
+import io.github.freya022.botcommands.internal.core.annotations.SkipJavaReflectionOverload
 import kotlin.reflect.KClass
 import kotlin.reflect.KType
 import kotlin.reflect.KTypeProjection
@@ -46,9 +47,11 @@ class ParameterType private constructor(val type: KType) {
             )
 
         @JvmStatic
+        @SkipJavaReflectionOverload
         fun ofKClass(clazz: KClass<*>) = ParameterType(clazz.starProjectedType)
 
         @JvmStatic
+        @SkipJavaReflectionOverload
         fun ofType(type: KType) = ParameterType(type)
     }
-}
+}

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

@@ -2,6 +2,7 @@ package io.github.freya022.botcommands.api.core.service
 
 import io.github.freya022.botcommands.api.core.utils.joinAsList
 import io.github.freya022.botcommands.api.core.utils.simpleNestedName
+import io.github.freya022.botcommands.internal.core.annotations.SkipJavaReflectionOverload
 import io.github.freya022.botcommands.internal.core.exceptions.ServiceException
 import io.github.freya022.botcommands.internal.utils.shortSignature
 import io.github.freya022.botcommands.internal.utils.throwInternal
@@ -31,12 +32,14 @@ class ServiceError private constructor(
         FAILED_FATAL_CUSTOM_CONDITION("At least one custom check returned an error message, and was configured to fail");
 
         @JvmOverloads
+        @SkipJavaReflectionOverload
         fun toError(errorMessage: String, extraMessage: String? = null, failedFunction: KFunction<*>? = null, nestedError: ServiceError? = null, siblingErrors: List<ServiceError> = emptyList(), extra: Map<String, Any> = emptyMap()) =
             ServiceError(this, errorMessage, nestedError, siblingErrors, buildMap(2) {
                 if (extraMessage != null) put("Extra message", extraMessage)
                 if (failedFunction != null) put("Failed function", failedFunction)
             } + extra)
 
+        @SkipJavaReflectionOverload
         fun <T : Any> toResult(errorMessage: String, extraMessage: String? = null, failedFunction: KFunction<*>? = null, nestedError: ServiceError? = null, siblingErrors: List<ServiceError> = emptyList(), extra: Map<String, Any> = emptyMap()) =
             ServiceResult.fail<T>(toError(errorMessage, extraMessage, failedFunction, nestedError, siblingErrors, extra))
     }
@@ -160,4 +163,4 @@ class ServiceResult<out T : Any> private constructor(val service: T?, val servic
         fun <T : Any> fail(error: ServiceError) = ServiceResult<T>(null, error)
         fun <T : Any> fail(errors: List<ServiceError>) = fail<T>(ServiceError.fromErrors(errors))
     }
-}
+}

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

@@ -4,6 +4,7 @@ import io.github.freya022.botcommands.api.core.BContext
 import io.github.freya022.botcommands.api.core.config.BServiceConfigBuilder
 import io.github.freya022.botcommands.api.core.service.annotations.*
 import io.github.freya022.botcommands.api.core.utils.simpleNestedName
+import io.github.freya022.botcommands.internal.core.annotations.SkipJavaReflectionOverload
 import kotlin.reflect.KClass
 
 /**
@@ -68,6 +69,7 @@ class ServiceSupplier<T : Any> @JvmOverloads constructor(
     }
 
     companion object {
+        @SkipJavaReflectionOverload
         fun defaultName(clazz: KClass<*>): String {
             return clazz.simpleNestedName.replaceFirstChar { it.lowercase() }
         }
@@ -77,4 +79,4 @@ class ServiceSupplier<T : Any> @JvmOverloads constructor(
             return clazz.simpleNestedName.replaceFirstChar { it.lowercase() }
         }
     }
-}
+}

BotCommands-core/src/main/kotlin/io/github/freya022/botcommands/internal/core/annotations/SkipJavaReflectionOverload.kt

@@ -0,0 +1,9 @@
+package io.github.freya022.botcommands.internal.core.annotations
+
+/**
+ * Marker to ensure functions requesting kotlin-reflect instances have a Java equivalent.
+ *
+ * The test essentially makes sure the contributor did not forget about adding a Java equivalent.
+ */
+@Retention(AnnotationRetention.SOURCE)
+annotation class SkipJavaReflectionOverload(val reason: String = "")

src/test/kotlin/io/github/freya022/botcommands/arch/JavaInteropTest.kt

@@ -0,0 +1,42 @@
+package io.github.freya022.botcommands.arch
+
+import com.lemonappdev.konsist.api.Konsist
+import com.lemonappdev.konsist.api.declaration.KoTypeArgumentDeclaration
+import com.lemonappdev.konsist.api.ext.list.functions
+import com.lemonappdev.konsist.api.ext.list.withParameter
+import com.lemonappdev.konsist.api.ext.list.withoutAnnotationNamed
+import com.lemonappdev.konsist.api.provider.*
+import com.lemonappdev.konsist.api.verify.assertEmpty
+import com.lemonappdev.konsist.api.verify.assertNotEmpty
+import io.github.freya022.botcommands.internal.core.annotations.SkipJavaReflectionOverload
+import kotlin.test.Test
+
+class JavaInteropTest {
+
+    @Test
+    fun `Check all functions accepting kotlin-reflect instances have Java equivalents`() {
+        Konsist.scopeFromProduction()
+            .classes(includeNested = true)
+            .filter { it.packagee!!.name.contains("api") }
+            .functions(includeNested = true)
+            .withoutAnnotationNamed(SkipJavaReflectionOverload::class.java.simpleName, JvmSynthetic::class.java.simpleName)
+            .also { it.assertNotEmpty(strict = true) }
+            .withParameter {
+                it.getAllTypes().any { type ->
+                    val typeSource = (type as KoSourceDeclarationProvider).sourceDeclaration as? KoPackageProvider ?: return@any false
+
+                    typeSource.packagee!!.hasNameStartingWith("kotlin.reflect")
+                }
+            }
+            .assertEmpty(strict = true)
+    }
+
+    fun KoNonNullableTypeProvider.getAllTypes(): List<KoBaseProvider> {
+        fun KoTypeArgumentProvider.allArgumentTypes(): List<KoTypeArgumentDeclaration> {
+            val args = typeArguments ?: return emptyList()
+            return args + args.flatMap { it.allArgumentTypes() }
+        }
+
+        return listOf(this.type) + this.type.allArgumentTypes()
+    }
+}