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.

Sign up for GitHub

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

Jump to bottom

Fix SSE session handling #373

Merged
merged 4 commits into from
Jan 8, 2025
Merged

Fix SSE session handling #373

merged 4 commits into from
Jan 8, 2025

Conversation

tphakala
Copy link
Owner

@tphakala tphakala commented Jan 8, 2025

This PR fixes #367 by properly managing one SSE session per client

@tphakala
feat: add debug mode for web server configuration
4869439 
- Introduced a new debug flag in the WebServer settings to enable detailed logging.
- Set the default value for the debug mode to false in the configuration.
- Updated validation logic to include the new debug flag for web server settings.
@tphakala
feat: enhance SSEHandler with debug logging for client connections
f78c88c 
- Added debug logging to the SSEHandler for tracking client connections and notifications.
- Logs the total number of connected clients when a new client connects, a notification is sent, or a client disconnects, contingent on the debug mode being enabled in the web server configuration.
@tphakala
feat: enhance SSEHandler with improved connection management and debu…
6b768e5 
…g logging

- Added context cancellation for better cleanup of client connections.
- Implemented heartbeat mechanism to keep connections alive and detect issues.
- Enhanced debug logging for client connection events, including successful notifications and errors during marshaling and writing.
- Updated client channel handling to prevent blocking and improve notification delivery.
@tphakala
feat: implement singleton SSE manager for improved notification handling
ab0483a 
- Added a singleton SSEManager to manage server-sent events (SSE) for real-time notifications.
- Implemented methods for subscribing and unsubscribing notification callbacks.
- Enhanced the initialization process to ensure a single event source is used and cleaned up on page unload.
- Updated the component initialization to utilize the new SSEManager for handling notifications.
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 8, 2025 •
edited
Loading

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces a debug configuration option for the web server across multiple files. The changes include adding a Debug field to the web server configuration struct, setting a default value of false, and updating the validation function. Additionally, the Server-Sent Events (SSE) handler in sse.go is enhanced with debug logging, improved client channel management, and a heartbeat mechanism. The frontend SSE management is also refactored with a new SSEManager to handle real-time notifications more robustly.

Changes

File Change Summary
internal/conf/config.go Added Debug bool field to WebServer struct
internal/conf/defaults.go Added default configuration webserver.debug set to false
internal/conf/validate.go Added Debug field to validation parameter struct
internal/httpcontroller/handlers/sse.go Enhanced SSE handler with debug logging, improved client management, and heartbeat mechanism
views/settings/settingsBase.html Introduced SSEManager for centralized SSE notification handling

Assessment against linked issues

Objective Addressed Explanation
Resolve random blocking in SSE routes [#367] ✅
Improve SSE route handling ✅

Poem

🐰 A rabbit's tale of debug delight,
Configurations now shine so bright!
SSE flows with grace and care,
No more requests caught in despair
Code hops forward, clean and light! 🌟

📜 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 ffd5d25 and ab0483a.

📒 Files selected for processing (5)
  • internal/conf/config.go (1 hunks)
  • internal/conf/defaults.go (1 hunks)
  • internal/conf/validate.go (1 hunks)
  • internal/httpcontroller/handlers/sse.go (2 hunks)
  • views/settings/settingsBase.html (3 hunks)

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.

@tphakala tphakala merged commit 3251595 into main Jan 8, 2025
9 checks passed
@tphakala tphakala mentioned this pull request Jan 9, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

/sse and /audio-level routes randomly block HTTP requests
1 participant
@tphakala