Add cleanupEmptyChildNamespaces server option #4602
Closed
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
- When a socket disconnects from a child namespace (those created by a ParentNamespace), if this option is enabled and there are no other sockets connected, it will call nsp.adapter.close() and remove the namespace. - The namespace can be connected to later (it will be recreated) - Added some tests to cover the new code changes
darrachequesne
pushed a commit
that referenced
this pull request
Jan 23, 2023
This commit adds a new option, "cleanupEmptyChildNamespaces". With this option enabled (disabled by default), when a socket disconnects from a dynamic namespace and if there are no other sockets connected to it then the namespace will be cleaned up and its adapter will be closed. Note: the namespace can be connected to later (it will be recreated) Related: socketio/socket.io-redis-adapter#480
|
Merged as 5d9220b. Thanks a lot 👍 |
haneenmahd
pushed a commit
to haneenmahd/socket.io
that referenced
this pull request
Apr 15, 2023
This commit adds a new option, "cleanupEmptyChildNamespaces". With this option enabled (disabled by default), when a socket disconnects from a dynamic namespace and if there are no other sockets connected to it then the namespace will be cleaned up and its adapter will be closed. Note: the namespace can be connected to later (it will be recreated) Related: socketio/socket.io-redis-adapter#480
dzad
pushed a commit
to dzad/socket.io
that referenced
this pull request
May 29, 2023
This commit adds a new option, "cleanupEmptyChildNamespaces". With this option enabled (disabled by default), when a socket disconnects from a dynamic namespace and if there are no other sockets connected to it then the namespace will be cleaned up and its adapter will be closed. Note: the namespace can be connected to later (it will be recreated) Related: socketio/socket.io-redis-adapter#480
|
Hello @stevebaum23 and @darrachequesne We have stumbled upon a similar issue, when using Redis adapter, tho not sure how should we go about fixing it. It appears that adapter cleanup isn't called when a socket.io middleware throws exception: I created a separate bug for this: #4772 I attempted a PR here but that does not seem to be the correct approach - we should only clean up when there are no more sockets Would you be able to help? |
This was referenced Jul 18, 2023
ankush
added a commit
to frappe/frappe
that referenced
this pull request
Jul 29, 2023
While serving many sites it's best to close down namespace when last connection is closed. refer socketio/socket.io#4602
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.
The kind of change this PR does introduce
Current behavior
Currently, child namespaces (those created by a
ParentNamespace, maybe dynamic namespace is the correct term?) exist forever while the server is running. This can cause issues with certain adapters (like redis) where it continues to subscribe and never unsubscribes, as pointed out in this issue.New behavior
This PR adds a new server option,
cleanupEmptyChildNamespaces. With this option enabled, when a client socket disconnects, if there are no other sockets connected to the namespace, the following with occur:nsp.adapter.close()_nsps)ParentNamespace.children)Calling
adapter.close()will allow the adapters to clean up any subscriptions.Removing the namespace from
_nspsis necessary, otherwise the adapters won't re-subscribe when the namespace is connected to again.Removing the namespace from the
ParentNamespace.childrenis to prevent memory leaks, since the old namespace is no longer used.Other information (e.g. related issues)
One thing I'm unsure of is how this will affect the other adapters. I only use the redis adapter, which doesn't implement close yet (I will be creating a new PR to implement it). I don't know if calling close on the other adapters would have some bad side effects.