NextjsSite: make image regenerator customizable (#1250)

* fix(nextJsStie): make regenerator function customizable

* Sync

* Allow customizing regeneration queue

Co-authored-by: Frank <wangfanjie@gmail.com>

Author: bshrram

packages/resources/src/NextjsSite.ts

@@ -38,6 +38,7 @@ import * as crossRegionHelper from "./nextjs-site/cross-region-helper";
 export interface NextjsSiteProps {
   path: string;
   s3Bucket?: s3.BucketProps;
+  sqsRegenerationQueue?: sqs.QueueProps;
   customDomain?: string | NextjsSiteDomainProps;
   cfCachePolicies?: NextjsSiteCachePolicyProps;
   cfDistribution?: NextjsSiteCdkDistributionProps;
@@ -99,6 +100,7 @@ export class NextjsSite extends Construct implements SSTConstruct {
   };
 
   public readonly s3Bucket: s3.Bucket;
+  public readonly sqsRegenerationQueue: sqs.Queue;
   public readonly cfDistribution: cloudfront.Distribution;
   public readonly hostedZone?: route53.IHostedZone;
   public readonly acmCertificate?: acm.ICertificate;
@@ -113,7 +115,6 @@ export class NextjsSite extends Construct implements SSTConstruct {
   private readonly mainFunctionVersion: lambda.IVersion;
   private readonly apiFunctionVersion: lambda.IVersion;
   private readonly imageFunctionVersion: lambda.IVersion;
-  private readonly regenerationQueue: sqs.Queue;
   private readonly regenerationFunction: lambda.Function;
 
   constructor(scope: Construct, id: string, props: NextjsSiteProps) {
@@ -157,7 +158,7 @@ export class NextjsSite extends Construct implements SSTConstruct {
     this.s3Bucket = this.createS3Bucket();
 
     // Handle Incremental Static Regeneration
-    this.regenerationQueue = this.createRegenerationQueue();
+    this.sqsRegenerationQueue = this.createRegenerationQueue();
     this.regenerationFunction = this.createRegenerationFunction();
 
     // Create Lambda@Edge functions (always created in us-east-1)
@@ -434,7 +435,7 @@ export class NextjsSite extends Construct implements SSTConstruct {
 
     // Attach permission
     this.s3Bucket.grantReadWrite(role);
-    this.regenerationQueue.grantSendMessages(role);
+    this.sqsRegenerationQueue.grantSendMessages(role);
     this.regenerationFunction.grantInvoke(role);
     if (fnProps?.permissions) {
       attachPermissionsToRole(role, fnProps.permissions);
@@ -444,7 +445,10 @@ export class NextjsSite extends Construct implements SSTConstruct {
   }
 
   private createRegenerationQueue(): sqs.Queue {
+    const { sqsRegenerationQueue } = this.props;
+
     return new sqs.Queue(this, "RegenerationQueue", {
+      ...(sqsRegenerationQueue || {}),
       // We call the queue the same name as the bucket so that we can easily
       // reference it from within the lambda@edge, given we can't use env vars
       // in a lambda@edge
@@ -477,15 +481,18 @@ export class NextjsSite extends Construct implements SSTConstruct {
       code = lambda.Code.fromInline("  ");
     }
 
+    // Create function
+    const { defaultFunctionProps: fnProps } = this.props;
     const fn = new lambda.Function(this, "RegenerationFunction", {
       handler: "index.handler",
       runtime: lambda.Runtime.NODEJS_12_X,
-      timeout: cdk.Duration.seconds(30),
+      memorySize: fnProps?.memorySize || 1024,
+      timeout: cdk.Duration.seconds(fnProps?.timeout || 30),
       code,
     });
 
     fn.addEventSource(
-      new lambdaEventSources.SqsEventSource(this.regenerationQueue)
+      new lambdaEventSources.SqsEventSource(this.sqsRegenerationQueue)
     );
 
     // Grant permissions
@@ -606,14 +613,13 @@ export class NextjsSite extends Construct implements SSTConstruct {
   }
 
   private createS3Bucket(): s3.Bucket {
-    let { s3Bucket } = this.props;
-    s3Bucket = s3Bucket || {};
+    const { s3Bucket } = this.props;
 
     return new s3.Bucket(this, "Bucket", {
       publicReadAccess: true,
       autoDeleteObjects: true,
       removalPolicy: cdk.RemovalPolicy.DESTROY,
-      ...s3Bucket,
+      ...(s3Bucket || {}),
     });
   }
 

packages/resources/test/NextjsSite.test.ts

@@ -12,6 +12,7 @@ import {
   ANY,
   ABSENT,
 } from "./helper";
+import * as cdk from "aws-cdk-lib";
 import * as cf from "aws-cdk-lib/aws-cloudfront";
 import * as route53 from "aws-cdk-lib/aws-route53";
 import * as acm from "aws-cdk-lib/aws-certificatemanager";
@@ -693,6 +694,23 @@ test("constructor: s3Bucket props", async () => {
   });
 });
 
+test("constructor: sqsRegenerationQueue props", async () => {
+  const stack = new Stack(new App(), "stack");
+  new NextjsSite(stack, "Site", {
+    path: "test/nextjs-site",
+    sqsRegenerationQueue: {
+      deliveryDelay: cdk.Duration.seconds(30),
+    },
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore: "jestBuildOutputPath" not exposed in props
+    jestBuildOutputPath: buildOutputPath,
+  });
+  countResources(stack, "AWS::SQS::Queue", 1);
+  hasResource(stack, "AWS::SQS::Queue", {
+    DelaySeconds: 30,
+  });
+});
+
 test("constructor: cfCachePolicies props default", async () => {
   const stack = new Stack(new App(), "stack");
   new NextjsSite(stack, "Site", {

www/docs/constructs/NextjsSite.md

@@ -237,9 +237,9 @@ Note that the certificate needs be created in the `us-east-1`(N. Virginia) regio
 
 Also note that you can also migrate externally hosted domains to Route 53 by [following this guide](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/MigratingDNS.html).
 
-### Configuring the Edge Functions
+### Configuring the Lambda Functions
 
-Configure the internally created CDK [`Lambda@Edge Function`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudfront.experimental.EdgeFunction.html) instance.
+Configure the internally created CDK [`Lambda Function`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html) instance.
 
 ```js {3-7}
 new NextjsSite(this, "Site", {
@@ -358,6 +358,12 @@ _Type_ : [`cdk.aws-cloudfront.Distribution`](https://docs.aws.amazon.com/cdk/api
 
 The internally created CDK `Distribution` instance.
 
+### sqsRegenerationQueue
+
+_Type_ : [`cdk.aws-sqs.Queue`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)
+
+The internally created CDK `Queue` instance.
+
 ## Methods
 
 An instance of `NextjsSite` contains the following methods.
@@ -436,11 +442,17 @@ _Type_: [`NextjsSiteCachePolicyProps`](#nextjssitecachepolicyprops)
 
 Pass in a `NextjsSiteCachePolicyProps` value to override the default CloudFront cache policies created internally.
 
+### sqsRegenerationQueue?
+
+_Type_: [`cdk.aws-sqs.QueueProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.QueueProps.html)
+
+Pass in a `cdk.aws-sqs.QueueProps` value to override the default settings this construct uses to create the CDK `Queue` internally.
+
 ### defaultFunctionProps?
 
 _Type_: [`NextjsSiteFunctionProps`](#nextjssitefunctionprops), _defaults to_ `{}`
 
-The default function props to be applied to all the Lambda@Edge functions created by this construct.
+The default function props to be applied to all the Lambda Functions created by this construct.
 
 ### disablePlaceholder?
 
@@ -494,13 +506,13 @@ Set this option if the domain is not hosted on Amazon Route 53.
 
 _Type_ : `number`, _defaults to 10_
 
-Lambda@Edge function execution timeout in seconds.
+Lambda function execution timeout in seconds.
 
 ### memorySize?
 
 _Type_ : `number`, _defaults to 1024_
 
-The amount of memory in MB allocated to this Lambda@Edge function.
+The amount of memory in MB allocated to this Lambda function.
 
 ### permissions?