Document RoadRunnerStore ttl / waitTtl options; fix wrong defaults#7
Document RoadRunnerStore ttl / waitTtl options; fix wrong defaults#7gam6itko wants to merge 1 commit into
Conversation
The constructor docblock claimed `$initialTtl` "Defaults to 0 (forever)", but the actual default is 300 seconds. `$initialWaitTtl` had no explanation of what its default of 0 does. `withTtl()` carried the same misleading "Defaults to 0 (forever)" text for a required `$ttl` argument. - Fix the `$initialTtl` default (300, not 0) in the constructor docblock. - Document `$initialWaitTtl`: default 0 is effectively non-blocking (the RoadRunner server caps a 0 wait at 1ms), a positive value blocks. - Clean up the `withTtl()` docblock (no bogus default; describe null waitTtl). - Add a "Store options" section to the README with a defaults table and a withTtl() example. Docs only — no behavior changes. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Warning Review limit reached
Next review available in: 34 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Why
$initialTtl"Defaults to 0 (forever)", but the actual default is300.0seconds — the doc was simply wrong.$initialWaitTtlhad no explanation of what its default of0does.withTtl()carried the same misleading "Defaults to 0 (forever)" text for a$ttlargument that has no default (it's required).Verified behavior of
waitTTL=0against the server plugin (roadrunner-server/lock,rpc.go): a wait of0is floored todefaultImmediateTimeout(1ms), so acquiring an already-held lock fails almost immediately —effectively non-blocking. A positive value blocks for up to that duration. (Same clarification as roadrunner-php/lock#9.)
Changes
$initialTtldefault in the constructor docblock (300, not 0).$initialWaitTtl(default 0 → non-blocking, 1ms server cap; positive blocks).withTtl()docblock (drop the bogus default, describenull $waitTtl).withTtl()example.Docs only — no behavior changes.