Document accept backoff configuration#292
Merged
leynos merged 2 commits intodevin/1754663283-configurable-backoff-parametersfrom Aug 8, 2025
Merged
Conversation
Contributor
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the ✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Contributor
Reviewer's GuideCleaned up stray comments in server builder examples, added a dedicated server configuration guide for accept loop backoff using BackoffConfig, and renamed the exponential backoff behavior test for clarity. Class diagram for BackoffConfig and WireframeServer accept backoff configurationclassDiagram
class WireframeServer {
+accept_backoff(initial_delay: Duration, max_delay: Duration) : Self
+accept_initial_delay(delay: Duration) : Self
+accept_max_delay(delay: Duration) : Self
-backoff_config: BackoffConfig
}
class BackoffConfig {
+initial_delay: Duration
+max_delay: Duration
}
WireframeServer --> BackoffConfig : uses
Flow diagram for accept loop backoff configuration in WireframeServerflowchart TD
A[User configures WireframeServer] --> B{accept_backoff called?}
B -- Yes --> C[Set initial_delay and max_delay in BackoffConfig]
B -- No --> D{accept_initial_delay or accept_max_delay called?}
D -- Yes --> E[Set individual delay in BackoffConfig]
D -- No --> F[Use default BackoffConfig values]
C --> G[Accept loop uses exponential backoff]
E --> G
F --> G
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey @leynos - I've reviewed your changes and they look great!
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location> `docs/server/configuration.md:9` </location>
<code_context>
+
+## Accept loop backoff
+
+The accept loop retries failed `accept()` calls using exponential backoff. Use
+`accept_backoff(initial_delay, max_delay)` to set both bounds in one call.
+These values are stored in `BackoffConfig`:
</code_context>
<issue_to_address>
The sentence 'Use `accept_backoff...`' addresses the reader directly with an implied 'you'.
To avoid second person, rephrase as: '`accept_backoff(initial_delay, max_delay)` sets both bounds in one call.'
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
![codescene-delta-analysis[bot]](https://avatars.githubusercontent.com/in/53921?s=60&v=4){kind=small}
Owner
Author
|
@coderabbitai review |
Contributor
✅ Actions performedReview triggered.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
leynos
merged commit 914da84
into
devin/1754663283-configurable-backoff-parameters
2 checks passed
leynos
added a commit
that referenced
this pull request
Aug 8, 2025
* Make exponential backoff parameters configurable in accept_loop - Add BackoffConfig struct with initial_delay and max_delay fields - Add builder methods: accept_backoff(), accept_initial_delay(), accept_max_delay() - Update accept_loop to use configurable parameters instead of hardcoded constants - Maintain backward compatibility with same default values (10ms initial, 1s max) - Add comprehensive tests for new configuration methods - Add validation to ensure sensible minimum values Fixes #264 Co-Authored-By: Leynos <leynos@troubledskies.net> * Address CodeRabbit feedback: improve documentation and validation - Add comprehensive documentation for BackoffConfig struct and field - Add module-level docs for BackoffConfig re-export - Fix accept_initial_delay to preserve initial ≤ max invariant - Make accept_max_delay validation logic explicit - Add test for initial_delay exceeding default max_delay - Fix clippy warning for accept() function name formatting Co-Authored-By: Leynos <leynos@troubledskies.net> * Complete documentation examples for backoff configuration methods - Fix incomplete documentation examples in accept_backoff, accept_initial_delay, and accept_max_delay - Add complete method call examples showing proper usage - Address user feedback on GitHub PR comments asking for complete examples Co-Authored-By: Leynos <leynos@troubledskies.net> * Address CodeRabbit feedback: make accept_backoff validation explicit - Replace silent coercion with explicit parameter swapping and validation - Add comprehensive documentation explaining behavior - Add test cases for parameter swapping edge cases - Ensure initial_delay <= max_delay invariant is preserved Co-Authored-By: Leynos <leynos@troubledskies.net> * Add exponential backoff behavior test - Add test_accept_exponential_backoff_behavior() to verify actual timing behavior - Test simulates repeated accept failures and measures timing intervals - Verifies delays follow exponential pattern: initial → 2×initial → 4×initial → max - Complements existing configuration tests with runtime behavior verification - Addresses user feedback about testing actual backoff behavior vs just configuration Co-Authored-By: Leynos <leynos@troubledskies.net> * Document accept backoff configuration (#292) * Document accept backoff configuration * Rephrase accept_backoff docs --------- Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: Leynos <leynos@troubledskies.net>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Testing
make fmtmake lintmake testmake markdownlintmake nixie(fails: Error running command mmdc -p /tmp/tmpm31eo4p1.json -i /tmp/tmpap7_ciod/async_stream_2.mmd -o /tmp/tmpap7_ciod/async_stream_2.svg for file 'examples/async_stream.md' (diagram 2): Error: Failed to launch the browser process! /root/.cache/puppeteer/chrome-headless-shell/linux-131.0.6778.204/chrome-headless-shell-linux64/chrome-headless-shell: error while loading shared libraries: libXcomposite.so.1: cannot open shared object file: No such file or directory)https://chatgpt.com/codex/tasks/task_e_68963277cb6c83228122a225eebbf642
Summary by Sourcery
Document the accept loop backoff configuration in the server guide, clean up stray example comments, and clarify the exponential backoff test naming
Documentation:
Tests:
Chores: