Skip to content

🧹 chore: Improve Accept* compliance with RFC 9110 #3548

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

Merged
merged 5 commits into from
Jun 28, 2025

Conversation

gaby
Copy link
Member

@gaby gaby commented Jun 27, 2025

Summary

  • handle multiple header fields in Accept* helpers
  • unescape quoted parameter values
  • update Accept* helpers to merge all header values
  • add tests for multi-field Accept headers

Related #3383

Copy link
Contributor

coderabbitai bot commented Jun 27, 2025

Walkthrough

The changes update the handling of HTTP Accept headers in the context implementation to aggregate and process all header values, not just the first. New helper functions are introduced for joining and unescaping header values. Tests are added to verify correct behavior when multiple Accept headers are present.

Changes

File(s) Change Summary
ctx.go Modified Accepts, AcceptsCharsets, AcceptsEncodings, and AcceptsLanguages to aggregate all header values and use them for content negotiation.
helpers.go Added joinHeaderValues to concatenate multiple headers and unescapeHeaderValue to process escaped header values. Modified parameter matching and parsing to use unescaped values with error handling.
ctx_test.go Added tests for Accepts*, AcceptsCharsets, AcceptsEncodings, and AcceptsLanguages methods with multiple header lines.
helpers_test.go Added tests for unescapeHeaderValue and joinHeaderValues functions verifying unescaping correctness and header joining logic. Also tested parameter matching with invalid escape sequences.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Context
    participant Helpers

    Client->>Context: Send HTTP request with multiple Accept* headers
    Context->>Helpers: joinHeaderValues(all Accept* headers)
    Helpers-->>Context: Combined header string
    Context->>Helpers: getOffer(combined header string, offers)
    Helpers->>Helpers: unescapeHeaderValue(parameter values)
    Helpers-->>Context: Best matching offer
    Context-->>Client: Return selected offer
Loading

Possibly related PRs

Suggested reviewers

  • sixcolors
  • ReneWerner87
  • efectn

Poem

In the warren of headers, a rabbit did hop,
Gathering each crumb, not letting one drop.
With helpers to join and unescape with care,
Tests now ensure all values are there.
So raise a carrot, let’s give a cheer—
Every header is welcome here! 🥕


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 680e78c and 3197539.

