🧹 chore: Improve CORS tests coverage #3530
Conversation
WalkthroughA new test was added to verify that a warning is logged when both Changes
Suggested labels
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (9)
✨ Finishing Touches
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
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 primarily focuses on enhancing the test suite for the CORS middleware. I've introduced a new regression test to validate that a warning message is correctly emitted when the CORS configuration includes both a wildcard origin and a custom origin function, which helps prevent silent misconfigurations and improves developer awareness of how these settings interact.
Highlights
- New Test Case: I've added a new regression test,
Test_CORS_Warn_AllowAllOrigins_WithFunc, to specifically verify that a warning is logged when the CORS middleware is configured with both a wildcardAllowOrigins(e.g.,"*") and a customAllowOriginsFunc. In such a scenario, theAllowOriginsFuncis effectively ignored, and the test ensures this behavior is correctly communicated via a log warning. - CORS Coverage: This PR increases the test coverage for the CORS middleware by addressing an important configuration edge case, ensuring that developers are properly warned about potentially redundant or misunderstood settings.
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
-
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. ↩
There was a problem hiding this comment.
Pull Request Overview
Adds a regression test to ensure a warning is logged when both wildcard origins and a custom AllowOriginsFunc are provided.
- Introduced
Test_CORS_Warn_AllowAllOrigins_WithFuncto capture and assert the warning log. - Imported
bytes,os, andfiber/v3/logto redirect and inspect log output.
There was a problem hiding this comment.
Code Review
This pull request adds a regression test to the CORS middleware, ensuring that a warning is logged when AllowOrigins is set to a wildcard and AllowOriginsFunc is also provided. The test is well-structured and verifies the expected warning message.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3530 +/- ##
==========================================
+ Coverage 90.40% 90.42% +0.02%
==========================================
Files 110 110
Lines 10939 10939
==========================================
+ Hits 9889 9892 +3
+ Misses 791 789 -2
+ Partials 259 258 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
middleware/cors/cors_test.go (1)
267-281: Good test structure with potential for improved assertion robustness.The test correctly implements a regression test for the warning scenario and follows good practices:
- Proper log output capture and restoration using
t.Cleanup- Tests the exact configuration mentioned in the PR objectives
- Clear test intent and structure
However, consider improving the assertion for better robustness:
The current assertion checks for a partial message that could be fragile:
- require.Contains(t, buf.String(), "AllowOriginsFunc' will not be used") + require.Contains(t, buf.String(), "AllowOriginsFunc will not be used when AllowOrigins is '*'")This would make the test more specific and less prone to false positives if the message format changes slightly.
Please verify that this test actually triggers the warning by running it and ensuring the CORS middleware implementation logs the expected message for this configuration.
#!/bin/bash # Description: Run the specific test to verify it captures the expected warning cd middleware/cors go test -v -run "Test_CORS_Warn_AllowAllOrigins_WithFunc"
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
middleware/cors/cors_test.go(2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (9)
- GitHub Check: unit (1.24.x, macos-13)
- GitHub Check: unit (1.24.x, ubuntu-latest)
- GitHub Check: unit (1.24.x, macos-latest)
- GitHub Check: unit (1.24.x, windows-latest)
- GitHub Check: Compare
- GitHub Check: repeated
- GitHub Check: lint
- GitHub Check: Analyse
- GitHub Check: govulncheck-check
🔇 Additional comments (1)
middleware/cors/cors_test.go (1)
4-4: LGTM: Necessary imports for log capture functionality.The added imports (
bytes,os, andlog) are appropriately used in the new test function for capturing and verifying log output.Also applies to: 6-6, 11-11
gaby
changed the title
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
⚠️ 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: 9516bd2 | Previous: 3b2af61 | Ratio |
|---|---|---|---|
Benchmark_Utils_GetOffer/6_offers |
223.3 ns/op 0 B/op 0 allocs/op |
130 ns/op 0 B/op 0 allocs/op |
1.72 |
Benchmark_Utils_GetOffer/6_offers - ns/op |
223.3 ns/op |
130 ns/op |
1.72 |
Benchmark_SlashRecognition/indexBytes |
7.904 ns/op 0 B/op 0 allocs/op |
4.982 ns/op 0 B/op 0 allocs/op |
1.59 |
Benchmark_SlashRecognition/indexBytes - ns/op |
7.904 ns/op |
4.982 ns/op |
1.59 |
Benchmark_GenericParseTypeBytes/benchmark_genericParseTypeBytes#01 |
35.21 ns/op 8 B/op 1 allocs/op |
21.17 ns/op 8 B/op 1 allocs/op |
1.66 |
Benchmark_GenericParseTypeBytes/benchmark_genericParseTypeBytes#01 - ns/op |
35.21 ns/op |
21.17 ns/op |
1.66 |
This comment was automatically generated by workflow using github-action-benchmark.
Summary