🧹 chore: Improve EarlyData middleware tests coverage #3520
Conversation
WalkthroughThe test file for the earlydata middleware was refactored to use the internal package, enabling direct access to unexported members. Three new test functions were introduced to verify middleware skipping logic and configuration defaulting. Existing references were updated to use local package calls, and unnecessary imports were removed. 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 (8)
✨ 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 focuses on enhancing the test suite for the EarlyData middleware. It refactors the test file structure by moving to an internal package and consolidating tests, while also adding new tests to improve coverage for middleware configuration options and helpers.
Highlights
- Test Structure Refinement: Converted the
earlydata_test.gofile to use an internal test package (package earlydata) and consolidated configuration tests into this file, dropping a separate test file. - Improved Test Coverage: Added new test cases to specifically cover the
Nextconfiguration option for the middleware and the behavior of theconfigDefaulthelper function under various conditions (no config and partial config).
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 configureGemini 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
This PR consolidates configuration tests into the primary earlydata_test.go, switches to the internal test package, and expands coverage for the EarlyData middleware.
- Moved standalone config tests into
earlydata_test.goand removed the extra file - Changed test package to
earlydatafor access to unexported functions - Added new tests:
Test_EarlyDataNext,Test_configDefault_NoConfig, andTest_configDefault_WithConfig
Comments suppressed due to low confidence (1)
middleware/earlydata/earlydata_test.go:229
- Add an assertion in
Test_configDefault_NoConfigto verify the defaultNextfunction is set correctly, for example:
require.Equal(t,
reflect.ValueOf(ConfigDefault.Next).Pointer(),
reflect.ValueOf(cfg.Next).Pointer(),
)require.Equal(t, reflect.ValueOf(ConfigDefault.AllowEarlyData).Pointer(), reflect.ValueOf(cfg.AllowEarlyData).Pointer())
There was a problem hiding this comment.
Code Review
This pull request improves the test coverage for the EarlyData middleware's configuration handling. The tests have been moved to earlydata_test.go and the package has been changed to earlydata, allowing for more thorough testing of unexported functions like configDefault. The new tests for Next functionality and configDefault scenarios are well-written and cover important edge cases.
gaby
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3520 +/- ##
==========================================
+ Coverage 83.82% 84.05% +0.22%
==========================================
Files 120 120
Lines 12286 12286
==========================================
+ Hits 10299 10327 +28
+ Misses 1561 1537 -24
+ Partials 426 422 -4
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 (3)
middleware/earlydata/earlydata_test.go (3)
23-30: Re-evaluate callingt.Parallelinside a shared helper
appWithConfigcallst.Parallel, which means the calling test will be marked parallel a second time. If the parent test already invokedt.Parallel, the second call is disallowed and will panic (testing: t.Parallel called multiple times).
Today every caller is a sub-test that does not sett.Parallel, so you’re safe—but the helper is easy to reuse incorrectly later. Consider:- t.Parallel() + // Leave concurrency control to the caller to avoid accidental double-parallel.or add a doc-comment warning users that the helper marks the test as parallel.
32-33: Expose a way to inject custom EarlyData configAll scenarios currently exercise only
earlydata.New()with default middleware configuration.
If future regressions surface in customConfigpaths, the current suite will miss them.
Adding a second argument toappWithConfig(or defining a helper similar toappWithConfigCustom) would keep the tests flexible without duplicating boilerplate.
228-230: Function-pointer equality can be fragile across buildsComparing function pointers via
reflect.ValueOf(fn).Pointer()works but is brittle: inlined or substituted functions may change addresses between compiler versions or with-gcflags=all=-l. A safer (and clearer) assertion is to call the functions and assert identical behaviour, e.g.:require.Equal(t, ConfigDefault.IsEarlyData(nil), cfg.IsEarlyData(nil))The current check is fine for now, just flagging the maintenance risk.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
middleware/earlydata/earlydata_test.go(3 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
middleware/earlydata/earlydata_test.go (4)
middleware/earlydata/earlydata.go (2)
New(22-52)IsEarly(16-18)ctx_interface_gen.go (1)
Ctx(17-379)middleware/earlydata/config.go (4)
Config(13-33)ConfigDefault(36-46)DefaultHeaderName(8-8)DefaultHeaderTrueValue(9-9)constants.go (2)
MethodGet(5-5)StatusOK(50-50)
⏰ Context from checks skipped due to timeout of 90000ms (8)
- GitHub Check: unit (1.24.x, macos-13)
- GitHub Check: lint
- GitHub Check: unit (1.24.x, macos-latest)
- GitHub Check: unit (1.24.x, windows-latest)
- GitHub Check: unit (1.24.x, ubuntu-latest)
- GitHub Check: repeated
- GitHub Check: Compare
- GitHub Check: Analyse
🔇 Additional comments (2)
middleware/earlydata/earlydata_test.go (2)
256-262: Nice touch on exercising the default predicatesVerifying both
IsEarlyDataandAllowEarlyDataagainst an actualfiber.Ctxcatches silent mis-wiring of defaults—good guard against regressions.
196-220:Test_EarlyDataNextaccurately validates the skip pathThe test covers the critical
cfg.Nextshort-circuit and asserts thatIsEarlyis never set—great addition.
![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: a740305 | Previous: 670fbd5 | Ratio |
|---|---|---|---|
Benchmark_GenericParseTypeString/benchmark_genericParseTypeString#01 |
14.23 ns/op 0 B/op 0 allocs/op |
8.867 ns/op 0 B/op 0 allocs/op |
1.60 |
Benchmark_GenericParseTypeString/benchmark_genericParseTypeString#01 - ns/op |
14.23 ns/op |
8.867 ns/op |
1.60 |
This comment was automatically generated by workflow using github-action-benchmark.
gaby
changed the title
Summary
next().