Skip to content

Conversation

cnlangzi
Copy link
Member

@cnlangzi cnlangzi commented Aug 13, 2025

Changed

Fixed

Added

Tests

Tasks to complete before merging PR:

  • Ensure unit tests are passing. If not run make unit-tests to check for any regressions 📋
  • Ensure lint tests are passing. if not run make lint to check for any issues
  • Ensure codecov/patch is passing for changes.

Summary by Sourcery

Refactor SSE server’s keepalive routine to use an external context for cancellation and switch from time.Sleep to time.After for pacing keepalive checks

Enhancements:

  • Change Server.KeepAlive signature to accept a context for external cancellation
  • Replace default-case Sleep loop with a select between the provided context and time.After

Tests:

  • Update KeepAlive test to pass a context argument

Copy link

sourcery-ai bot commented Aug 13, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

The KeepAlive method is refactored to accept an external context and use time.After for interval handling instead of a default Sleep, with accompanying test updates to match the new signature.

Sequence diagram for updated KeepAlive method with external context

sequenceDiagram
    participant ExternalContext as ctx: context.Context
    participant Server
    participant Client
    loop every timeout interval
        ExternalContext->>Server: ctx.Done()?
        Server->>ExternalContext: check ctx.Done()
        alt ctx.Done()
            Server->>Server: return (stop KeepAlive)
        else time.After(timeout)
            Server->>Client: check client activity
            Server->>Client: mark dead clients
        end
    end
Loading

Class diagram for updated Server KeepAlive method

classDiagram
    class Server {
        +KeepAlive(ctx context.Context)
        -KeepAlive()
        ...
    }
    class Client
    Server "1" -- "*" Client: manages
    class context.Context
    Server ..> context.Context: uses in KeepAlive
Loading

File-Level Changes

Change Details Files
Refactor KeepAlive to use passed-in context and time.After for scheduling
  • Changed KeepAlive signature to accept a context.Context parameter
  • Replaced default+time.Sleep loop with select including ctx.Done and time.After
  • Removed reliance on server’s internal context (s.ctx) for cancellation
ext/sse/server.go
Update tests to invoke KeepAlive with a context
  • Modified test to call KeepAlive(context.TODO()) instead of no-arg invocation
ext/sse/server_test.go

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey there - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link

deepsource-io bot commented Aug 13, 2025

Here's the code health analysis summary for commits 8324d0a..f283844. View details on DeepSource ↗.

Analysis Summary

AnalyzerStatusSummaryLink
DeepSource Go LogoGo✅ SuccessView Check ↗

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

Copy link

codecov bot commented Aug 13, 2025

Codecov Report

❌ Patch coverage is 50.00000% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 91.70%. Comparing base (8324d0a) to head (f283844).
⚠️ Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
ext/sse/server.go 50.00% 2 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main      #81   +/-   ##
=======================================
  Coverage   91.70%   91.70%           
=======================================
  Files          66       66           
  Lines        2675     2676    +1     
=======================================
+ Hits         2453     2454    +1     
  Misses        192      192           
  Partials       30       30           
Flag Coverage Δ
Unit-Tests 91.70% <50.00%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@cnlangzi cnlangzi merged commit 6f18ecc into main Aug 13, 2025
6 of 7 checks passed
@cnlangzi cnlangzi deleted the fix/sse_keepalive branch August 13, 2025 23:54
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