fix(sse): breakline and concurrent write issues #65

cnlangzi · 2025-03-24T10:00:59Z

Changed

Fixed

fix(sse): used two breaklines to split event data
fix(sse): added mutex to prevent data race issue on Send

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

Fixes issues with server-sent events (SSE) by ensuring proper event data separation and preventing data races during concurrent writes.

Bug Fixes:

Fixes an issue where event data was not properly separated due to missing breaklines.
Adds a mutex to the Conn struct to prevent data race issues on the Send method, ensuring thread-safe concurrent writes to the SSE stream.
Fixes an issue where ping events were not properly separated due to missing breaklines

Enhancements:

Improves the reliability and stability of SSE communication by addressing concurrency issues and ensuring correct event formatting.

sourcery-ai · 2025-03-24T10:01:03Z

Reviewer's Guide by Sourcery

This pull request addresses two issues in the SSE implementation: a data race condition in the Send method and an incorrect event data separation. A mutex was added to the Conn struct to prevent concurrent writes. The event writing logic was modified to use two breaklines to separate event data, ensuring proper event parsing.

Updated class diagram for Conn

classDiagram
  class Conn {
    -sync.Mutex lock
    -string ID
    -Streamer s
    -context.Context ctx
    -chan error done
    +Connect(ctx context.Context, s Streamer)
    +Send(evt Event) error
    +Close() error
  }
  note for Conn "Added mutex to prevent data race issue on Send"

File-Level Changes

Change	Details	Files
Added a mutex to the `Conn` struct to prevent data races when sending events.	Added a `sync.Mutex` field to the `Conn` struct. Acquire the mutex before writing event data in the `Send` method. Release the mutex after writing event data in the `Send` method. Check if the context is done before acquiring the lock.	`ext/sse/conn.go`
Modified the event writing logic to use two breaklines to separate event data.	The `TextEvent`, `JsonEvent`, and `PingEvent` now write two breaklines instead of one. The `EventReader` now expects two breaklines instead of one.	`ext/sse/reader.go` `ext/sse/event.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!
Generate a plan of action for an issue: Comment @sourcery-ai plan on
an issue to generate a plan of action for it.

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

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai

Hey @cnlangzi - I've reviewed your changes - here's some feedback:

Overall Comments:

Consider using sync.Once to initialize the connection rather than a mutex for every send.
The PingEvent.Write method now includes three newlines; is this intentional?

Here's what I looked at during the review

🟡 General issues: 1 issue found
🟢 Security: all looks good
🟢 Testing: all looks good
🟢 Complexity: all looks good
🟢 Documentation: all looks good

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

sourcery-ai · 2025-03-24T10:01:54Z

ext/sse/reader.go

@@ -44,7 +45,11 @@ func (r *EventReader) Next() (TextEvent, error) {
 		}

 		if line == "\n" {
-			return evt, nil
+			breakLineNum++


suggestion (bug_risk): Handling of consecutive blank lines in EventReader.Next()

The logic increments breakLineNum when encountering a blank line and returns the event only if breakLineNum exceeds 1. Consider whether the breakLineNum should be reset upon receiving a non-blank line so that non-consecutive blank lines do not inadvertently signal event termination.

Suggested implementation:

breakLineNum = 0 if strings.HasPrefix(line, "id:") {

Ensure that the new reset of breakLineNum is implemented for all non-blank lines. You might want to verify any other relevant cases in the function where non-blank lines are processed.

codecov · 2025-03-24T10:02:00Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.23%. Comparing base (abfc600) to head (383602a).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #65      +/-   ##
==========================================
+ Coverage   91.21%   91.23%   +0.02%     
==========================================
  Files          62       62              
  Lines        2537     2545       +8     
==========================================
+ Hits         2314     2322       +8     
  Misses        192      192              
  Partials       31       31

Flag	Coverage Δ
Unit-Tests	`91.23% <100.00%> (+0.02%)`	⬆️

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:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

deepsource-io · 2025-03-24T10:02:03Z

Here's the code health analysis summary for commits abfc600..383602a. View details on DeepSource ↗.

Analysis Summary

Analyzer	Status	Summary	Link
Go	✅ Success		View Check ↗

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

cnlangzi added 2 commits March 24, 2025 15:51

fix(sse): use two breaklines to split event data

aa38125

fix(sse): added mutex to prevent data race on Send

fb15b33

sourcery-ai bot reviewed Mar 24, 2025

View reviewed changes

fix(sse): reset breaklineNum

383602a

cnlangzi merged commit bc36f14 into main Mar 24, 2025
7 checks passed

cnlangzi deleted the fix/sse_breakline branch March 24, 2025 10:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(sse): breakline and concurrent write issues #65

fix(sse): breakline and concurrent write issues #65

Uh oh!

cnlangzi commented Mar 24, 2025 •

edited by sourcery-ai bot

Loading

Uh oh!

sourcery-ai bot commented Mar 24, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Uh oh!

sourcery-ai bot Mar 24, 2025

Uh oh!

codecov bot commented Mar 24, 2025 •

edited

Loading

Uh oh!

deepsource-io bot commented Mar 24, 2025 •

edited

Loading

Analysis Summary

Uh oh!

Uh oh!

Uh oh!

fix(sse): breakline and concurrent write issues #65

fix(sse): breakline and concurrent write issues #65

Uh oh!

Conversation

cnlangzi commented Mar 24, 2025 • edited by sourcery-ai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changed

Fixed

Added

Tests

Summary by Sourcery

Uh oh!

sourcery-ai bot commented Mar 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide by Sourcery

Updated class diagram for Conn

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 24, 2025

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Mar 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

deepsource-io bot commented Mar 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Analysis Summary

Uh oh!

Uh oh!

Uh oh!

cnlangzi commented Mar 24, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Mar 24, 2025 •

edited

Loading

codecov bot commented Mar 24, 2025 •

edited

Loading

deepsource-io bot commented Mar 24, 2025 •

edited

Loading