feat(ui): Show operation and message description, fix publishing when using AsyncMessage#name

springwolf-examples/e2e/tests/publishing.spec.ts

@@ -61,6 +61,11 @@ function testPublishingEveryChannelItem() {
       const channelName = operation.channel.$ref.split("/").pop();
       const schemaType = messageReference.$ref.split("/").pop();
       const payload = asyncApiDoc.components.messages[schemaType]?.title;
+      const payloadType = asyncApiDoc.components.messages[
+        schemaType
+      ]?.payload.schema.$ref
+        .split("/")
+        .pop();
 
       if (
         payload === "AnotherPayloadAvroDto" || // Avro publishing is not supported
@@ -100,13 +105,15 @@ function testPublishingEveryChannelItem() {
                   const found = dockerLogs.messages
                     .filter((m) => m.includes("Publishing to"))
                     .filter((m) => m.includes(channelName))
-                    .filter((m) => m.includes(schemaType)).length;
+                    .filter((m) => m.includes(payloadType)).length;
                   console.debug(
-                    "Polling for publish message and found=" + found
+                    `Polling for publish message and found=${found}`
                   );
                   return found;
                 },
-                { message: "Expected publishing message in application logs" }
+                {
+                  message: `Expected publishing message in application logs in channel ${channelName} with type ${payloadType}`,
+                }
               )
               .toBeGreaterThanOrEqual(1);
           }
@@ -118,12 +125,12 @@ function testPublishingEveryChannelItem() {
                     .filter((m) => m.includes("Received new message in"))
                     .filter((m) => m.includes(channelName)).length;
                   console.debug(
-                    "Polling for receive message and found=" + found
+                    `Polling for receive message and found=${found}`
                   );
                   return found;
                 },
                 {
-                  message: "Expected receiving message in appliation logs",
+                  message: `Expected receiving message in application logs in channel ${channelName}`,
                   timeout: 10_000,
                 }
               )

springwolf-examples/springwolf-kafka-example/src/main/java/io/github/springwolf/examples/kafka/consumers/StringConsumer.java

@@ -3,6 +3,7 @@
 
 import io.github.springwolf.core.asyncapi.annotations.AsyncApiPayload;
 import io.github.springwolf.core.asyncapi.annotations.AsyncListener;
+import io.github.springwolf.core.asyncapi.annotations.AsyncMessage;
 import io.github.springwolf.core.asyncapi.annotations.AsyncOperation;
 import io.github.springwolf.plugins.kafka.asyncapi.annotations.KafkaAsyncOperationBinding;
 import io.swagger.v3.oas.annotations.media.Schema;
