[@aws-cdk/aws-route53-patterns]: HttpsRedirect throws 'The parameter Comment is too big'

[fbaba-nibtravel]

I'm trying to create a HttpsRedirect on Route53 with CloudFront. When deploying, the CDK is throwing the below error.

The comment itself is auto-generated and the props interface for the HttpsRedirect does not allow to customize the comment. The comment pattern is: Redirect to <target> from <recordName>.

The parameter Comment is too big. (Service: AmazonCloudFront; Status Code: 400; Error Code: InvalidArgument; Request ID: c8ea25db-e10a-4b47-bc81-d1cc818806d9; Proxy: null)
--
  | new CloudFrontWebDistribution (/app/node_modules/@aws-cdk/aws-cloudfront/lib/web-distribution.js:293:30)
  | \_ new HttpsRedirect (/app/node_modules/@aws-cdk/aws-route53-patterns/lib/website-redirect.js:51:30)
  | \_ StorybookAppStack.createRedirect (/app/dist/apps/deploy/src/stacks/storybook.stack.js:50:9)
  | \_ new StorybookAppStack (/app/dist/apps/deploy/src/stacks/storybook.stack.js:12:14)
  | \_ Object.<anonymous> (/app/dist/apps/deploy/src/storybook.app.js:9:1)
  | \_ Module._compile (internal/modules/cjs/loader.js:1063:30)
  | \_ Object.Module._extensions..js (internal/modules/cjs/loader.js:1092:10)
  | \_ Module.load (internal/modules/cjs/loader.js:928:32)
  | \_ Function.Module._load (internal/modules/cjs/loader.js:769:14)
  | \_ Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:72:12)
  | \_ internal/main/run_main_module.js:17:47

Reproduction Steps

    const dnsSuffix = StackHelper.dnsSuffix(slice);
    const zone = StackHelper.getHostedZone(this);
    const {
      aws_certificatemanager: { Certificate, CertificateValidation },
      aws_route53_patterns: { HttpsRedirect },
    } = base;

    new HttpsRedirect(this, StackHelper.createId('Redirect'), {
      zone: zone,
      recordNames: [`super.large.url.should.help.${application}${dnsSuffix}`],
      targetDomain: `${bucket.bucketWebsiteDomainName}/add/more/blocks/just/to/increase/the/size`,
      certificate: new Certificate(this, 'Certificate', {
        domainName: `${stage}.${DOMAIN}`,
        validation: CertificateValidation.fromDns(zone),
      }),
    });

What did you expect to happen?

Should create the route redirect using AWS CloudFront from a dns to a bucket target url

What actually happened?

The route fails to be created because of a comment property, not an invalid redirect.

Environment

• CDK CLI Version : 1.95.1
• Framework Version : 1.95.1
• Node.js Version : 14.16.0
• **OS : Linux **
• Language (Version): TypeScript 4.2.3

Other

---

This is 🐛 Bug Report

[njlynch]

Thanks for the bug report, @fbaba-nibtravel .

This appears to be due to the CloudFront distribution comment having an (undocumented) limit of 128 characters. While we could fix this within the route53-patterns construct, I think a better solution would be to fix this in the Distribution (and CloudFrontWebDistribution) constructs themselves.

The fix here is quite simple -- if the comment passed in is more than 128 characters, trim it down. This would be a great first issue for someone wanting to get started contributing to the CDK.

We would just need to trim the comment in two places:

https://github.com/aws/aws-cdk/blob/master/packages/@aws-cdk/aws-cloudfront/lib/distribution.ts#L290
https://github.com/aws/aws-cdk/blob/master/packages/@aws-cdk/aws-cloudfront/lib/web-distribution.ts#L773

And add a test for each, of course!

PRs welcome!

[hoegertn]

@fbaba-nibtravel Do you want to take this? Otherwise, I would look into it.

[fbaba-nibtravel]

Hi @njlynch, thanks for the reply. I'll give it a go and will shout out if run into any trouble.

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.