fix(core): allow to publish with different jackson naming strategies (#1563)

Author: timonback

springwolf-core/src/main/java/io/github/springwolf/core/controller/PublishingPayloadCreator.java

@@ -30,7 +30,7 @@ public class PublishingPayloadCreator {
     private final ObjectMapper objectMapper;
 
     public Result createPayloadObject(MessageDto message) {
-        String messagePayloadType = message.getPayloadType();
+        String messageType = message.getType();
 
         if (MessageDto.EMPTY.equals(message.getPayload())) {
             return new Result(null, Optional.empty());
@@ -44,7 +44,7 @@ public Result createPayloadObject(MessageDto message) {
             SchemaObject schema = componentSchema.getSchema();
 
             // security: match against user input, but always use our controlled data from the DefaultSchemaService
-            if (schemaName != null && schemaName.equals(messagePayloadType)) {
+            if (schemaName != null && schemaName.equals(messageType)) {
                 try {
                     Object payload = resolveActualPayload(message, schema, schemaName);
                     return new Result(payload, Optional.empty());
@@ -57,10 +57,10 @@ public Result createPayloadObject(MessageDto message) {
             }
         }
 
-        String errorMessage = MessageFormat.format(
-                "Specified payloadType {0} is not a registered springwolf schema.", messagePayloadType);
+        String errorMessage =
+                MessageFormat.format("Specified type {0} is not a registered springwolf schema.", messageType);
         String knownPayloadsMessage =
-                MessageFormat.format(" Known payloadTypes: [{0}]", StringUtils.join(knownSchemaNames, ", "));
+                MessageFormat.format(" Known types: [{0}]", StringUtils.join(knownSchemaNames, ", "));
         log.info("{}{}", errorMessage, knownPayloadsMessage);
         return new Result(null, Optional.of(errorMessage));
     }

springwolf-core/src/main/java/io/github/springwolf/core/controller/dtos/MessageDto.java

@@ -1,11 +1,15 @@
 // SPDX-License-Identifier: Apache-2.0
 package io.github.springwolf.core.controller.dtos;
 
+import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.core.JsonParser;
 import com.fasterxml.jackson.databind.DeserializationContext;
 import com.fasterxml.jackson.databind.JsonDeserializer;
 import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.JsonSerializer;
+import com.fasterxml.jackson.databind.SerializerProvider;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
 import lombok.Data;
@@ -26,12 +30,13 @@ public class MessageDto {
     private final Map<String, HeaderValue> headers;
 
     @Builder.Default
-    private final String payloadType = String.class.getCanonicalName();
+    private final String type = String.class.getCanonicalName();
 
     @Builder.Default
     private final String payload = EMPTY;
 
     @JsonDeserialize(using = HeaderValueDeserializer.class)
+    @JsonSerialize(using = HeaderValueSerializer.class)
     public record HeaderValue(String stringValue) {}
 
     public static class HeaderValueDeserializer extends JsonDeserializer<HeaderValue> {
@@ -46,4 +51,17 @@ public HeaderValue deserialize(JsonParser p, DeserializationContext ctxt) throws
             return new HeaderValue(node.toString());
         }
     }
+
+    public static class HeaderValueSerializer extends JsonSerializer<HeaderValue> {
+        @Override
+        public void serialize(HeaderValue value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
+            String stringValue = value.stringValue();
+            try {
+                double number = Double.parseDouble(stringValue);
+                gen.writeNumber(number);
+            } catch (NumberFormatException e) {
+                gen.writeString(stringValue);
+            }
+        }
+    }
 }

springwolf-core/src/test/java/io/github/springwolf/core/asyncapi/controller/dtos/MessageDtoDeserializationTest.java

@@ -0,0 +1,89 @@
+// SPDX-License-Identifier: Apache-2.0
+package io.github.springwolf.core.asyncapi.controller.dtos;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.PropertyNamingStrategies;
+import com.fasterxml.jackson.databind.node.JsonNodeType;
+import io.github.springwolf.core.controller.dtos.MessageDto;
+import io.swagger.v3.core.util.Json;
+import org.junit.jupiter.api.Test;
+
+import static java.util.Collections.singletonMap;
+import static org.assertj.core.api.Assertions.assertThat;
+
+class MessageDtoTest {
+    private static final ObjectMapper objectMapper = Json.mapper();
+
+    @Test
+    void canBeSerialized() throws Exception {
+        String content = "{" + "\"headers\": { \"some-header-key\" : \"some-header-value\" }, "
+                + "\"payload\": \"{\\\"some-payload-key\\\":\\\"some-payload-value\\\"}\", "
+                + "\"type\": \""
+                + MessageDto.class.getCanonicalName() + "\"" + "}";
+
+        MessageDto value = objectMapper.readValue(content, MessageDto.class);
+
+        assertThat(value).isNotNull();
+        assertThat(value.getHeaders())
+                .isEqualTo(singletonMap("some-header-key", new MessageDto.HeaderValue("some-header-value")));
+        assertThat(value.getPayload())
+                .isEqualTo(
+                        new ObjectMapper().writeValueAsString(singletonMap("some-payload-key", "some-payload-value")));
+        assertThat(value.getType()).isEqualTo("io.github.springwolf.core.controller.dtos.MessageDto");
+    }
+
+    @Test
+    void serializationWithDifferentNamingStrategiesIsIndifferent() throws Exception {
+        // https://github.com/springwolf/springwolf-core/issues/1535
+        MessageDto messageDto = MessageDto.builder()
+                .headers(singletonMap("some-header-key", new MessageDto.HeaderValue("some-header-value")))
+                .payload("some-payload-value")
+                .type(MessageDto.class.getCanonicalName())
+                .build();
+
+        String expected = objectMapper.writeValueAsString(messageDto);
+        String actual = objectMapper
+                .copy()
+                .setPropertyNamingStrategy(PropertyNamingStrategies.SNAKE_CASE)
+                .writeValueAsString(messageDto);
+
+        assertThat(actual).isEqualTo(expected);
+    }
+
+    @Test
+    void canDeserializeStringHeaderValue() throws Exception {
+        // given
+        String content = "\"12345\"";
+
+        // when
+        MessageDto.HeaderValue value = objectMapper.readValue(content, MessageDto.HeaderValue.class);
+
+        // then
+        assertThat(value).isEqualTo(new MessageDto.HeaderValue("12345"));
+    }
+
+    @Test
+    void canDeserializeNumericHeaderValue() throws Exception {
+        // given
+        String content = "12345";
+
+        // when
+        MessageDto.HeaderValue value = objectMapper.readValue(content, MessageDto.HeaderValue.class);
+
+        // then
+        assertThat(value).isEqualTo(new MessageDto.HeaderValue("12345"));
+    }
+
+    @Test
+    void canSerializeNumericHeaderValue() throws Exception {
+        // given
+        MessageDto.HeaderValue headerValue = new MessageDto.HeaderValue("12345");
+
+        // when
+        JsonNode json = objectMapper.valueToTree(headerValue);
+
+        // then
+        assertThat(json.getNodeType()).isEqualTo(JsonNodeType.NUMBER);
+    }
+}