Docs/migration 1x to 2x by ayushiahjolia · Pull Request #655 · aws/aws-durable-execution-sdk-python

ayushiahjolia · 2026-08-18T21:06:59Z

Issue #, if available: N/A

Description of changes:
Migration guide for python v2

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

github-actions · 2026-08-27T20:22:14Z

Claude AI review

Documentation-only PR: a new docs/migration-1.x-to-2.x.md migration guide and an expanded WaitForConditionConfig docstring in packages/aws-durable-execution-sdk-python/src/aws_durable_execution_sdk_python/waits.py.

I verified the guide's technical claims against the source rather than reviewing runtime behavior, since inaccurate migration docs would misdirect users:

Error hierarchy / exports — DurableOperationError base, StepError/InvokeError/ChildContextError/WaitForConditionError, graded CallbackError subtypes, SerDesError (child of DurableExecutionsError), RetryableSerDesError (retryable InvocationError); all root exports match __init__.py __all__.
__cause__ — raise_as_operation_error reconstructs a DurableOperationError stand-in (registry fallback to base for non-SDK types) on both first run and replay; the guide's claim is accurate.
First-run round trip — confirmed in step.py, child.py, wait_for_condition.py; invoke.py does not round-trip, matching "invoke unaffected."
wait_for_condition — initial_state round-tripped before first check; empty-string payload treated as no stored state, restarting from initial_state.
wait_for_callback serdes — enclosing child context uses default extended-type serdes, distinct from WaitForCallbackConfig.serdes.
Completion predicate / BatchResult — should_complete, complete_batch/continue_batch, BatchCompletionError (only CUSTOM_COMPLETION_FAILED), throw_if_error typed raises, and fail-fast map/parallel defaults all match.
attempt field — required no-default field on StepContext and WaitForConditionCheckContext.
Removed names — CallableRuntimeError, WaitDecision, ItemBatcher, WaitStrategyConfig.timeout*, etc. confirmed absent.

No inaccurate statements or broken examples found. No actionable findings.

Residual test risk: the guide's code snippets and rg helpers are not covered by doctests/CI, so future API drift wouldn't be caught automatically — acceptable for a docs-only change. Separately (out of scope, not in this diff): the pre-existing DurableOperationError docstring at packages/aws-durable-execution-sdk-python/src/aws_durable_execution_sdk_python/exceptions.py:268-269 states the escaping error "is preserved as __cause__ on the first run," which contradicts the actual reconstruction behavior the new guide correctly documents.

Reviewed commit 6c1c23fe6206a4982795f437c0e251941292116b. Workflow run

github-actions · 2026-09-01T20:21:00Z

Codex AI review

Found three migration-guide issues: one replay-safety omission and two misleading API descriptions.

Reviewed commit ea3ae4884dcd84d9c1d47eb03121c61c437f7f6e. Workflow run

yaythomas · 2026-09-03T21:30:04Z

picking up this PR to incorporate #698

