Return ErrAlreadyDetached when reattaching

[hackerwins]

What this PR does / why we need it:

Return ErrAlreadyDetached when reattaching

This commit addresses the need for handling reattaching detached
documents. When reattaching a document that was previously detached,
special processing is required to prevent attachment in cases where
tombstone nodes may have been garbage collected by another client during
editing.

If attaching a new document with the same key, it should attach normally.
Therefore, there needs to be a distinction between attaching a new
document and reattaching.

While there is no difference in DB.ClientInfo, the Request ChangePack's
Checkpoint.ServerSeq value can be used to distinguish between attaching
a new document and reattaching a detached document. In cases where
Checkpoint.ServerSeq is greater than 0, the ErrAlreadyDetached error
should be returned.

Which issue(s) this PR fixes:

Addresses #904

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

Additional documentation:

Checklist:

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

Summary by CodeRabbit

• New Features

  • Added a new method to check if a document is attached based on the server sequence number.
  • Included a new error for document detachment scenarios.

• Bug Fixes

  • Updated methods and tests to handle an additional parameter for document attachment status.

• Refactor

  • Refactored document attachment logic across various files for consistency and error handling.

• Tests

  • Updated multiple test cases to include additional argument in document attachment calls.

[coderabbitai]

Warning

Review failed

The pull request is closed.

Walkthrough

The changes primarily add an IsAttached() method to the Pack struct, update the AttachDocument method in ClientInfo to accept an alreadyAttached parameter, and handle new error mappings related to document attachment states. These modifications enhance the backend's capability to manage document attachment status by refining method signatures, adjusting error handling, and updating test cases accordingly.

Changes

Files/Groups	Change Summary
pkg/document/change/pack.go	Added IsAttached() method to Pack struct.
server/backend/database/client_info.go	Added ErrDocumentAlreadyDetached and updated AttachDocument method to include alreadyAttached parameter.
server/backend/database/client_info_test.go	Updated AttachDocument method signature in various test cases to include alreadyAttached parameter.
server/backend/database/testcases/testcases.go	Added alreadyAttached parameter to AttachDocument calls within multiple test functions.
server/rpc/connecthelper/status.go	Added error mapping for database.ErrDocumentAlreadyDetached to connect.CodeFailedPrecondition.
server/rpc/yorkie_server.go	Updated AttachDocument method to use pack.IsAttached() when calling clientInfo.AttachDocument.
test/bench/push_pull_bench_test.go	Updated AttachDocument call to include alreadyAttached parameter in the setUpClientsAndDocs function.
test/integration/document_test.go	Added new imports and refactored test cases involving document attachment, detachment, and reattachment logic.

Poem

A document's dance in data's embrace,
By Pack's new steps and Client's retrace,
Attached or not, a query so wise,
With bugs now fleeing, the tests comply.
In backend's realm, where code does bloom,
Improvements shine, dispelling gloom. ✨

---

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
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • 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 Configration 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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.