cdk-nextjs 0.3.11 → 0.4.1

package/lib/nextjs-build/global-containers.Dockerfile

@@ -1,10 +1,10 @@
 #checkov:skip=CKV_DOCKER_2: healthcheck run by ALB and ECS
 #checkov:skip=CKV_DOCKER_7: latest tag is ok to use for local builder container
 # Modified from: https://github.com/vercel/next.js/blob/canary/examples/with-docker/Dockerfile
-ARG BUILDER_IMAGE_TAG
-FROM $BUILDER_IMAGE_TAG as builder
+ARG BUILDER_IMAGE_ALIAS=cdk-nextjs/builder:latest
+FROM $BUILDER_IMAGE_ALIAS AS builder
 # Production image, copy all the files and run next
-FROM public.ecr.aws/docker/library/node:22-alpine as runner
+FROM public.ecr.aws/docker/library/node:22-alpine AS runner
 WORKDIR /app
 
 ENV NODE_ENV production
@@ -14,23 +14,33 @@ ENV NODE_ENV production
 RUN addgroup --system --gid 1001 nodejs
 RUN adduser --system --uid 1001 nextjs
 
-ARG RELATIVE_PATH_TO_WORKSPACE
-COPY --from=builder --chown=nextjs:nodejs /app/$RELATIVE_PATH_TO_WORKSPACE/.next/standalone ./
+ARG RELATIVE_PATH_TO_PACKAGE
+COPY --from=builder --chown=nextjs:nodejs /app/$RELATIVE_PATH_TO_PACKAGE/.next/standalone ./
+# html,rsc,body,meta files don't need to be in compute container b/c they're handled by cdk-nextjs-cache-handler.cjs
+RUN find . -type f \( -name "*.html" -o -name "*.rsc" -name "*.body" -name "*.meta" \) -delete
+COPY --from=builder --chown=nextjs:nodejs /app/cdk-nextjs-cache-handler.cjs ./$RELATIVE_PATH_TO_PACKAGE/
+ARG BUILD_ID
+ARG CACHE_PATH
+ARG DATA_CACHE_PATH
+ARG IMAGE_CACHE_PATH
 ARG MOUNT_PATH
-ARG DATA_CACHE_DIR
-ARG FULL_ROUTE_CACHE_DIR
-ARG IMAGE_CACHE_DIR
-ARG PUBLIC_DIR
-RUN mkdir -p $MOUNT_PATH/$DATA_CACHE_DIR && \
-  mkdir -p $MOUNT_PATH/$FULL_ROUTE_CACHE_DIR && \
-  mkdir -p $MOUNT_PATH/$IMAGE_CACHE_DIR && \
-  mkdir -p $MOUNT_PATH/$PUBLIC_DIR && \
-  chmod -R u+rw $MOUNT_PATH && \
-  mkdir -p ./$RELATIVE_PATH_TO_WORKSPACE/.next/cache && \
-  ln -s $MOUNT_PATH/$DATA_CACHE_DIR ./$RELATIVE_PATH_TO_WORKSPACE/.next/cache/fetch-cache && \
-  ln -s $MOUNT_PATH/$IMAGE_CACHE_DIR ./$RELATIVE_PATH_TO_WORKSPACE/.next/cache/images && \
-  ln -s $MOUNT_PATH/$PUBLIC_DIR ./$RELATIVE_PATH_TO_WORKSPACE/public && \
-  ln -s $MOUNT_PATH/$FULL_ROUTE_CACHE_DIR ./$RELATIVE_PATH_TO_WORKSPACE/.next/server/app
+ARG PUBLIC_PATH
+RUN sed -i 's/"env":{},/"env":{},cacheHandler:"\.\.\/cdk-nextjs-cache-handler.cjs",/g' ./$RELATIVE_PATH_TO_PACKAGE/server.js && \
+  # locally in this docker image the paths where EFS will be mounted need to exist for symlinks to be made
+  mkdir -p $MOUNT_PATH/$BUILD_ID/$DATA_CACHE_PATH && \
+  mkdir -p $MOUNT_PATH/$BUILD_ID/$IMAGE_CACHE_PATH && \
+  mkdir -p $MOUNT_PATH/$BUILD_ID/$PUBLIC_PATH && \
+  # delete if exists so that symlinks can be made; image cache doesn't exist at build time
+  rm -rf ./$RELATIVE_PATH_TO_PACKAGE/$DATA_CACHE_PATH && \
+  rm -rf ./$RELATIVE_PATH_TO_PACKAGE/$PUBLIC_PATH && \
+  # create .next/cache if doesn't exist. won't exist if no cached fetch data.
+  mkdir -p ./$RELATIVE_PATH_TO_PACKAGE/$CACHE_PATH && \
+  # `ln -s <src_file> <target_file>` such that accessing <target_file> accesses <src_file>
+  ln -s $MOUNT_PATH/$BUILD_ID/$DATA_CACHE_PATH ./$RELATIVE_PATH_TO_PACKAGE/$DATA_CACHE_PATH && \
+  ln -s $MOUNT_PATH/$BUILD_ID/$IMAGE_CACHE_PATH ./$RELATIVE_PATH_TO_PACKAGE/$IMAGE_CACHE_PATH && \
+  ln -s $MOUNT_PATH/$BUILD_ID/$PUBLIC_PATH ./$RELATIVE_PATH_TO_PACKAGE/$PUBLIC_PATH && \
+  # chown needs to be at end after all files are added so that nextjs:nodejs can access all files
+  chown -R nextjs:nodejs $MOUNT_PATH/$BUILD_ID
 
 USER nextjs
 

