Remove socket listeners on channel disconnect #1375
Merged
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
paul-maxime
reviewed
Mar 6, 2019
| @@ -26,6 +26,20 @@ function listenToSocketEvents(client) { | |||
| client.channel.on('disconnect', client.onDisconnect.bind(client)); | |||
| } | |||
|
|
|||
| function stopListeningToSocketEvents(client) { | |||
| log.info('Stop listening to socket events'); | |||
| client.channel.socketRemoveListener('sendDataStream', client.onSendDataStream.bind(client)); | |||
There was a problem hiding this comment.
I think the removeListener call will not remove anything here.
bind() returns a new function every time it is called, so this function will be different from the one that was registered.
There was a problem hiding this comment.
You have to store the generated function somewhere if you want to remove it later:
const handler = instance.onEvent.bind(instance);
on('some event', handler);
removeListener('some event', handler);There was a problem hiding this comment.
Note that we might also just call removeAllListeners here instead.
There was a problem hiding this comment.
Good catch, thats not good at all. I will work on a fix later today.
Regarding removeAllListeners I prefer explicitly removing the listeners that we set up in listenToSocketEvents.
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.
Description
We've detected some instances where
Clientwould process calls even afterChannelhas disconnected. This PR makes sureClientdoes not receive any events fromsocketwhendisconnectis called or when thedisconnectevent is fired.[] It needs and includes Unit Tests
Changes in Client or Server public APIs
[] It includes documentation for these changes in
/doc.