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: Middleware/CORS Remove Scheme Restriction #3163

Merged

Conversation

zingi
Copy link
Contributor

@zingi zingi commented Oct 10, 2024

Description

The Fiber CORS middleware unnecessarily restricts the scheme for the origins that can be configured. As already stated here, the CORS spec does not define any restrictions on the scheme. However, the Fiber CORS middleware restricts the scheme to http or https.

Fixes #3160

Changes introduced

Removes the scheme restriction of the CORS middleware configuration.

  • Benchmarks: Describe any performance benchmarks and improvements related to the changes.
  • Documentation Update: Detail the updates made to the documentation and links to the changed files.
  • Changelog/What's New: Include a summary of the additions for the upcoming release notes.
  • Migration Guide: If necessary, provide a guide or steps for users to migrate their existing code to accommodate these changes.
  • API Alignment with Express: Explain how the changes align with the Express API.
  • API Longevity: Discuss the steps taken to ensure that the new or updated APIs are consistent and not prone to breaking changes.
  • Examples: Provide examples demonstrating the new features or changes in action.

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)
  • Enhancement (improvement to existing features and functionality)
  • Documentation update (changes to documentation)
  • Performance improvement (non-breaking change which improves efficiency)
  • Code consistency (non-breaking change which improves code reliability and robustness)

Checklist

Before you submit your pull request, please make sure you meet these requirements:

  • Followed the inspiration of the Express.js framework for new functionalities, making them similar in usage.
  • Conducted a self-review of the code and provided comments for complex or critical parts.
  • Updated the documentation in the /docs/ directory for Fiber's documentation.
  • Added or updated unit tests to validate the effectiveness of the changes or new features.
  • Ensured that new and existing unit tests pass locally with the changes.
  • Verified that any new dependencies are essential and have been agreed upon by the maintainers/community.
  • Aimed for optimal performance with minimal allocations in the new code.
  • Provided benchmarks for the new code to analyze and improve upon.

Commit formatting

Please use emojis in commit messages for an easy way to identify the purpose or intention of a commit. Check out the emoji cheatsheet here: CONTRIBUTING.md

@zingi zingi requested a review from a team as a code owner October 10, 2024 11:32
@zingi zingi requested review from gaby, sixcolors, ReneWerner87 and efectn and removed request for a team October 10, 2024 11:32
Copy link

welcome bot commented Oct 10, 2024

Thanks for opening this pull request! 🎉 Please check out our contributing guidelines. If you need help or want to chat with us, join us on Discord https://gofiber.io/discord

Copy link
Contributor

coderabbitai bot commented Oct 10, 2024

Walkthrough

The changes primarily involve modifications to the normalizeOrigin function in the CORS middleware, allowing origins with non-standard schemes, such as "app", to be processed without validation of their scheme. Additionally, a new test case has been added to ensure that the normalization of the "app" scheme is functioning correctly, while existing validations for other schemes remain intact.

Changes

File Change Summary
middleware/cors/utils.go Modified normalizeOrigin to remove scheme validation for origins, allowing non-http/https schemes.
middleware/cors/utils_test.go Added a test case in Test_NormalizeOrigin for the "app" scheme normalization; other tests unchanged.

Assessment against linked issues

Objective Addressed Explanation
Allow origins with any protocol to prevent application panic (#3160)

🐰 In the meadow, changes bloom,
CORS now welcomes every room.
From "http" to "app" we glide,
No more panics, let joy abide!
With tests to cheer, we hop along,
In the fiber world, we all belong! 🌼


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.

@gaby gaby changed the title 🩹 Fix: middleware/cors remove scheme restriction (gofiber#3160) 🩹 Fix: middleware/cors remove scheme restriction Oct 10, 2024
@gaby gaby added this to the v3 milestone Oct 10, 2024
Copy link

codecov bot commented Oct 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.38%. Comparing base (3fc1b29) to head (5d75a9d).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3163      +/-   ##
==========================================
- Coverage   82.46%   82.38%   -0.08%     
==========================================
  Files         113      113              
  Lines        8468     8466       -2     
==========================================
- Hits         6983     6975       -8     
- Misses       1084     1088       +4     
- Partials      401      403       +2     
Flag Coverage Δ
unittests 82.38% <ø> (-0.08%) ⬇️

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.

@gaby gaby changed the title 🩹 Fix: middleware/cors remove scheme restriction 🩹 Fix: Middleware/CORS Remove scheme restriction Oct 10, 2024
@gaby gaby changed the title 🩹 Fix: Middleware/CORS Remove scheme restriction 🩹 Fix: Middleware/CORS Remove Scheme Restriction Oct 10, 2024
Copy link
Member

@gaby gaby left a comment

Choose a reason for hiding this comment

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

👍 LGTM

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

🧹 Outside diff range and nitpick comments (1)
middleware/cors/utils_test.go (1)

Line range hint 1-186: Overall impact: Positive, with room for enhancement.

The addition of the "app" scheme test case is a good start in addressing the issue with non-standard schemes. However, to ensure robust coverage, consider the following suggestions:

  1. Add more test cases for other potential non-standard schemes (e.g., "custom://", "ftp://").
  2. Include edge cases, such as schemes with special characters or unusual formats.
  3. Consider adding negative test cases to ensure that invalid schemes are still properly rejected.

These additions would further strengthen the test suite and provide more comprehensive coverage for the CORS middleware changes.

Would you like assistance in generating additional test cases to cover these scenarios?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between c86c3c0 and 39a2459.

📒 Files selected for processing (2)
  • middleware/cors/utils.go (0 hunks)
  • middleware/cors/utils_test.go (1 hunks)
💤 Files with no reviewable changes (1)
  • middleware/cors/utils.go
🧰 Additional context used
🔇 Additional comments (1)
middleware/cors/utils_test.go (1)

20-20: LGTM: New test case aligns with PR objectives.

The added test case for the "app" scheme correctly validates the new behavior of the normalizeOrigin function. This change directly addresses the issue described in #3160, allowing non-standard schemes like "app://" to be processed without causing panics.

To ensure comprehensive coverage, let's verify if similar test cases exist for other non-standard schemes:

This will help us confirm if the change is consistently applied across all relevant test cases.

✅ Verification successful

Verification Successful: Comprehensive test coverage confirmed.

The test suite includes the new "app" scheme and appropriately handles existing standard and non-standard origins. No additional test cases for other non-standard schemes are required at this time.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for test cases with non-standard schemes in the CORS middleware tests
rg --type go 'origin:.*?://' middleware/cors

Length of output: 5578

@efectn
Copy link
Member

efectn commented Oct 11, 2024

Hi @zingi can you backport this PR to v2 as well?

@gaby
Copy link
Member

gaby commented Oct 11, 2024

Hi @zingi can you backport this PR to v2 as well?

Yes, we need a separate PR to address this in the v2 branch. Affected code is here https://github.com/gofiber/fiber/blob/v2/middleware/cors/utils.go#L41

@efectn efectn merged commit 079d301 into gofiber:main Oct 11, 2024
14 of 18 checks passed
Copy link

welcome bot commented Oct 11, 2024

Congrats on merging your first pull request! 🎉 We here at Fiber are proud of you! If you need help or want to chat with us, join us on Discord https://gofiber.io/discord

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.

🐛 [Bug]: CORS Middleware, URL-protocol check too strict
4 participants