recorder: 1.1.2 - The `JsonSerializer` is used for serialization recorder recorder-1.1.2
authorKai Moritz <kai@juplo.de>
Sun, 5 May 2024 11:26:28 +0000 (13:26 +0200)
committerKai Moritz <kai@juplo.de>
Sun, 26 May 2024 19:47:20 +0000 (21:47 +0200)
* Configured the Spring Kafka `JsonSerializer` for serialization.
* The `JsonSerializer` is configured, to add _no_ type-info to the headers.
* Added an integration test to proof, that everything works as expected.

Dockerfile
pom.xml
src/main/java/de/juplo/kafka/wordcount/recorder/RecorderApplication.java
src/main/java/de/juplo/kafka/wordcount/recorder/RecorderController.java
src/main/java/de/juplo/kafka/wordcount/recorder/Recording.java [new file with mode: 0644]
src/test/java/de/juplo/kafka/wordcount/recorder/ApplicationTests.java
src/test/java/de/juplo/kafka/wordcount/recorder/RecordingData.java [new file with mode: 0644]

index 9c0b843..cb9ad4e 100644 (file)
@@ -1,4 +1,4 @@
-FROM openjdk:11-jre-slim
+FROM eclipse-temurin:17-jre
 COPY target/*.jar /opt/app.jar
 EXPOSE 8081
 ENTRYPOINT ["java", "-jar", "/opt/app.jar"]
diff --git a/pom.xml b/pom.xml
index 44a6cd1..0377da1 100644 (file)
--- a/pom.xml
+++ b/pom.xml
@@ -5,12 +5,12 @@
        <parent>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-parent</artifactId>
-               <version>3.0.2</version>
+               <version>3.2.5</version>
                <relativePath/> <!-- lookup parent from repository -->
        </parent>
        <groupId>de.juplo.kafka.wordcount</groupId>
        <artifactId>recorder</artifactId>
-       <version>1.0.2</version>
+       <version>1.1.2</version>
        <name>Wordcount-Recorder</name>
        <description>Recorder-service of the multi-user wordcount-example</description>
        <properties>
@@ -26,8 +26,8 @@
                        <artifactId>spring-boot-starter-web</artifactId>
                </dependency>
                <dependency>
-                       <groupId>org.apache.kafka</groupId>
-                       <artifactId>kafka-clients</artifactId>
+                       <groupId>org.springframework.kafka</groupId>
+                       <artifactId>spring-kafka</artifactId>
                </dependency>
                <dependency>
                        <groupId>org.hibernate.validator</groupId>
                        <artifactId>spring-boot-starter-test</artifactId>
                        <scope>test</scope>
                </dependency>
+               <dependency>
+                       <groupId>org.springframework.kafka</groupId>
+                       <artifactId>spring-kafka-test</artifactId>
+                       <scope>test</scope>
+               </dependency>
+               <dependency>
+                       <groupId>org.awaitility</groupId>
+                       <artifactId>awaitility</artifactId>
+                       <scope>test</scope>
+               </dependency>
        </dependencies>
 
        <build>
index abe0685..3928f2f 100644 (file)
@@ -7,6 +7,7 @@ import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.annotation.Bean;
+import org.springframework.kafka.support.serializer.JsonSerializer;
 import org.springframework.util.Assert;
 
 import java.util.Properties;
@@ -17,14 +18,15 @@ import java.util.Properties;
 public class RecorderApplication
 {
        @Bean(destroyMethod = "close")
-       KafkaProducer<String, String> producer(RecorderApplicationProperties properties)
+       KafkaProducer<String, Recording> producer(RecorderApplicationProperties properties)
        {
                Assert.hasText(properties.getBootstrapServer(), "juplo.wordcount.recorder.bootstrap-server must be set");
 
                Properties props = new Properties();
                props.put(ProducerConfig.BOOTSTRAP_SERVERS_CONFIG, properties.getBootstrapServer());
                props.put(ProducerConfig.KEY_SERIALIZER_CLASS_CONFIG, StringSerializer.class);
-               props.put(ProducerConfig.VALUE_SERIALIZER_CLASS_CONFIG, StringSerializer.class);
+               props.put(ProducerConfig.VALUE_SERIALIZER_CLASS_CONFIG, JsonSerializer.class);
+               props.put(JsonSerializer.ADD_TYPE_INFO_HEADERS, false);
 
                return new KafkaProducer<>(props);
        }
index f7e32e2..c9d2109 100644 (file)
@@ -18,10 +18,12 @@ import jakarta.validation.constraints.NotEmpty;
 public class RecorderController
 {
   private final String topic;
-  private final KafkaProducer<String, String> producer;
+  private final KafkaProducer<String, Recording> producer;
 
 
-  public RecorderController(RecorderApplicationProperties properties, KafkaProducer<String,String> producer)
+  public RecorderController(
+      RecorderApplicationProperties properties,
+      KafkaProducer<String,Recording> producer)
   {
     this.topic = properties.getTopic();
     this.producer = producer;
@@ -44,7 +46,11 @@ public class RecorderController
   {
     DeferredResult<ResponseEntity<RecordingResult>> result = new DeferredResult<>();
 
-    ProducerRecord<String, String> record = new ProducerRecord<>(topic, username, sentence);
+    ProducerRecord<String, Recording> record = new ProducerRecord<>(
+        topic,
+        username,
+        Recording.of(username, sentence));
+
     producer.send(record, (metadata, exception) ->
     {
       if (metadata != null)
diff --git a/src/main/java/de/juplo/kafka/wordcount/recorder/Recording.java b/src/main/java/de/juplo/kafka/wordcount/recorder/Recording.java
new file mode 100644 (file)
index 0000000..6117438
--- /dev/null
@@ -0,0 +1,11 @@
+package de.juplo.kafka.wordcount.recorder;
+
+import lombok.Value;
+
+
+@Value(staticConstructor = "of")
+public class Recording
+{
+  String user;
+  String sentence;
+}
index 885a408..a76c223 100644 (file)
 package de.juplo.kafka.wordcount.recorder;
 
+import lombok.extern.slf4j.Slf4j;
+import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
 import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.test.context.TestConfiguration;
+import org.springframework.context.annotation.Bean;
+import org.springframework.http.MediaType;
+import org.springframework.kafka.annotation.KafkaListener;
+import org.springframework.kafka.support.KafkaHeaders;
+import org.springframework.kafka.test.context.EmbeddedKafka;
+import org.springframework.messaging.handler.annotation.Header;
+import org.springframework.messaging.handler.annotation.Payload;
+import org.springframework.test.web.servlet.MockMvc;
+import org.springframework.test.web.servlet.MvcResult;
+import org.springframework.util.LinkedMultiValueMap;
+import org.springframework.util.MultiValueMap;
 
-@SpringBootTest
+import java.time.Duration;
+import java.util.List;
+import java.util.stream.Stream;
+
+import static de.juplo.kafka.wordcount.recorder.ApplicationTests.TOPIC_OUT;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.awaitility.Awaitility.await;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.asyncDispatch;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
+import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+
+@SpringBootTest(
+               properties = {
+                               "spring.kafka.consumer.auto-offset-reset=earliest",
+                               "spring.kafka.consumer.value-deserializer=org.springframework.kafka.support.serializer.JsonDeserializer",
+                               "spring.kafka.consumer.properties.spring.json.value.default.type=de.juplo.kafka.wordcount.recorder.RecordingData",
+                               "spring.kafka.consumer.properties.spring.json.trusted.packages=de.juplo.kafka.wordcount.recorder",
+                               "logging.level.root=WARN",
+                               "logging.level.de.juplo=DEBUG",
+                               "juplo.wordcount.recorder.bootstrap-server=${spring.embedded.kafka.brokers}",
+                               "juplo.wordcount.recorder.topic=" + TOPIC_OUT })
+@AutoConfigureMockMvc
+@EmbeddedKafka(topics = { TOPIC_OUT })
+@Slf4j
 class ApplicationTests
 {
+       static final String TOPIC_OUT = "out";
+
+       @Autowired
+       MockMvc mockMvc;
+       @Autowired
+       Consumer consumer;
+
+
        @Test
-       void contextLoads()
+       @DisplayName("Posted messages are accepted and sent to Kafka")
+       void userMessagesAreAcceptedAndSentToKafka()
+       {
+               MultiValueMap<String, RecordingData> recordings = new LinkedMultiValueMap<>();
+
+               Stream
+                               .of(
+                                               new RecordingData("päter", "Hall° Wält?¢*&%€!"),
+                                               new RecordingData("päter", "Hallo Welt!"),
+                                               new RecordingData("klühs", "Müsch gäb's auch!"),
+                                               new RecordingData("päter", "Boäh, echt! ß mal nä Nümmäh!"))
+                               .forEach(recording ->
+                               {
+                                       sendRedording(recording.getUser(), recording.getSentence());
+                                       recordings.add(recording.getUser(), recording);
+                               });
+
+
+               await("Received expected messages")
+                               .atMost(Duration.ofSeconds(5))
+                               .untilAsserted(() -> recordings.forEach((user, userRecordings) ->
+                                               assertThat(consumer.receivedFor(user)).containsExactlyElementsOf(userRecordings)));
+       }
+
+       void sendRedording(String user, String sentence)
+       {
+               try
+               {
+                       MvcResult result = mockMvc
+                                       .perform(post("/{user}", user)
+                                                       .contentType(MediaType.TEXT_PLAIN)
+                                                       .content(sentence))
+                                       .andReturn();
+
+                       mockMvc.perform(asyncDispatch(result))
+                                       .andDo(print())
+                                       .andExpect(status().isOk())
+                                       .andExpect(jsonPath("$.username").value(user))
+                                       .andExpect(jsonPath("$.sentence").value(sentence));
+               }
+               catch (Exception e)
+               {
+                       throw new RuntimeException(e);
+               }
+       }
+
+
+       static class Consumer
+       {
+               private final MultiValueMap<String, RecordingData> received = new LinkedMultiValueMap<>();
+
+               @KafkaListener(groupId = "TEST", topics = TOPIC_OUT)
+               public synchronized void receive(
+                               @Header(KafkaHeaders.RECEIVED_KEY) String user,
+                               @Payload RecordingData recording)
+               {
+                       log.debug("Received message: {}={}", user, recording);
+                       received.add(user, recording);
+               }
+
+               synchronized List<RecordingData> receivedFor(String user)
+               {
+                       return received.get(user);
+               }
+       }
+
+       @TestConfiguration
+       static class Configuration
        {
+               @Bean
+               Consumer consumer()
+               {
+                       return new Consumer();
+               }
        }
 }
diff --git a/src/test/java/de/juplo/kafka/wordcount/recorder/RecordingData.java b/src/test/java/de/juplo/kafka/wordcount/recorder/RecordingData.java
new file mode 100644 (file)
index 0000000..95f3288
--- /dev/null
@@ -0,0 +1,15 @@
+package de.juplo.kafka.wordcount.recorder;
+
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+public class RecordingData
+{
+  String user;
+  String sentence;
+}