feat: Introduce WebSocket Reconnect Behavior#167
Open
jake-luster wants to merge 1 commit intoelevenlabs:mainfrom
Open
feat: Introduce WebSocket Reconnect Behavior#167jake-luster wants to merge 1 commit intoelevenlabs:mainfrom
jake-luster wants to merge 1 commit intoelevenlabs:mainfrom
Conversation
Collaborator
|
Could you add some tests for the new functionality please? |
Contributor
|
@jake-luster do you think this would support retries in scenarios where it fails an initial connection? i.e., #257 |
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
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.
This pull request introduces a configurable automatic reconnection mechanism for WebSocket connections, improving connection reliability in the client. The changes add new configuration options, refactor event listener management, and implement logic to handle reconnection attempts with customizable limits and delays.
WebSocket reconnection support
WebSocketConnectionConfigtype toBaseConnection.tsthat allows configuring reconnection behavior, including enabling/disabling, max attempts, and delay between attempts. (packages/client/src/utils/BaseConnection.ts, packages/client/src/utils/BaseConnection.tsR50-R55)BaseSessionConfigtype to include an optionalwebSocketConnectionConfigproperty for passing reconnection settings to sessions. (packages/client/src/utils/BaseConnection.ts, packages/client/src/utils/BaseConnection.tsR102)WebSocketConnection class enhancements
WebSocketConnectionto manage event listeners with dedicated setup and removal methods, improving resource management and reliability. (packages/client/src/utils/WebSocketConnection.ts, packages/client/src/utils/WebSocketConnection.tsR20-R64)tryReconnectmethod, which attempts to reconnect the socket based on configuration and exponential delay, and resets attempts on success. (packages/client/src/utils/WebSocketConnection.ts, packages/client/src/utils/WebSocketConnection.tsL158-R243)createmethod to accept and store session config, enabling access to reconnection parameters throughout the connection lifecycle. (packages/client/src/utils/WebSocketConnection.ts, [1] [2]