📒 Files selected for processing (1)
  • helpers_test.go (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • helpers_test.go
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: lint
  • GitHub Check: Compare
  • GitHub Check: unit (1.24.x, macos-13)
  • GitHub Check: unit (1.24.x, macos-latest)
  • GitHub Check: unit (1.24.x, windows-latest)
  • GitHub Check: Analyse
  • GitHub Check: repeated
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Summary of Changes

Hello @gaby, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the HTTP Accept* header parsing logic to align more closely with RFC 9110. It addresses scenarios where multiple Accept* headers are present and ensures correct handling of escaped characters within header parameter values, improving the robustness and compliance of the application's content negotiation.

Highlights

  • RFC 9110 Compliance: I've improved the handling of Accept* headers to correctly process multiple instances of the same header field, aligning with RFC 9110 specifications for content negotiation.
  • Parameter Unescaping: I've implemented logic to properly unescape quoted parameter values within Accept* headers, ensuring accurate comparison and matching of client preferences.
  • Consolidated Header Processing: The Accept* helper functions now merge all occurrences of a given Accept* header into a single string before parsing, providing a comprehensive view of client preferences.
  • Enhanced Test Coverage: I've added new test cases specifically for multi-field Accept headers across all Accept* methods to validate the new parsing behavior and ensure robustness.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@gaby gaby changed the title Improve Accept* compliance with RFC 9110 🧹 chore: Improve Accept* compliance with RFC 9110 Jun 27, 2025
@gaby gaby added this to v3 Jun 27, 2025
@gaby gaby moved this to In Progress in v3 Jun 27, 2025
@gaby gaby added this to the v3 milestone Jun 27, 2025
Copy link

codecov bot commented Jun 27, 2025

Codecov Report

Attention: Patch coverage is 80.00000% with 10 lines in your changes missing coverage. Please review.

Project coverage is 90.56%. Comparing base (43ad9f7) to head (3197539).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
helpers.go 76.19% 7 Missing and 3 partials ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3548      +/-   ##
==========================================
- Coverage   90.61%   90.56%   -0.06%     
==========================================
  Files         110      110              
  Lines       10912    10955      +43     
==========================================
+ Hits         9888     9921      +33     
- Misses        773      780       +7     
- Partials      251      254       +3     
Flag Coverage Δ
unittests 90.56% <80.00%> (-0.06%) ⬇️

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.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@gaby gaby marked this pull request as ready for review June 27, 2025 01:30
@gaby gaby requested a review from a team as a code owner June 27, 2025 01:30
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

The pull request enhances the application's compliance with RFC 9110 by improving the handling of Accept* headers. The changes include handling multiple header fields and unescaping quoted parameter values. Additional tests and simplification of the joinHeaderValues function are suggested.

@ReneWerner87
Copy link
Member

Pls share benchmark before and after

@gaby
Copy link
Member Author

gaby commented Jun 27, 2025

Pls share benchmark before and after

Will do after updating the PR with bot eview comments

@gaby
Copy link
Member Author

gaby commented Jun 27, 2025

Pls share benchmark before and after

Will do after updating the PR with bot eview comments

@ReneWerner87

main:

2025-06-26T12:15:28.5427501Z Benchmark_Ctx_Accepts/run-[]string{".xml"}-4            	 4618149	       262.1 ns/op	       0 B/op	       0 allocs/op
2025-06-26T12:15:29.7393213Z Benchmark_Ctx_Accepts/run-[]string{"json",_"xml"}-4     	 3373304	       354.5 ns/op	       0 B/op	       0 allocs/op
2025-06-26T12:15:30.9447898Z Benchmark_Ctx_Accepts/run-[]string{"application/json",_"application/xml"}-4         	 4598558	       262.0 ns/op	       0 B/op	       0 allocs/op
2025-06-26T12:15:32.0999625Z Benchmark_Ctx_AcceptsCharsets-4                                                     	 8474654	       136.2 ns/op	       0 B/op	       0 allocs/op
2025-06-26T12:15:33.2987524Z Benchmark_Ctx_AcceptsEncodings-4                                                    	 5860231	       204.4 ns/op	       0 B/op	       0 allocs/op
2025-06-26T12:15:34.4702656Z Benchmark_Ctx_AcceptsLanguages-4                                                    	 3672067	       318.9 ns/op	       0 B/op	       0 allocs/op

PR:

Benchmark_Ctx_Accepts/run-[]string{".xml"}-4            	 4390270	       276.5 ns/op	       0 B/op	       0 allocs/op
Benchmark_Ctx_Accepts/run-[]string{"json",_"xml"}-4     	 3191682	       376.3 ns/op	       0 B/op	       0 allocs/op
Benchmark_Ctx_Accepts/run-[]string{"application/json",_"application/xml"}-4         	 4491657	       269.6 ns/op	       0 B/op	       0 allocs/op
Benchmark_Ctx_AcceptsCharsets-4                                                     	 8434958	       142.6 ns/op	       0 B/op	       0 allocs/op
Benchmark_Ctx_AcceptsEncodings-4                                                    	 5773927	       208.7 ns/op	       0 B/op	       0 allocs/op
Benchmark_Ctx_AcceptsLanguages-4                                                    	 3492201	       343.6 ns/op	       0 B/op	       0 allocs/op

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.50.

Benchmark suite Current: 3197539 Previous: 43ad9f7 Ratio
Benchmark_Fiberlog_SetLevel_Parallel/Test_case_1_Parallel 13.32 ns/op 0 B/op 0 allocs/op 6.371 ns/op 0 B/op 0 allocs/op 2.09
Benchmark_Fiberlog_SetLevel_Parallel/Test_case_1_Parallel - ns/op 13.32 ns/op 6.371 ns/op 2.09
Benchmark_Fiberlog_SetLevel_Parallel/Test_case_2_Parallel 13.32 ns/op 0 B/op 0 allocs/op 6.44 ns/op 0 B/op 0 allocs/op 2.07
Benchmark_Fiberlog_SetLevel_Parallel/Test_case_2_Parallel - ns/op 13.32 ns/op 6.44 ns/op 2.07
Benchmark_Fiberlog_SetLevel_Parallel/Test_case_3_Parallel 13.34 ns/op 0 B/op 0 allocs/op 6.546 ns/op 0 B/op 0 allocs/op 2.04
Benchmark_Fiberlog_SetLevel_Parallel/Test_case_3_Parallel - ns/op 13.34 ns/op 6.546 ns/op 2.04
Benchmark_Fiberlog_SetLevel_Parallel/Test_case_4_Parallel 13.32 ns/op 0 B/op 0 allocs/op 6.403 ns/op 0 B/op 0 allocs/op 2.08
Benchmark_Fiberlog_SetLevel_Parallel/Test_case_4_Parallel - ns/op 13.32 ns/op 6.403 ns/op 2.08
Benchmark_Fiberlog_SetLevel_Parallel/Test_case_5_Parallel 12.88 ns/op 0 B/op 0 allocs/op 6.416 ns/op 0 B/op 0 allocs/op 2.01
Benchmark_Fiberlog_SetLevel_Parallel/Test_case_5_Parallel - ns/op 12.88 ns/op 6.416 ns/op 2.01

This comment was automatically generated by workflow using github-action-benchmark.

@gaby
Copy link
Member Author

gaby commented Jun 27, 2025

Adding missing code coverage in a bit.

@ReneWerner87 ReneWerner87 merged commit 55818fb into main Jun 28, 2025
12 of 14 checks passed
@github-project-automation github-project-automation bot moved this from In Progress to Done in v3 Jun 28, 2025
@gaby gaby deleted the 2025-06-27-01-28-54 branch June 28, 2025 19:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants