Fix/socketsjoin race condition #5432
Open
+61
−14
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.
The kind of change this PR does introduce
Current behavior
In multi-server environments using the cluster adapter, there is a race condition when calling
socketsJoin()followed immediately byemit()to the same room. The issue occurs because:socketsJoin()publishes a message to join sockets to a room across workersemit()may be processed before the join operation completes on remote workersExample of the problematic pattern:
This affects users running Socket.IO in cluster mode (multiple Node.js processes) and causes intermittent message delivery failures that are difficult to debug.
New behavior
The socketsJoin() method now returns a Promise when using the cluster adapter, ensuring the join operation completes across all workers before resolving. Similarly, socketsLeave() and disconnectSockets() have been updated with the same pattern.
Correct usage pattern:
Key changes:
Test coverage:
Other information (e.g. related issues)
Fixes #4734
Implementation notes:
Migration guidance:
Breaking changes: