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

Fix panic in pubsub by deleting subs in callback #1101

Merged
merged 1 commit into from
Dec 16, 2024
Merged

Conversation

hackerwins
Copy link
Member

@hackerwins hackerwins commented Dec 16, 2024

What this PR does / why we need it:

Fix panic in pubsub by deleting subs in callback

This PR addresses a panic error that occurred after the introduction of a concurrency map in the pubsub by modifying the deletion process of subscriptions. Now, instead of causing a panic, subs are deleted within the callback to ensure thread safety and prevent race conditions.

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
  • Addressed and resolved all CodeRabbit review comments
  • Didn't break anything

Summary by CodeRabbit

  • Bug Fixes

    • Improved logic for managing subscription deletions, ensuring active subscriptions are not prematurely removed.
  • Chores

    • Maintained existing debug logging for the unsubscribe process.

Copy link

coderabbitai bot commented Dec 16, 2024

Walkthrough

The pull request modifies the Unsubscribe method in the PubSub struct within the pubsub.go file. The changes focus on improving the logic for managing subscriptions during the unsubscription process. The updated implementation adds more precise conditions for deleting a subscription, ensuring that only truly empty subscriptions are removed from the subscriptionsMap.

Changes

File Change Summary
server/backend/sync/memory/pubsub.go Updated Unsubscribe method logic to more carefully check subscription status before deletion

Sequence Diagram

sequenceDiagram
    participant PubSub
    participant Subscription
    
    PubSub->>Subscription: Unsubscribe request
    alt Subscription exists and is empty
        PubSub->>PubSub: Delete subscription from map
        PubSub->>Subscription: Close subscription
    else Subscription not empty or doesn't exist
        PubSub->>PubSub: No action taken
    end
Loading

The sequence diagram illustrates the refined unsubscription logic, showing how the method now checks the subscription's status before performing any deletion or closure actions.

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f35cc77 and 6f77acc.

📒 Files selected for processing (1)
  • server/backend/sync/memory/pubsub.go (1 hunks)
🔇 Additional comments (1)
server/backend/sync/memory/pubsub.go (1)

148-155: ⚠️ Potential issue

Fix incorrect condition in subscription cleanup logic

There's a critical logic error in the deletion condition. The current implementation will never delete empty subscriptions because:

  1. When !exists is true, it returns false (skips deletion)
  2. When 0 < subs.Len() is true (has subscriptions), it returns false (skips deletion)
  3. When both are false (exists and empty), it deletes - but the condition 0 < subs.Len() means "has subscriptions"

This effectively prevents cleanup of empty subscription maps, potentially causing memory leaks.

Apply this fix to correct the logic:

 m.subscriptionsMap.Delete(docKey, func(subs *Subscriptions, exists bool) bool {
-    if !exists || 0 < subs.Len() {
     if !exists || subs.Len() > 0 {
         return false
     }
 
     subs.Close()
     return true
 })

Let's verify the subscription cleanup behavior:

Would you like me to help create test cases to verify:

  1. Proper cleanup of empty subscription maps
  2. No cleanup when subscriptions still exist
  3. Memory leak prevention

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

Copy link

codecov bot commented Dec 16, 2024

Codecov Report

Attention: Patch coverage is 50.00000% with 3 lines in your changes missing coverage. Please review.

Project coverage is 46.82%. Comparing base (f35cc77) to head (6f77acc).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
server/backend/sync/memory/pubsub.go 50.00% 2 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1101       /-   ##
==========================================
- Coverage   46.84%   46.82%   -0.03%     
==========================================
  Files          84       84              
  Lines       12256    12257        1     
==========================================
- Hits         5741     5739       -2     
- Misses       5939     8631        2     
- Partials      576      577        1     

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

@hackerwins hackerwins merged commit 2bd6d39 into main Dec 16, 2024
5 checks passed
@hackerwins hackerwins deleted the fix-subs-nil branch December 16, 2024 09:27
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.

1 participant