DefaultPollableMessageSource: invoke afterSendCompletion for already-applied interceptors when a message is discarded
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 74/100
- issue の種類
- バグ
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- java
調査の方向性
Start in DefaultPollableMessageSource, especially ReceiveAdvice.invoke, setSource(), and the poll() overload that converts to ParameterizedTypeReference. Trace how interceptors are applied and where completion callbacks run for discarded messages and conversion exceptions. Add focused tests based on the two reproductions; done means each interceptor whose preSend succeeds gets exactly one completion callback on both paths, and the tests pass.
索引モデルが issue の本文から書いたものです。
説明
Describe the issue
Follow-up to #3131 / #3253. Since 5.0.4, DefaultPollableMessageSource invokes the full ChannelInterceptor contract, but there are two paths where interceptors whose preSend already succeeded never receive afterSendCompletion, unlike AbstractMessageChannel (which calls triggerAfterSendCompletion for the already-applied interceptors):
- A later interceptor returns
nullfrompreSend: thepreSendloop inReceiveAdvice(the local class created insetSource()that wrapsMessageSource.receive()) returnsnull,poll()returnsfalse, and noafterSendCompletionis invoked for the interceptors already applied. - Payload conversion fails in
receive(ParameterizedTypeReference): theMessageConversionExceptionis thrown afterReceiveAdvicehas runpreSend, but before thetry/finallyofpoll(), soafterSendCompletionis skipped for all interceptors.
Interceptors that open resources in preSend and release them in afterSendCompletion (tracing scope, MDC, thread locals) leak them on the poller thread. A typical case is a filtering interceptor that discards messages by returning null, registered after a tracing interceptor.
To Reproduce
Plain JUnit test, no application context needed (spring-cloud-stream 5.0.4). Both tests fail at the completion assertion:
package com.example.demoStreamPollable;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
import java.util.ArrayList;
import java.util.List;
import org.junit.jupiter.api.Test;
import org.springframework.cloud.stream.binder.DefaultPollableMessageSource;
import org.springframework.core.ParameterizedTypeReference;
import org.springframework.messaging.Message;
import org.springframework.messaging.MessageChannel;
import org.springframework.messaging.converter.CompositeMessageConverter;
import org.springframework.messaging.converter.StringMessageConverter;
import org.springframework.messaging.support.ChannelInterceptor;
import org.springframework.messaging.support.GenericMessage;
class PollableInterceptorCompletionTests {
private final List<String> events = new ArrayList<>();
@Test
void afterSendCompletionIsInvokedForAppliedInterceptorsWhenLaterPreSendReturnsNull() {
DefaultPollableMessageSource source = newSource();
source.setSource(() -> new GenericMessage<>("foo"));
source.addInterceptor(recorder("A"));
source.addInterceptor(new ChannelInterceptor() {
@Override
public Message<?> preSend(Message<?> message, MessageChannel channel) {
return null; // e.g. a filtering interceptor discarding the message
}
});
assertThat(source.poll(message -> { })).isFalse();
// Same contract as AbstractMessageChannel: A's preSend succeeded, so it must be completed
assertThat(this.events).containsExactly("A.preSend", "A.afterSendCompletion(sent=false)");
}
@Test
void afterSendCompletionIsInvokedWhenPayloadConversionFails() {
DefaultPollableMessageSource source = newSource();
source.setSource(() -> new GenericMessage<>("not a Foo"));
source.addInterceptor(recorder("A"));
assertThatThrownBy(() -> source.poll(message -> { }, new ParameterizedTypeReference<Foo>() { }))
.isInstanceOf(RuntimeException.class);
assertThat(this.events).contains("A.preSend").anyMatch(e -> e.startsWith("A.afterSendCompletion"));
}
private static DefaultPollableMessageSource newSource() {
return new DefaultPollableMessageSource(new CompositeMessageConverter(List.of(new StringMessageConverter())));
}
private ChannelInterceptor recorder(String name) {
return new ChannelInterceptor() {
@Override
public Message<?> preSend(Message<?> message, MessageChannel channel) {
events.add(name + ".preSend");
return message;
}
@Override
public void afterSendCompletion(Message<?> message, MessageChannel channel, boolean sent, Exception ex) {
events.add(name + ".afterSendCompletion(sent=" + sent + ")");
}
};
}
record Foo(String value) {
}
}
Version of the framework
Spring Cloud Stream 5.0.4 (Spring Cloud 2025.1.4), Spring Boot 4.1.2.
Expected behavior
Every interceptor whose preSend returned a message receives afterSendCompletion exactly once, also when the message is discarded by a later interceptor or when conversion fails, consistent with AbstractMessageChannel.
Additional context
Proposal:
- In the
preSendloop ofReceiveAdvice.invoke, track the interceptors whosepreSendreturned a message, and callafterSendCompletion(message, DUMMY_CHANNEL, false, null)in reverse order when a later one returnsnull, the same asAbstractMessageChannel. - Run the completion when conversion fails as well (for example, by moving the conversion inside the
tryofpoll(), or by completing with the exception).
Happy to submit a PR.
- 主要言語
- Java
- スター
- 1.1k
- フォーク
- 651
- 平均マージ
- 1日 16時間
- マージ済み PR(30日)
- 16
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
spring-cloud/spring-cloud-stream のほかの issue
-
難易度 4/5 3〜5日 初心者へのやさしさ 55/100
spring-cloud/spring-cloud-stream#3332 ·
メンテナーはふだん 1 日以内に返信
-
Kafka binder health-check consumer failures return DOWN without logging the exception対応中かも @Sanskar121543 が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 25/100
spring-cloud/spring-cloud-stream#3329 ·
メンテナーはふだん 1 日以内に返信
-
Kafka pollable consumers lose ConsumerFactory listeners when max.poll.records is greater than oneオープン
難易度 4/5 3〜5日 初心者へのやさしさ 55/100
spring-cloud/spring-cloud-stream#3324 ·
メンテナーはふだん 1 日以内に返信
-
StreamBridge removing BindingProperties leads to wrong destination in ProvisioningProvider再び着手できるかも @olegz が 59 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンbug
spring-cloud/spring-cloud-stream#3257 · コメント 6 件 · リアクション 2 件 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
-
StreamBridge's hashProducerProperties produces hash collisions across different binding names, causing Partition key cannot be null再び着手できるかも このイシューのプルリクエストはマージされずにクローズされました。 オープン
難易度 4/5 3〜5日 初心者へのやさしさ 48/100
spring-cloud/spring-cloud-stream#3242 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
spring-cloud/spring-cloud-stream の issue をすべて見る
似ている issue
-
Type: Bug
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
メンテナーはふだん 1 日以内に返信
-
MCP add-on: JSON responses with non-ASCII characters are truncated (wrong Content-Length)対応中かも @dhanushbs10 が今日担当しました。 オープンadd-on bug in:mcp
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
vaadin-map
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
vaadin/flow-components#10586 ·
メンテナーはふだん 1 日以内に返信
-
WeReadInstaller writes the launcher database on the main thread at handover (Activity pause timeout)オープンbug good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 63/100
wpilibsuite/SystemcoreTesting#446 ·
メンテナーはふだん 1 日以内に返信