feat(ws,worker,api): add context-based room routing for ws connections fixes NV-6790 #9341
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
github-actions
bot
changed the title
ChmaraX
force-pushed
the
nv-6790-ws-context-isolated-event-emitting
branch
from
e00f688 to
c1708b1
Compare
|
@coderabbitai summary |
✅ Actions performedSummary regeneration triggered. |
ChmaraX
changed the title
commit: |
WalkthroughAdds optional contextKeys propagation across WebSocket payloads and routing. Updates DTOs, commands, services, and gateways to accept and forward contextKeys, enabling context-based room joins and targeted emits. Refactors socket-worker and queue services to object-based sendMessage params. Includes a submodule pointer update. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant API/Worker as API/Worker Usecases
participant SocketSvc as SocketWorkerService
participant WSQueue as WebSocketsQueueService
participant WSProc as WebSocket Worker
participant WSGW as WS Gateway
participant Rooms as Context Rooms
API/Worker->>SocketSvc: sendMessage({ userId, event, data, contextKeys? })
SocketSvc->>WSQueue: add({ userId, event, data, contextKeys?, ... })
WSQueue-->>WSProc: job({ userId, event, data, contextKeys? })
WSProc->>WSGW: sendMessage(userId, event, data, contextKeys?)
Note over WSGW: On connect, subscribers join default<br/>or per-context rooms based on contextKeys
alt contextKeys provided
loop for each key
WSGW->>Rooms: emit to room userId:contextKey
end
else no contextKeys
WSGW->>Rooms: emit to room userId:__default__
end
rect rgba(240,248,255,0.6)
Note over SocketSvc,WSGW: Unread/Unseen count paths pass contextKeys to<br/>repository getCount and to WSGateway.sendMessage
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
✨ Finishing touches
🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (15)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
…t-isolated-event-emitting
ChmaraX
force-pushed
the
nv-6790-ws-context-isolated-event-emitting
branch
from
556defd to
0c9de11
Compare
✅ Deploy Preview for dashboard-v2-novu-staging canceled.
|
ChmaraX
commented
Oct 13, 2025
Comment on lines
+160
to
+175
| // Join context-specific rooms for efficient message routing | ||
| if (contextKeys.length === 0) { | ||
| // Join default room for connections without context | ||
| await connection.join(`${subscriber._id}:${DEFAULT_CONTEXT_ROOM}`); | ||
| Logger.log(`Connection ${connection.id} joined default room for ${subscriber._id}`, LOG_CONTEXT); | ||
| } else { | ||
| // Join a room for each context key | ||
| for (const contextKey of contextKeys) { | ||
| await connection.join(`${subscriber._id}:${contextKey}`); | ||
| } | ||
| Logger.log( | ||
| `Connection ${connection.id} joined context rooms for ${subscriber._id}: ${contextKeys.join(', ')}`, | ||
| LOG_CONTEXT | ||
| ); | ||
| } | ||
|
|
There was a problem hiding this comment.
To route events only to inbox sessions with matching contexts, there are two possible approaches:
-
Room-based routing (chosen): Each inbox session joins a context-specific room on connection. Events are emitted directly to the appropriate rooms.
-
JWT-based filtering: Decode the JWT token for each connected client when sending an event, extract the contextKeys, and decide whether to emit.
I think the #1 approach is better for performance and scalability.
ChmaraX
commented
Oct 13, 2025
| LOG_CONTEXT | ||
| ); | ||
|
|
||
| await connection.join(subscriber._id); |
There was a problem hiding this comment.
I also left the original subscriberId room for backwards compatibility, so after this change is rolled-out, the number of open rooms will double (until we remove this line), but that shouldn't be a problem, its just a server side grouping mechanism not a new WS connection.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What changed? Why was the change needed?
Screenshots
Expand for optional sections
Related enterprise PR
Special notes for your reviewer
Summary by CodeRabbit
New Features
Chores