package/lib/nextjs-build/global-functions.Dockerfile

@@ -1,12 +1,11 @@
 #checkov:skip=CKV_DOCKER_2: healthcheck run by AWS Lambda Web Adapter
 #checkov:skip=CKV_DOCKER_7: latest tag is ok to use for local builder container
 # Modified from: https://github.com/vercel/next.js/blob/canary/examples/with-docker/Dockerfile
-ARG BUILDER_IMAGE_TAG
-FROM $BUILDER_IMAGE_TAG as builder
+ARG BUILDER_IMAGE_ALIAS=cdk-nextjs/builder:latest
+FROM $BUILDER_IMAGE_ALIAS AS builder
 # Production image, copy all the files and run next
-FROM public.ecr.aws/docker/library/node:22-alpine as runner
-ARG MOUNT_PATH
-COPY --from=public.ecr.aws/awsguru/aws-lambda-adapter:0.8.3 /lambda-adapter /opt/extensions/lambda-adapter
+FROM public.ecr.aws/docker/library/node:22-alpine AS runner
+COPY --from=public.ecr.aws/awsguru/aws-lambda-adapter:0.9.1 /lambda-adapter /opt/extensions/lambda-adapter
 WORKDIR /app
 
 ENV NODE_ENV production
@@ -16,26 +15,33 @@ ENV NODE_ENV production
 RUN addgroup --system --gid 1001 nodejs
 RUN adduser --system --uid 1001 nextjs
 
-ARG RELATIVE_PATH_TO_WORKSPACE
-COPY --from=builder --chown=nextjs:nodejs /app/$RELATIVE_PATH_TO_WORKSPACE/.next/standalone ./
-COPY --chown=nextjs:nodejs ./add-cache-handler.mjs ./cache-handler.cjs ./
+ARG RELATIVE_PATH_TO_PACKAGE
+COPY --from=builder --chown=nextjs:nodejs /app/$RELATIVE_PATH_TO_PACKAGE/.next/standalone ./
+# html,rsc,body,meta files don't need to be in compute container b/c they're handled by cdk-nextjs-cache-handler.cjs
+RUN find . -type f \( -name "*.html" -o -name "*.rsc" -name "*.body" -name "*.meta" \) -delete
+COPY --from=builder --chown=nextjs:nodejs /app/cdk-nextjs-cache-handler.cjs ./$RELATIVE_PATH_TO_PACKAGE/
+ARG BUILD_ID
+ARG CACHE_PATH
+ARG DATA_CACHE_PATH
+ARG IMAGE_CACHE_PATH
 ARG MOUNT_PATH
