Skip to content

GH-11183: Fix batch mode message ID generation in KafkaMessageDrivenChannelAdapter #11184

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
artembilan merged 3 commits into from
Jul 15, 2026
+44 −4
Merged

GH-11183: Fix batch mode message ID generation in KafkaMessageDrivenChannelAdapter #11184

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4407eef
GH-11183: Fix batch mode message ID generation in KafkaMessageDrivenC…
Zernov-A Jul 15, 2026
5cb3819
Add @author tags and consolidate converter setup in KafkaMessageDrive…
Zernov-A Jul 15, 2026
9d705dd
remove foo/bar and redundant test config
Zernov-A Jul 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions .../java/org/springframework/integration/kafka/inbound/KafkaMessageDrivenChannelAdapter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@
import org.springframework.kafka.support.JsonKafkaHeaderMapper;
import org.springframework.kafka.support.KafkaHeaders;
import org.springframework.kafka.support.converter.BatchMessageConverter;
import org.springframework.kafka.support.converter.BatchMessagingMessageConverter;
import org.springframework.kafka.support.converter.ConversionException;
import org.springframework.kafka.support.converter.KafkaMessageHeaders;
import org.springframework.kafka.support.converter.MessageConverter;
Expand All @@ -77,6 +78,7 @@
* @author Artem Bilan
* @author Urs Keller
* @author Jooyoung Pyoung
* @author Zernov Oleksii

@artembilan artembilan Jul 15, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the international naming convention is to express first name first.
See an example of my name in this list which is Ukrainian, too.

*
* @since 5.4
*/
Expand Down Expand Up @@ -143,17 +145,22 @@ public KafkaMessageDrivenChannelAdapter(AbstractMessageListenerContainer<K, V> m
JacksonMessagingUtils.DEFAULT_TRUSTED_PACKAGES
.toArray(new String[0]));
messageConverter.setHeaderMapper(headerMapper);
this.recordListener.setMessageConverter(messageConverter);
this.batchListener.setMessageConverter(messageConverter);
}
else if (JacksonPresent.isJackson2Present()) {
var headerMapper = new org.springframework.kafka.support.DefaultKafkaHeaderMapper();
headerMapper.addTrustedPackages(
org.springframework.integration.support.json.JacksonJsonUtils.DEFAULT_TRUSTED_PACKAGES
.toArray(new String[0]));
messageConverter.setHeaderMapper(headerMapper);
this.recordListener.setMessageConverter(messageConverter);
this.batchListener.setMessageConverter(messageConverter);
}

this.recordListener.setMessageConverter(messageConverter);

if (this.mode.equals(ListenerMode.batch)) {
var batchMessagingMessageConverter = new BatchMessagingMessageConverter(messageConverter);
batchMessagingMessageConverter.setGenerateMessageId(true);
batchMessagingMessageConverter.setGenerateTimestamp(true);
this.batchListener.setBatchMessageConverter(batchMessagingMessageConverter);
}
}

