Peer conn info changes #83
Open
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
Problem: applications often need to introspect the state of a connection with a peer in order to debug synchronization issues. For example, if two users are on a video call and one notices that they have made changes which the other has not received, they need to determine if the issue is with the network connection, or a bug in the application, or a bug in automerge-repo. Solution: provide Repo::peer_conn_info_changes, which is a stream of changes to the connection to a particular peer. This includes the last time we received and sent a message to the peer for any document, and the last sent/receive for each document, as well as the last acked and sent heads for each document. This patch implements this logic very inefficiently, scanning every document on every change to any document. If the API turns out to be useful and performance is a problem then we can investigate ways to optimize this.
|
I think it's good on our end 👍 thanks for the heads-up |
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.
This PR adds a
RepoHandle::peer_conn_info_changesmethod which returns a stream ofPeerConnectionInfos, which look like this:The idea here is to allow applications to provide information about the state of a connection both globally and for a particular document in order to aid in debugging.
I've also renamed
PeerState->PeerDocStateto try and disambiguate it from the global peer connection state inPeerConnectionInfoand while I was there I moved from usingInstantto represent the last sent and received times toSystemTimeasSystemTimeis intended for comparison between processes whereasInstantis not. @tylerjl I know you were using this API, let me know if those changes are a problem.