-ARG DATA_CACHE_DIR
-ARG FULL_ROUTE_CACHE_DIR
-ARG IMAGE_CACHE_DIR
-ARG PUBLIC_DIR
-RUN node add-cache-handler.mjs ./$RELATIVE_PATH_TO_WORKSPACE/.next/required-server-files.json && \
-  rm add-cache-handler.mjs && \
-  mkdir -p $MOUNT_PATH/$DATA_CACHE_DIR && \
-  mkdir -p $MOUNT_PATH/$FULL_ROUTE_CACHE_DIR && \
-  mkdir -p $MOUNT_PATH/$IMAGE_CACHE_DIR && \
-  mkdir -p $MOUNT_PATH/$PUBLIC_DIR && \
-  chmod -R u+rw $MOUNT_PATH && \
-  mkdir -p ./$RELATIVE_PATH_TO_WORKSPACE/.next/cache && \
-  ln -s $MOUNT_PATH/$DATA_CACHE_DIR ./$RELATIVE_PATH_TO_WORKSPACE/.next/cache/fetch-cache && \
-  ln -s $MOUNT_PATH/$IMAGE_CACHE_DIR ./$RELATIVE_PATH_TO_WORKSPACE/.next/cache/images && \
-  ln -s $MOUNT_PATH/$PUBLIC_DIR ./$RELATIVE_PATH_TO_WORKSPACE/public && \
-  ln -s $MOUNT_PATH/$FULL_ROUTE_CACHE_DIR ./$RELATIVE_PATH_TO_WORKSPACE/.next/server/app
+ARG PUBLIC_PATH
+RUN sed -i 's/"env":{},/"env":{},cacheHandler:"\.\.\/cdk-nextjs-cache-handler.cjs",/g' ./$RELATIVE_PATH_TO_PACKAGE/server.js && \
+  # locally in this docker image the paths where EFS will be mounted need to exist for symlinks to be made
+  mkdir -p $MOUNT_PATH/$BUILD_ID/$DATA_CACHE_PATH && \
+  mkdir -p $MOUNT_PATH/$BUILD_ID/$IMAGE_CACHE_PATH && \
+  mkdir -p $MOUNT_PATH/$BUILD_ID/$PUBLIC_PATH && \
+  # delete if exists so that symlinks can be made; image cache doesn't exist at build time
+  rm -rf ./$RELATIVE_PATH_TO_PACKAGE/$DATA_CACHE_PATH && \
+  rm -rf ./$RELATIVE_PATH_TO_PACKAGE/$PUBLIC_PATH && \
+  # create .next/cache if doesn't exist. won't exist if no cached fetch data.
+  mkdir -p ./$RELATIVE_PATH_TO_PACKAGE/$CACHE_PATH && \
+  # `ln -s <src_file> <target_file>` such that accessing <target_file> accesses <src_file>
+  ln -s $MOUNT_PATH/$BUILD_ID/$DATA_CACHE_PATH ./$RELATIVE_PATH_TO_PACKAGE/$DATA_CACHE_PATH && \
+  ln -s $MOUNT_PATH/$BUILD_ID/$IMAGE_CACHE_PATH ./$RELATIVE_PATH_TO_PACKAGE/$IMAGE_CACHE_PATH && \
+  ln -s $MOUNT_PATH/$BUILD_ID/$PUBLIC_PATH ./$RELATIVE_PATH_TO_PACKAGE/$PUBLIC_PATH && \
+  # chown needs to be at end after all files are added so that nextjs:nodejs can access all files
+  chown -R nextjs:nodejs $MOUNT_PATH/$BUILD_ID
 
 USER nextjs
 

package/lib/nextjs-build/nextjs-build.d.ts

@@ -1,7 +1,7 @@
 import { DockerImageAsset, Platform } from "aws-cdk-lib/aws-ecr-assets";
 import { AssetImageCodeProps, DockerImageCode } from "aws-cdk-lib/aws-lambda";
 import { Construct } from "constructs";
