Improved ThingBuilder

Author: Robert Winkler

kotlin-wot-integration-tests/src/main/kotlin/integration/HttpAgent.kt

@@ -1,7 +1,9 @@
 package ai.ancf.lmos.wot.integration
 
 import ai.ancf.lmos.wot.Wot
+import ai.ancf.lmos.wot.reflection.ThingBuilder
 import ai.ancf.lmos.wot.reflection.annotations.ThingAgent
+import ai.ancf.lmos.wot.thing.schema.WoTExposedThing
 import kotlinx.coroutines.Job
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.runBlocking
@@ -21,12 +23,12 @@ fun main(): Unit = runBlocking {
     })
 
     val wot = Wot.create(servient)
-    val exposedThing = createExposedThing(wot, agent)
+    val exposedThing = ThingBuilder.createExposedThing(wot, agent, ThingAgent::class)
 
     // Start `servient` in a separate coroutine
     servient.start()
     // Add and expose the thing after `start()` has had time to begin
-    servient.addThing(exposedThing)
+    servient.addThing(exposedThing as WoTExposedThing)
     servient.expose("agent")
 
     println("Exposed Agent on HTTP Server")

kotlin-wot-integration-tests/src/main/kotlin/integration/MqttAgent.kt

@@ -1,7 +1,9 @@
 package ai.ancf.lmos.wot.integration
 
 import ai.ancf.lmos.wot.Wot
+import ai.ancf.lmos.wot.reflection.ThingBuilder
 import ai.ancf.lmos.wot.reflection.annotations.ThingAgent
+import ai.ancf.lmos.wot.thing.schema.WoTExposedThing
 import kotlinx.coroutines.Job
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.runBlocking
@@ -20,14 +22,14 @@ fun main(): Unit = runBlocking {
     })
 
     val wot = Wot.create(servient)
-    val exposedThing = createExposedThing(wot, agent)
-
+    val exposedThing = ThingBuilder.createExposedThing(wot, agent, ThingAgent::class)
     // Start `servient` in a separate coroutine
     servient.start()
     // Add and expose the thing after `start()` has had time to begin
-    servient.addThing(exposedThing)
+    servient.addThing(exposedThing as WoTExposedThing)
     servient.expose("agent")
     println("Exposed Agent on MQTT Server")
+    println("Exposed Thing:${exposedThing.toJson()}")
     // Keep the application running until process is stopped
     Job().join()
 }

kotlin-wot-integration-tests/src/main/kotlin/integration/ThingAgent.kt

@@ -1,24 +1,34 @@
 package ai.ancf.lmos.wot.reflection.annotations
 
 import dev.langchain4j.model.azure.AzureOpenAiChatModel
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.MutableSharedFlow
 
 
 @Thing(id= "agent", title="Agent",
     description= "A simple agent.")
-class ThingAgent() {
+class ThingAgent(@Property(name = "modelTemperature", readOnly = true)
+                 val modelConfiguration: ModelConfiguration = ModelConfiguration(0.5, 50)) {
+
+    private val messageFlow = MutableSharedFlow<String>(replay = 1) // Replay last emitted value
 
     private val model: AzureOpenAiChatModel = AzureOpenAiChatModel.builder()
         .apiKey("af12dab9c046453e82dcf4b24af90bca")
         .deploymentName("GPT35T-1106")
         .endpoint("https://gpt4-uk.openai.azure.com/")
+        .temperature(modelConfiguration.modelTemperature)
         .build();
 
-    @Property(name = "modelTemperature", readOnly = true)
-    var modelTemperature: ModelConfiguration = ModelConfiguration(0.5, 50)
+    @Action(name = "ask", title = "Ask", description = "Ask the agent a question.")
+    suspend fun  ask(message : String) : String {
+        val response = model.generate(message)
+        messageFlow.emit(response)
+        return model.generate(response)
+    }
 
-    @Action(name = "ask")
-    fun ask(message : String) : String {
-        return model.generate(message)
+    @Event(name = "messageGenerated", title = "Generated message")
+    fun messageGenerated() : Flow<String> {
+        return messageFlow
     }
 }
 

kotlin-wot-integration-tests/src/main/kotlin/integration/Util.kt

@@ -25,7 +25,7 @@ fun createServient(protocol: String): Servient {
             clientFactories = listOf(HttpProtocolClientFactory())
         )
         "MQTT" -> {
-            val mqttConfig = MqttClientConfig("localhost", 54884, "wotServer")
+            val mqttConfig = MqttClientConfig("localhost", 60234, "wotServer")
             Servient(
                 servers = listOf(MqttProtocolServer(mqttConfig))
             )

kotlin-wot-integration-tests/src/test/kotlin/integration/AgentBuilderTest.kt

@@ -5,8 +5,8 @@ import ai.ancf.lmos.wot.Servient
 import ai.ancf.lmos.wot.Wot
 import ai.ancf.lmos.wot.binding.http.HttpProtocolClientFactory
 import ai.ancf.lmos.wot.binding.http.HttpProtocolServer
+import ai.ancf.lmos.wot.reflection.ThingBuilder.createExposedThing
 import ai.ancf.lmos.wot.reflection.annotations.ThingAgent
-import ai.ancf.lmos.wot.reflection.annotations.ThingBuilder
 import ai.ancf.lmos.wot.thing.schema.WoTExposedThing
 import ai.ancf.lmos.wot.thing.schema.toInteractionInputValue
 import kotlinx.coroutines.test.runTest
@@ -26,8 +26,7 @@ class AgentBuilderTest {
         servient.start()
 
         val wot = Wot.create(servient)
-        val exposedThing = ThingBuilder()
-            .createThingDescription(wot, ThingAgent(), ThingAgent::class)
+        val exposedThing = createExposedThing(wot, ThingAgent(), ThingAgent::class)
         if(exposedThing != null){
 
 

kotlin-wot-reflection/src/main/kotlin/reflection/ThingBuilder.kt

@@ -44,7 +44,7 @@ object ThingBuilder {
      * @param clazz The KClass of the object to be described.
      * @return An [ExposedThing] or null if no description could be generated.
      */
-    fun <T : Any> createThingDescription(wot: Wot, instance: T, clazz: KClass<T>): ExposedThing? {
+    fun <T : Any> createExposedThing(wot: Wot, instance: T, clazz: KClass<T>): ExposedThing? {
         log.debug("Creating ThingDescription for class: ${clazz.simpleName}")
 
         // 1. Get the @Thing annotation from the class

kotlin-wot-reflection/src/test/kotlin/reflection/ComplexThingTest.kt

@@ -25,7 +25,7 @@ class ComplexThingTest {
         complexThing = ComplexThing()
 
         // Generate ThingDescription from the class
-        exposedThing = ThingBuilder.createThingDescription(wot, complexThing, ComplexThing::class) as WoTExposedThing
+        exposedThing = ThingBuilder.createExposedThing(wot, complexThing, ComplexThing::class) as WoTExposedThing
         thingDescription = exposedThing.getThingDescription()
     }
 
@@ -47,6 +47,16 @@ class ComplexThingTest {
         assertEquals("Hello World", exampleStringProperty.const)
     }
 
+    @Test
+    fun `test constructorProperty in ThingDescription`() {
+        // Assertions for String Property
+        assertTrue(thingDescription.properties.containsKey("constructorProperty"), "ThingDescription should contain 'constructorProperty' property")
+        val exampleStringProperty = thingDescription.properties["constructorProperty"]
+        assertNotNull(exampleStringProperty, "'constructorProperty' property should not be null")
+        assertIs<StringProperty>(exampleStringProperty, "'constructorProperty' should be a StringProperty")
+        assertEquals("Hello World", exampleStringProperty.const)
+    }
+
     @Test
     fun `test exampleIntProperty in ThingDescription`() {
         // Assertions for Int Property

kotlin-wot-reflection/src/test/kotlin/reflection/SimpleThingTest.kt

@@ -40,7 +40,7 @@ class SimpleThingTest {
         simpleThing = SimpleThing()
 
         // Generate ThingDescription from the class
-        exposedThing = ThingBuilder.createThingDescription(wot, simpleThing, SimpleThing::class)!!
+        exposedThing = ThingBuilder.createExposedThing(wot, simpleThing, SimpleThing::class)!!
 
         servient.addThing(exposedThing)
         servient.expose("simpleThing")

kotlin-wot-reflection/src/test/kotlin/reflection/things/ComplexThing.kt

@@ -16,7 +16,7 @@ import kotlin.random.Random
     title = "Complex Thing",
     description = "A thing with complex properties, actions, and events."
 )
-class ComplexThing {
+class ComplexThing(@Property(name = "constructorProperty", readOnly = true) val constructorProperty: String = "Hello World") {
 
     private val statusChangedFlow = MutableSharedFlow<String>(replay = 1) // Replay last emitted value