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(bulk): regression on bulk endpoint using content type application/json #597

Merged
merged 1 commit into from
Dec 9, 2024

Conversation

gfyrag
Copy link
Contributor

@gfyrag gfyrag commented Dec 2, 2024

No description provided.

@gfyrag gfyrag requested a review from a team as a code owner December 2, 2024 14:12
Copy link

coderabbitai bot commented Dec 2, 2024

Walkthrough

The changes in this pull request involve enhancements to the bulkHandler function in controllers_bulk.go, specifically regarding the handling of the Content-Type header. A new import for the strings package has been added, and logic has been introduced to default the Content-Type to "application/json" if it is empty, and to extract the media type if it contains a semicolon. Additionally, the test cases in controllers_bulk_test.go have been updated to include a new headers field in the bulkTestCase struct, allowing for the specification of custom HTTP headers in tests.

Changes

File Change Summary
internal/api/v2/controllers_bulk.go Enhanced bulkHandler to default Content-Type to "application/json" if empty and extract media type from semicolon-separated values. Added import for strings.
internal/api/v2/controllers_bulk_test.go Added headers field to bulkTestCase struct and introduced a new test case for custom Content-Type. Updated test logic to utilize the headers field.

Poem

In the land of code where rabbits play,
New headers hop in, brightening the day.
Content-Type dances, splits with delight,
JSON's the default, oh what a sight!
With tests now more clever, they jump and they cheer,
For each little change brings us all near! 🐇✨


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
🪧 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.

Copy link

@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

🧹 Outside diff range and nitpick comments (1)
internal/api/v2/controllers_bulk.go (1)

20-22: LGTM: Content-Type parsing handles charset correctly

The changes correctly handle Content-Type headers with charset parameters by extracting just the media type. This fixes the regression where requests with application/json; charset=utf-8 were failing.

However, consider using the standard mime.ParseMediaType function for more robust MIME type parsing:

-if strings.Index(contentType, ";") > 0 {
-    contentType = strings.Split(contentType, ";")[0]
-}
+mediaType, _, err := mime.ParseMediaType(contentType)
+if err != nil {
+    api.BadRequest(w, common.ErrValidation, fmt.Errorf("invalid content type: %v", err))
+    return
+}
+contentType = mediaType
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 90cb10b and ec22221.

📒 Files selected for processing (2)
  • internal/api/v2/controllers_bulk.go (2 hunks)
  • internal/api/v2/controllers_bulk_test.go (3 hunks)
🔇 Additional comments (3)
internal/api/v2/controllers_bulk_test.go (3)

40-40: LGTM: Added headers field to support Content-Type testing

The addition of the headers field to bulkTestCase is a good enhancement that allows testing of header-specific behaviors.


421-479: LGTM: Test case properly validates Content-Type handling

The new test case "with custom content type" effectively validates the fix by:

  1. Testing with application/json; charset=utf-8
  2. Verifying that the request is processed correctly
  3. Maintaining consistent test structure with other cases

491-492: LGTM: Header application in test request

The test correctly applies the custom headers to the request, ensuring proper end-to-end testing of the Content-Type handling.

@gfyrag gfyrag added this pull request to the merge queue Dec 9, 2024
Merged via the queue into main with commit 2e3bb90 Dec 9, 2024
15 of 16 checks passed
@gfyrag gfyrag deleted the fix/bulk-content-type-charset branch December 9, 2024 08:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants