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

changes timeouts to more reasonable values #206

Merged
merged 2 commits into from
Jun 14, 2024
Merged

changes timeouts to more reasonable values #206

merged 2 commits into from
Jun 14, 2024

Conversation

skhugh
Copy link
Contributor

@skhugh skhugh commented Jun 13, 2024

What this PR does / why we need it?

changes timeouts to more reasonable values

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

  • Improvements
    • Increased timeout durations in the client operations for better performance and reliability.
    • Introduced a new dynamic streamTimeout calculation to enhance adaptability based on various timeout settings.

@skhugh skhugh requested a review from 7hong13 June 13, 2024 22:59
@skhugh skhugh self-assigned this Jun 13, 2024
Copy link

coderabbitai bot commented Jun 13, 2024

Walkthrough

The recent updates focus on modifying the timeout durations in the Client.kt file within the Client class. The timeouts in the watchDocument function and the responseChannel loop have been updated from fixed values to a dynamic streamTimeout calculated based on several other time-related settings, ensuring better responsiveness and reliability.

Changes

File Change Summary
.../core/Client.kt Timeout durations updated to streamTimeout in watchDocument and responseChannel loop; dynamically calculated streamTimeout added, based on multiple timeout settings.

Poem

In the code of Yorkie, where time would flee,
We’ve lengthened the wait, from one to infinity. 🕰️
With streams now robust, like a rabbit’s dash,
The clients respond in a flash! 🌟
Time now bound, by values so wise,
In Yorkie’s world, efficiency shall rise! ✨


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 971eb30 and 45203f6.

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

315-315: Increased timeout in watchDocument to 60,000 milliseconds.

This change should enhance the client's tolerance to network delays. However, consider monitoring the system to ensure that this does not adversely affect responsiveness or error detection times in scenarios where a quick failure is preferable.


325-325: Increased timeout in responseChannel to 180,000 milliseconds.

While this adjustment can help in scenarios with slow or unstable network conditions, it's essential to observe the impact on the system's ability to detect and handle errors promptly. Consider introducing a configuration option for clients to adjust this timeout based on their specific needs and environment.

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 45203f6 and 8bb6a9c.

Files selected for processing (1)
  • yorkie/src/main/kotlin/dev/yorkie/core/Client.kt (4 hunks)
Files skipped from review as they are similar to previous changes (1)
  • yorkie/src/main/kotlin/dev/yorkie/core/Client.kt

@skhugh skhugh merged commit e2915b8 into main Jun 14, 2024
4 of 6 checks passed
@skhugh skhugh deleted the stream branch June 14, 2024 01:57
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