[BUG] Streaming subscribe returns None after a reconnect, making test_streaming_subscribe_receives_published_message flaky
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 45/100
- issue の種類
- バグ
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- grpc, python, redis
- 領域
- backend, testing-qa
調査の方向性
The bug is in dapr/clients/grpc/subscription.py and dapr/aio/clients/grpc/subscription.py. Start by reading the next_message method and the reconnect_stream logic. Run the failing test with pytest tests/integration/test_pubsub.py -k streaming. Examine the fake sidecar in unit tests to simulate reconnects. The fix must ensure next_message retries after a reconnect and that acks are not lost.
索引モデルが issue の本文から書いたものです。
説明
Expected Behavior
tests/integration/test_pubsub.py::test_streaming_subscribe_receives_published_message passes on every run, and Subscription.next_message() returns the next message even when the stream reconnects while it waits.
Actual Behavior
The test fails intermittently. It failed in 6 of the 25 most recent run-tests runs before #1229, on main pushes, merge-queue runs and unrelated PRs (for example runs 35790024069 on main, 35790699043 and 35791305700 in the merge queue). Latest occurrence: #1229, validate (3.14), runtime 1.18.4. Re-running the job on the same commit passed.
WARNING dapr.clients.grpc.subscription:subscription.py:97 Subscription stream error (StatusCode.UNKNOWN): EOF — reconnecting
WARNING dapr.clients.grpc.subscription:subscription.py:124 Can't send message on inactive stream: 'NoneType' object has no attribute 'id'
E AttributeError: 'NoneType' object has no attribute 'data'
tests/integration/test_pubsub.py:113: AttributeError
Sidecar log for the same test:
Subscribing to pubsub 'pubsub' topic 'TOPIC_STREAM' ConnectionID 1
Unsubscribed from pubsub 'pubsub' topic 'TOPIC_STREAM'
error retrieving pending Redis messages: context canceled
Subscribing to pubsub 'pubsub' topic 'TOPIC_STREAM' ConnectionID 2
encountered a non-retriable error while publishing a subscribed message to topic TOPIC_STREAM, err: stream closed
Unsubscribed from pubsub 'pubsub' topic 'TOPIC_STREAM'
The first stream ends with EOF right after it connects. The SDK reconnects, and the runtime is about to deliver the message on connection 2. But next_message() has already returned None to the caller, so the test fails and its finally: subscription.close() closes connection 2 in the middle of that delivery.
Likely cause (SDK side)
next_message()returnsNoneafter a reconnect instead of reading from the new stream. Indapr/clients/grpc/subscription.py#L89-L102, theUNAVAILABLE/UNKNOWN/INTERNALbranch callsreconnect_stream()and falls through, so the method returnsNone. The docstring saysNonemeans "no message received within the timeout", but there is no timeout. A caller that doessub.next_message().data(), or iterates withfor msg in sub, getsNoneor crashes on a transient reconnect. The async client does the same indapr/aio/clients/grpc/subscription.py#L69-L84. It also does not treatINTERNALas retryable, unlike the sync client.- Suspected, not yet confirmed: acks can be lost across a reconnect. The request generator of the old stream (
subscription.py#L52-L56) blocks onself._send_queue.get()and checks_is_stream_active()only afterget()returns. Afterstart()makes the subscription active again, the old generator can take the next ack off the shared queue and yield it into the dead stream. That message is then never acked and is redelivered.
Why the first stream gets EOF right after it connects is a separate question. It may be on the runtime side.
Related: project coverage changes between runs of the same code
The same timing shows up in unit-test coverage. codecov/project uses threshold: 0%, so it fails a PR whenever these lines happen not to run. On #1229, which does not touch client.py, coverage dropped by 7 lines. They are the error and reconnect branches of subscribe_with_handler's stream_messages loop, dapr/clients/grpc/client.py#L641-L654. They ran on main at 03eebe1 and did not run on the PR head 2a11bb8.
test_subscribe_topic_with_handler (tests/clients/test_dapr_grpc_client.py#L411-L463) calls close_fn() and returns without waiting for the streaming thread. close_fn does not join it either. Whether the thread reaches the StreamInactiveError / reconnect branches before the test run ends depends on timing. A deterministic fix would make close_fn join the thread with a timeout, or have the test wait on it. A test that drives each branch on purpose would also help.
Steps to Reproduce the Problem
Run the integration suite repeatedly against runtime 1.18.4 with Redis pub/sub, e.g. uv run pytest tests/integration/test_pubsub.py -k streaming --count 50 (with pytest-repeat), or re-run validate in CI. The failure is timing-dependent.
Suggested fix
- After a successful reconnect,
next_message()should read again from the new stream instead of returningNone, with a bound on retries so a sidecar that keeps failing still surfaces an error. Same for the async client, includingINTERNAL. - Give each stream its own send queue, or stop the old generator on
close(), so acks cannot go to a dead stream. - Add unit tests for both clients against the fake sidecar: a stream that fails with
UNKNOWNonce, then delivers a message.next_message()returns that message, and the ack reaches the new stream. - Keep the integration test as is, since it is what caught this.
- Make the
subscribe_with_handlerunit test deterministic, so thatcodecov/projectstops changing between runs of the same code.
Release Note
RELEASE NOTE: FIX Streaming subscriptions return the next message after a transient reconnect instead of None.
- 主要言語
- Python
- スター
- 272
- フォーク
- 152
- 平均マージ
- 3日 21時間
- マージ済み PR(30日)
- 5
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
dapr/python-sdk のほかの issue
-
dapr-ext-workflow good first issue kind/enhancement P2
難易度 2/5 1〜2日 初心者へのやさしさ 72/100
dapr/python-sdk#853 · コメント 4 件 ·
-
feature-request
難易度 3/5 1〜2日 初心者へのやさしさ 76/100
dapr/python-sdk#1214 · 担当者 1 名 ·
-
dapr-ext-workflow kind/enhancement
難易度 3/5 1〜2日 初心者へのやさしさ 78/100
dapr/python-sdk#1213 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 76/100
dapr/python-sdk#1200 ·
-
dapr-ext-workflow kind/enhancement
難易度 3/5 1〜2日 初心者へのやさしさ 58/100
dapr/python-sdk#1188 ·
dapr/python-sdk の issue をすべて見る
似ている issue
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
stephrobert/dsoxlab#238 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
sublimehq/package_control#1780 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
nwg-piotr/nwg-displays#145 ·