fix(ecs-patterns): add validation for queue and queue related props #21717
Conversation
This file contains 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
…riod, visibilityTimeout and maxReceiveCount have no effect when queue is specified.
|
|
TheRealAmazonKendra
previously requested changes
Aug 23, 2022
Comment on lines
294
to
295
| if (props.queue && (props.retentionPeriod || props.visibilityTimeout || props.maxReceiveCount)) { | ||
| throw new Error('retentionPeriod, visibilityTimeout and maxReceiveCount can be set only when queue is not set. Specify them in the QueueProps of the queue'); |
There was a problem hiding this comment.
We should probably have different error messages depending on which prop is provided that shouldn't be. It may be confusing if all are listed and a customer hasn't provided them all.
There was a problem hiding this comment.
Thank you very much for your quick reviews!
Added some unit tests and fixed the error messages.
mergify
bot
dismissed
TheRealAmazonKendra’s stale review
Pull request has been modified.
|
@Mergifyio update |
✅ Branch has been successfully updated |
TheRealAmazonKendra
approved these changes
Aug 30, 2022
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). |
josephedward
pushed a commit
to josephedward/aws-cdk
that referenced
this pull request
Aug 30, 2022
…ws#21717) ## Problem When queue construct is set, queue related props (maxReceiveCount, visibilityTimeout, retentionPeriod) have no effect to the queue of the `QueueProcessingService`. I think this is a reasonable behavior, but it is difficult to notice when wrongly configured. ## Fix This pull request adds a validation to prevent from setting both queue and queue related props at the same time, and notice users the configuration error. Also, updates the param docs for this behavior. ---- ### All Submissions: * [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
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.
Problem
When queue construct is set, queue related props (maxReceiveCount, visibilityTimeout, retentionPeriod) have no effect to the queue of the
QueueProcessingService. I think this is a reasonable behavior, but it is difficult to notice when wrongly configured.Fix
This pull request adds a validation to prevent from setting both queue and queue related props at the same time, and notice users the configuration error. Also, updates the param docs for this behavior.
All Submissions:
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license