Commit ff41a37
authored
docs(2275): remove non-existent RetryConfig.Builder methods from README [skip-runtime-e2e] (#180)
The README's 'Retry Configuration' section advertised three RetryConfig.Builder
methods that do not exist in the public API:
- initialDelayMs(int) — actual Builder has initialDelay(Duration)
- maxDelayMs(int) — actual Builder has maxDelay(Duration)
- retryableStatusCodes(Set<Integer>) — does not exist at all; the retry
policy is hard-coded in
RetryExecutor.isRetryable
(5xx + 429 + connect/timeout, with
401/403/PolicyViolation/Config
exceptions always terminal)
The third method was the most load-bearing in the #2275 context. A user
reading the README would expect to be able to configure which statuses retry.
If they looked for the method and didn't find it, they might write a
workaround that bypassed retryExecutor entirely, reintroducing the storm
that PR #178 added regression coverage for.
Decision: delete the misleading example, not implement the methods.
Implementing retryableStatusCodes would be a feature addition (a new
configuration surface + serialized semantics + tests), not a doc fix.
This PR replaces the offending block with:
- one paragraph documenting the ACTUAL retry contract from
RetryExecutor.isRetryable
- a citation back to #2275 (the regression test from PR #178 locks in
that 401 stays terminal)
- a list of every Builder method that ACTUALLY exists (enabled,
maxAttempts, initialDelay, maxDelay, multiplier) with default values
- a working example using initialDelay(Duration.ofMillis(100)) /
maxDelay(Duration.ofSeconds(5)) so the code-block compiles against the
real API
CHANGELOG entry under [Unreleased] notes this is a documentation-only
fix — no public-API or behavior change.
Lineage:
- Hostile review of PR #178 (regression test for issue #2275) flagged
this as HIGH doc-debt. PR #178 author punted.
- This follow-up PR closes the finding.
Out of scope:
- Adding retryableStatusCodes or any per-status configuration to the
Builder (that's a feature).
- Changing RetryExecutor.isRetryable behavior.
- Version bump.
Signed-off-by: Saurabh Jain <saurabh.jain@getaxonflow.com>1 parent 6778902 commit ff41a37
2 files changed
Lines changed: 36 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
8 | 23 | | |
9 | 24 | | |
10 | 25 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
337 | 337 | | |
338 | 338 | | |
339 | 339 | | |
340 | | - | |
| 340 | + | |
| 341 | + | |
| 342 | + | |
| 343 | + | |
| 344 | + | |
| 345 | + | |
| 346 | + | |
| 347 | + | |
| 348 | + | |
| 349 | + | |
| 350 | + | |
| 351 | + | |
| 352 | + | |
| 353 | + | |
| 354 | + | |
| 355 | + | |
341 | 356 | | |
342 | 357 | | |
| 358 | + | |
| 359 | + | |
343 | 360 | | |
344 | 361 | | |
345 | 362 | | |
346 | | - | |
| 363 | + | |
347 | 364 | | |
348 | 365 | | |
349 | | - | |
350 | | - | |
| 366 | + | |
| 367 | + | |
351 | 368 | | |
352 | | - | |
353 | 369 | | |
354 | 370 | | |
355 | 371 | | |
| |||
0 commit comments