slackapi / slackapi/python-slack-sdk
SocketModeClient.connect() retries forever against a permanently closed aiohttp ClientSession
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 4k
- フォーク
- 857
- 平均マージ
- 22時間 21分
- マージ済み PR(30日)
- 16
説明
Title
SocketModeClient.connect() retries forever against a permanently closed aiohttp ClientSession
Environment
slack_sdk3.43.0- File:
slack_sdk/socket_mode/aiohttp/__init__.py - Relevant locations: session creation ~L130,
is_connected()~L321-334,connect()~L347-409,close()~L446-457
Description
SocketModeClient (aiohttp implementation) keeps a single aiohttp.ClientSession for the client's entire lifetime — a reasonable design, per the comment at its creation: "it is suggested you use a single session for the lifetime of your application, to benefit from connection pooling." The bug isn't that design choice; it's that the unbounded retry loop doesn't handle that session ever entering a closed state.
connect() wraps reconnection attempts in while True: (~L352). On exception it logs "Failed to connect (error: {e}); Retrying..." (~L408) and loops again, reusing self.aiohttp_client_session. If that session itself has been closed (not just the individual WebSocket tracked as self.current_session), every subsequent retry fails identically forever with RuntimeError: Session is closed — nothing inside this loop ever recreates the session; that only happens when a new SocketModeClient instance is constructed from scratch.
Separately, is_connected() checks self.current_session/ping-pong state but does not check self.aiohttp_client_session.closed, so downstream consumers building their own health checks or watchdogs on top of this client have no way to detect this specific failure mode without reaching into a private-ish attribute themselves.
Impact observed
In production, a consumer application's own reconnect watchdog (checking is_connected()) never detected this state, because the WebSocket layer could still look "connected enough" (some event types were still being delivered) while the HTTP session underneath was permanently dead. The client was stuck retrying every ~10 seconds for over 24 hours with no self-healing, until the whole process was restarted externally.
Likely forced repro (not yet reduced to a minimal script)
- Construct a
SocketModeClientwith a valid app token;await client.connect(). await client.aiohttp_client_session.close()(or otherwise force it closed) while the connection is established.- Trigger a reconnect attempt (e.g. disconnect the network, or otherwise cause
connect()'s loop to retry). - Observe it fails forever:
Failed to connect (error: Session is closed); Retrying... - Observe
is_connected()may not reflect the problem ifself.current_session(the WebSocket) hasn't itself been marked closed/None.
Suggested fixes (ranked)
- Preferred: in
connect()'s retry loop, checkself.aiohttp_client_session.closedat the top of each iteration; if closed, recreate it (e.g. re-instantiateaiohttp.ClientSession) before retryingws_connect. - Minimum: if recreating isn't desired,
raiseorbreakout of the loop when the session is closed, so the caller can rebuild the whole client instead of retrying forever against a dead one. - Consumer-facing improvement: reflect
aiohttp_client_session.closedinis_connected()(or an equivalent health-check property), so consumers can detect this without reaching into a non-public attribute.
Notes
We don't have a minimal standalone repro yet — this was diagnosed from production logs plus reading this source after a ~39 hour incident where a single client instance got stuck in this state. Happy to help characterize a repro further if useful. We've worked around this downstream by having our own consumer explicitly check aiohttp_client_session.closed before deciding whether to rebuild — happy to link that once it's merged, in case the pattern is useful context here too.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
slack_sdk/socket_mode/aiohttp/init.py のセッション作成部分(~L130)、is_connected()(~L321-334)、connect()(~L347-409)、close()(~L446-457)から始めます。強制的に閉じられたセッションのシナリオを再現し、再試行ループを追跡します。完了の条件は、クライアントが閉じられたセッションに対して無限に再試行し続けなくなり、ヘルスチェックが失敗を反映するか、呼び出し元が明確な終了シグナルを受け取ることです。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- backend, networking
- issue の種類
- バグ
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 活発
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 72/100