Skip to content

fix: terminate WebSocket and remove listeners on connectWs timeout #1788

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
chenghao-mou wants to merge 8 commits into
base: main
Choose a base branch
from
+13 −4
Open

fix: terminate WebSocket and remove listeners on connectWs timeout #1788

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
5b44124
fix: terminate WebSocket and remove listeners on connectWs timeout
chenghao-mou Jun 12, 2026
1fffdb7
chore: add changeset for connectWs socket leak fix
chenghao-mou Jun 12, 2026
a300cb1
fix: also terminate socket on connection error, not just timeout
chenghao-mou Jun 12, 2026
4c84ad0
fix: remove redundant socket.terminate() from onError
chenghao-mou Jun 12, 2026
1020120
fix: only clear timeout in onOpen, keep error/close listeners live
chenghao-mou Jun 12, 2026
f496d82
fix: simplify connectWs timeout — terminate socket and use APITimeout…
chenghao-mou Jun 12, 2026
8ffdee6
chore: update changeset description
chenghao-mou Jun 12, 2026
64678f2
fix: reject connectWs promise on any close before open
chenghao-mou Jun 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fix-connectws-timeout-socket-leak.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@livekit/agents': patch
---

Fix orphaned WebSocket leak in `connectWs`: when the connection timeout fires, the socket is now terminated so it cannot connect and linger without an owner. Also fixes a hang where a normal (code 1000) close during the handshake left the promise unsettled — it now rejects on any close before the socket opens. Uses `APITimeoutError` instead of `APIConnectionError` for clearer retry semantics.
12 changes: 8 additions & 4 deletions agents/src/inference/utils.ts
View file
Open in desktop

@devin-ai-integration devin-ai-integration Bot Jun 12, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚩 Pattern alignment with ws_transport.ts

This change aligns connectWs with the established pattern in agents/src/inference/interruption/ws_transport.ts, which already calls ws.terminate() before rejecting with APITimeoutError on connection timeout. The ws_transport.ts version also terminates on error events (not just timeout), which connectWs does not do — the onError and onClose handlers here don't call terminate(). This is a pre-existing inconsistency that could leave sockets lingering after error/close events if the caller doesn't clean up, though in practice the ConnectionPool manages the socket lifecycle.

(Refers to lines 102-129)

Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

@chenghao-mou chenghao-mou Jun 12, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

During the handshake, ws self-cleans on error and close. All the connection-phase error paths (lines 729, 886, 912) funnel through emitErrorAndClose (line 1039):

  function emitErrorAndClose(websocket, err) {
    websocket._readyState = WebSocket.CLOSING;
    websocket._errorEmitted = true;
    websocket.emit('error', err);   // <-- our onError runs here
    websocket.emitClose();
  }

Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import { ThrowsPromise } from '@livekit/throws-transformer/throws';
import { AccessToken } from 'livekit-server-sdk';
import { WebSocket } from 'ws';
import { APIConnectionError, APIStatusError } from '../_exceptions.js';
import { APIConnectionError, APIStatusError, APITimeoutError } from '../_exceptions.js';
import { getJobContext } from '../job.js';
import { version } from '../version.js';

Expand Down Expand Up @@ -90,12 +90,16 @@ export async function connectWs(
return new ThrowsPromise<WebSocket, APIConnectionError | APIStatusError>((resolve, reject) => {
const socket = new WebSocket(url, { headers: { ...buildMetadataHeaders(), ...headers } });

let opened = false;

const timeout = setTimeout(() => {
reject(new APIConnectionError({ message: 'Timeout connecting to LiveKit WebSocket' }));
socket.terminate();
reject(new APITimeoutError({ message: 'Timeout connecting to LiveKit WebSocket' }));
}, timeoutMs);

const onOpen = () => {
clearTimeout(timeout);
opened = true;
resolve(socket);
};

Expand All @@ -113,9 +117,9 @@ export async function connectWs(
}
};

const onClose = (code: number) => {
const onClose = () => {
clearTimeout(timeout);
if (code !== 1000) {
if (!opened) {
reject(
new APIConnectionError({
message: 'Connection closed unexpectedly',
Expand Down
Loading