Handle local changes correctly when receiving snapshot

[humdrum]

What this PR does / why we need it:

• Handle local changes correctly when receiving snapshot yorkie-js-sdk#868

Which issue(s) this PR fixes:

Fixes #

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

  • Introduced a method to check for snapshots within document change packs.
  • Enhanced document handling to apply local changes if a snapshot exists before garbage collection.

• Tests

  • Added a test to ensure local changes are correctly managed when handling snapshots during client synchronization.

[coderabbitai]

Walkthrough

The update introduces a new method hasSnapshot() in the ChangePack struct to check for snapshots. Additionally, the Document.swift file now includes a conditional block to apply local changes if a snapshot exists before garbage collection. A new test method was added to ensure correct handling of local changes when receiving snapshots in synchronized client environments.

Changes

Files	Change Summary
Sources/.../Change/ChangePack.swift	Added hasSnapshot() method to ChangePack struct.
Sources/.../Document/Document.swift	Added a conditional block to handle local changes if a snapshot exists before garbage collection.
Tests/.../ClientIntegrationTests.swift	Added test_should_handle_local_changes_correctly_when_receiving_snapshot test method.

Poem

In a forest of code, where snapshots bloom,
A method to check them now sprouts in the room. 🌸
Documents rejoice, local changes align,
Synced clients dance, in a rhythm so fine.
Testing the flow, with counters they play,
A harmonious update to brighten the day. 🌼🐇

---

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.

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 29 lines in your changes missing coverage. Please review.

Project coverage is 45.13%. Comparing base (023f1d7) to head (9416b28).

Files	Patch %	Lines
Tests/Integration/ClientIntegrationTests.swift	0.00%	21 Missing ⚠️
Sources/Document/Document.swift	0.00%	6 Missing ⚠️
Sources/Document/Change/ChangePack.swift	0.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #186      +/-   ##
==========================================
- Coverage   45.20%   45.13%   -0.07%     
==========================================
  Files         105      105              
  Lines       19304    19333      +29     
==========================================
  Hits         8726     8726              
- Misses      10578    10607      +29     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[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 023f1d7 and 9416b28.

Files selected for processing (3)

• Sources/Document/Change/ChangePack.swift (1 hunks)
• Sources/Document/Document.swift (1 hunks)
• Tests/Integration/ClientIntegrationTests.swift (1 hunks)

Additional comments not posted (3)

Sources/Document/Change/ChangePack.swift (1)

103-109: Add a missing return statement.

The method hasSnapshot() should include a return statement to explicitly return the result.

-    func hasSnapshot() -> Bool {
-        self.snapshot != nil
+    func hasSnapshot() -> Bool {
+        return self.snapshot != nil

Likely invalid or redundant comment.

Sources/Document/Document.swift (1)

283-289: Ensure local changes are correctly reapplied after snapshot.

The added code correctly applies local changes after a snapshot is received. This ensures that local changes are not lost.

Tests/Integration/ClientIntegrationTests.swift (1)

782-815: Comprehensive test for handling local changes with snapshot.

The new test method test_should_handle_local_changes_correctly_when_receiving_snapshot is well-written and covers the scenario comprehensively.