Skip to content

test(server): reliably detect Start/Shutdown deadlock in SSEServer #264

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
Merged
merged 1 commit into from
May 10, 2025
Merged

test(server): reliably detect Start/Shutdown deadlock in SSEServer #264

merged 1 commit into from
May 10, 2025

Conversation

rwjblue-glean
Copy link
Collaborator

@rwjblue-glean rwjblue-glean commented May 9, 2025 •
edited
Loading

This test demonstrates the deadlock described in
#254 and #263 by running SSEServer.Start then SSEServer.Shutdown. If it deadlocks, the test fails quickly and reliably, rather than hanging indefinitely.

I've confirmed (locally) that the fix from #255 makes this test pass.

References:

Summary by CodeRabbit

  • Tests
    • Added a new test to ensure that starting and then shutting down the SSE server does not result in a deadlock or indefinite blocking.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented May 9, 2025 •
edited
Loading

Walkthrough

A new subtest was added to the TestSSEServer suite to verify that calling Start() followed by Shutdown() on the SSE server does not result in a deadlock. The test checks that shutdown completes within a specified timeout, ensuring no indefinite blocking occurs.

Changes

File(s) Change Summary
server/sse_test.go Added a subtest to TestSSEServer to verify Start() then Shutdown() does not deadlock.

Possibly related issues

Possibly related PRs

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

📜 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 6429019 and 80f98f5.

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

1404-1434: Clear and effective deadlock detection test.

This test effectively verifies that the Start() and Shutdown() methods of SSEServer don't deadlock, which addresses the issue mentioned in #254 and #263. The approach is well-designed with:

  1. Proper timing controls with both a context timeout (300ms) and a safety timeout (1s)
  2. Clear error conditions that distinguish between context deadline exceeded and other failure modes
  3. Good use of goroutines and channels to manage concurrent operations

This will serve as an excellent regression test to prevent the deadlock from recurring in the future.

✨ 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.

@rwjblue-glean rwjblue-glean mentioned this pull request May 9, 2025
Merged
@rwjblue-glean
Copy link
Collaborator Author

@ezynda3 - You can see the failure on CI here. Once #255 lands, I can rebase this (or a maintainer can push this to the branch for #255).

@ezynda3
Copy link
Contributor

ezynda3 commented May 10, 2025

@robert-jackson-glean #255 has been merged

@rwjblue-glean
test(server): reliably detect Start/Shutdown deadlock in SSEServer
80f98f5 
This test demonstrates the deadlock described in
mark3labs#254 and
mark3labs#263 by running
`SSEServer.Start` then `SSEServer.Shutdown`. If it deadlocks, the test
fails quickly and reliably, rather than hanging indefinitely.

References:

- mark3labs#254
- mark3labs#255
- mark3labs#263
@rwjblue-glean rwjblue-glean force-pushed the rwjblue/push-yxpvrwykkkmn branch from 71c215c to 80f98f5 Compare May 10, 2025 17:14
@rwjblue-glean rwjblue-glean marked this pull request as ready for review May 10, 2025 17:15
@rwjblue-glean rwjblue-glean merged commit 1c99eaf into mark3labs:main May 10, 2025
3 checks passed
@rwjblue-glean rwjblue-glean deleted the rwjblue/push-yxpvrwykkkmn branch May 10, 2025 17:18
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.

The SSEServer.Shutdown() function deadlocks, preventing the service from shutting down. SSEServer：The Shutdown method fails to exit normally
2 participants
@rwjblue-glean @ezynda3
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy