fix(websockets): use is_ws_alive across modern websockets>=12 API#113
Merged
nicolotognoni merged 1 commit intoMay 27, 2026
Merged
Conversation
Two parked-WS-liveness checks in the SDK still used `ws.closed`, removed from the `websockets` library in v12. Patter pins `websockets>=14,<16` in pyproject.toml, so calls crashed immediately with: AttributeError: 'ClientConnection' object has no attribute 'closed' Promote the existing `_is_parked_ws_alive` helper out of stream_handler into `getpatter/utils/ws.py` as `is_ws_alive`, and use it at every WS liveness check that goes through the `websockets` library: - stream_handler.py:2192 (TTS WS adoption) - stream_handler.py:2230 (STT WS adoption) - providers/elevenlabs_ws_tts.py:453 (parked WS pickup in synthesize) aiohttp-backed providers (assemblyai_stt, cartesia_stt, soniox_stt) still call `.closed` because `aiohttp.ClientWebSocketResponse.closed` remains a valid property — they are unaffected. Adds 8 unit tests covering modern (`state`, `close_code`) and legacy (`closed`) shapes, plus the fail-closed default for unknown shapes. Closes PatterAI#111.
6 tasks
nicolotognoni
added a commit
that referenced
this pull request
May 27, 2026
…115) (#118) - Pipeline mode in `libraries/typescript/src/stream-handler.ts` did not inject the built-in `transfer_call` / `end_call` tools into the `LLMLoop` (both `new LLMLoop(...)` call sites at lines 1891 and 1906 passed `agent.tools` through unchanged). The Realtime path injects them at `server.ts:374`; pipeline was missing the parity. Added `augmentWithBuiltinHandoffTools` helper mirroring the Python helper shipped in #115; it builds handler closures that validate E.164 / default `reason` and dispatch to the existing telephony bridge methods (`bridge.transferCall` / `bridge.endCall`). Built-ins are skipped when the corresponding callback is missing, keeping non-telephony test harnesses clean. Exported `TRANSFER_CALL_TOOL` / `END_CALL_TOOL` from `server.ts` so the helper can re-use the canonical schema. - Docs: `docs/typescript-sdk/events.mdx` advertised the same non-existent `phone.events.on(PatterEventType.X, handler)` API as the Python events page (closed by #114). Replaced the broken `EventBus` section with documentation of the APIs that actually exist on the TypeScript `Patter` class: speech-edge attribute setters (`onUserSpeechStarted` / `onAgentSpeechEnded` / `onLlmToken` / `onAudioOut` etc.) and tool events via `onTranscript` with `role === "tool"`. - CHANGELOG: backfilled `## Unreleased` `### Fixed` entries for upstream PRs #113, #114, #115 (Python fixes by @knowsuchagency that landed without the corresponding TypeScript / changelog updates), plus entries for the two TypeScript parity fixes shipped here. Test plan: - Python: covered by tests added in the upstream PRs (#113, #115). - TypeScript: 8 new unit tests in `libraries/typescript/tests/pipeline-builtin-tools.test.ts` cover empty-user-tools, non-empty user tools order, missing-callback skip, transfer dispatch + E.164 rejection, end_call default and user-supplied `reason`. Full suite: 1521 passed / 8 skipped, lint clean, build green.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
_is_parked_ws_alivehelper out ofstream_handler.pyintolibraries/python/getpatter/utils/ws.pyasis_ws_alive, and re-use it at every WS-liveness check that goes through thewebsocketslibrary.AttributeError: 'ClientConnection' object has no attribute 'closed'that crashed pipeline-mode calls immediately on stream start (Patter pinswebsockets>=14,<16, which dropped.closedin v12).tests/test_utils_ws.pycover modern (state,close_code), legacy (closed), and unknown-shape paths.Closes #111.
Why
Two parked-WS-adoption sites still relied on
ws.closed:stream_handler.py:2192(TTS WS adoption)stream_handler.py:2230(STT WS adoption)providers/elevenlabs_ws_tts.py:453(parked WS pickup insynthesize)The
websocketslibrary removed.closedin v12, butpyproject.tomlpinswebsockets>=14,<16. The result is that every pipeline-mode call crashes immediately on stream start:The existing
_is_parked_ws_alivehelper already handles both APIs cleanly; it just wasn't reused everywhere.Out of scope
The aiohttp-backed STT providers (
assemblyai_stt,cartesia_stt,soniox_stt) still call.closedbecauseaiohttp.ClientWebSocketResponse.closedremains valid. They are not affected by this bug. Docstring comments inopenai_realtime.py:465andcartesia_stt.py:307still mentionnot ws.closedas a precondition — left as a follow-up since the code there is correct.Test plan
pytest libraries/python/tests/test_utils_ws.py -v— 8/8 passElevenLabsWebSocketTTS(via thegetpatter[local]editable install) no longer raisesAttributeErroron stream start