Show the body regardless of what's the Content Type

[shackra]

Show the body of the response, even if we expected it to be JSON, for error reporting and debugging purposes.

Example output:

{"level":"error","ts":1730327736.9045234,"caller":"connectorrunner/runner.go:182","msg":"runner: error processing on-demand task","error":"runner: error processing task: rpc error: code = NotFound desc = error: listing resources failed: rpc error: code = NotFound desc = 404 Not Found\nunexpected content type for JSON response: custom-mime/empty. body: « \" Not Available \" »","task_id":"","task_type":"sync_full"}
{"level":"error","ts":1730327736.9045494,"caller":"cli/commands.go:178","msg":"error running connector","error":"runner: error processing task: rpc error: code = NotFound desc = error: listing resources failed: rpc error: code = NotFound desc = 404 Not Found\nunexpected content type for JSON response: custom-mime/empty. body: « \" Not Available \" »"}
runner: error processing task: rpc error: code = NotFound desc = error: listing resources failed: rpc error: code = NotFound desc = 404 Not Found
unexpected content type for JSON response: custom-mime/empty. body: « " Not Available " »

Summary by CodeRabbit

• Bug Fixes
  • Improved error handling for non-JSON HTTP responses, providing clearer error messages that include response body content when applicable.
  • Enhanced content type evaluation by normalizing input, ensuring consistent processing of variations in casing and whitespace.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request primarily focus on enhancing the error handling capabilities within the WithJSONResponse function of the pkg/uhttp/wrapper.go file. The modifications include a new approach to managing content type headers, improving the clarity of error messages by incorporating the response body. Additionally, the IsJSONContentType function in pkg/uhttp/contenttype.go has been updated to normalize the content type parameter, ensuring consistent evaluation. The error handling in the WithErrorResponse function remains unchanged, and the overall structure of the Do method in the BaseHttpClient class is preserved.

Changes

File	Change Summary
pkg/uhttp/wrapper.go	Modified WithJSONResponse to enhance error handling for unexpected content types, improving error messages with content type and body details.
pkg/uhttp/contenttype.go	Updated IsJSONContentType to normalize content type input. Import statement reformatted for style consistency. IsXMLContentType remains unchanged.

Possibly related PRs

• made WithJSONResponse body human readable #247: The changes in this PR enhance the WithJSONResponse function by improving error messages related to JSON responses, which directly relates to the modifications made in the main PR that also focus on refining error reporting for unexpected content types in JSON responses.

Suggested reviewers

• jirwin
• btipling

🐇 In the code where errors did dwell,
A new way to handle, we now tell.
With content types clearer, and bodies in sight,
Our responses grow strong, and error logs bright!
Hooray for the changes, let's hop with delight! 🌟

---

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: 0

🧹 Outside diff range and nitpick comments (1)

pkg/uhttp/wrapper.go (1)

189-194: Consider defining the body size limit as a constant.

The implementation correctly shows the response body for better error reporting. However, the magic number 4096 used for the body size limit should be defined as a package-level constant for better maintainability.

 const (
        ContentType               = "Content-Type"
        applicationJSON           = "application/json"
        applicationXML           = "application/xml"
        applicationFormUrlencoded = "application/x-www-form-urlencoded"
        applicationVndApiJSON     = "application/vnd.api+json"
        acceptHeader             = "Accept"
        cacheTTLMaximum          = 31536000 // 31536000 seconds = one year
        cacheTTLDefault          = 3600     // 3600 seconds = one hour
+       maxErrorBodySize         = 4096     // Maximum size of response body to include in error messages
 )

Then update the error message to use this constant:

-               return fmt.Errorf("unexpected content type for JSON response: %s. body: «%s»", contentHeader, logBody(resp.Body, 4096))
+               return fmt.Errorf("unexpected content type for JSON response: %s. body: «%s»", contentHeader, logBody(resp.Body, maxErrorBodySize))

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between de1f00d and e0bdf91.

📒 Files selected for processing (1)

• pkg/uhttp/wrapper.go (1 hunks)

🔇 Additional comments (2)

pkg/uhttp/wrapper.go (2)

183-187: LGTM! Good addition of default content type.

The fallback to "custom-mime/empty" when the content type header is missing improves debugging by making it explicit that the header was absent rather than empty.

---

189-194: Verify potential exposure of sensitive data in error messages.

While showing response bodies in error messages improves debugging, please verify that this change won't inadvertently expose sensitive information (PII, secrets, etc.) in logs or error responses.

Let's check for potential sensitive endpoints: