Do not set the content-type when response has no body

[kevinpollet]

This pull request is a follow-up of #1011 which addresses an additional issue where the Content-Type was set for responses that have no body.

Co-authored-by: Romain rtribotte@users.noreply.github.com

Summary by CodeRabbit

• New Features

  • Enhanced logic for detecting Content-Type when not specified.
  • Adjusted conditions for applying gzip compression based on response content.

• Bug Fixes

  • Improved error handling to prevent silent failures during write operations.

• Tests

  • Introduced a new test to verify Content-Type behavior when no body is written.
  • Retained existing tests to ensure consistent handling of Content-Type in various scenarios.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes in this pull request involve modifications to the gzhttp/compress.go file, focusing on the handling of the Content-Type header and the conditions for applying gzip compression. The logic for inferring Content-Type has been refined, ensuring it only occurs when appropriate. Additionally, the conditions for initiating gzip compression have been adjusted, and error handling has been improved. A new test has been added to gzhttp/compress_test.go to verify the behavior when no body is present in the response.

Changes

File	Change Summary
gzhttp/compress.go	- Refined logic for inferring Content-Type when unspecified. - Adjusted conditions for gzip compression initiation. - Updated handling of HeaderNoCompression header. - Enhanced error handling in startGzip method.
gzhttp/compress_test.go	- Added TestNoContentTypeWhenNoBody to verify empty Content-Type when status 200 has no body. - Retained existing test for status 204 behavior.

Possibly related PRs

• No content-type on no body response code #1011: This PR modifies the Close method in the GzipResponseWriter class to ensure that the Content-Type header is only set when the response status code allows for a body, which directly relates to the changes made in the main PR regarding Content-Type handling.

Suggested reviewers

• klauspost

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)

gzhttp/compress.go (1)

Line range hint 398-406: Check for potential race conditions in the Flush method

In the Flush method, the detection and setting of the Content-Type occur. If Flush can be called concurrently, ensure that appropriate synchronization mechanisms are in place to prevent race conditions when accessing and modifying headers and internal buffers.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between f2a4f25 and 02d8408.

📒 Files selected for processing (2)

• gzhttp/compress.go (3 hunks)
• gzhttp/compress_test.go (1 hunks)

🔇 Additional comments (3)

gzhttp/compress_test.go (1)

1620-1637: LGTM! This test case is crucial for verifying the PR's objective.

This new test function TestNoContentTypeWhenNoBody is well-structured and directly addresses the main focus of the pull request. It effectively verifies that the Content-Type header is not set when the response body is empty, even when the status code is 200 OK. This test is important for ensuring that the gzip handler behaves correctly in scenarios where responses have no body content.

gzhttp/compress.go (2)

134-142: Verify that Content-Type inference aligns with HTTP specifications

In the Write method, the code infers the Content-Type from the buffer when it is missing and the response has a body. Ensure that this behavior complies with the HTTP specifications, particularly regarding responses with unknown content types and the potential impact on client content negotiation mechanisms.

---

352-359: Ensure consistency in header manipulation

When setting the Content-Type header in the Close method (lines 352-359), make sure it is consistent with how headers are managed elsewhere in the code to prevent any unexpected side effects. Confirm that headers are only set when appropriate and that existing headers are not unintentionally overwritten.