fix: make message traits referenceable (#86)

* Make message traits referencable

* Fix context module

Author: lorenzsimon

kotlin-asyncapi-context/src/main/kotlin/com/asyncapi/kotlinasyncapi/context/annotation/processor/MappingUtils.kt

@@ -1,7 +1,5 @@
 package com.asyncapi.kotlinasyncapi.context.annotation.processor
 
-import com.fasterxml.jackson.core.type.TypeReference
-import com.fasterxml.jackson.databind.ObjectMapper
 import com.asyncapi.kotlinasyncapi.annotation.CorrelationID
 import com.asyncapi.kotlinasyncapi.annotation.ExternalDocumentation
 import com.asyncapi.kotlinasyncapi.annotation.Schema
@@ -27,13 +25,15 @@ import com.asyncapi.kotlinasyncapi.model.ReferencableSchemasMap
 import com.asyncapi.kotlinasyncapi.model.Reference
 import com.asyncapi.kotlinasyncapi.model.TagsList
 import com.asyncapi.kotlinasyncapi.model.channel.MessageExamplesList
-import com.asyncapi.kotlinasyncapi.model.channel.MessageTraitsList
 import com.asyncapi.kotlinasyncapi.model.channel.OneOfReferencableMessages
 import com.asyncapi.kotlinasyncapi.model.channel.Operation
+import com.asyncapi.kotlinasyncapi.model.channel.ReferencableMessageTraitsList
 import com.asyncapi.kotlinasyncapi.model.channel.ReferencableMessagesList
 import com.asyncapi.kotlinasyncapi.model.channel.ReferencableOperationTraitsList
 import com.asyncapi.kotlinasyncapi.model.channel.ReferencableParametersMap
 import com.asyncapi.kotlinasyncapi.model.server.SecurityRequirementsList
+import com.fasterxml.jackson.core.type.TypeReference
+import com.fasterxml.jackson.databind.ObjectMapper
 import java.util.AbstractMap
 
 internal fun Message.toMessage(): com.asyncapi.kotlinasyncapi.model.channel.Message =
@@ -140,8 +140,8 @@ internal fun Array<MessageExample>.toMessageExamplesList(): MessageExamplesList
         addAll(this@toMessageExamplesList.map { it.toMessageExample() })
     }
 
-internal fun Array<MessageTrait>.toMessageTraitsList(): MessageTraitsList =
-    MessageTraitsList().apply {
+internal fun Array<MessageTrait>.toMessageTraitsList(): ReferencableMessageTraitsList =
+    ReferencableMessageTraitsList().apply {
         addAll(this@toMessageTraitsList.map { it.toMessageTrait() })
     }
 

kotlin-asyncapi-core/src/main/kotlin/com/asyncapi/kotlinasyncapi/model/channel/Message.kt

@@ -49,7 +49,7 @@ class Message {
     var externalDocs: ExternalDocumentation? = null
     var bindings: Any? = null
     var examples: MessageExamplesList? = null
-    var traits: MessageTraitsList? = null
+    var traits: ReferencableMessageTraitsList? = null
 
     fun messageId(value: String): String =
         value.also { messageId = it }
@@ -105,6 +105,6 @@ class Message {
     inline fun examples(build: MessageExamplesList.() -> Unit): MessageExamplesList =
         MessageExamplesList().apply(build).also { examples = it }
 
-    inline fun traits(build: MessageTraitsList.() -> Unit): MessageTraitsList =
-        MessageTraitsList().apply(build).also { traits = it }
+    inline fun traits(build: ReferencableMessageTraitsList.() -> Unit): ReferencableMessageTraitsList =
+        ReferencableMessageTraitsList().apply(build).also { traits = it }
 }

kotlin-asyncapi-core/src/main/kotlin/com/asyncapi/kotlinasyncapi/model/channel/MessageTrait.kt

@@ -8,9 +8,12 @@ import com.asyncapi.kotlinasyncapi.model.Schema
 import com.asyncapi.kotlinasyncapi.model.TagsList
 
 @AsyncApiComponent
-class MessageTraitsList : ArrayList<MessageTrait>() {
+class ReferencableMessageTraitsList : ArrayList<Any>() {
     inline fun trait(build: MessageTrait.() -> Unit): MessageTrait =
         MessageTrait().apply(build).also { add(it) }
+
+    inline fun reference(build: Reference.() -> Unit): Reference =
+        Reference().apply(build).also { add(it) }
 }
 
 @AsyncApiComponent

kotlin-asyncapi-core/src/test/kotlin/com/asyncapi/kotlinasyncapi/model/AsyncApiIntegrationTest.kt

@@ -1,9 +1,9 @@
 package com.asyncapi.kotlinasyncapi.model
 
-import org.junit.jupiter.api.Test
 import com.asyncapi.kotlinasyncapi.model.AsyncApi.Companion.asyncApi
 import com.asyncapi.kotlinasyncapi.model.TestUtils.assertJsonEquals
 import com.asyncapi.kotlinasyncapi.model.TestUtils.json
+import org.junit.jupiter.api.Test
 
 internal class AsyncApiIntegrationTest {
 
@@ -93,6 +93,11 @@ internal class AsyncApiIntegrationTest {
                         bindingsRef {
                             ref("#/components/messageBindings/streamingHeaders")
                         }
+                        traits {
+                            reference {
+                                ref("#/components/messageTraits/cloudEventHeaders")
+                            }
+                        }
                     }
                 }
                 messageBindings {
@@ -114,6 +119,11 @@ internal class AsyncApiIntegrationTest {
                         }
                     }
                 }
+                messageTraits {
+                    trait("cloudEventHeaders") {
+                        name("Cloud Events Header")
+                    }
+                }
             }
         }
         val expected = json("async_api_integration.json")

kotlin-asyncapi-core/src/test/resources/async_api_integration.json

@@ -4,17 +4,6 @@
     "title" : "Gitter Streaming API",
     "version" : "1.0.0"
   },
-  "id" : "urn:com:gitter:streaming:api",
-  "servers" : {
-    "production" : {
-      "url" : "https://stream.gitter.im/v1",
-      "protocol" : "https",
-      "protocolVersion" : "1.1",
-      "security" : [ {
-        "httpBearerToken" : [ ]
-      } ]
-    }
-  },
   "channels" : {
     "/rooms/{roomId}" : {
       "subscribe" : {
@@ -42,6 +31,17 @@
       }
     }
   },
+  "id" : "urn:com:gitter:streaming:api",
+  "servers" : {
+    "production" : {
+      "url" : "https://stream.gitter.im/v1",
+      "protocol" : "https",
+      "protocolVersion" : "1.1",
+      "security" : [ {
+        "httpBearerToken" : [ ]
+      } ]
+    }
+  },
   "components" : {
     "messages" : {
       "chatMessage" : {
@@ -73,7 +73,10 @@
         "summary" : "Its purpose is to keep the connection alive.",
         "bindings" : {
           "$ref" : "#/components/messageBindings/streamingHeaders"
-        }
+        },
+        "traits" : [ {
+          "$ref" : "#/components/messageTraits/cloudEventHeaders"
+        } ]
       }
     },
     "securitySchemes" : {
@@ -82,6 +85,11 @@
         "scheme" : "bearer"
       }
     },
+    "messageTraits" : {
+      "cloudEventHeaders" : {
+        "name" : "Cloud Events Header"
+      }
+    },
     "messageBindings" : {
       "streamingHeaders" : {
         "http" : {