feat(lazer): Improve JS SDK reliability via redundant parallel websocket cxns #2236
Conversation
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
2 Skipped Deployments
|
tejasbadadare
commented
Jan 10, 2025
Comment on lines
117
to
123
| addSubscription(request: Request) { | ||
| if (request.type !== "subscribe") { | ||
| throw new Error("Request must be a subscribe request"); | ||
| } | ||
| this.subscriptions.set(request.subscriptionId, request); | ||
| this.sendRequest(request); | ||
| } |
There was a problem hiding this comment.
I think it's good to listen for subscribed response here and throw an error if it was not successful
There was a problem hiding this comment.
Added error handling code to dedupeHandler, which will throw an Error if the server responds with a subscriptionError or error type message. Btw in my manual testing, looks like the server abruptly closes the connection for issues like bad subscription payload.
There was a problem hiding this comment.
we should improve the server side error handling for sure
Comment on lines
130
to
136
| removeSubscription(subscriptionId: number) { | ||
| this.subscriptions.delete(subscriptionId); | ||
| const request: Request = { | ||
| type: "unsubscribe", | ||
| subscriptionId, | ||
| }; | ||
| this.sendRequest(request); |
keyvankhademi
approved these changes
Jan 10, 2025
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.
Purpose
Improve JS SDK reliability via redundant parallel websocket connections (default of 3.) This reduces the chance of dropped messages during reconnection events, since other websockets will be receiving the otherwise missed messages. The parallel streams are merged and deduped to provide a single reliable stream to the SDK user.
Try it out by running
pnpm run example(examples/index.ts)Technical details
PythLazerClientis a thin wrapper aroundWebSocketPoolwhich provides some convenient parsing on the received messages.Introduced
WebSocketPool, which handles resilience at the pool level.ReliableWebSocketinstances, and provides usage semantics similar to a single standard WebSocket so that users don't have to deal with the details of managing multiple connections.sendcommands to all sockets in the pool for un/subscribing.Reused and adapted
ReliableWebSocketto handle resilience at the individual connection level.openmessage before sending messages. However, this hasn't been an issue in practice when testing manually.Testing
Tested manually successfully with up to 50 parallel connections. Reconnections are handled cleanly and no duplicate messages are delivered.