docs: add warning regarding using socket.data reference equality #436
Conversation
This file contains 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 ↗︎
|
|
|
||
| socket.on("disconnect", () => { | ||
| // ... however primitive values will be preserved | ||
| activeUsers.delete(socket.data.user.name); |
There was a problem hiding this comment.
Two things that bother me with this example:
socket.data.user.namemust be unique (implicitly)- using a map here means it won't work when scaling to multiple servers
What do you think?
There was a problem hiding this comment.
Agreed, i've simply removed the 'Good' example. Hopefully just knowing it is bad will be enough to guide anyone who ran into the same problem as I did using a reference.
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.
Related: socketio/socket.io#4935
This adds to the Socket#data, there are a few other places that mentioned socket.data
https://socket.io/docs/v4/server-instance/#fetchsockets
https://socket.io/docs/v4/server-api/#socketdata
So happy to move to either of these places.