fix(utils): address issues in printing override warnings #1113
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
biffgaut
requested review from
hayesry,
mobri2a,
emcfins,
mickychetta and
georgebearden
as code owners
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
georgebearden
previously approved these changes
May 1, 2024
| @@ -456,6 +456,7 @@ test("Custom resource is provisioned if encryption key is provided as bucketProp | |||
| } | |||
| }); | |||
| const template = Template.fromStack(stack); | |||
| defaults.printWarning(`******************${JSON.stringify(template)}`); | |||
There was a problem hiding this comment.
intended to leave this line?
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
hayesry
reviewed
May 6, 2024
| @@ -35,19 +35,38 @@ import { Construct } from 'constructs'; | |||
| import { Stack, StackProps } from 'aws-cdk-lib'; | |||
| import { ConstructsFactories } from '@aws-solutions-constructs/aws-constructs-factories'; | |||
|
|
|||
| const factories = new ConstructsFactories(this, 'integ-test'); | |||
| const factories = new ConstructsFactories(this, MyFactories'); | |||
There was a problem hiding this comment.
nit: Missing an open apostrophe before MyFactories
edit: typo
hayesry
previously approved these changes
May 6, 2024
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
hayesry
approved these changes
May 6, 2024
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.
Issue 1 - Spurious overwrite warnings come up when synth’ing a stack using aws-openapigateway-lambda.
Cause – we use buildLambdaFunction() in the TemplateWriter custom resource. We fully specify the props, including the role. When overrideProps is called – this generates warnings (that have nothing to do with the client’s infrastructure or props)
Changes:
Issue 2 – deepdiff() dies. This is for 2 reasons.
Reason 1 – some properties do not have scalar values, such as maxRecordAge, which has a cdk.Duration.minutes(5) value. This causes deepdiff() to die. We have a prefilter list of values to ignore so this doesn’t happen, but if the customer does overwrite one of those values they won’t be informed.
Change– when we skip a value because it is in the prefilter list we print a warning that we cannot report on that value (is completely open with client, but will lead to noise)
Reason 2 – circular references in the props cause an infinite loop that exhausts memory requirements
Change – constructs in the props object seem to be the primary cause of this – let’s add ‘node’ to the prefilter list so deepdiff doesn’t dive into a CDK construct in props. We can print out a different warning for ‘node’ than for other prefilter list values