springwolf-core: SpringWolf UI send the payloadType with the name of the message when the payload is a String and produce a 400 BadRequest
Describe the bug
I’m using spring integration with some jms adapter, I created the specification on my listener like in the code example. When i try to publish a message from the SpringWolf UI , the client send this request body:
{
"payload":"\"string\"",
"payloadType":"XDataMessagePayload",
"headers":{
"x1":"xValue",
"x2":"xValue"
}
The payloadType is filled with the attribute name = "XDataMessagePayload" and not with the attribute payloadType = String.class setted in the annoation.
This produce a 400 BadRequest and a pubilsh failed error in the UI.
Dependencies and versions used
springboot version 3.2.3
springwolf-ui version 1.2.0
springwolf-core version 1.2.0
springwolf-jms version 1.2.0
Code example
Note: If I omit the attribute name=“XDataMessagePayload” and have multiple messages with the same payloadType (String.class), in the UI the labels all appear the same as the last processed message… 👎🏻
@AsyncListener(
operation = @AsyncOperation(
channelName = "queue-x-to-y-data",
description = "X send the data to Y over this channel",
payloadType = String.class,
message = @AsyncMessage(
name = "XDataMessagePayload",
messageId = "XDataMessage",
description = "Example payload message that X send to Y",
title = "X Data to Y Message"
),
headers = @Headers(
schemaName = "XToYDataHeaders",
values = {
@Header(name = "header1", value = "X1", description = "X1 value"),
@Header(name = "header2", value = "X2", description = "X2 value")
}
)
))
@JmsAsyncOperationBinding
public IntegrationFlow xDataToYListener(....){
//Flow logic
}
@AsyncListener(
operation = @AsyncOperation(
channelName = "queue-z-to-y-data",
description = "Z send the data to Y over this channel",
payloadType = String.class,
message = @AsyncMessage(
name = "ZDataMessagePayload",
messageId = "ZDataMessage",
description = "Example payload message that Z send to Y",
title = "Z Data to Y Message"
),
headers = @Headers(
schemaName = "ZToYDataHeaders",
values = {
@Header(name = "header1", value = "Z1", description = "Z1 value"),
@Header(name = "header2", value = "Z2", description = "Z2 value")
}
)
))
@JmsAsyncOperationBinding
public IntegrationFlow zDataToYListener(....){
//Flow logic
}
Stack trace and error logs
On the chrome console side :
Publishing to /springwolf/jms/publish with messageBinding {} and headers {"x1":"2021-07-01T00:00:00Z","x2":"24324234234"}: {"payload":"\"string\"","payloadType":"XDataMessagePayload ","headers":{"x1":"xValue","x2":"xValue"},"bindings":{}}
POST http://localhost:8080/springwolf/jms/publish?topic=queue-x-to-y-data 400 (Bad Request)
On the backend side with the debug log enabled
INFO 20528 --- [nio-8080-exec-4] i.g.s.c.c.PublishingPayloadCreator : Specified payloadType XDataMessagePayload is not a registered springwolf schema. Known payloadTypes: [XToYDataHeaders,"ZToYDataHeaders",java.lang.String]
About this issue
- Original URL
- State: closed
- Created 3 years ago
- Comments: 16 (7 by maintainers)
Commits related to this issue
- reproduce GH-752 — committed to timonback/springwolf-core by timonback 3 years ago
Thank you, great collaboration!
Can we feature your company as an user, see https://github.com/springwolf/springwolf-core/issues/342 ?
Hi @timonback , I tested some minutes ago the new solution and it works! 🚀 I’m looking forward to introducing version 1.3.0 into my project to document it 😄
Thanks again for your effort! I hope I was helpful! It was a pleasure, see you next time 🙏🏻 ⏭️
@pcomp96 The PRs have been merged and are ready as SNAPSHOT
Hi @pcomp96, I used your code to reproduce it in https://github.com/springwolf/springwolf-core/pull/764
https://github.com/springwolf/springwolf-core/pull/762 (show both descriptions, fix publishing with custom AsyncMessage#name) and https://github.com/springwolf/springwolf-core/pull/763 (using the messageId field internally) should address it.
precisely when i set the name attribute in the @AsyncMessage and the payloadType in @AsyncLis/Pub annotations is setted to String.class, the UI use this value (name attribute) to fill the field payloadType in the request for testing the channel. (It’s wrong because not exist a payloadType with this name).
When i set String.class as payloadType and not set the name attribute in @AsyncMessage, the UI show the same messages label for the messages that have different messageId and same payloadType. (It’s caused by the name duplicate because the schemaName now is the String.class and so mix the message)
I have 2 listener on 2 different channels, They have a String payload with different messageId,name and description.
I’m not able to make a PR this week because i’m really busy sorry , but i think that my example on the top is enough to reproduce the steps. I paste a skeleton to test
Hi @pcomp96 , The plan is to release at the end of each month, so in two weeks. Until then, you can use/verify the current snapshot version.
Thank you for the fix, when u think to publish the release 1.3.x @timonback ?
I need to implement springwolf in my project for the docs generation and for testing purpose. ☺️