docs: add payload offloader examples and E2E coverage - #683
Conversation
| | `producerContext` | Exact SDK payload context used to create the reference | | ||
| | `requiresLoad` | Whether the producer's payload offloader must restore the serialized data | | ||
|
|
||
| Exactly one of `data` and `reference` is non-null. Version 1 SDK envelopes bind all custom-offloader results to | ||
| `producerContext`, populate the ownership and digest fields, and require the nested context to match them. A recognized |
There was a problem hiding this comment.
Codex AI review · Finding arf_v1_klillh6j5zkiglgos5i7422z4s
[P2] Specify the producerContext wire schema. Java requires this object and passes it to PayloadOffloader.load, but this document never defines its property names, nullability, enum encodings, or stable entityId construction. Another SDK therefore cannot reliably produce an envelope Java will accept. Add a normative field table or JSON example covering every context field and the execution/operation entity-ID rules.
| Then generate, build, and deploy the filesystem Lambda stack with | ||
| `FileSystemInfrastructureStackName=JavaSDKFileSystemPayloadE2EInfrastructureStack`, and include | ||
| `-Dtest.filesystem.enabled=true` when running `CloudBasedIntegrationTest`. |
There was a problem hiding this comment.
Codex AI review · Finding arf_v1_nhpk4wy3nhd73ew76a47dqolf5
[P2] Show the filesystem-specific generation and deployment commands. The default generator now excludes filesystem examples, so following the earlier python3 generate-template.py flow and merely supplying this parameter produces a template containing neither this function nor FileSystemInfrastructureStackName. Include the exact --file-system-only --output ..., sam build --template-file ..., and matching sam deploy --parameter-overrides ... commands.
| @Test | ||
| @EnabledIfSystemProperty(named = "test.filesystem.enabled", matches = "true") |
There was a problem hiding this comment.
Codex AI review · Finding arf_v1_53ul4lt5y7uz5fbbcc6drjr4zb
[P3] Add default local replay coverage for this example. This is the only Java test referencing the new handler, and it is skipped unless both cloud flags are enabled, so normal mvn test never exercises its step/wait/replay path or verifies the restored output. Add a LocalDurableTestRunner test using a temporary filesystem configuration, asserting the final length/checksum and that the pre-wait step executes once; retain this test for EFS integration.
Codex AI reviewFound three issues: an incomplete cross-SDK wire contract, unusable manual deployment instructions, and missing default replay coverage for the new example. Reviewed commit |
Stack
Scope
Architecture decision records and general design documentation remain in #678 and are intentionally not modified here.
Validation
mvn -pl examples -am testpython3 -m unittest examples/test_generate_template.pygit diff --checkmvn spotless:checkRelated to #463.