Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

cnlangzi
Copy link
Member

@cnlangzi cnlangzi commented Feb 9, 2025

Changed

  • exposed StatusCode in context

Fixed

Added

Tests

Tasks to complete before merging PR:

  • Ensure unit tests are passing. If not run make unit-test 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

New Features:

  • Added a StatusCode() method to the Context struct, allowing access to the current HTTP status code.

@sourcery-ai
Copy link

sourcery-ai bot commented Feb 9, 2025

Reviewer's Guide by Sourcery

This pull request refactors the Context implementation to expose the HTTP status code by replacing the writtenStatus flag with a statusCode integer and adding a new getter function. The changes focus on updating how the status code is set and retrieved in the context, ensuring that if a code is not explicitly set, a default status (200 OK) is returned.

Updated class diagram for Context implementation

classDiagram
    class Context {
      +Response: http.ResponseWriter
      +Request: *http.Request
      -statusCode: int
      -values: map[string]any
      +WriteStatus(code: int): void
      +StatusCode(): int
    }

    %% Note: The 'writtenStatus' field has been removed and replaced by 'statusCode'
    note for Context "Removed 'writtenStatus' bool and added 'statusCode' int with default handling"
Loading

File-Level Changes

Change Details Files
Exposed the HTTP status code within the Context.
  • Replaced the boolean flag used to track if a status was written with an integer that stores the actual status code.
  • Modified the WriteStatus method to check the statusCode value rather than a boolean flag before setting the header.
  • Added the StatusCode method to retrieve the current HTTP status code, defaulting to 200 if not explicitly set.
context.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

@codecov
Copy link

codecov bot commented Feb 9, 2025

Codecov Report

All modified and coverable lines are covered by tests βœ…

Project coverage is 92.01%. Comparing base (f4c86b5) to head (53edc13).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #38      +/-   ##
==========================================
+ Coverage   91.93%   92.01%   +0.07%     
==========================================
  Files          38       38              
  Lines        1414     1427      +13     
==========================================
+ Hits         1300     1313      +13     
  Misses         78       78              
  Partials       36       36              
Flag Coverage Ξ”
Unit-Tests 92.01% <100.00%> (+0.07%) ⬆️

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.

@deepsource-io
Copy link

deepsource-io bot commented Feb 9, 2025

Here's the code health analysis summary for commits f4c86b5..53edc13. 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

@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 an explicit flag for status written to avoid potential ambiguity if someone explicitly calls WriteStatus(0).
Here's what I looked at during the review
  • 🟒 General issues: all looks good
  • 🟒 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.

@cnlangzi cnlangzi merged commit 34263b4 into main Feb 9, 2025
7 checks passed
@cnlangzi cnlangzi deleted the fix/status_code branch February 9, 2025 10:09
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