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

Avoid creation of list instances in a while true loop #196

Merged
merged 2 commits into from
Jun 4, 2024
Merged

Conversation

skhugh
Copy link
Contributor

@skhugh skhugh commented Jun 4, 2024

What this PR does / why we need it?

Avoids creation of list instances in a while true loop.

Any background context you want to provide?

What are the relevant tickets?

Fixes #

Checklist

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

Summary by CodeRabbit

  • Refactor

    • Improved real-time synchronization by refactoring internal methods.
    • Enhanced the runSyncLoop method for better performance and reliability.
  • New Features

    • Introduced a new AttachmentEntry class to streamline attachment handling.

@skhugh skhugh requested a review from 7hong13 June 4, 2024 08:35
@skhugh skhugh self-assigned this Jun 4, 2024
Copy link

coderabbitai bot commented Jun 4, 2024

Walkthrough

The changes in Client.kt refactor the synchronization logic by removing the filterRealTimeSyncNeeded method and updating the asSyncFlow method to handle real-time synchronization conditions. A new AttachmentEntry class is introduced, and the runSyncLoop method is adjusted to use attachments.value.entries. These updates streamline the synchronization process and improve code clarity.

Changes

File Path Change Summary
yorkie/src/main/kotlin/dev/yorkie/core/Client.kt Added import for kotlin.collections.Map.Entry and kotlinx.coroutines.flow.mapNotNull. Removed filterRealTimeSyncNeeded method. Updated runSyncLoop and asSyncFlow methods. Added AttachmentEntry class.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant Client
    participant Attachments
    participant SyncFlow

    Client->>Attachments: Get entries
    Attachments-->>Client: Return entries
    Client->>SyncFlow: Call asSyncFlow(entries, realTimeOnly)
    SyncFlow-->>Client: Return Flow<SyncResult>
    Client->>SyncFlow: Collect { (document, result) -> ... }
Loading

Poem

In the code where syncs align,
Attachments flow, a dance divine.
Real-time checks now swift and keen,
With entries mapped, the code's pristine.
A rabbit hops, with joy so bright,
For Yorkie's sync, now set just right. 🐇✨


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

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

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

Files selected for processing (1)
  • yorkie/src/main/kotlin/dev/yorkie/core/Client.kt (6 hunks)
Additional comments not posted (3)
yorkie/src/main/kotlin/dev/yorkie/core/Client.kt (3)

72-72: Added import kotlinx.coroutines.flow.mapNotNull.

This import is necessary for the changes in the asSyncFlow method to utilize mapNotNull.


171-171: Refactored runSyncLoop and syncAsync methods to use attachments.value.entries and updated asSyncFlow.

The refactoring aligns with the PR's objective to optimize performance by avoiding unnecessary list instantiations. The use of entries directly is a good practice in this context.

Also applies to: 193-198, 215-232


641-645: Added AttachmentEntry class implementing Map.Entry<Document.Key, Attachment>.

This addition is crucial for the changes in asSyncFlow to work with Collection<Map.Entry<Document.Key, Attachment>> instead of Collection<Attachment>. It ensures type safety and clarity in the handling of document keys and attachments.

Copy link
Contributor

@7hong13 7hong13 left a comment

Choose a reason for hiding this comment

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

you should check on lint errors

@skhugh
Copy link
Contributor Author

skhugh commented Jun 4, 2024

you should check on lint errors

done 30055a6

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

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 b2b2051 and 30055a6.

Files selected for processing (1)
  • yorkie/src/main/kotlin/dev/yorkie/core/Client.kt (7 hunks)
Additional comments not posted (6)
yorkie/src/main/kotlin/dev/yorkie/core/Client.kt (6)

43-43: Added import for kotlin.collections.Map.Entry.

This import is necessary for the new AttachmentEntry class implementation.


73-73: Added import for kotlinx.coroutines.flow.mapNotNull.

This import supports the new implementation in the asSyncFlow method, allowing for more efficient flow operations.


172-172: Refactored runSyncLoop to use attachments.value.entries directly.

This change aligns with the PR's objective to optimize performance by reducing unnecessary list creations.


194-198: Introduced conditional logic to handle specific document synchronization.

This change is well-implemented, providing a clear path for handling both specific and general document synchronization scenarios.


216-235: Refactored asSyncFlow to handle real-time synchronization conditions.

The method now correctly handles different synchronization modes based on the realTimeOnly parameter, improving clarity and functionality.


644-647: Added a new AttachmentEntry class implementing Map.Entry.

This addition is necessary for the new handling of attachments as entries rather than standalone objects, which helps in optimizing memory usage.

@skhugh skhugh merged commit 080f2cc into main Jun 4, 2024
4 of 6 checks passed
@skhugh skhugh deleted the more_perf branch June 4, 2024 13:29
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.

2 participants