This repository has been archived by the owner on Aug 23, 2019. It is now read-only.
fix: prevent undefined error during a mutual hangup #260
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
ghost
assigned 
dryajov
reviewed
May 30, 2018
src/index.js
Outdated
| @@ -110,6 +110,11 @@ class Switch extends EE { | |||
| this.stats.stop() | |||
| series([ | |||
| (cb) => each(this.muxedConns, (conn, cb) => { | |||
| // If the connection was destroyed while we are hanging up, continue | |||
| if (conn === undefined) { | |||
There was a problem hiding this comment.
Should this check be so restrictive? Perhaps an if (conn) {...} should do?
There was a problem hiding this comment.
I originally had a more generic check if (!conn), but changed it to undefined as there shouldn't be a situation where conn is something other than undefined or an object with the muxer property. The only way it would be something other than those two options is if deletions of the muxers changes internally, or if they are overridden by another library.
I suppose the tiny performance benefit during a swarm stop isn't worth the longer term resilience of the generic check. I can update this.
There was a problem hiding this comment.
Update pushed, this should be good to go.
dryajov
reviewed
May 30, 2018
Pull Request Test Coverage Report for Build 867
💛 - Coveralls |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This resolves an issue where if connected nodes hang up at the same time, such as during testing, a muxedConnection could be deleted from the switch at the same time as it's async iteration was occurring to end those connections. This would result in an undefined error.
This PR ensures we don't attempt to close connections that have been hung up on.
You can see the passing CI build for js-libp2p that uses this branch here: https://ci.ipfs.team/blue/organizations/jenkins/libp2p%2Fjs-libp2p/detail/chore%2Fupdate-switch/4/pipeline
connects to libp2p/js-libp2p#198