Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sync android-sdk with js-sdk: Implement updates to v0.4.27 #212

Merged
merged 35 commits into from
Sep 24, 2024

Conversation

daeyounglnc
Copy link
Contributor

@daeyounglnc daeyounglnc commented Aug 28, 2024

What this PR does / why we need it?

Applied changes from JS SDK up to 0.4.27.
Not all tasks are complete, so I make the list of tasks below.

0.4.27

0.4.26

0.4.25

Any background context you want to provide?

What are the relevant tickets?

It wasn't limited to just a single task or PR.
Please check below releases, this PR included tasks from versions 0.4.25 through 0.4.27.
https://github.com/yorkie-team/yorkie-js-sdk/releases

Fixes #

Checklist

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

@daeyounglnc daeyounglnc requested review from skhugh and 7hong13 August 28, 2024 13:28
@daeyounglnc daeyounglnc self-assigned this Aug 28, 2024
Copy link

coderabbitai bot commented Aug 28, 2024

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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
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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

@daeyounglnc daeyounglnc changed the title Sync Android SDK with JS SDK: Implement Updates to v0.4.27 Sync android-sdk with js-sdk: Implement updates to v0.4.27 Aug 29, 2024
@@ -11,7 +11,7 @@ android.suppressUnsupportedOptionWarnings=android.suppressUnsupportedOptionWarni
kotlin.code.style=official
kotlin.mpp.stability.nowarn=true
GROUP=dev.yorkie
VERSION_NAME=0.4.25-rc
VERSION_NAME=0.4.27-rc
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I set the RC version because even after the merge this PR, there are still specs to discuss.
yorkie-team/yorkie-js-sdk#865

c1.syncAsync().await()

// 02. c2 receives the snapshot and increases the counter simultaneously.
// The tc in js-sdk, it performed the sync before update, but it is not necessary.
Copy link
Contributor Author

@daeyounglnc daeyounglnc Aug 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@raararaara ,

As we talked in the offline conversation, calling the sync function in the js-sdk isn't mandatory.
So I didn't write the code to call the sync (syncAsync in android) function, I thought it might cause unnecessary to understand exactly what TC is trying to do.
If you has any thoughts on this, please comment.

@@ -621,4 +623,215 @@ class DocumentTest {
collectJobs.values.forEach(Job::cancel)
}
}

@Test
fun test_single_document_event_stream_can_emit_document_status_changed() {
Copy link
Contributor Author

@daeyounglnc daeyounglnc Aug 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We doesn't implement this behavior before, but I added this for more detailed validation, I think.

daeyounglnc and others added 3 commits September 1, 2024 03:00
Co-authored-by: Hyowoo Kim <skhugh@gmail.com>
Co-authored-by: Hyowoo Kim <skhugh@gmail.com>
Co-authored-by: Hyowoo Kim <skhugh@gmail.com>
val document2StatusChangedList = mutableListOf<Event.DocumentStatusChanged>()
val jobs = mapOf(
"document1 status changed events" to launch(start = CoroutineStart.UNDISPATCHED) {
document1.events.filterIsInstance<Event.DocumentStatusChanged>()
Copy link
Contributor

@7hong13 7hong13 Sep 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just a trivial question, but is there any reason to use a Map instead of a List? It seems like you're not using the keys.

Copy link
Contributor Author

@daeyounglnc daeyounglnc Sep 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't intend to use Map for anything else.
Actually, as your comment, there was no need to use Map in another function.
Also, some functions I've written don't need Map. Maybe it's better to use List.
but I think it makes sense for naming purposes, so I'll keep it as it is for now.

@daeyounglnc daeyounglnc merged commit a5a62a5 into yorkie-team:v0.4.27 Sep 24, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants