refactor(middleware/cors)!: Config, lists as list types.

[sixcolors]

PR Description:

This PR improves the configuration handling for CORS middleware by ensuring that configuration options related to allowed origins, methods, headers, and exposed headers are consistently treated as lists. This change provides better clarity and flexibility when specifying multiple values for these options.

Changes Made:

• Configuration Enhancement:
  • Updated the CORS middleware configuration to treat allowed origins (AllowOrigins), methods (AllowMethods), headers (AllowHeaders), and exposed headers (ExposeHeaders) as lists of strings.
  • Modified the Config struct to use slice types ([]string) for these configuration options, allowing multiple values to be specified.

Notes for Review:

• Consistency Check: Review the changes to ensure that the configuration options are consistently handled as lists throughout the CORS middleware implementation.
• Compatibility: Consider any compatibility implications with existing configurations or usage patterns.
• Documentation Update: Confirm that relevant documentation (e.g., README, inline comments) is updated to reflect the new configuration approach.
• Testing: Verify that existing tests cover the updated configuration handling and ensure that the middleware behaves correctly with various list-based configurations.

Please review the PR and provide feedback. Thank you!

Summary by CodeRabbit

• Documentation

  • Updated CORS middleware documentation to reflect enhanced flexibility and control in handling CORS settings.

• New Features

  • Introduced a new configuration structure for CORS settings in Fiber applications, allowing detailed customization.

• Refactor

  • Restructured CORS middleware to improve handling and validation of CORS headers and configurations.

• Tests

  • Added comprehensive tests for various CORS configurations to ensure robustness and security.

[coderabbitai]

Walkthrough

The updates revolve around enhancing the CORS middleware in a Fiber application, introducing array-based configurations for flexibility, refining origin validation, and adding support for private network access headers.

Changes

Files	Change Summary
docs/api/.../cors.md	Updated documentation to reflect array-based configurations for AllowOrigins, AllowHeaders, AllowMethods, and ExposeHeaders. Clarified behavior with empty AllowOrigins.
middleware/cors/config.go middleware/cors/cors.go	Introduced Config struct, restructured configurations for CORS settings, improved error handling, and warnings for insecure setups.
middleware/cors/cors_test.go	Included tests for various CORS configurations like wildcard headers and negative max age.

Possibly related issues

• 📝 [Proposal]: Add Support for the Private Network Access CORS Header Access-Control-Request-Private-Network #2804: The addition of AllowPrivateNetworkAccess aligns with the request for Access-Control-Request-Private-Network header support.
• 🐛 [BUG]: CORS panic with AcceptOrigins with whitespace #2882: Enhancements in origin validation and normalization could address issues related to AllowOrigins with whitespace, preventing potential panics.

🐇✨🎉
A hop, a skip, in the code we dip,
Arrays and strings, such flexible things!
CORS is now spry, with headers so high,
Bugs in retreat, our tasks complete!
🎉✨🐇

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[codecov]

Codecov Report

Attention: Patch coverage is 94.73684% with 2 lines in your changes are missing coverage. Please review.

Project coverage is 82.78%. Comparing base (68780cd) to head (e2b4dfb).
Report is 1 commits behind head on main.

❗ Current head e2b4dfb differs from pull request most recent head 45ab856. Consider uploading reports for the commit 45ab856 to get more accurate results

Files	Patch %	Lines
middleware/cors/cors.go	94.73%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2962      +/-   ##
==========================================
- Coverage   82.83%   82.78%   -0.06%     
==========================================
  Files         116      116              
  Lines        8411     8409       -2     
==========================================
- Hits         6967     6961       -6     
- Misses       1106     1109       +3     
- Partials      338      339       +1     

Flag	Coverage Δ
unittests	82.78% <94.73%> (-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.

[sixcolors]

Validated against https://github.com/sixcolors/fiber-cors-middleware-validation-sample/tree/v3

[coderabbitai]

Actionable comments posted: 2

[gaby]

@sixcolors v3 is not released yet so it wouldnt be a breaking change

[gaby]

Since when coderabbit approves PR's? 😂

[gaby]

LGTM, just one comment. This is a great improvement.