GH-3542: Adds the ability to add record interceptors instead of override them #3937

chickenchickenlove · 2025-06-01T04:01:17Z

Fixes: #3542
Issue link: #3542

What?
Change RecordInterceptor to List<RecordInterceptor> in MessageListenerContainer.

Why?
To allow adding multiple RecordInterceptor instances instead of overriding the existing one. Currently, only a single RecordInterceptor is supported. Users may want to register multiple RecordInterceptors. There are some workarounds, but they are not clean or ideal solutions.

By supporting List<RecordInterceptor>, users can add their own interceptors via setRecordInterceptor(...).

…nstead of override them Fixes: spring-projects#3542 Issue link: spring-projects#3542 What? Change `RecordInterceptor` to `List<RecordInterceptor>` in `MessageListenerContainer`. Why? To allow adding multiple `RecordInterceptor` instances instead of overriding the existing one. Currently, only a single `RecordInterceptor` is supported. Users may want to register multiple `RecordInterceptors`. There are some workarounds, but they are not clean or ideal solutions. By supporting `List<RecordInterceptor`>, users can add their own interceptors via `setRecordInterceptor(...)`. Signed-off-by: Sanghyeok An <[email protected]>

Signed-off-by: Sanghyeok An <[email protected]>

artembilan

We already have this: https://github.com/spring-projects/spring-kafka/blob/main/spring-kafka/src/main/java/org/springframework/kafka/listener/CompositeRecordInterceptor.java#L51.
So, I would expect done change over there . This is really not a container responsibility. Plus, you made too many braking changes. And setter contract is to override , not add. For add we would implement adder.
At a glance a cannot accept the change .
Thank you for understanding!

Signed-off-by: Sanghyeok An <[email protected]>

chickenchickenlove · 2025-06-01T14:16:57Z

@artembilan

Sorry to bother you.
I misunderstood your point at all 🙇‍♂️.

I made new commits to use CompositeRecordInterceptor.
When you have time, please take a look!

artembilan · 2025-06-01T14:40:03Z

...kafka/src/main/java/org/springframework/kafka/listener/AbstractMessageListenerContainer.java

+	 */
+	public void addRecordInterceptor(RecordInterceptor<K, V> recordInterceptor) {
+		if (this.recordInterceptor instanceof CompositeRecordInterceptor<K, V> compositeRecordInterceptor) {
+			compositeRecordInterceptor.addRecordInterceptor(recordInterceptor);


So, if the composite is an external and shared, calling this from one container would mutate all others. I understand a desire to have everything container related in one place, but consequences might not be good.
Or we just leave responsibility only in the composite, or bite a bullet and always have a composite here internally as a value of interceptor property. This way any add on the container would not effect the rest of application . The awkward situation when composite is provided, but I don’t see any other way to protect from race condition .
Of course, I’d prefer to have add only in the composite, but I’m opened for any other arguments.

You are right.
I missed that case. (Many users already create it as bean and use it)

As you said, Adding a new API addRecordInterceptor(...) to only CompositeRecordInterceptor makes sense to me 👍 . Also, I don't like useless recursive usage (Composite -> Composite -> ... -> Composite) 😄.

Signed-off-by: Sanghyeok An <[email protected]>

artembilan

Your name to the @author list of this affected class?

spring-kafka/src/main/java/org/springframework/kafka/listener/CompositeRecordInterceptor.java

Signed-off-by: Sanghyeok An <[email protected]>

artembilan

Looks like we also need a getRecordInterceptor() in the container. See issue for more info.
As we have just discussed the add in the container is not OK, but get, compose manually and then set should be clear enough without consequences .

Signed-off-by: Sanghyeok An <[email protected]>

...kafka/src/main/java/org/springframework/kafka/listener/AbstractMessageListenerContainer.java

sobychacko

@chickenchickenlove Changes look good to me. As @artembilan suggested, please make the getter in AMLC public (add since tag etc.). I would also suggest adding some type of unit testing for the changes involved. Apart from that, I think we may need some documentation updates as well as a small indicator for this in the whats-new docs. Thanks!

Signed-off-by: Sanghyeok An <[email protected]>

artembilan

Checkstyle violation:

 Error: eckstyle] [ERROR] /home/runner/work/spring-kafka/spring-kafka/spring-kafka/src/test/java/org/springframework/kafka/listener/KafkaMessageListenerContainerTests.java:3865: Line has leading space characters; indentation should be performed with tabs only. [RegexpSinglelineJava]

Use gradlew check locally before push, please.

Signed-off-by: Sanghyeok An <[email protected]>

chickenchickenlove · 2025-06-04T14:10:00Z

I'm so sorry. I forgot it. 🙇‍♂️
I fixed lint error.

spring-kafka-docs/src/main/antora/modules/ROOT/pages/whats-new.adoc

Signed-off-by: Sanghyeok An <[email protected]>

artembilan

Just couple docs suggestions.
Thanks

artembilan · 2025-06-06T12:58:35Z

spring-kafka-docs/src/main/antora/modules/ROOT/pages/whats-new.adoc

+=== Configure additional `RecordInterceptor`
+
+The `KafkaMessageListenerContainer` and `ConcurrentMessageListenerContainer` support `getRecordInterceptor()`.
+If the returned interceptor is an instance of `CompositeRecordInterceptor`, additional `RecordInterceptor` instances can be added to it.


This technical detail is not required to be present in What's New.

.../src/main/antora/modules/ROOT/pages/kafka/receiving-messages/message-listener-container.adoc

Signed-off-by: Sanghyeok An <[email protected]>

artembilan · 2025-06-07T00:04:44Z

.../src/main/antora/modules/ROOT/pages/kafka/receiving-messages/message-listener-container.adoc

+    if (container.getRecordInterceptor() instanceof CompositeRecordInterceptor interceptor) {
+        compositeInterceptor = interceptor;
+    } else {
+        compositeInterceptor = new CompositeRecordInterceptor<>();


Looks like just returned interceptor is not preserved in a new composite.

Sorry for that.
I added a new commit to fix that!

Please, look into my comment again .
that interceptor variable is out of use after this. I believe it has to be propagated to ctor of new composite .

artembilan · 2025-06-07T00:10:05Z

.../src/main/antora/modules/ROOT/pages/kafka/receiving-messages/message-listener-container.adoc

+    if (container.getRecordInterceptor() instanceof CompositeRecordInterceptor interceptor) {
+        compositeInterceptor = interceptor;
+    } else {
+        compositeInterceptor = new CompositeRecordInterceptor<>();


Please, look into my comment again .
that interceptor variable is out of use after this. I believe it has to be propagated to ctor of new composite .

Signed-off-by: Sanghyeok An <[email protected]>

artembilan

LGTM
Paging @sobychacko for final approval .
Thank you!

chickenchickenlove added 2 commits June 1, 2025 12:46

Remove useless comment and code.

5896ec2

Signed-off-by: Sanghyeok An <[email protected]>

chickenchickenlove changed the title ~~spring-projectsGH-3542: Adds the ability to add record interceptors instead of override them~~ GH-3542: Adds the ability to add record interceptors instead of override them Jun 1, 2025

artembilan requested changes Jun 1, 2025

View reviewed changes

chickenchickenlove added 3 commits June 1, 2025 22:21

Revert 2 commits.

7a6a385

Signed-off-by: Sanghyeok An <[email protected]>

Add new API addRecordInterceptor.

7d94fca

Signed-off-by: Sanghyeok An <[email protected]>

Add an CompositeRecordInterceptor to addRecordInterceptor API.

d38216b

Signed-off-by: Sanghyeok An <[email protected]>

chickenchickenlove requested a review from artembilan June 1, 2025 14:17

artembilan requested changes Jun 1, 2025

View reviewed changes

chickenchickenlove added 2 commits June 1, 2025 23:55

Revert 2 commits.

b84556e

Signed-off-by: Sanghyeok An <[email protected]>

Add new API addRecordInterceptor.

defe8fb

Signed-off-by: Sanghyeok An <[email protected]>

artembilan requested changes Jun 2, 2025

View reviewed changes

spring-kafka/src/main/java/org/springframework/kafka/listener/CompositeRecordInterceptor.java Show resolved Hide resolved

Addressing PR review

21a7717

Signed-off-by: Sanghyeok An <[email protected]>

chickenchickenlove requested a review from artembilan June 3, 2025 00:41

artembilan requested a review from sobychacko June 3, 2025 01:11

artembilan requested changes Jun 3, 2025

View reviewed changes

Addressing PR review

0d9010d

Signed-off-by: Sanghyeok An <[email protected]>

artembilan requested changes Jun 3, 2025

View reviewed changes

...kafka/src/main/java/org/springframework/kafka/listener/AbstractMessageListenerContainer.java Show resolved Hide resolved

sobychacko requested changes Jun 3, 2025

View reviewed changes

Addressing PR review

61c4ad2

Signed-off-by: Sanghyeok An <[email protected]>

chickenchickenlove requested review from sobychacko and artembilan June 4, 2025 12:36

artembilan approved these changes Jun 4, 2025

View reviewed changes

artembilan requested changes Jun 4, 2025

View reviewed changes

Addressing PR review

0a6c020

Signed-off-by: Sanghyeok An <[email protected]>

artembilan approved these changes Jun 4, 2025

View reviewed changes

sobychacko requested changes Jun 4, 2025

View reviewed changes

spring-kafka-docs/src/main/antora/modules/ROOT/pages/whats-new.adoc Outdated Show resolved Hide resolved

Addressing PR review -s

d684913

Signed-off-by: Sanghyeok An <[email protected]>

chickenchickenlove requested a review from sobychacko June 5, 2025 23:57

artembilan requested changes Jun 6, 2025

View reviewed changes

sobychacko approved these changes Jun 6, 2025

View reviewed changes

chickenchickenlove added 2 commits June 7, 2025 08:58

Addressing PR review.

7150d68

Signed-off-by: Sanghyeok An <[email protected]>

Add missing comments.

77b2051

Signed-off-by: Sanghyeok An <[email protected]>

artembilan requested changes Jun 7, 2025

View reviewed changes

Addressing PR review.

327debf

Signed-off-by: Sanghyeok An <[email protected]>

artembilan approved these changes Jun 7, 2025

View reviewed changes

GH-3542: Adds the ability to add record interceptors instead of override them #3937

Are you sure you want to change the base?

GH-3542: Adds the ability to add record interceptors instead of override them #3937

Uh oh!

Conversation

chickenchickenlove commented Jun 1, 2025

Uh oh!

artembilan left a comment

Choose a reason for hiding this comment

Uh oh!

chickenchickenlove commented Jun 1, 2025

Uh oh!

artembilan Jun 1, 2025

Choose a reason for hiding this comment

Uh oh!

chickenchickenlove Jun 1, 2025

Choose a reason for hiding this comment

Uh oh!

artembilan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

artembilan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sobychacko left a comment

Choose a reason for hiding this comment

Uh oh!

artembilan left a comment

Choose a reason for hiding this comment

Uh oh!

chickenchickenlove commented Jun 4, 2025

Uh oh!

Uh oh!

artembilan left a comment

Choose a reason for hiding this comment

Uh oh!

artembilan Jun 6, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

artembilan Jun 7, 2025

Choose a reason for hiding this comment

Uh oh!

chickenchickenlove Jun 7, 2025

Choose a reason for hiding this comment

Uh oh!

artembilan Jun 7, 2025

Choose a reason for hiding this comment

Uh oh!

artembilan Jun 7, 2025

Choose a reason for hiding this comment

Uh oh!

artembilan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!