-
Notifications
You must be signed in to change notification settings - Fork 4.2k
feat(stepfunctions): add support for custom WriterConfig fields for ResultWriter in Distributed Map (#33772) and (#33601) #33831
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(This review is outdated)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(This review is outdated)
|
Dismissing outdated PRLinter review.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(This review is outdated)
Exemption Request Need to add this to allowed-breaking-changes.txt.
Example: below is perfectly valid now
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @vishalsatam , Thank you contributing this pull request, we don't accept any breaking changes to the stable library module, please see below how changing a prop type from required to optional can break customers
https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md#breaking-changes
what's recommended in such cases is we add a new type with v2 and mark the existing one as deprecated.
packages/aws-cdk-lib/aws-stepfunctions/lib/states/distributed-map/result-writer.ts
Show resolved
Hide resolved
✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #33831 +/- ##
=======================================
Coverage 83.98% 83.98%
=======================================
Files 120 120
Lines 6976 6976
Branches 1178 1178
=======================================
Hits 5859 5859
Misses 1005 1005
Partials 112 112
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
...ework-integ/test/aws-stepfunctions/test/integ.distribution-map-with-result-writer-jsonata.ts
Show resolved
Hide resolved
Thank you @vishalsatam for adding comprehensive integration and unit test, just few minor comments to address |
…terConfig in ResultWriter object in Distributed Map Closes #33772 and #33601. Reason for making this change: A new property `WriterConfig` was added under ResultWriter property of Distributed Map. `WriterConfig` contains OutputType and Transformation Ref: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-resultwriter.html#input-output-resultwriter-field-contents `ItemReader` also supports "JSONL" as the `InputType`. It's currently missing in the enum. Ref: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-itemreader.html#itemreader-field-contents Changes: * Created a copy of ResultWriter as ResultWriterV2 to avoid introducing a breaking change to ResultWriter. * Consumers will need to set feature`@aws-cdk/aws-stepfunctions:useDistributedMapResultWriterV2` to true in the context. * Create new class `WriterConfig` and add `writerConfig` property under `ResultWriterV2` in Distributed Map. * Add `OutputType` and `Transformation` properties under `WriterConfig`. * Add Warning when ResultWriter is empty. * Add the missing `JSONL` type which is a part of `InputType` `ItemReader` of Distributed Map. * Permissions - No additions. But removed the permission to put object when just `writerConfig` is specified. * Also added the missing `JSONL` from `InputType` in the `ItemReader` of Distributed Map. * Add a unit test and an integ test. - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
@shikha372 , Thank you for your patience with this pull request. Really appreciate the review and the comments.. |
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
This pull request has been removed from the queue for the following reason: The pull request can't be updated. You should update or rebase your pull request manually. If you do, this pull request will automatically be requeued once the queue conditions match again. |
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
@Mergifyio update |
❌ Mergify doesn't have permission to updateFor security reasons, Mergify can't update this pull request. Try updating locally. |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
Comments on closed issues and PRs are hard for our team to see. |
feat(stepfunctions): Create a new ResultWriterV2 class to support WriterConfig in ResultWriter object in Distributed Map
Closes #33772 and #33601.
Reason for making this change:
A new property
WriterConfig
was added under ResultWriter property of Distributed Map.WriterConfig
contains OutputType and TransformationRef: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-resultwriter.html#input-output-resultwriter-field-contents
ItemReader
also supports "JSONL" as theInputType
. It's currently missing in the enum.Ref: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-itemreader.html#itemreader-field-contents
Changes:
@aws-cdk/aws-stepfunctions:useDistributedMapResultWriterV2
to true in the context.WriterConfig
and addwriterConfig
property underResultWriterV2
in Distributed Map.OutputType
andTransformation
properties underWriterConfig
.JSONL
type which is a part ofInputType
ItemReader
of Distributed Map.writerConfig
is specified.JSONL
fromInputType
in theItemReader
of Distributed Map.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license