Add ServerSeq into ChangeInfo

[7hong13]

What this PR does / why we need it?

Any background context you want to provide?

What are the relevant tickets?

• Fix invalid error message in CRDTTreePos yorkie-js-sdk#830
• Add ServerSeq into ChangeInfo yorkie-js-sdk#833

Fixes #

Checklist

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

Summary by CodeRabbit

• New Features

  • Enhanced toChangeInfo function to accept clientSeq and serverSeq parameters for improved change tracking.

• Improvements

  • Updated error messages in the CrdtTree class for better clarity and debugging.

[coderabbitai]

Walkthrough

The recent changes across several Kotlin files in the Yorkie project focus on enhancing the functionality of handling change identifiers and sequences. The modifications include adding serverSeq to various functions and data classes to improve synchronization and error messaging. Additionally, the CrdtTree class error messages were updated for better clarity.

Changes

Files & Directories	Change Summary
yorkie/src/main/kotlin/dev/yorkie/api/ChangeConverter.kt	Added serverSeq parameter and assignments in toPBChangeID and toChangeID functions.
yorkie/src/main/kotlin/dev/yorkie/document/Document.kt	Updated toChangeInfo function and ChangeInfo data class to include clientSeq and serverSeq.
yorkie/src/main/kotlin/dev/yorkie/document/change/ChangeID.kt	Added serverSeq property with a default value of 0 to ChangeID class.
yorkie/src/main/kotlin/dev/yorkie/document/crdt/CrdtTree.kt	Improved error messages to provide more specific information about missing nodes.

Poem

In Yorkie's code, a change unfolds,
With serverSeq now in its hold.
ChangeID and ChangeInfo grow,
Synchronizing data, to and fro.
CrdtTree speaks clearer, no more plight,
Yorkie's future, shining bright! 🌟

---

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 9cae02b and 68a41b4.

Files selected for processing (4)

• yorkie/src/main/kotlin/dev/yorkie/api/ChangeConverter.kt (2 hunks)
• yorkie/src/main/kotlin/dev/yorkie/document/Document.kt (2 hunks)
• yorkie/src/main/kotlin/dev/yorkie/document/change/ChangeID.kt (1 hunks)
• yorkie/src/main/kotlin/dev/yorkie/document/crdt/CrdtTree.kt (1 hunks)

Files skipped from review due to trivial changes (1)

• yorkie/src/main/kotlin/dev/yorkie/document/crdt/CrdtTree.kt

Additional comments not posted (5)

yorkie/src/main/kotlin/dev/yorkie/document/change/ChangeID.kt (1)

14-14: Addition of serverSeq with a default value ensures backward compatibility.

yorkie/src/main/kotlin/dev/yorkie/api/ChangeConverter.kt (2)

51-51: Correct handling of serverSeq in toChangeID function aligns with the new ChangeID structure.

---

61-61: Inclusion of serverSeq in toPBChangeID ensures complete serialization of ChangeID.

yorkie/src/main/kotlin/dev/yorkie/document/Document.kt (2)

477-477: Proper inclusion of serverSeq in toChangeInfo function ensures consistent change tracking.

---

577-578: Addition of serverSeq as a nullable field in ChangeInfo provides flexibility in handling changes without a server sequence.

[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 68a41b4 and 670dd5c.

Files selected for processing (1)

• yorkie/src/main/kotlin/dev/yorkie/document/Document.kt (2 hunks)

Files skipped from review due to trivial changes (1)

• yorkie/src/main/kotlin/dev/yorkie/document/Document.kt