Refactor async aiservices, Upgrade coroutines to 1.9.0 (#147)

- Refactor async aiservices
- Upgrade coroutines to 1.9.0 (max version compatible with Kotlin 1.9)

Author: kpavlov

langchain4j-kotlin/src/main/kotlin/me/kpavlov/langchain4j/kotlin/service/AiServiceOrchestrator.kt

@@ -175,7 +175,7 @@ internal class AiServiceOrchestrator<T : Any>(
 
     private fun handleStreamingCall(
         returnType: Type,
-        messages: MutableList<ChatMessage?>,
+        messages: MutableList<ChatMessage>,
         toolServiceContext: ToolServiceContext,
         augmentationResult: AugmentationResult?,
         memoryId: Any,
@@ -202,10 +202,10 @@ internal class AiServiceOrchestrator<T : Any>(
     @Suppress("LongParameterList")
     private suspend fun handleNonStreamingCall(
         returnType: Type,
-        messages: MutableList<ChatMessage?>,
+        messages: MutableList<ChatMessage>,
         toolServiceContext: ToolServiceContext,
         augmentationResult: AugmentationResult?,
-        moderationFuture: Future<Moderation?>?,
+        moderationFuture: Future<Moderation>?,
         chatMemory: ChatMemory?,
         memoryId: ChatMemoryId,
         supportsJsonSchema: Boolean,
@@ -302,10 +302,10 @@ internal class AiServiceOrchestrator<T : Any>(
     private fun triggerModerationIfNeeded(
         method: Method,
         messages: MutableList<ChatMessage?>,
-    ): Future<Moderation?>? =
+    ): Future<Moderation>? =
         if (method.isAnnotationPresent(Moderate::class.java)) {
             executor.submit(
-                Callable<Moderation?> {
+                Callable {
                     val messagesToModerate = AiServices.removeToolMessages(messages)
                     context.moderationModel
                         .moderate(messagesToModerate)
@@ -322,11 +322,11 @@ internal class AiServiceOrchestrator<T : Any>(
         args: Array<Any?>,
     ): SystemMessage? =
         findSystemMessageTemplate(memoryId, method)
-            .map<SystemMessage> { systemMessageTemplate: String ->
+            .map { systemMessageTemplate: String ->
                 PromptTemplate
                     .from(systemMessageTemplate)
                     .apply(
-                        ReflectionVariableResolver.findTemplateVariables(
+                        findTemplateVariables(
                             systemMessageTemplate,
                             method,
                             args,
@@ -339,7 +339,7 @@ internal class AiServiceOrchestrator<T : Any>(
         method: Method,
     ): Optional<String> {
         val annotation =
-            method.getAnnotation<dev.langchain4j.service.SystemMessage>(
+            method.getAnnotation(
                 dev.langchain4j.service.SystemMessage::class.java,
             )
         if (annotation != null) {
@@ -364,9 +364,9 @@ internal class AiServiceOrchestrator<T : Any>(
         value: Array<String>,
         delimiter: String,
     ): String {
-        var messageTemplate: String =
+        val messageTemplate: String =
             if (!resource.trim { it <= ' ' }.isEmpty()) {
-                val resourceText = getResourceText(method.getDeclaringClass(), resource)
+                val resourceText = getResourceText(method.declaringClass, resource)
                 if (resourceText == null) {
                     throw IllegalConfigurationException.illegalConfiguration(
                         "@%sMessage's resource '%s' not found",
@@ -393,7 +393,7 @@ internal class AiServiceOrchestrator<T : Any>(
     ): String? {
         var inputStream = clazz.getResourceAsStream(resource)
         if (inputStream == null) {
-            inputStream = clazz.getResourceAsStream("/" + resource)
+            inputStream = clazz.getResourceAsStream("/$resource")
         }
         return getText(inputStream)
     }
@@ -418,9 +418,9 @@ internal class AiServiceOrchestrator<T : Any>(
 
         val prompt = PromptTemplate.from(template).apply(variables)
 
-        val maybeUserName = findUserName(method.getParameters(), args)
+        val maybeUserName = findUserName(method.parameters, args)
         return maybeUserName
-            .map<UserMessage> { userName: String? ->
+            .map { userName: String? ->
                 UserMessage.from(
                     userName,
                     prompt.text(),
@@ -436,48 +436,48 @@ internal class AiServiceOrchestrator<T : Any>(
             findUserMessageTemplateFromMethodAnnotation(method)
         val templateFromParameterAnnotation =
             findUserMessageTemplateFromAnnotatedParameter(
-                method.getParameters(),
+                method.parameters,
                 args,
             )
 
-        if (templateFromMethodAnnotation.isPresent() &&
-            templateFromParameterAnnotation.isPresent()
+        if (templateFromMethodAnnotation.isPresent &&
+            templateFromParameterAnnotation.isPresent
         ) {
             throw IllegalConfigurationException.illegalConfiguration(
                 "Error: The method '%s' has multiple @UserMessage annotations. Please use only one.",
-                method.getName(),
+                method.name,
             )
         }
 
-        if (templateFromMethodAnnotation.isPresent()) {
+        if (templateFromMethodAnnotation.isPresent) {
             return templateFromMethodAnnotation.get()
         }
-        if (templateFromParameterAnnotation.isPresent()) {
+        if (templateFromParameterAnnotation.isPresent) {
             return templateFromParameterAnnotation.get()
         }
 
         val templateFromTheOnlyArgument =
             findUserMessageTemplateFromTheOnlyArgument(
-                method.getParameters(),
+                method.parameters,
                 args,
             )
-        if (templateFromTheOnlyArgument.isPresent()) {
+        if (templateFromTheOnlyArgument.isPresent) {
             return templateFromTheOnlyArgument.get()
         }
 
         throw IllegalConfigurationException.illegalConfiguration(
             "Error: The method '%s' does not have a user message defined.",
-            method.getName(),
+            method.name,
         )
     }
 
     private fun findUserMessageTemplateFromMethodAnnotation(method: Method): Optional<String> =
         Optional
             .ofNullable<dev.langchain4j.service.UserMessage>(
-                method.getAnnotation<dev.langchain4j.service.UserMessage>(
+                method.getAnnotation(
                     dev.langchain4j.service.UserMessage::class.java,
                 ),
-            ).map<String> { userMessage ->
+            ).map { userMessage ->
                 getTemplate(
                     method,
                     "User",

langchain4j-kotlin/src/main/kotlin/me/kpavlov/langchain4j/kotlin/service/ReflectionVariableResolver.kt

@@ -3,11 +3,9 @@ package me.kpavlov.langchain4j.kotlin.service
 import dev.langchain4j.internal.Exceptions
 import dev.langchain4j.model.input.structured.StructuredPrompt
 import dev.langchain4j.model.input.structured.StructuredPromptProcessor
-import dev.langchain4j.service.IllegalConfigurationException
+import dev.langchain4j.service.InternalReflectionVariableResolver
 import dev.langchain4j.service.MemoryId
-import dev.langchain4j.service.UserMessage
 import dev.langchain4j.service.UserName
-import dev.langchain4j.service.V
 import me.kpavlov.langchain4j.kotlin.ChatMemoryId
 import java.lang.reflect.Method
 import java.lang.reflect.Parameter
@@ -23,95 +21,24 @@ import java.util.Optional
  *
  * @see https://github.com/langchain4j/langchain4j/pull/2951
  */
-@Suppress("detekt:all")
 internal object ReflectionVariableResolver {
     public fun findTemplateVariables(
         template: String,
         method: Method,
         args: Array<Any?>?,
-    ): MutableMap<String?, Any?> {
-        if (args == null) {
-            return mutableMapOf<String?, Any?>()
-        }
-        val parameters = method.getParameters()
-
-        val variables: MutableMap<String?, Any?> = HashMap<String?, Any?>()
-        for (i in args.indices) {
-            val variableName = getVariableName(parameters[i])
-            val variableValue = args[i]
-            variables.put(variableName, variableValue)
-        }
-
-        if (template.contains("{{it}}") && !variables.containsKey("it")) {
-            val itValue = getValueOfVariableIt(parameters, args)
-            variables.put("it", itValue)
-        }
-
-        return variables
-    }
-
-    private fun getVariableName(parameter: Parameter): String? {
-        val annotation = parameter.getAnnotation<V?>(V::class.java)
-        if (annotation != null) {
-            return annotation.value
-        } else {
-            return parameter.getName()
-        }
-    }
-
-    private fun getValueOfVariableIt(
-        parameters: Array<Parameter>,
-        args: Array<Any?>?,
-    ): String? {
-        if (args != null) {
-            if (args.size == 1) {
-                val parameter = parameters[0]
-                if (!parameter.isAnnotationPresent(MemoryId::class.java) &&
-                    !parameter.isAnnotationPresent(
-                        UserMessage::class.java,
-                    ) &&
-                    !parameter.isAnnotationPresent(
-                        UserName::class.java,
-                    ) &&
-                    (
-                        !parameter.isAnnotationPresent(V::class.java) ||
-                            isAnnotatedWithIt(
-                                parameter,
-                            )
-                    )
-                ) {
-                    return asString(args[0])
-                }
-            }
-
-            for (i in args.indices) {
-                if (isAnnotatedWithIt(parameters[i])) {
-                    return asString(args[i])
-                }
-            }
-        }
+    ): MutableMap<String?, Any?> =
+        InternalReflectionVariableResolver.findTemplateVariables(template, method, args)
 
-        throw IllegalConfigurationException.illegalConfiguration(
-            "Error: cannot find the value of the prompt template variable \"{{it}}\".",
-        )
-    }
-
-    private fun isAnnotatedWithIt(parameter: Parameter): Boolean {
-        val annotation = parameter.getAnnotation<V?>(V::class.java)
-        return annotation != null && "it" == annotation.value
-    }
-
-    public fun asString(arg: Any?): String? {
+    public fun asString(arg: Any?): String =
         if (arg == null) {
-            return "null"
+            "null"
         } else if (arg is Array<*>?) {
-            return arrayAsString(arg)
+            arrayAsString(arg)
         } else if (arg.javaClass.isAnnotationPresent(StructuredPrompt::class.java)) {
-            return StructuredPromptProcessor.toPrompt(arg).text()
+            StructuredPromptProcessor.toPrompt(arg).text()
         } else {
-            return arg.toString()
+            arg.toString()
         }
-    }
 
     private fun arrayAsString(arg: Array<*>?): String =
         if (arg == null) {
@@ -132,50 +59,65 @@ internal object ReflectionVariableResolver {
     fun findUserMessageTemplateFromTheOnlyArgument(
         parameters: Array<Parameter>?,
         args: Array<Any?>,
-    ): Optional<String> {
-        if (parameters != null &&
+    ): Optional<String> =
+        if (
+            parameters != null &&
             parameters.size == 1 &&
             parameters[0].getAnnotations().size == 0
         ) {
-            return Optional.ofNullable<String>(asString(args[0]))
+            Optional.ofNullable<String>(asString(args[0]))
+        } else {
+            Optional.empty()
         }
-        return Optional.empty()
-    }
+
 
     fun findUserName(
         parameters: Array<Parameter>,
         args: Array<Any?>,
     ): Optional<String> {
-        for (i in parameters.indices) {
+        var result = Optional.empty<String>()
+        for (i in args.indices) {
             if (parameters[i].isAnnotationPresent(UserName::class.java)) {
-                return Optional.of<String>(args[i].toString())
+                result = Optional.of(args[i].toString())
+                break
             }
         }
-        return Optional.empty<String>()
+        return result
     }
 
+    @Suppress("ReturnCount")
     fun findMemoryId(
         method: Method,
         args: Array<Any?>?,
     ): Optional<ChatMemoryId> {
         if (args == null) {
-            return Optional.empty<ChatMemoryId>()
+            return Optional.empty()
         }
+
+        val memoryIdParam = findMemoryIdParameter(method, args)
+        if (memoryIdParam != null) {
+            val (parameter, memoryId) = memoryIdParam
+            if (memoryId is ChatMemoryId) {
+                return Optional.of(memoryId)
+            } else {
+                throw Exceptions.illegalArgument(
+                    "The value of parameter '%s' annotated with @MemoryId in method '%s' must not be null",
+                    parameter.getName(),
+                    method.getName(),
+                )
+            }
+        }
+
+        return Optional.empty()
+    }
+
+    private fun findMemoryIdParameter(method: Method, args: Array<Any?>): Pair<Parameter, Any?>? {
         for (i in args.indices) {
             val parameter = method.parameters[i]
             if (parameter.isAnnotationPresent(MemoryId::class.java)) {
-                val memoryId = args[i]
-                if (memoryId is ChatMemoryId) {
-                    return Optional.of(memoryId)
-                } else {
-                    throw Exceptions.illegalArgument(
-                        "The value of parameter '%s' annotated with @MemoryId in method '%s' must not be null",
-                        parameter.getName(),
-                        method.getName(),
-                    )
-                }
+                return Pair(parameter, args[i])
             }
         }
-        return Optional.empty()
+        return null
     }
 }

langchain4j-kotlin/src/main/kotlin/me/kpavlov/langchain4j/kotlin/service/memory/ChatMemoryServiceExtensions.kt

@@ -2,15 +2,26 @@ package me.kpavlov.langchain4j.kotlin.service.memory
 
 import dev.langchain4j.memory.ChatMemory
 import dev.langchain4j.service.memory.ChatMemoryService
-import kotlinx.coroutines.coroutineScope
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.withContext
 import me.kpavlov.langchain4j.kotlin.ChatMemoryId
+import kotlin.coroutines.CoroutineContext
 
 public suspend fun ChatMemoryService.getOrCreateChatMemoryAsync(
     memoryId: ChatMemoryId,
-): ChatMemory = coroutineScope { this@getOrCreateChatMemoryAsync.getOrCreateChatMemory(memoryId) }
+    context: CoroutineContext = Dispatchers.IO,
+): ChatMemory =
+    withContext(context) { this@getOrCreateChatMemoryAsync.getOrCreateChatMemory(memoryId) }
 
-public suspend fun ChatMemoryService.getChatMemoryAsync(memoryId: ChatMemoryId): ChatMemory? =
-    coroutineScope { this@getChatMemoryAsync.getChatMemory(memoryId) }
+public suspend fun ChatMemoryService.getChatMemoryAsync(
+    memoryId: ChatMemoryId,
+    context: CoroutineContext = Dispatchers.IO,
+): ChatMemory? =
+    withContext(context)
+    { this@getChatMemoryAsync.getChatMemory(memoryId) }
 
-public suspend fun ChatMemoryService.evictChatMemoryAsync(memoryId: ChatMemoryId): ChatMemory? =
-    coroutineScope { this@evictChatMemoryAsync.evictChatMemory(memoryId) }
+public suspend fun ChatMemoryService.evictChatMemoryAsync(
+    memoryId: ChatMemoryId,
+    context: CoroutineContext = Dispatchers.IO,
+): ChatMemory? =
+    withContext(context) { this@evictChatMemoryAsync.evictChatMemory(memoryId) }

pom.xml

@@ -57,7 +57,7 @@
         <awaitility.version>4.2.2</awaitility.version>
         <finchly.version>0.1.1</finchly.version>
         <junit.version>5.12.2</junit.version>
-        <kotlinx-coroutines.version>1.8.1</kotlinx-coroutines.version>
+        <kotlinx-coroutines.version>1.9.0</kotlinx-coroutines.version>
         <langchain4j.version>1.0.0</langchain4j.version>
         <mockito-kotlin.version>5.4.0</mockito-kotlin.version>
         <mockito.version>5.17.0</mockito.version>