- Rename to migration-1.x-to-2.0.md; name the release 2.0, not 2.x - Add a Why upgrade to 2.0 section listing only 2.0 additions - Rewrite in active voice; remove filler and passive constructions - Rename batching heading to Removed 1.x-only names - Add max_concurrency in-flight semantics section - Add replay operation identity validation (#698) - Add wait_for_condition unreadable-polling-state failure - Scope RetryableSerDesError guidance to invocation replay and step semantics; scope exhaustion to create_wait_strategy - Correct callbacks note: create_callback().result() still exists - Move the experimental plugin note to its own linked section - Mark the grep checklist as non-exhaustive

ayushiahjolia had a problem deploying to ai-pr-review August 18, 2026 21:07 — with GitHub Actions Error

ayushiahjolia force-pushed the docs/migration-1x-to-2x branch from 31f5f5e to 162361b Compare August 18, 2026 21:38

ayushiahjolia had a problem deploying to ai-pr-review August 18, 2026 21:38 — with GitHub Actions Error

ayushiahjolia marked this pull request as ready for review August 18, 2026 21:39

ayushiahjolia temporarily deployed to ai-pr-review-runtime August 18, 2026 21:39 — with GitHub Actions Inactive

github-actions Bot reviewed Aug 18, 2026

View reviewed changes

Comment thread docs/migration-1.x-to-2.x.md Outdated

github-actions Bot reviewed Aug 18, 2026

View reviewed changes

Comment thread docs/migration-1.x-to-2.x.md Outdated

github-actions Bot reviewed Aug 18, 2026

View reviewed changes

Comment thread docs/migration-1.x-to-2.x.md Outdated

This comment has been minimized.

Sign in to view

github-actions Bot reviewed Aug 18, 2026

View reviewed changes

Comment thread docs/migration-1.x-to-2.x.md Outdated

github-actions Bot reviewed Aug 18, 2026

View reviewed changes

Comment thread docs/migration-1.x-to-2.x.md Outdated

This comment has been minimized.

Sign in to view

ayushiahjolia force-pushed the docs/migration-1x-to-2x branch from 162361b to e4ae074 Compare August 19, 2026 20:57

ayushiahjolia temporarily deployed to ai-pr-review-runtime August 19, 2026 20:57 — with GitHub Actions Inactive

github-actions Bot reviewed Aug 19, 2026

View reviewed changes

Comment thread docs/migration-1.x-to-2.x.md Outdated

github-actions Bot reviewed Aug 19, 2026

View reviewed changes

Comment thread docs/migration-1.x-to-2.x.md Outdated

This comment has been minimized.

Sign in to view

github-actions Bot reviewed Aug 19, 2026

View reviewed changes

Comment thread docs/migration-1.x-to-2.x.md Outdated

This comment has been minimized.

Sign in to view

ayushiahjolia mentioned this pull request Aug 20, 2026

Migration guide for customers #663

Open

ayushiahjolia had a problem deploying to ai-pr-review-runtime August 20, 2026 17:19 — with GitHub Actions Failure

ayushiahjolia force-pushed the docs/migration-1x-to-2x branch from e4ae074 to 2681198 Compare August 20, 2026 17:46

ayushiahjolia temporarily deployed to ai-pr-review-runtime August 20, 2026 17:53 — with GitHub Actions Inactive

github-actions Bot reviewed Aug 20, 2026

View reviewed changes

Comment thread docs/migration-1.x-to-2.x.md Outdated

This comment has been minimized.

Sign in to view

github-actions Bot reviewed Aug 20, 2026

View reviewed changes

Comment thread docs/migration-1.x-to-2.x.md Outdated

ayushiahjolia marked this pull request as ready for review August 27, 2026 19:32

ayushiahjolia temporarily deployed to ai-pr-review-runtime August 27, 2026 19:32 — with GitHub Actions Inactive

This comment has been minimized.

Sign in to view

ayushiahjolia had a problem deploying to ai-pr-review-runtime August 27, 2026 19:37 — with GitHub Actions Failure

ayushiahjolia temporarily deployed to ai-pr-review-runtime August 27, 2026 19:37 — with GitHub Actions Inactive

github-actions Bot reviewed Aug 27, 2026

View reviewed changes

Comment thread docs/migration-1.x-to-2.x.md Outdated

This comment has been minimized.

Sign in to view

ayushiahjolia force-pushed the docs/migration-1x-to-2x branch from be09914 to 6c1c23f Compare August 27, 2026 20:07

ayushiahjolia temporarily deployed to ai-pr-review-runtime August 27, 2026 20:07 — with GitHub Actions Inactive

This comment has been minimized.

Sign in to view

zhongkechen reviewed Aug 27, 2026

View reviewed changes

Comment thread docs/migration-1.x-to-2.x.md Outdated

yaythomas reviewed Aug 27, 2026

View reviewed changes

Comment thread docs/migration-1.x-to-2.x.md Outdated

Comment thread docs/migration-1.x-to-2.x.md Outdated

ayushiahjolia force-pushed the docs/migration-1x-to-2x branch from 6c1c23f to 0edb4a6 Compare August 31, 2026 23:28

ayushiahjolia requested a review from yaythomas August 31, 2026 23:32

ayushiahjolia had a problem deploying to ai-pr-review-runtime August 31, 2026 23:36 — with GitHub Actions Failure

github-actions Bot reviewed Aug 31, 2026

View reviewed changes

Comment thread docs/migration-1.x-to-2.x.md Outdated

This comment has been minimized.

Sign in to view

docs: add 1.x to 2.x migration guide

ea3ae48

yaythomas previously requested changes Sep 1, 2026

View reviewed changes

Comment thread docs/migration-1.x-to-2.x.md Outdated

Comment thread docs/migration-1.x-to-2.x.md Outdated

github-actions Bot reviewed Sep 1, 2026

View reviewed changes

Comment thread docs/migration-1.x-to-2.x.md Outdated

github-actions Bot reviewed Sep 1, 2026

View reviewed changes

Comment thread docs/migration-1.x-to-2.x.md Outdated

github-actions Bot reviewed Sep 1, 2026

View reviewed changes

Comment thread docs/migration-1.x-to-2.x.md Outdated

zhongkechen reviewed Sep 1, 2026

View reviewed changes

Comment thread docs/migration-1.x-to-2.x.md Outdated

Merge branch 'main' into docs/migration-1x-to-2x

17d51df

zhongkechen and others added 2 commits September 3, 2026 14:32

Merge branch 'main' into docs/migration-1x-to-2x

f0b6407

Uh oh!

Conversation

ayushiahjolia commented Aug 18, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment has been minimized.

Uh oh!

Uh oh!

This comment has been minimized.

Uh oh!

Uh oh!

This comment has been minimized.

Uh oh!

This comment has been minimized.

Uh oh!

This comment has been minimized.

Uh oh!

This comment has been minimized.

Uh oh!

This comment has been minimized.

This comment has been minimized.

github-actions Bot commented Aug 27, 2026

Claude AI review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment has been minimized.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Sep 1, 2026

Codex AI review

Uh oh!

Uh oh!

yaythomas commented Sep 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants