fix: enforce global timeout using context.WithTimeout
Fixes #1560
Problem
The -timeout flag was inconsistently enforced across different runs. Although HTTP clients respected the timeout value, the overall enumeration process was not constrained, causing long or indefinite execution when sources delayed or hung.
Root Cause
The CLI-level -timeout value was not applied to the root execution context (RunEnumerationWithCtx). As a result, even if individual HTTP requests timed out, the global orchestration layer continued waiting for results.
Changes
- Wrap
RunEnumerationWithCtxwithcontext.WithTimeoutusing the configuredr.options.Timeout - The updated context is passed throughout the enumeration lifecycle
- Now ensures a strict upper bound on total enumeration time, regardless of individual source behavior
Result
Before:
subfinder -d erlang.org -timeout 5
[INF] Found 10 subdomains for erlang.org in 30 seconds
After:
subfinder -d erlang.org -timeout 5
[INF] Found 8 subdomains for erlang.org in 5 seconds
Sources that do not return within the timeout window are safely cancelled, resulting in consistent timing.
Summary by CodeRabbit
-
New Features
- Added a timeout to the enumeration process, ensuring operations are automatically canceled if they exceed the specified duration.
Walkthrough
The RunEnumerationWithCtx method in the Runner struct was updated to wrap its execution context with a timeout, using the duration specified in r.options.Timeout. This ensures the enumeration process is automatically canceled if it exceeds the allotted time. No other logic or method signatures were changed.
Changes
| Cohort / File(s) | Change Summary |
|---|---|
Timeout Context Additionpkg/runner/runner.go |
Added a timeout to the context in RunEnumerationWithCtx using r.options.Timeout, ensuring enumeration is canceled if it exceeds the specified duration. |
Sequence Diagram(s)
sequenceDiagram
participant Caller
participant Runner
participant EnumerationProcess
Caller->>Runner: RunEnumerationWithCtx(ctx)
Runner->>Runner: Create timeout context (WithTimeout)
Runner->>EnumerationProcess: Start enumeration with timeout context
EnumerationProcess-->>Runner: Complete or timeout
Runner->>Runner: Defer cancel()
Runner-->>Caller: Return result or context error
Estimated code review effort
🎯 2 (Simple) | ⏱️ ~7 minutes
Assessment against linked issues
| Objective | Addressed | Explanation |
|---|---|---|
Ensure the -timeout flag consistently enforces a timeout during enumeration (#1560) |
✅ |
Poem
A timeout now wraps the runner’s quest,
No endless loops—just time to rest!
With context trimmed, the search won’t stall,
Five seconds up? It cancels all.
🕰️🐇 Hooray for code that keeps its pace—
Subfinder now runs a timely race!
[!NOTE]
⚡️ Unit Test Generation is now available in beta!
Learn more here, or try it out under "Finishing Touches" below.
📜 Recent review details
Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro
📥 Commits
Reviewing files that changed from the base of the PR and between 8feb51ff7f6a3cde5c555cac55efa0c099600058 and b9e891928b4031dc87ad31de44c62e583d933586.
📒 Files selected for processing (1)
-
pkg/runner/runner.go(2 hunks)
🔇 Additional comments (2)
pkg/runner/runner.go (2)
13-13: LGTM!The
timeimport is correctly added and necessary for the timeout implementation.
84-86: Excellent implementation of global timeout enforcement!This change correctly addresses issue #1560 by wrapping the execution context with a timeout. The implementation properly:
- Converts the timeout option to a
time.Duration- Creates a timeout context that will cascade to all downstream operations
- Defers the cancel function for proper cleanup
This ensures the enumeration process will be terminated if it exceeds the specified timeout, preventing indefinite execution when sources hang or delay.
✨ Finishing Touches
- [ ] 📝 Generate Docstrings
🧪 Generate unit tests
- [ ] Create PR with unit tests
- [ ] Post copyable unit tests in a comment
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.
🪧 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. -
Explain this complex logic. -
Open a follow-up GitHub issue for this discussion.
-
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:-
@coderabbitai explain this code block. -
@coderabbitai modularize this function.
-
- PR comments: Tag
@coderabbitaiin 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 explain its main purpose. -
@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.
-
Support
Need 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)
-
@coderabbitai pauseto pause the reviews on a PR. -
@coderabbitai resumeto resume the paused reviews. -
@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository. -
@coderabbitai full reviewto do a full review from scratch and review all the files again. -
@coderabbitai summaryto regenerate the summary of the PR. -
@coderabbitai generate docstringsto generate docstrings for this PR. -
@coderabbitai generate sequence diagramto generate a sequence diagram of the changes in this PR. -
@coderabbitai generate unit teststo generate unit tests for this PR. -
@coderabbitai resolveresolve all the CodeRabbit review comments. -
@coderabbitai configurationto show the current CodeRabbit configuration for the repository. -
@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.