search

yorkie-team / yorkie

Yorkie is a document store for collaborative applications.
https://yorkie.dev
Apache License 2.0
780 stars 144 forks source link

Add RHTNode removal to converter for consistency #888

Closed hackerwins closed 4 months ago

hackerwins commented 4 months ago

What this PR does / why we need it:

This commit addresses the missing isRemoved encoding in the RHT. Similar to other CRDTs like ElementRHT, including tombstone nodes like isRemoved during encoding is crucial. However, the RHT did not include tombstone nodes in its encoding, leading to inconsistencies in snapshots.

Which issue(s) this PR fixes:

Address https://github.com/yorkie-team/yorkie/issues/889 Address https://github.com/yorkie-team/yorkie/issues/869

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

Additional documentation:

Checklist:

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

Walkthrough

The recent changes enhance XML style attribute handling, improve internal data conversion functions, update OpenAPI specifications for better consistency, and introduce new tests for deep copy functionality. The modifications ensure more robust and flexible handling of document attributes, streamline API documentation, and improve test coverage for the system's core components.

Changes

File(s) Change Summary
api/converter/converter_test.go Added style attributes to XML elements, removed a style attribute, updated XML output, and added assertions for these changes.
api/converter/from_pb.go Introduced fromRHT function for converting api.NodeAttr to crdt.RHT.
api/converter/to_bytes.go Added toRHT function for converting crdt.RHT to map[string]*api.NodeAttr and updated toTreeNode function to use it.
api/docs/yorkie/v1/resources.openapi.yaml, api/docs/yorkie/v1/yorkie.openapi.yaml Updated descriptions, URL structures, and schema references for better consistency and readability.
api/yorkie/v1/resources.proto Added is_removed boolean field to NodeAttr message.
pkg/document/crdt/rht.go Added IsRemoved and SetInternal methods, modified Nodes and DeepCopy methods.
pkg/document/crdt/rht_test.go Added TestRHT_DeepCopy function, modified TestRHT_Remove function with new test cases and expectations.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant Client
    participant API
    participant Converter
    participant CRDT

    Client->>API: Request to modify XML styles
    API->>Converter: Convert request data
    Converter->>CRDT: Apply style changes
    CRDT-->>Converter: Return updated tree
    Converter-->>API: Return updated XML
    API-->>Client: Send updated XML response

Poem

In the land of code, where changes flow,
Styles and attributes now brightly glow.
With tests that dive so deep and true,
Yorkie's docs get a fresh review.
The CRDT trees stand tall and proud,
As Yorkie's updates shout aloud. 🌳✨

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 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](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] commented 4 months ago

Codecov Report

Attention: Patch coverage is 78.78788% with 7 lines in your changes missing coverage. Please review.

Project coverage is 50.67%. Comparing base (4a47984) to head (5c4b736).

Files Patch % Lines
api/converter/from_pb.go 58.33% 3 Missing and 2 partials :warning:
pkg/document/crdt/rht.go 81.81% 2 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #888 +/- ## ========================================== + Coverage 50.50% 50.67% +0.16% ========================================== Files 70 70 Lines 10454 10471 +17 ========================================== + Hits 5280 5306 +26 + Misses 4646 4638 -8 + Partials 528 527 -1 ```

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