Skip to content

fix(viewer): doesn't write body when it is HEAD request #42

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 3 commits into from
Feb 11, 2025
Merged

fix(viewer): doesn't write body when it is HEAD request #42

merged 3 commits into from
Feb 11, 2025

Conversation

cnlangzi
Copy link
Member

@cnlangzi cnlangzi commented Feb 11, 2025 •
edited by sourcery-ai bot
Loading

Changed

Fixed

  • doesn't write body when it is a HEAD request

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

Bug Fixes:

  • Prevent writing the body when the request method is HEAD.

@sourcery-ai Sourcery AI
Copy link

sourcery-ai bot commented Feb 11, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This PR fixes an issue where response bodies were written even for HEAD requests. The implementation now uses a conditional check in each viewer's Render method to ensure that content is only rendered and written when the request method is not HEAD. This change has been applied across all viewer types (HTML, JSON, Text, XML, and String), and the header is set appropriately based on the viewer type.

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

File-Level Changes

Change Details Files
Add conditional check for HEAD requests in the HTML viewer.
  • Introduced a conditional (if r.Method != HEAD) to bypass rendering when handling HEAD requests.
  • Wrapped buffer acquisition and template execution within the conditional block.
  • Moved setting of Content-Type header and writing of buffer data into the conditional block.
 viewer_html.go
Add conditional check for HEAD requests in the JSON viewer.
  • Added an if statement to conditionally execute JSON encoding only for non-HEAD requests.
  • Relocated header setting and writing of encoded data within the conditional block of the Render method.
 viewer_json.go
Add conditional check for HEAD requests in the Text viewer.
  • Implemented an if check to ensure rendering with template occurs only for non-HEAD requests.
  • Moved Content-Type header setting and buffer to response writing inside the conditional block.
 viewer_text.go
Add conditional check for HEAD requests in the XML viewer.
  • Introduced a conditional to restrict XML encoding to non-HEAD requests.
  • Ensured that the header is set and the encoded XML is written only when the request method is not HEAD.
 viewer_xml.go
Add conditional check for HEAD requests in the String viewer.
  • Wrapped the logic that writes the response content with an if statement checking for non-HEAD requests.
  • Kept the Content-Type header setting and content writing inside the conditional block to avoid writing a body for HEAD requests.
 viewer_string.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 Feb 11, 2025 •
edited
Loading

Here's the code health analysis summary for commits a4888e7..3009a69. 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 Feb 11, 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 creating a common render function to avoid duplicating the HEAD request check and buffer logic.
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 Feb 11, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.38%. Comparing base (a4888e7) to head (3009a69).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main      #42      +/-   ##
==========================================
+ Coverage   91.97%   92.38%   +0.41%     
==========================================
  Files          43       43              
  Lines        1644     1654      +10     
==========================================
+ Hits         1512     1528      +16     
+ Misses         97       93       -4     
+ Partials       35       33       -2
Flag Coverage Δ
Unit-Tests 92.38% <100.00%> (+0.41%) ⬆️

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.

@cnlangzi cnlangzi merged commit 2b11318 into main Feb 11, 2025
7 checks passed
@cnlangzi cnlangzi deleted the fix/head branch February 11, 2025 13:24
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