@@ -28,6 +29,7 @@ public class StringConsumer {
                             description =
                                     "Final classes (like String) can be documented using an envelope class and the @AsyncApiPayload annotation.",
                             payloadType = StringEnvelope.class,
+                            message = @AsyncMessage(name = "StringPayload"),
                             headers = @AsyncOperation.Headers(notUsed = true)))
     @KafkaAsyncOperationBinding
     public void receiveStringPayload(String stringPayload) {

springwolf-examples/springwolf-kafka-example/src/test/resources/asyncapi.json

@@ -104,8 +104,8 @@
     },
     "string-topic": {
       "messages": {
-        "io.github.springwolf.examples.kafka.consumers.StringConsumer$StringEnvelope": {
-          "$ref": "#/components/messages/io.github.springwolf.examples.kafka.consumers.StringConsumer$StringEnvelope"
+        "StringPayload": {
+          "$ref": "#/components/messages/StringPayload"
         },
         "java.lang.String": {
           "$ref": "#/components/messages/java.lang.String"
@@ -1213,7 +1213,7 @@
           }
         }
       },
-      "io.github.springwolf.examples.kafka.consumers.StringConsumer$StringEnvelope": {
+      "StringPayload": {
         "headers": {
           "$ref": "#/components/schemas/HeadersNotUsed"
         },
@@ -1223,7 +1223,7 @@
             "$ref": "#/components/schemas/io.github.springwolf.examples.kafka.consumers.StringConsumer$StringEnvelope"
           }
         },
-        "name": "io.github.springwolf.examples.kafka.consumers.StringConsumer$StringEnvelope",
+        "name": "StringPayload",
         "title": "StringEnvelope",
         "description": "Payload description using @Schema annotation and @AsyncApiPayload within envelope class",
         "bindings": {
@@ -1604,7 +1604,7 @@
       },
       "messages": [
         {
-          "$ref": "#/channels/string-topic/messages/io.github.springwolf.examples.kafka.consumers.StringConsumer$StringEnvelope"
+          "$ref": "#/channels/string-topic/messages/StringPayload"
         },
         {
           "$ref": "#/channels/string-topic/messages/java.lang.String"

springwolf-ui/src/app/components/channels/channel-main/channel-main.component.css

@@ -33,6 +33,20 @@ button {
   height: 50px;
 }
 
+.table {
+  display: table;
+}
+.table .table-row {
+  display: table-row;
+}
+.table-row * {
+  display: table-cell;
+}
+.table-row *:first-child {
+  font-weight: bold;
+  padding-right: 8px;
+}
+
 [hidden] {
   display: none !important;
 }

springwolf-ui/src/app/components/channels/channel-main/channel-main.component.html

@@ -1,10 +1,17 @@
 <!-- SPDX-License-Identifier: Apache-2.0 -->
 <section>
   <mat-divider></mat-divider>
-  <div *ngIf="operation.message.description">
-    <p>
-      <markdown [data]="operation.message.description"></markdown>
-    </p>
+  <div *ngIf="operation.description || operation.message.description">
+    <div class="table">
+      <div *ngIf="operation.description" class="table-row">
+        <span>Operation description</span>
+        <markdown [data]="operation.description"></markdown>
+      </div>
+      <div *ngIf="operation.message.description" class="table-row">
+        <span>Message description</span>
+        <markdown [data]="operation.message.description"></markdown>
+      </div>
+    </div>
     <mat-divider></mat-divider>
   </div>
   <mat-tab-group animationDuration="0ms">

springwolf-ui/src/app/components/channels/channel-main/channel-main.component.ts

@@ -47,7 +47,7 @@ export class ChannelMainComponent implements OnInit {
 
       this.defaultExample = this.schema.example;
       this.exampleTextAreaLineCount = this.defaultExample?.lineCount || 1;
-      this.defaultExampleType = this.operation.message.name;
+      this.defaultExampleType = this.operation.message.payload.type;
 
       this.headersSchemaIdentifier = this.operation.message.headers.name.slice(
         this.operation.message.headers.name.lastIndexOf("/") + 1

springwolf-ui/src/app/models/message.model.ts

@@ -7,6 +7,7 @@ export interface Message {
   description?: string;
   payload: {
     name: string;
+    type: string;
     title: string;
     anchorUrl: string;
   };

springwolf-ui/src/app/models/operation.model.ts

@@ -4,6 +4,7 @@ import { Bindings } from "./bindings.model";
 
 export type OperationType = "receive" | "send";
 export interface Operation {
+  description?: string;
   message: Message;
   bindings?: Bindings;
   protocol?: string;

springwolf-ui/src/app/service/asyncapi/asyncapi-mapper.service.ts

@@ -108,7 +108,8 @@ export class AsyncApiMapperService {
                 channels[channelName],
                 message,
                 operation.action,
-                operation.bindings
+                operation.bindings,
+                operation.description
               )
           );
 
@@ -126,12 +127,14 @@ export class AsyncApiMapperService {
     channel: ServerChannel,
     message: Message,
     operationType: ServerOperation["action"],
-    operationBinding: ServerBindings
+    operationBinding: ServerBindings,
+    description?: string
   ): ChannelOperation {
     const operation = this.mapOperation(
       operationType,
       message,
-      operationBinding
+      operationBinding,
+      description
     );
 
     return {
@@ -175,6 +178,7 @@ export class AsyncApiMapperService {
               payload: {
                 name: message.payload.schema.$ref,
                 title: this.resolveRef(message.payload.schema.$ref),
+                type: this.resolveRef(message.payload.schema.$ref),
                 anchorUrl:
                   AsyncApiMapperService.BASE_URL +
                   this.resolveRef(message.payload.schema.$ref),
@@ -230,11 +234,13 @@ export class AsyncApiMapperService {
   private mapOperation(
     operationType: ServerOperation["action"],
     message: Message,
-    bindings?: Bindings
+    bindings?: Bindings,
+    description?: string
   ): Operation {
     return {
       protocol: this.getProtocol(bindings),
       operationType: operationType == "send" ? "send" : "receive",
+      description,
       message,
       bindings,
     };

springwolf-ui/src/app/service/asyncapi/models/operations.model.ts

@@ -7,6 +7,7 @@ export interface ServerOperations {
 
 export interface ServerOperation {
   action: string;
+  description?: string;
   channel: {
     $ref: string;
   };

springwolf-ui/src/app/service/mock/mock-server.ts

@@ -8,7 +8,7 @@ import { exampleSchemas } from "./example-data";
 
 export class MockServer implements InMemoryDbService {
   createDb() {
-    return { kafka: [] };
+    return {};
   }
 
   get(reqInfo: RequestInfo) {