slackapi / slackapi/python-slack-sdk

SocketModeClient.connect() retries forever against a permanently closed aiohttp ClientSession

Ouverte
#1,922 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

auto-triage-skip bug socket-mode
Langage dominant
Python
Étoiles
4k
Forks
857
Merge moyen
22 h 21 min
PR mergées (30 j)
16

Description

Title

SocketModeClient.connect() retries forever against a permanently closed aiohttp ClientSession

Environment

  • slack_sdk 3.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)

  1. Construct a SocketModeClient with a valid app token; await client.connect().
  2. await client.aiohttp_client_session.close() (or otherwise force it closed) while the connection is established.
  3. Trigger a reconnect attempt (e.g. disconnect the network, or otherwise cause connect()'s loop to retry).
  4. Observe it fails forever: Failed to connect (error: Session is closed); Retrying...
  5. Observe is_connected() may not reflect the problem if self.current_session (the WebSocket) hasn't itself been marked closed/None.

Suggested fixes (ranked)

  1. Preferred: in connect()'s retry loop, check self.aiohttp_client_session.closed at the top of each iteration; if closed, recreate it (e.g. re-instantiate aiohttp.ClientSession) before retrying ws_connect.
  2. Minimum: if recreating isn't desired, raise or break out of the loop when the session is closed, so the caller can rebuild the whole client instead of retrying forever against a dead one.
  3. Consumer-facing improvement: reflect aiohttp_client_session.closed in is_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.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez dans slack_sdk/socket_mode/aiohttp/init.py, au niveau de la création de la session (~L130), de is_connected() (~L321-334), de connect() (~L347-409) et de close() (~L446-457). Reproduisez le scénario d’une session fermée de force et suivez la boucle de réessai ; le travail est terminé lorsque le client ne réessaie plus indéfiniment avec une session fermée et que le contrôle de santé reflète l’échec ou que l’appelant reçoit un signal clair de terminaison.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
backend, networking
Type d'issue
Bug
Difficulté
3/5
Temps estimé
1-2 jours
Activité
Active
Clarté
Plutôt claire
Accessibilité débutants
72/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.