-import { NextjsType } from "../common";
+import { NextjsType } from "../constants";
 import { OptionalDockerImageAssetProps } from "../generated-structs/OptionalDockerImageAssetProps";
 import { NextjsBaseProps } from "../root-constructs/nextjs-base-props";
 export interface BuilderImageProps {
@@ -33,7 +33,8 @@ export interface BuilderImageProps {
      */
     readonly exclude?: string[];
     /**
-     * Name of Dockerfile
+     * Name of Dockerfile in builder build context. If specified, you are responsible
+     * for ensuring it exists in build context before construct is instantiated.
      * @default "builder.Dockerfile"
      */
     readonly file?: string;
@@ -43,16 +44,41 @@ export interface BuilderImageProps {
      * @default false
      */
     readonly skipBuild?: boolean;
-    /**
-     * Path to your custom builder.Dockerfile which will be copied into {@link NextBaseProps.buildContext}.
-     * It is recommended to override this prop to optimize build caching for your setup.
-     */
-    readonly customDockerfilePath?: string;
 }
 export interface NextjsBuildOverrides {
     readonly nextjsContainersDockerImageAssetProps?: OptionalDockerImageAssetProps;
     readonly nextjsFunctionsAssetImageCodeProps?: AssetImageCodeProps;
     readonly nextjsAssetDeploymentAssetImageCodeProps?: AssetImageCodeProps;
+    /**
+     * Default folder for build context is the "lib/nextjs-build" folder in the
+     * installed cdk-nextjs library which has the "global-functions.Dockerfile".
+     * Note, if you specify this then you're responsible for ensuring the dockerfile
+     * is present in the build context directory and any referenced files are
+     * present as well. You can specify dockerfile name with adjacent
+     * `nextjsFunctionsAssetImageCodeProps.file` property.
+     * @default "cdk-nextjs/lib/nextjs-build"
+     */
+    readonly functionsImageBuildContext?: string;
+    /**
+     * Default folder for build context is the "lib/nextjs-build" folder in the
+     * installed cdk-nextjs library which has the "assets-deployment.Dockerfile".
+     * Note, if you specify this then you're responsible for ensuring the dockerfile
+     * is present in the build context directory and any referenced files are
+     * present as well. You can specify dockerfile name with adjacent
+     * `nextjsAssetDeploymentAssetImageCodeProps.file` property.
+     * @default "cdk-nextjs/lib/nextjs-build"
+     */
+    readonly assetsDeploymentImageBuildContext?: string;
+    /**
+     * Default folder for build context is the "assets/lambdas/assets-deployment/assets-deployment.lambda" folder in the
+     * installed cdk-nextjs library which has the "{...}-containers.Dockerfile".
+     * Note, if you specify this then you're responsible for ensuring the dockerfile
+     * is present in the build context directory and any referenced files are
+     * present as well. You can specify dockerfile name with adjacent
+     * `nextjsContainersDockerImageAssetProps.file` property.
+     * @default "cdk-nextjs/lib/nextjs-build"
+     */
+    readonly containersImageBuildContext?: string;
 }
 export interface NextjsBuildProps {
     /**
@@ -68,9 +94,9 @@ export interface NextjsBuildProps {
      */
     readonly builderImageProps?: BuilderImageProps;
     /**
-     * @see {@link NextjsBaseProps.relativePathToWorkspace}
+     * @see {@link NextjsBaseProps.relativePathToPackage}
      */
-    readonly relativePathToWorkspace?: NextjsBaseProps["relativePathToWorkspace"];
+    readonly relativePathToPackage?: NextjsBaseProps["relativePathToPackage"];
     readonly nextjsType: NextjsType;
     readonly overrides?: NextjsBuildOverrides;
 }
@@ -83,22 +109,23 @@ export interface PublicDirEntry {
  * @link https://nextjs.org/docs/pages/api-reference/next-config-js/output
  */
 export declare class NextjsBuild extends Construct {
+    /**
+     * Image alias of builder image Next.js app which is built for other images to be
+     * built `FROM`. This image isn't built with CDK Assets construct b/c it
+     * doesn't need to be uploaded to ECR. We still need to include slice of
+     * `node.addr` in tag in case multiple cdk-nextjs constructs are used.
+     */
+    builderImageAlias: string;
+    /**
+     * Unique id for Next.js build. Used to partition EFS FileSystem.
+     */
+    buildId: string;
     /**
      * Hash of builder image which will change whenever the image changes. Useful
      * for passing to properties of custom resources that depend upon the builder
      * image to re-run when build image changes.
      */
     buildImageDigest: string;
-    /**
-     * Mount path in container for EFS. Next.js image optimization, data, and full
-     * route cache will be symlinked to this location.
-     *
-     * Must comply with pattern: ^/mnt/[a-zA-Z0-9-_.]+$ due to lambda requirement.
-     * Fargate doesn't have this same requirement but we share code for lambda and
-     * fargate.
-     * @see https://docs.aws.amazon.com/lambda/latest/api/API_FileSystemConfig.html
-     */
-    containerMountPathForEfs: string;
     /**
      * Docker image built if using Fargate.
      */
@@ -124,15 +151,12 @@ export declare class NextjsBuild extends Construct {
      */
     relativePathToEntrypoint: string;
     /**
-     * Tag of builder image Next.js app which is built for other images to be
-     * built `FROM`. This image isn't built with CDK Assets construct b/c it
-     * doesn't need to be uploaded to ECR. We still need to include slice of
-     * `node.addr` in tag in case multiple cdk-nextjs constructs are used.
+     * Repository name for the builder image.
      */
-    private builderImageTag;
+    private builderImageRepo;
     private containerRuntime;
     private props;
-    private relativePathToWorkspace;
+    private relativePathToPackage;
     constructor(scope: Construct, id: string, props: NextjsBuildProps);
     private getRelativeEntrypointPath;
     /**
@@ -142,10 +166,11 @@ export declare class NextjsBuild extends Construct {
      * it with `execSync` and other images will be built `FROM` it.
      */
     private createBuilderImage;
+    private injectBuilderDockerfileEnvVars;
     private createBuildArgStr;
-    private createLoadEnvVarsScript;
     private getBuilderImageDigest;
     private getPublicDirEntries;
+    private getBuildId;
     private createImageForNextjsContainers;
     private createImageForNextjsFunctions;
     private createImageForNextjsAssetsDeployment;