fix(cli): ecs hotswap fails on log configuration enabled#26876
fix(cli): ecs hotswap fails on log configuration enabled#26876mergify[bot] merged 2 commits intoaws:mainfrom
Conversation
aws-cdk-automation
left a comment
There was a problem hiding this comment.
The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.
A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.
|
Exemption Request: this should be covered with cli-integ tests. Also I tested e2e hotswap manually in my aws account. |
✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.
|
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). |
|
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). |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
Problem
ECS hotswap fails on a task definition containing log configuration like the following.
Root cause
When we transform object keys in a task definition, we pass
excludeFromTransformto avoid from transforming keys with arbitrary string, such aslogDriver.options.However, it was not working when we transform keys with upperCaseFirstCharacter, because the keys in
excludeFromTransformwas uppercased, where the source object was lowercased.This misconfiguration resulted in the output task definition uppercased in an unexpected way:
{ "logConfiguration": { "logDriver": "awslogs", "options": { "Awslogs-group": "my-test-stack-TaskEcsAppLogGroupD5C9C1DD-BPB6zgX4S0wU", "Awslogs-region": "ap-northeast-1", }, }, }The problem was not detected by unit tests because they only contained cases with uppercase keys in a source task definition.
Fix
Use lowercased
excludeFromTransformwhen we use it withupperCaseFirstCharacter, also adding a test case with lowercased keys in a source task definition.Closes #26871.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license