Detect and correct "incorrect" use of new FnJoin
#516
Merged
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
A common developer error is to pass an array as the second argument of `new FnJoin`, but that argument is variadic. This causes invalid CloudFormation templates to be generated. This change detects this usage pattern (vararg contains a single element that is an array) and fixes it up transparently. Related to #512
eladb
suggested changes
Aug 7, 2018
| @@ -88,6 +88,18 @@ export class FnJoin extends Fn { | |||
| * @param listOfValues The list of values you want combined. | |||
| */ | |||
| constructor(delimiter: string, ...listOfValues: any[]) { | |||
There was a problem hiding this comment.
I think I rather we align the signature here to CloudFormation instead of be "smart" about it. FnConcat is a nice sugar on top that has a variadic signature.
There was a problem hiding this comment.
Okay. Can do that then.
eladb
approved these changes
Aug 7, 2018
|
|
||
| export = nodeunit.testCase({ | ||
| 'Fn::Join': { | ||
| 'rejects empty list of arguments to join'(test: nodeunit.Test) { |
There was a problem hiding this comment.
Are you sure there aren’t already tests for these?
There was a problem hiding this comment.
Reasonably:
- Nothing showed up in
/test/when I grep'd forFnJoin(. - There was no
test.fn.tsand that's where I expect those unit tests to be
|
I'm tracking down places where the "old" syntax was used and fixing those (they are what causes the CodeBuild to fail). |
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.
A common developer error is to pass an array as the second argument of
new FnJoin, but that argument is variadic. This causes invalidCloudFormation templates to be generated. This change corrects the
API to match the
Fn::Joinsyntax where the second argument is anarray.
Related to #512