🔥 feat: Add config for Timeout middleware #3604
Conversation
WalkthroughThe timeout middleware has been refactored to use a new Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant Fiber
participant TimeoutMiddleware
participant Handler
Client->>Fiber: Sends Request
Fiber->>TimeoutMiddleware: Passes Request
TimeoutMiddleware->>TimeoutMiddleware: Checks Config (Next, Timeout, OnTimeout, Errors)
alt Next returns true
TimeoutMiddleware->>Fiber: Skips middleware, calls next handler
else Timeout > 0
TimeoutMiddleware->>Handler: Runs handler with timeout context
alt Handler completes in time
Handler-->>TimeoutMiddleware: Returns response
TimeoutMiddleware-->>Fiber: Passes response
else Timeout occurs or custom error
alt OnTimeout handler set
TimeoutMiddleware->>OnTimeout: Invokes custom handler
OnTimeout-->>TimeoutMiddleware: Returns custom response
else
TimeoutMiddleware-->>Fiber: Returns fiber.ErrRequestTimeout
end
end
else
TimeoutMiddleware->>Handler: Runs handler without timeout
Handler-->>TimeoutMiddleware: Returns response
TimeoutMiddleware-->>Fiber: Passes response
end
Fiber-->>Client: Sends Response
Possibly related PRs
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. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
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 @ReneWerner87, 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 refactors the timeout middleware to introduce a more robust and extensible configuration mechanism. By moving from simple parameters to a dedicated Config struct, it provides developers with fine-grained control over timeout behavior, custom error handling, and middleware skipping, enhancing the middleware's utility and adaptability.
Highlights
- Configurable Timeout Middleware: The
timeoutmiddleware can now be configured using a newConfigstruct, replacing the previous fixedtime.Durationanderrorparameters. This allows for more flexible and powerful control over timeout behavior. - New Configuration Options: The
Configstruct introduces several new options:Next(a function to skip the middleware),OnTimeout(a custom handler to execute on timeout), andErrors(a list of custom errors to treat as timeouts), alongside theTimeoutduration. - Updated API and Documentation: The
Newfunction signature for thetimeoutmiddleware has been updated to accept theConfigstruct. Corresponding documentation indocs/middleware/timeout.mdanddocs/whats_new.mdhas been added and updated, including migration examples. - Comprehensive Testing: Existing tests have been updated, and new tests have been added to ensure full coverage of the new configuration options, including scenarios for negative timeout durations, custom timeout handlers, and various error handling cases.
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
This PR refactors the timeout middleware to be configurable through a Config struct instead of accepting timeout duration and errors as separate parameters. The changes improve the middleware's flexibility by allowing customization of timeout behavior, error handling, and conditional execution.
- Introduces a new
Configstruct with fields for timeout duration, custom timeout handler, error list, and skip condition - Updates the
Newfunction signature to accept variadicConfigparameters instead of separate duration and error parameters - Adds comprehensive test coverage for new configuration options and edge cases
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| middleware/timeout/config.go | New configuration struct and default handling logic |
| middleware/timeout/timeout.go | Updated middleware implementation to use Config struct |
| middleware/timeout/timeout_test.go | Enhanced test suite with new test cases for configuration options |
| docs/middleware/timeout.md | Updated documentation with new API and configuration table |
| docs/whats_new.md | Migration guide and changelog entries for the API changes |
Comments suppressed due to low confidence (2)
middleware/timeout/timeout_test.go:173
- This test directly calls the internal
runHandlerfunction but doesn't uset.Parallel()like other test functions. Consider addingt.Parallel()for consistency with the testing pattern used throughout this file.
func TestRunHandler_DefaultOnTimeout(t *testing.T) {
middleware/timeout/timeout_test.go:186
- This test directly calls the internal
runHandlerfunction but doesn't uset.Parallel()like other test functions. Consider addingt.Parallel()for consistency with the testing pattern used throughout this file.
func TestRunHandler_CustomOnTimeout(t *testing.T) {
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #3604 +/- ##
==========================================
+ Coverage 90.93% 90.97% +0.04%
==========================================
Files 111 112 +1
Lines 11236 11260 +24
==========================================
+ Hits 10217 10244 +27
+ Misses 764 762 -2
+ Partials 255 254 -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:
|
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
gaby
changed the title
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Summary
ConfigConfigstruct and update code exampleswhats_new.golangci.ymlchangesTesting
make formatmake lint(fails: unsupported version of config)make testhttps://chatgpt.com/codex/tasks/task_e_687cda110df083268e34701e17ff98e7