Skip to content

fix(SSE): only initialize http.Server when not set #229

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

Merged
merged 1 commit into from
May 1, 2025

Conversation

cryo-zd
Copy link
Contributor

@cryo-zd cryo-zd commented Apr 30, 2025

Fix issue #156
  Currently, func SSEServer.Start() always resets SSEServer.http.Server, which may prevent us from customizing the process logic of SSEServer.http.Server when we call func NewSSEserver() with SSEOption argument of type WithHTTPServer

func WithHTTPServer(srv *http.Server) SSEOption {
	return func(s *SSEServer) {
		s.srv = srv
	}
}

  This PR enhances func SSEServer.Start() in following aspects:

  1. only set http.Server when it is not obviously set by user
  2. set http.Server.Addr if it is not set in func WithHTTPServer
  3. report Error when Addr set in func WithHTTPServer is not consistent with func Start's argument

Summary by CodeRabbit

  • Bug Fixes
    • Improved server initialization to prevent address conflicts and ensure consistent server configuration.

Copy link
Contributor

coderabbitai bot commented Apr 30, 2025

Walkthrough

The Start method of the SSEServer in server/sse.go was updated to improve how the embedded HTTP server (s.srv) is initialized and validated. The method now checks if s.srv is already set before creating a new instance, and enforces consistency by detecting and reporting address conflicts if the existing server's address differs from the one provided to Start. The mutex unlock is also deferred to ensure proper resource management during these checks.

Changes

File(s) Change Summary
server/sse.go Updated SSEServer.Start to conditionally initialize s.srv, add address conflict detection, and defer mutex unlock.

Possibly related issues

Possibly related PRs


📜 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 df73667 and b73d79f.

📒 Files selected for processing (1)
  • server/sse.go (1 hunks)
🔇 Additional comments (1)
server/sse.go (1)

193-206: Improved server initialization to respect user configurations

The changes to the Start method are well-implemented and address the PR objectives effectively. The logic now:

  1. Preserves any existing HTTP server configuration provided via WithHTTPServer option
  2. Only sets the server address when it's empty
  3. Detects and reports address conflicts between the existing server configuration and the address provided to Start
  4. Uses deferred mutex unlock for better resource management

This enhancement makes the SSE server more flexible by properly respecting user-provided HTTP server instances.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

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.

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