fix: sync state with disconnected peers (take 2) #891
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
gmaclennan
commented
Oct 3, 2024
| /** | ||
| * @param {PeerId} peerId | ||
| */ | ||
| #getOrCreatePeerState(peerId) { |
There was a problem hiding this comment.
The name of this method was misleading, and its use in #onPeerRemove was causing a bug, because it was recreating a removed state.
EvanHahn
approved these changes
Oct 3, 2024
| /** | ||
| * @param {string} peerId | ||
| */ | ||
| disconnectPeer(peerId) { |
There was a problem hiding this comment.
Nit: should this be called removePeer() to match addPeer()? Same comment applies elsewhere.
There was a problem hiding this comment.
I renamed it because there is a removePeer in CoreSyncState which means something different.
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.
There are two scenarios where a disconnected peer results in sync never showing as complete.
Scenario A:
Scenario B:
Note that these bugs affect
project.$sync.waitForSync(), which I don't think the front-end is not currently using. The mechanism used for determining if sync is completed in the front-end may still work.Fix
This PR fixes what appears to be an oversight for what happens when a peer disconnects (e.g. turns wifi off or force-closes app). We were removing the
PeerSyncController, but we were not removing the remote state fromCoreSyncState. I think I had some confusion about whether we should keep remote states for disconnected peers. For now, this PR "fixes" this to just completely remove remote states for disconnected peers. If we think keeping the remote state for disconnected peers in the future is useful, we can add it at a later stage. Right now, the remote state for a disconnected peer is just a cause of bugs, so not useful.