Expand Down
36 changes: 36 additions & 0 deletions ...egration-kafka/src/test/java/org/springframework/integration/kafka/dsl/KafkaDslTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@
* @author Anshul Mehra
* @author Jooyoung Pyoung
* @author Glenn Renfro
* @author Zernov Oleksii
*
* @since 5.4
*/
Expand All @@ -123,6 +124,8 @@ public class KafkaDslTests {

static final String TEST_TOPIC8 = "test-topic8";

static final String TEST_TOPIC10 = "test-topic10";

@Autowired
@Qualifier("sendToKafkaFlow.input")
private MessageChannel sendToKafkaFlowInput;
Expand All @@ -133,6 +136,9 @@ public class KafkaDslTests {
@Autowired
private PollableChannel listeningFromKafkaResults2;

@Autowired
private PollableChannel listeningFromKafkaResults3;

@Autowired
@Qualifier("kafkaProducer1.handler")
private KafkaProducerMessageHandler<?, ?> kafkaProducer1;
Expand All @@ -155,6 +161,9 @@ public class KafkaDslTests {
@Qualifier("kafkaTemplate:" + TEST_TOPIC2)
private KafkaTemplate<?, ?> kafkaTemplateTopic2;

@Autowired
private KafkaTemplate<Integer, String> kafkaTemplate;

@Autowired
private JsonKafkaHeaderMapper mapper;

Expand Down Expand Up @@ -195,6 +204,7 @@ void testKafkaAdapters() throws Exception {
assertThat(headers.containsKey(KafkaHeaders.ACKNOWLEDGMENT)).isTrue();
Acknowledgment acknowledgment = headers.get(KafkaHeaders.ACKNOWLEDGMENT, Acknowledgment.class);
acknowledgment.acknowledge();
assertThat(headers.get(MessageHeaders.ID)).isNotNull();
assertThat(headers.get(KafkaHeaders.RECEIVED_TOPIC)).isEqualTo(TEST_TOPIC1);
assertThat(headers.get(KafkaHeaders.RECEIVED_KEY)).isEqualTo(i + 1);
assertThat(headers.get(KafkaHeaders.RECEIVED_PARTITION)).isEqualTo(0);
Expand All @@ -211,6 +221,7 @@ void testKafkaAdapters() throws Exception {
assertThat(headers.containsKey(KafkaHeaders.ACKNOWLEDGMENT)).isTrue();
Acknowledgment acknowledgment = headers.get(KafkaHeaders.ACKNOWLEDGMENT, Acknowledgment.class);
acknowledgment.acknowledge();
assertThat(headers.get(MessageHeaders.ID)).isNotNull();
assertThat(headers.get(KafkaHeaders.RECEIVED_TOPIC)).isEqualTo(TEST_TOPIC2);
assertThat(headers.get(KafkaHeaders.RECEIVED_KEY)).isEqualTo(i + 1);
assertThat(headers.get(KafkaHeaders.RECEIVED_PARTITION)).isEqualTo(0);
Expand Down Expand Up @@ -269,6 +280,17 @@ void channels(@Qualifier("topic6Channel") MessageChannel topic6Channel,
.isEqualTo("foo");
}

@Test
void testBatchListener() {
this.kafkaTemplate.send(TEST_TOPIC10, "foo");

@artembilan artembilan Jul 15, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please, don't use foo/bar language in the code.
I know we have a lot of them already there, but we prefer to get rid of it eventually.

Thanks


Message<?> receive = this.listeningFromKafkaResults3.receive(20000);
assertThat(receive).isNotNull();
assertThat(receive.getPayload()).isEqualTo("foo");
MessageHeaders headers = receive.getHeaders();
assertThat(headers.get(MessageHeaders.ID)).isNotNull();
}

@Configuration
@EnableIntegration
@EnableKafka
Expand Down Expand Up @@ -341,6 +363,20 @@ public IntegrationFlow topic2ListenerFromKafkaFlow() {
.get();
}

@Bean
public IntegrationFlow batchListenerFromKafkaFlow() {
return IntegrationFlow
.from(Kafka
.messageDrivenChannelAdapter(consumerFactory(),
KafkaMessageDrivenChannelAdapter.ListenerMode.batch, TEST_TOPIC10)
.configureListenerContainer(c ->
c.ackMode(ContainerProperties.AckMode.MANUAL)
.id("topic10ListenerContainer")))

@artembilan artembilan Jul 15, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think that we need any of these customization to proof the concept.
I mean the goal of this specific test to make sure splitter doesn't fail.
So, what container id or what mode, doesn't matter.
Therefore redundant from the readability perspective.
Less code in the test - less chance of bugs in tests 😄

.split()
.channel(c -> c.queue("listeningFromKafkaResults3"))
.get();
}

@Bean
public ProducerFactory<Integer, String> producerFactory() {
Map<String, Object> props = KafkaTestUtils.producerProps(this.embeddedKafkaBrokers);
Expand Down