Prevent remote-change events in RealtimeSyncOff mode

[7hong13]

What this PR does / why we need it?

Prevent remote-change events in RealtimeSyncOff mode.
(I have also cleaned up the outdated test code.)

Any background context you want to provide?

What are the relevant tickets?

• https://github.com/yorkie-team/yorkie-js-sdk/pull/824/files

Fixes #

Checklist

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

Summary by CodeRabbit

• New Features

  • Updated app version to 0.4.20.
  • Added a new test to ensure remote changes are prevented when sync is off.

• Bug Fixes

  • Improved handling of synchronization modes to correctly process response changes.

• Tests

  • Enhanced test cases for XML structure editing in document tests.
  • Added Ignore annotations for specific test cases.

[coderabbitai]

Walkthrough

The recent updates include a version bump in gradle.properties, the addition of a new test method in ClientTest.kt, a condition check enhancement in Client.kt, and modifications in CrdtTreeTest.kt to improve XML structure handling in tests. These changes enhance synchronization behavior, improve test coverage, and update the project version.

Changes

Files	Change Summary
gradle.properties	Updated VERSION_NAME from 0.4.19-rc2 to 0.4.20.
.../androidTest/kotlin/dev/yorkie/core/ClientTest.kt	Added test_prevent_remote_changes_in_sync_off to test remote change prevention when sync is off.
.../main/kotlin/dev/yorkie/core/Client.kt	Enhanced condition check to include RealtimeSyncOff in addition to RealtimePushOnly for response changes.
.../test/kotlin/dev/yorkie/document/crdt/CrdtTreeTest.kt	Added import org.junit.Ignore and modified target.edit calls to handle XML text nodes and elements.

Poem

In code's domain, a version ascends,
Sync off, remote change it defends.
Tests bloom like flowers, precise and bright,
XML nodes find their place in the light.
With every tweak, our project grows,
In harmony, the software flows.
🌟✨🚀

---

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.

[coderabbitai]

Actionable comments posted: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b552be7 and 74d7268.

Files selected for processing (2)

• yorkie/src/androidTest/kotlin/dev/yorkie/core/ClientTest.kt (1 hunks)
• yorkie/src/main/kotlin/dev/yorkie/core/Client.kt (1 hunks)

Additional comments not posted (2)

yorkie/src/main/kotlin/dev/yorkie/core/Client.kt (1)

242-245: Ensure correct handling of SyncMode values to prevent remote changes in RealtimeSyncOff mode.

This change correctly implements the logic to ignore remote changes when the client is in RealtimeSyncOff mode, aligning with the PR's objectives. Good use of conditional checks to differentiate behavior based on SyncMode.

yorkie/src/androidTest/kotlin/dev/yorkie/core/ClientTest.kt (1)

701-770: Add comprehensive test for RealtimeSyncOff mode.

This test method effectively checks that no remote changes are received when the client is in RealtimeSyncOff mode. It simulates the scenario described in the PR objectives and ensures that the new functionality behaves as expected.

[coderabbitai]

Actionable comments posted: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 74d7268 and 1d08dee.

Files selected for processing (4)

• gradle.properties (1 hunks)
• yorkie/src/androidTest/kotlin/dev/yorkie/core/ClientTest.kt (1 hunks)
• yorkie/src/main/kotlin/dev/yorkie/core/Client.kt (1 hunks)
• yorkie/src/test/kotlin/dev/yorkie/document/crdt/CrdtTreeTest.kt (3 hunks)

Files skipped from review due to trivial changes (1)

• gradle.properties

Files skipped from review as they are similar to previous changes (2)

• yorkie/src/androidTest/kotlin/dev/yorkie/core/ClientTest.kt
• yorkie/src/main/kotlin/dev/yorkie/core/Client.kt

Additional comments not posted (3)

yorkie/src/test/kotlin/dev/yorkie/document/crdt/CrdtTreeTest.kt (3)

12-12: Added import org.junit.Ignore to support ignoring specific tests.

---

189-244: Added a comprehensive test should merge and edit different levels with edit, currently ignored due to dependencies on JS SDK.

Ensure the documentation clearly states the dependency on the JS SDK implementation to avoid confusion.

---

107-108: Simplified deletion range in should delete text nodes with edit.