Allow provider awareness to be disabled #675
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
raineorshine
commented
Aug 10, 2023
raineorshine
commented
Aug 10, 2023
janthurau
reviewed
Aug 12, 2023
janthurau
approved these changes
Aug 12, 2023
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.
Fixes #673
Awareness provides an additional overhead of computation, memory, and network usage for each provider. This can become significant when there are hundreds of documents that are multiplexed through a single websocket connection.
This PR allows users to opt-out of the provider's default Awareness instance by specifying
awareness: nullin the config.If awareness is disabled...
setAwarenessFieldwill throw an error.Open to feedback, and will add documentation if approved :)