Clear presence when housekeeping process

[raararaara]

What this PR does / why we need it?

This PR addresses the absence of presence clearing logic in document detach during client deactivation for Housekeeping compared to document detach by the SDK. By implementing server-side presence clearance, this PR ensures that presence is correctly handled during the housekeeping process.

Any background context you want to provide?

The changes include: 1) Performing document detach with client deactivation and updating the SyncedSeq solely through the database -> making an API call similar to the SDK's document detach This change allows presence to be cleared through client.detach() during deactivation and detach processes, simplifying the process and omitting the need for updating SyncedSeq separately. In case of deactivation failure, some documents may not detach completely, but another deactivation attempt is possible. 2) Consideration for clustering and sharding per document Taking into account document structures sharded across clusters by keys, the update allows one server to act as a client while multiple servers can perform detach operations.

What are the relevant tickets?

Fixes #602

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

Additional documentation:

Checklist:

• [x] Added relevant tests or not required
• [x] Didn't break anything

Summary by CodeRabbit

Summary by CodeRabbit

• New Features

  • Introduced methods for simulating document attachment and client activation, enhancing server-side operations.
  • Added functionality for converting internal documents to public documents, improving document management.
  • Enhanced client connection capabilities, allowing for improved document and client interaction.
  • Implemented configuration options for dynamic gateway service referencing in Kubernetes.
  • Added command-line flags for backend gateway address configuration, increasing server flexibility.

• Bug Fixes

  • Improved error handling for detach requests to ensure system integrity in case of failures.
  • Enhanced logic for client deactivation, ensuring the most up-to-date client state is utilized.

• Chores

  • Streamlined methods for client deactivation, simplifying document status management during operations.
  • Expanded configuration options in the Helm chart for better service adaptability.
  • Added new constants and configuration fields to improve server setup and management.

[coderabbitai[bot]]

[!IMPORTANT]

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This update enhances error handling and control flow during client detachment and deactivation processes, ensuring system consistency and integrity. Key enhancements include new methods for simulating document attachment and activation, improved backend interactions during client deactivation, and effective presence management. The housekeeping process has been refined to clean up presence more efficiently, addressing potential growth in the presence snapshot.

Changes

File	Change Summary
client/client.go	Added PretendAttach and PretendActivate methods for simulating attachment and activation; improved error handling in the Detach method.
pkg/document/document.go	Introduced ToDocument function for converting InternalDocument to Document; added setInternalDoc for better internal document management.
pkg/document/internal_document.go	Added SyncCheckpoint and ToDocument methods to enhance synchronization and conversion functionalities.
server/clients/clients.go	Modified Deactivate function to utilize *backend.Backend, ensuring proper client info retrieval and document update logic.
server/rpc/yorkie_server.go	Updated DeactivateClient to use s.backend instead of s.backend.DB, improving backend interactions.
server/server.go	Altered DeactivateClient and RegisterHousekeepingTasks methods to integrate rpcAddr, enhancing client management and housekeeping task registration.
build/charts/yorkie-cluster/templates/yorkie/deployment.yaml	Added GATEWAY_HOST environment variable to Kubernetes deployment for flexible service discovery.
build/charts/yorkie-cluster/values.yaml	Introduced a new gateway configuration option to enhance service routing capabilities.

Assessment against linked issues

Objective	Addressed	Explanation
Handle Presence Cleanup in Housekeeping Process (#602)	✅
Ensure presence is cleared during document detachment	✅	Presence is now correctly managed during detachment processes.

🐇 In warren deep, where shadows play,
Changes weave a bright array.
With presence clear, and logic sound,
The rabbit hops where joy is found!
🥕✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

[codecov[bot]]

Codecov Report

Attention: Patch coverage is 27.45098% with 37 lines in your changes missing coverage. Please review.

Project coverage is 50.82%. Comparing base (a4ce314) to head (3c5f5e1). Report is 15 commits behind head on main.

Files	Patch %	Lines
pkg/document/internal_document.go	0.00%	12 Missing :warning:
client/client.go	0.00%	10 Missing :warning:
server/backend/config.go	0.00%	5 Missing :warning:
server/backend/housekeeping/housekeeping.go	0.00%	4 Missing :warning:
server/server.go	0.00%	3 Missing :warning:
pkg/document/document.go	0.00%	2 Missing :warning:
server/backend/database/mongo/client.go	80.00%	0 Missing and 1 partial :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #936 +/- ## ========================================== - Coverage 51.47% 50.82% -0.66% ========================================== Files 71 73 +2 Lines 10575 10793 +218 ========================================== + Hits 5444 5486 +42 - Misses 4585 4757 +172 - Partials 546 550 +4 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

[raararaara]

@hackerwins

The answer to question B is:

During the deactivate process, the VerifyAccess() was performed, and a test case that failed was found during this process, such as authorization webhook test.

For the remaining questions, I look forward to hearing ideas from others.

[krapie]

@hackerwins I think using yorkie gateway to delegate detach is a good idea, considering that the housekeeping server will send only necessary request to the server to delegate. I'm wondering what will happen when detach is not performed on other documents that user was attached, and then deactivation occurs?

[raararaara]

@krapie Could you please explain in more detail what you are curious about?

Are you referring to a situation where document detach fails and only client deactivate occured during the process of client deactivation, specifically clients.deactivate()?

[raararaara]

I have identified an issue related to Authorization as pointed out by @hackerwins . Specifically, the issues are as follows:

• For clients with a token value, the verifyAccess process is required during deactivate or detach.
  • When receiving a deactivate or detach request from an external source, the client's token value is passed along with the request.
  • However, in cases where a client is temporarily created during the server (Housekeeping) process, there is no way to know this token value.

To address this issue, I'm considering the following two actions:

1. Issuing a Server-Specific Token:
   We plan to generate a shared token for all servers, allowing us to skip the verifyAccess step for server-specific tokens. We are considering methods such as injecting this token through the defaultFlag or a DevOps manifest.

2. Defining a systemService:
   Currently, only rpcService and adminService are defined. We propose defining a new systemService to separate the logic for inter-server communication from existing services.

---

Given the additional work required, I will mark this PR as a draft.

And of course, any feedback or comments are welcome!

[krapie]

@raararaara My apologizes, I was asking the wrong question.