Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(cloudfront): trim autogenerated cache policy name #18953

Merged
merged 6 commits into from
Feb 22, 2022
Merged

fix(cloudfront): trim autogenerated cache policy name #18953

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
00c6312
fix(cloudfront): trim autogenerated cache policy name
robertd Feb 12, 2022
bd65ae4
slice only uniqueId
robertd Feb 21, 2022
dee863c
Merge branch 'master' into robertd/cloudfront
robertd Feb 21, 2022
5e7394e
Merge branch 'master' into robertd/cloudfront
robertd Feb 21, 2022
398d116
Merge branch 'master' into robertd/cloudfront
mergify[bot] Feb 21, 2022
ff6cb52
Merge branch 'master' into robertd/cloudfront
robertd Feb 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions packages/@aws-cdk/aws-cloudfront/lib/cache-policy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,9 +129,14 @@ export class CachePolicy extends Resource implements ICachePolicy {
physicalName: props.cachePolicyName,
});

const cachePolicyName = props.cachePolicyName ?? `${Names.uniqueId(this)}-${Stack.of(this).region}`;
const cachePolicyName = props.cachePolicyName ?? `${Names.uniqueId(this).slice(0, 110)}-${Stack.of(this).region}`;

if (!Token.isUnresolved(cachePolicyName) && !cachePolicyName.match(/^[\w-]+$/i)) {
throw new Error(`'cachePolicyName' can only include '-', '_', and alphanumeric characters, got: '${props.cachePolicyName}'`);
throw new Error(`'cachePolicyName' can only include '-', '_', and alphanumeric characters, got: '${cachePolicyName}'`);
}

if (cachePolicyName.length > 128) {
throw new Error(`'cachePolicyName' cannot be longer than 128 characters, got: '${cachePolicyName.length}'`);
}

const minTtl = (props.minTtl ?? Duration.seconds(0)).toSeconds();
Expand Down
2 changes: 1 addition & 1 deletion packages/@aws-cdk/aws-cloudfront/lib/distribution.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,7 +285,7 @@ export class Distribution extends Resource implements IDistribution {
// Comments have an undocumented limit of 128 characters
const trimmedComment =
props.comment && props.comment.length > 128
? `${props.comment.substr(0, 128 - 3)}...`
? `${props.comment.slice(0, 128 - 3)}...`
: props.comment;

const distribution = new CfnDistribution(this, 'Resource', {
Expand Down
7 changes: 6 additions & 1 deletion packages/@aws-cdk/aws-cloudfront/test/cache-policy.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,12 @@ describe('CachePolicy', () => {
});
});

test('throws if given a cachePolicyName with invalid characters', () => {
test('throws on long policy names over 128 characters', () => {
const errorMessage = /'cachePolicyName' cannot be longer than 128 characters/;
expect(() => new CachePolicy(stack, 'CachePolicy1', { cachePolicyName: 'FooBarBaz'.repeat(15) })).toThrow(errorMessage);
});

test('throws if cachePolicyName contains invalid characters', () => {
const errorMessage = /'cachePolicyName' can only include '-', '_', and alphanumeric characters/;
expect(() => new CachePolicy(stack, 'CachePolicy1', { cachePolicyName: 'My Policy' })).toThrow(errorMessage);
expect(() => new CachePolicy(stack, 'CachePolicy2', { cachePolicyName: 'MyPolicy!' })).toThrow(errorMessage);
Expand Down