yorkie-team / yorkie

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

Handle concurrent Tree.RemoveStyle #883

Closed hackerwins closed 1 month ago

hackerwins commented 1 month ago

What this PR does / why we need it:

Handle concurrent Tree.RemoveStyle

This commit addresses an issue where if a node has an attribute with the same key as the RemoveStyle is simultaneously inserted by Tree.Edit functions, the attribute of the concurrently inserted Node with the same key gets deleted. To resolve this issue, this commit adds filtering logic in RemoveStyle to prevent attribute deletion from concurrently inserted nodes.

Which issue(s) this PR fixes:

Address #884

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

Additional documentation:

Checklist:

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

Recent updates focus on refining the handling of styling operations within the tree structures in the codebase. The changes primarily enhance the order of operations and the parameters involved in styling and attribute removal processes. These improvements ensure more accurate and efficient management of node attributes, particularly when dealing with concurrent edits and different actors.

Changes

File Change Summary
api/converter/from_pb.go Rearranged operations order in fromTreeStyle and updated operations.NewTreeStyleRemove call to include createdAtMapByActor.
pkg/document/crdt/tree.go Refined logic in canStyle and Style methods; added maxCreatedAtMapByActor parameter to RemoveStyle.
pkg/document/json/tree.go Added maxCreationMapByActor parameter to RemoveStyle method.
pkg/document/operations/tree_style.go Added maxCreatedAtMapByActor parameter to NewTreeStyleRemove and updated Execute method.
test/integration/tree_concurrency_test.go Modified TestTreeConcurrencyEditStyle to include new attributes and updated StyleRemove and StyleSet operations.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant API
    participant CRDT
    participant JSON
    participant Operations

    User->>API: Call fromTreeStyle with TreeStyle
    API->>Operations: Call NewTreeStyleRemove with createdAtMapByActor
    Operations->>CRDT: Execute TreeStyle with maxCreatedAtMapByActor
    User->>JSON: Call RemoveStyle with maxCreationMapByActor
    JSON->>CRDT: RemoveStyle with updated parameters
    CRDT->>Operations: RemoveStyle with maxCreatedAtMapByActor
    Operations->>CRDT: Update node attributes

Poem

In the forest of code where trees reside,
With styles and attributes, they now abide.
A map of actors, a time to keep,
Ensuring harmony where conflicts seep.
Blue and bold, they dance anew,
In the world of bytes, a vibrant hue.
🐇✨


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 1 month ago

Codecov Report

Attention: Patch coverage is 9.52381% with 38 lines in your changes are missing coverage. Please review.

Project coverage is 50.50%. Comparing base (3647f35) to head (e0837cf).

Files Patch % Lines
pkg/document/crdt/tree.go 11.42% 31 Missing :warning:
api/converter/from_pb.go 0.00% 7 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #883 +/- ## ========================================== - Coverage 50.57% 50.50% -0.07% ========================================== Files 70 70 Lines 10435 10454 +19 ========================================== + Hits 5277 5280 +3 - Misses 4630 4646 +16 Partials 528 528 ```

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