docs: linear retry strategy and retry helpers#211
Merged
Conversation
203a32c to
27c73cf
Compare
wangyb-A
previously approved these changes
Jun 24, 2026
dhegberg
reviewed
Jun 24, 2026
Document the linear retry strategy and the per-language retry helpers in docs/sdk-reference/error-handling/retries.md. Closes #155 and #209. - Restructure 'Configure a retry strategy' into sibling subsections for 'Exponential backoff' and 'Linear backoff', each with a walkthrough, config signature, and delay-calculation block. - Add a 'Retry any durable operation' section for the helper (TypeScript withRetry, Python with_retry, Java withRetry and withRetryAsync) and contrast it with a step's own retryStrategy. - Revise 'Retry presets' to document the new linear preset across all three languages and Python's RetryPresets.fixed(interval). - Add nine new example files (linear-retry-strategy, linear-retry-strategy-config-signature, with-retry-helper) across TypeScript, Python, and Java. - Refresh the existing retry-presets examples in all three languages to include the new presets. All signatures verified against the SDK source on origin/main: TypeScript createLinearRetryStrategy and withRetry, Python create_linear_retry_strategy and with_retry, Java RetryStrategies.linearBackoff overloads and DurableContext.withRetry. Closes #155 Closes #209
27c73cf to
df19850
Compare
dhegberg
approved these changes
Jun 24, 2026
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
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.
Documents the linear retry strategy helper and the retry helper for
durable operations that cannot live inside a step.
Changes to
docs/sdk-reference/error-handling/retries.mdConfigure a retry strategysoExponential backoffandLinear backoffare sibling subsections, each with its own walkthrough,config signature, and delay-calculation block.
Retry a durable operationcovering the retry helper:TypeScript
withRetry, Pythonwith_retry, JavaDurableContext.withRetry/withRetryAsync. Explains when to use itinstead of a step retry strategy (for
invoke,waitForCallback,waitForCondition, etc., which cannot be inside a step).Retry presets: addretryPresets.linear(TypeScript),RetryStrategies.Presets.LINEAR(Java), andRetryPresets.linear()/RetryPresets.fixed(interval)(Python).New examples
linear-retry-strategy.{ts,py,java}— configures a linear strategyon a step.
linear-retry-strategy-config-signature.{ts,py,java}— config shapereference, mirroring the existing
retry-strategy-config-signature.*.with-retry-helper.{ts,py,java}— wraps aninvokewith the retryhelper.
The existing
retry-presets.{ts,py,java}examples are updated todemonstrate the new linear preset (and Python
fixed).Source verification
All signatures verified against
origin/mainof each SDK repo. Onecorrection relative to the issue text:
withRetry, notretryOperation. It isexported from
@aws/durable-execution-sdk-js(seepackages/aws-durable-execution-sdk-js/src/utils/with-retry/index.tsand the package
index.tsre-export).RetryStrategies.linearBackoff(the existing factory name), notRetryStrategies.linear.Verification
mdformat docs/sdk-reference/error-handling/retries.mdis idempotent.zensical build --cleanfinishes cleanly:No issues found.Closes #155
Closes #209