Lock watchDocuments depending on the client #479
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
Codecov Report
@@ Coverage Diff @@
## main #479 +/- ##
==========================================
- Coverage 46.56% 46.51% -0.06%
==========================================
Files 69 69
Lines 5788 5805 +17
==========================================
+ Hits 2695 2700 +5
- Misses 2785 2797 +12
Partials 308 308
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
hackerwins
reviewed
Mar 3, 2023
server/rpc/yorkie_server.go
Outdated
Comment on lines
395
to
415
| locker, err := s.backend.Coordinator.NewLocker( | ||
| stream.Context(), | ||
| sync.NewKey(cli.ID.String()), | ||
| ) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| if err := locker.Lock(stream.Context()); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| subscription, peersMap, err := s.watchDocs(stream.Context(), *cli, docKeys) | ||
| if err != nil { | ||
| logging.From(stream.Context()).Error(err) | ||
| return err | ||
| } | ||
| defer func() { | ||
| s.unwatchDocs(docKeys, subscription) | ||
| if err := locker.Unlock(stream.Context()); err != nil { | ||
| logging.DefaultLogger().Error(err) | ||
| } |
There was a problem hiding this comment.
-
If an error is returned by
s.watchDocs, releasing the lock is not executed. So, How about movinglocker.Unlockto just belowlocker.lockwith defer? -
locker.Unlockmay not be executed when the stream is terminated and the context is in the cancel state. How about usingcontext.Backgroundinstead ofstream.Context? https://pkg.go.dev/context#pkg-overview -
We need to separate the key of the lock with
snapshot-*orpushpull-*. How about creating a key with the prefixwatchdocs-*?
chacha912
force-pushed
the
watch-documents
branch
from
edd2e09 to
d4b6758
Compare
chacha912
added a commit
to yorkie-team/yorkie-js-sdk
that referenced
this pull request
Mar 6, 2023
The event order has been modified to be guaranteed yorkie-team/yorkie#479
This was referenced Mar 6, 2023
2 tasks
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.
What this PR does / why we need it:
If a client requests to attach to multiple documents simultaneously,
the existing connection will be disconnected and reconnected.
Depending on the order of the published events, problems may occur on the client.
If the
watchedevent is published before theunwatchedevent, the test will failsince the final state is
watched, but theunwatchedevent arrives later.(please refer to the yorkie-js-sdk test).
This image shows the server log when the
watchedevent is published first.To resolve this, I added a lock for each client in the
watchDocument.This ensures that a lock is set when a client establishes a stream and released when the client unwatches.
Which issue(s) this PR fixes:
Fixes yorkie-team/yorkie-js-sdk#464 (comment)
Special notes for your reviewer:
Does this PR introduce a user-facing change?:
Additional documentation:
Checklist: