fix(utils): address issues in printing override warnings - Githubissues

awslabs / aws-solutions-constructs

The AWS Solutions Constructs Library is an open-source extension of the AWS Cloud Development Kit (AWS CDK) that provides multi-service, well-architected patterns for quickly defining solutions

https://docs.aws.amazon.com/solutions/latest/constructs/

Apache License 2.0

1.19k stars 240 forks source link

fix(utils): address issues in printing override warnings #1113

Closed biffgaut closed 2 months ago

biffgaut commented 2 months ago

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:

Change ConsolidateProps() to print warnings when customer props overwrite defaults, but not when Construct props overwrite customer props (will be great as long as people used consolidateProps correctly)
update template-writer to not send a role to buildLambaFunction, but to update the role afterwards (this is how constructs do it)

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

aws-solutions-constructs-team commented 2 months ago

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v2
Commit ID: 1b4c68589a4999c8c9551966743af22f0d712f8a
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-solutions-constructs-team commented 2 months ago

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v2
Commit ID: f17f7942fe1895019d26058a896a5c6b4e33243a
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-solutions-constructs-team commented 2 months ago

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v2
Commit ID: 526c9784af7642d6ee7b078550cc2a8d85b6c063
Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-solutions-constructs-team commented 2 months ago

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v2
Commit ID: 9aaa229629483f6560058e0f46641072be504897
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-solutions-constructs-team commented 2 months ago

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v2
Commit ID: 2c990738db86c5174e067e34c2ea45e54a77b82e
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-solutions-constructs-team commented 2 months ago

AWS CodeBuild CI Report

CodeBuild project: githubautobuild-for-cdk-v2
Commit ID: 683a153ceeb5051395da5a1b47acbdf3adca2fb9
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository