Skip to content

fix(sse): use ReadCloser instead of Reader #64

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 2 commits into from
Mar 13, 2025
Merged

fix(sse): use ReadCloser instead of Reader #64

merged 2 commits into from
Mar 13, 2025

Conversation

cnlangzi
Copy link
Member

@cnlangzi cnlangzi commented Mar 13, 2025 •
edited by sourcery-ai bot
Loading

Changed

Fixed

  • fix(sse): use ReadCloser instead of Reader

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

Bug Fixes:

  • Fixes a resource leak by ensuring the SSE reader closes the underlying reader.

@sourcery-ai Sourcery AI
Copy link

sourcery-ai bot commented Mar 13, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

The pull request updates the EventReader to use io.ReadCloser instead of io.Reader. This change ensures that the underlying reader can be closed properly. The tests were also updated to use a readCloser wrapper around bytes.Buffer to satisfy the io.ReadCloser interface.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Updated EventReader to use io.ReadCloser instead of io.Reader.
  • Changed the type of the r field in EventReader from io.Reader to io.ReadCloser.
  • Updated the NewReader function to accept an io.ReadCloser instead of an io.Reader.
  • Added a Close method to the EventReader that calls the Close method on the underlying io.ReadCloser.
 ext/sse/reader.go
Modified the tests to use a readCloser wrapper around bytes.Buffer to satisfy the io.ReadCloser interface.
  • Created a readCloser struct that embeds bytes.Buffer and implements the io.ReadCloser interface.
  • Updated the tests to use readCloser when creating a new EventReader.
  • Added defer r.Close() calls to ensure the reader is closed after use.
 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!
  • 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

@deepsource-io deepsource.io
Copy link

deepsource-io bot commented Mar 13, 2025 •
edited
Loading

Here's the code health analysis summary for commits b4440d5..fe5afc3. 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.

sourcery-ai[bot]
sourcery-ai bot reviewed Mar 13, 2025
View reviewed changes
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 @cnlangzi - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a comment to EventReader.Close explaining why errors are ignored.
  • It might be better to define the readCloser struct closer to where it is used.
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.

@codecov Codecov
Copy link

codecov bot commented Mar 13, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.21%. Comparing base (b4440d5) to head (fe5afc3).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main      #64   +/-   ##
=======================================
  Coverage   91.20%   91.21%           
=======================================
  Files          62       62           
  Lines        2535     2537    +2     
=======================================
+ Hits         2312     2314    +2     
  Misses        192      192           
  Partials       31       31
Flag Coverage Δ
Unit-Tests 91.21% <100.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:
  • ❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@cnlangzi cnlangzi merged commit abfc600 into main Mar 13, 2025
7 checks passed
@cnlangzi cnlangzi deleted the fix/sse_reader branch March 13, 2025 12:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@cnlangzi