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.

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

Add include_presences to return active user list in GetDocument, GetDocuments #976

Open
hackerwins opened this issue Aug 24, 2024 · 0 comments
Labels
enhancement 🌟 New feature or request

Comments

@hackerwins
Copy link
Member

Description:

Add include_presences to return active user list in GetDocument, GetDocuments

Currently, CodePair displays document lists using the last modified time from AdminService/GetDocuments. It would be beneficial to include a list of users currently editing documents within this list.

Screenshot 2024-08-24 at 2 09 51 PM

To achieve this, I propose adding an include_presences option to the REST APIs GetDocument and GetDocuments, allowing the return of Presence information alongside the document data. Additionally, while Yorkie clusters shard documents to specific servers, Presence information could be returned without any issues since it only requires read operations.

For reference, Liveblocks offers a similar API at /rooms/:roomId/active_users, and it recommends calling this endpoint with a frequency greater than 10 seconds, which could serve as a benchmark for our implementation.

Why:

This enhancement would enable users to see who is currently editing a document, thereby improving collaboration and transparency during the editing process.

@hackerwins hackerwins added the enhancement 🌟 New feature or request label Aug 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement 🌟 New feature or request
Projects
Status: Backlog
Development

No branches or pull requests

1 participant