Skip to content
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.

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

fix: zhttp supports more complex content type strings #99

Merged
merged 1 commit into from
Feb 20, 2025

Conversation

Oudwins
Copy link
Owner

@Oudwins Oudwins commented Feb 20, 2025

Addresses #95

Summary by CodeRabbit

  • Refactor
    • Improved the handling of the Content-Type header by extracting only the media type, ensuring consistent request routing even when extra parameters (e.g., charset) are present.
  • Tests
    • Expanded test coverage to validate JSON parsing with complex Content-Type headers, including scenarios with charset specifications.

Copy link
Contributor

coderabbitai bot commented Feb 20, 2025

Walkthrough

The changes update the request handling in the zhttp package to improve Content-Type header parsing. The Request function now extracts the media type using strings.Cut to ignore additional parameters before switching on the type. A new test, TestParseJsonWithComplexContentType, is added to validate that JSON requests with charset specifications are correctly handled.

Changes

File Change Summary
zhttp/zhttp.go Modified the Request function to use strings.Cut for extracting the media type from the Content-Type header, maintaining existing functionality and warnings.
zhttp/zhttp_test.go Added TestParseJsonWithComplexContentType to validate JSON parsing with complex Content-Type headers (e.g., including charset).

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant RequestFunc as Request()
    participant StrCut as strings.Cut
    participant Parser

    Client->>RequestFunc: Send HTTP request with Content-Type header
    RequestFunc->>StrCut: Extract media type from header
    StrCut-->>RequestFunc: Return media type (e.g., "application/json")
    RequestFunc->>Parser: Route request based on extracted media type
    Parser-->>RequestFunc: Process request accordingly
    RequestFunc-->>Client: Return parsed response
Loading

Poem

In a burrow of bytes, I hop along,
Trimming extra bits where headers belong.
With strings.Cut magic, the media's set free,
Parsing JSON like a crisp carrot spree.
Cheers from a rabbit in digital delight,
Hopping through code from morning 'til night!

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
zhttp/zhttp.go (1)

79-81: Consider enhancing Content-Type parsing robustness.

The changes correctly handle complex Content-Type strings by following RFC 2045 format. However, consider these improvements:

  1. Add error handling for malformed Content-Type headers
  2. Use constants for content type strings
+const (
+    contentTypeJSON = "application/json"
+    contentTypeForm = "application/x-www-form-urlencoded"
+)

 func Request(r *http.Request) p.DpFactory {
     // Content-Type follows this format: Content-Type: <media-type> [; parameter=value]
-    typ, _, _ := strings.Cut(r.Header.Get("Content-Type"), ";")
+    contentType := r.Header.Get("Content-Type")
+    if contentType == "" {
+        return Config.Parsers.Query(r)
+    }
+    typ, _, found := strings.Cut(contentType, ";")
+    if !found {
+        typ = contentType
+    }
     switch typ {
-    case "application/json":
+    case contentTypeJSON:
         return Config.Parsers.JSON(r)
-    case "application/x-www-form-urlencoded":
+    case contentTypeForm:
         return Config.Parsers.Form(r)
     default:
         return Config.Parsers.Query(r)
     }
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1cc4c40 and 39b5324.

📒 Files selected for processing (2)
  • zhttp/zhttp.go (2 hunks)
  • zhttp/zhttp_test.go (1 hunks)
🔇 Additional comments (2)
zhttp/zhttp.go (1)

6-6: LGTM!

The strings import is required for the new Content-Type parsing logic.

zhttp/zhttp_test.go (1)

195-204: LGTM! Good test coverage for complex Content-Type handling.

The test effectively validates that JSON requests with charset specifications are correctly handled. It follows the established test patterns and provides good coverage for the new functionality.

@Oudwins Oudwins merged commit 9460ea2 into master Feb 20, 2025
9 checks passed
@Oudwins Oudwins deleted the fix/zhttp-content-type branch February 20, 2025 19:46
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