fix(local): Use shared local master with bots#838
Merged
Conversation
This returns a shared local master from the Local transport even when `bots` is passed in the options to `Local`. #553 changed this to avoid out-of-date bots persisting, but in the process broke scenarios where several clients should remain in sync on a single page (see #800). This implements a more careful check, returning a shared master as long as the `bots` options passed are *equal* to each other (via simple object equality). The reliance on object identity could still represent a confusing gotcha, so in the future it might be better to offer a more explicit API for getting a new clean transport. Moving the global map of master instances *inside* the function scope of `Local`, could do this — calling `Local` would always return a new transport layer that could be shared around — but would potentially break current usage where repeatedly calling `Local` would still connect to the same master. Fix #800
Totally subjective, but reads more clearly to me.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 returns a shared local master from the Local transport even when
botsis passed in the options toLocal. #553 changed this to avoid out-of-date bots persisting, but in the process broke scenarios where several clients should remain in sync on a single page (see #800). This implements a more careful check, returning a shared master as long as thebotsoptions passed are equal to each other (via simple object equality).The reliance on object identity could still represent a confusing gotcha, so in the future it might be better to offer a more explicit API for getting a new clean transport. Moving the global map of master instances inside the function scope of
Local, could do this — callingLocalwould always return a new transport layer that could be shared around — but would potentially break current usage where repeatedly callingLocalwould still connect to the same master.Fix #800