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

Prevent remote-change events in RealtimeSyncOff mode #176

Merged
merged 3 commits into from
May 29, 2024
Merged

Conversation

humdrum
Copy link
Contributor

@humdrum humdrum commented May 28, 2024

What this PR does / why we need it:

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

@humdrum humdrum requested review from myupage and chacha912 May 28, 2024 12:52
@humdrum humdrum self-assigned this May 28, 2024
Copy link
Contributor

coderabbitai bot commented May 28, 2024

Walkthrough

The recent updates involve modifying a conditional check within the Client actor to include additional conditions for attachment.syncMode. Additionally, two presence-related test functions were removed from the PresenceTests.swift file, impacting the test coverage for presence scenarios.

Changes

Files Change Summary
Sources/Core/Client.swift Updated conditional check in Client actor to include attachment.syncMode.
Tests/Integration/PresenceTests.swift Removed two test functions related to presence data and syncing changes.

Poem

In the code where changes flow,
Sync modes now in tow,
Presence tests bid adieu,
Clearing paths for something new.
🎉


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

codecov bot commented May 28, 2024

Codecov Report

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

Project coverage is 43.45%. Comparing base (d32e035) to head (49ba55b).

Files Patch % Lines
Sources/Core/Client.swift 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #176      +/-   ##
==========================================
+ Coverage   43.25%   43.45%   +0.20%     
==========================================
  Files         105      105              
  Lines       19071    18981      -90     
==========================================
  Hits         8249     8249              
+ Misses      10822    10732      -90     

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

@humdrum humdrum marked this pull request as draft May 28, 2024 13:00
@humdrum humdrum marked this pull request as ready for review May 29, 2024 02:08
Copy link
Contributor

@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 d32e035 and 49ba55b.
Files selected for processing (2)
  • Sources/Core/Client.swift (1 hunks)
  • Tests/Integration/PresenceTests.swift (1 hunks)
Files skipped from review due to trivial changes (1)
  • Tests/Integration/PresenceTests.swift
Additional comments not posted (1)
Sources/Core/Client.swift (1)

718-718: Refine synchronization logic to prevent unnecessary sync in realtimeSyncOff and realtimePushOnly modes.

This change correctly implements the intended behavior to prevent remote-change events when the client is in RealtimeSyncOff mode, as described in the PR. It's a good practice to ensure that this logic does not interfere with other synchronization modes or functionalities. Consider adding unit tests specifically for this new condition to verify its behavior under different scenarios.

@humdrum humdrum merged commit 58f5114 into main May 29, 2024
3 checks passed
@humdrum humdrum deleted the fix/sync-off branch May 29, 2024 04:36
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.

None yet

2 participants