Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Handle Presence Cleanup in Housekeeping Process #602

Closed
chacha912 opened this issue Aug 7, 2023 · 0 comments · Fixed by #1036
Closed

Handle Presence Cleanup in Housekeeping Process #602

chacha912 opened this issue Aug 7, 2023 · 0 comments · Fixed by #1036
Assignees
@raararaara
Labels
cleanup 🧹 Paying off technical debt enhancement 🌟 New feature or request

Comments

@chacha912
Copy link
Contributor

Description:

When a document is explicitly detached, the presence is removed from the presences through PresenceChange{type: 'clear'}. This helps keep snapshot presence lightweight. However, when the client does not explicitly invoke detach, there is an issue that the presence not to be cleared.

Currently, during housekeeping, the document state is updated using clientInfo.DetachDocument(). It is also necessary to clear the presence at this point.

yorkie/server/backend/housekeeping/housekeeping.go

Lines 171 to 177 in 65c8164

for _, clientInfo := range candidates {
if _, err := clients.Deactivate(
ctx,
h.database,
clientInfo.ProjectID,
clientInfo.ID,
); err != nil {

yorkie/server/clients/clients.go

Lines 72 to 80 in 65c8164

if err := clientInfo.DetachDocument(id); err != nil {
return nil, err
}
// TODO(hackerwins): We need to remove the presence of the client from the document.
// Be careful that housekeeping is executed by the leader. And documents are sharded
// by the servers in the cluster. So, we need to consider the case where the leader is
// not the same as the server that handles the document.

Why:
To prevent continuous growth of the presence snapshot.
@hackerwins hackerwins added the cleanup 🧹 Paying off technical debt label Aug 7, 2023
@hackerwins hackerwins added the enhancement 🌟 New feature or request label Aug 25, 2023
@krapie krapie assigned chacha912 and unassigned chacha912 Sep 8, 2023
@raararaara raararaara mentioned this issue Jul 22, 2024
Closed
2 tasks
@hackerwins hackerwins moved this to In progress in Yorkie Project - 2024 Jul 24, 2024
@hackerwins hackerwins mentioned this issue Oct 18, 2024
Merged
2 tasks
@github-project-automation github-project-automation bot moved this from In progress to Done in Yorkie Project - 2024 Oct 18, 2024
@raararaara raararaara mentioned this issue Nov 11, 2024
Open
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@raararaara raararaara

Labels
cleanup 🧹 Paying off technical debt enhancement 🌟 New feature or request
Projects
Yorkie Project - 2024
Status: Done
Yorkie Project
Status: Todo
Milestone
No milestone
3 participants
@hackerwins @raararaara @chacha912