serverless-nextjs/serverless-next.js

CDK Construct - S3 Deployment stage missing `basePath`

Open

#1620 opened on Sep 2, 2021

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (3,998 stars) (447 forks)batch import
good first issue

Description

If basePath is set in next.config.js, the build would put static assets within ${sererlessBuildOutDir}/assets/${basePath}.

However, in the CDK construct (NextJSLambdaEdge), it tries to read the assets from ${sererlessBuildOutDir}/assets without including the basePath

https://github.com/serverless-nextjs/serverless-next.js/blob/145c16d9e163aca7b5f6a753f60404363c842b8f/packages/serverless-components/nextjs-cdk-construct/src/index.ts#L404

The function returns with an empty assets object leading to none of the assets being uploaded.

Similar code in s3-static-assets handle this correctly

https://github.com/serverless-nextjs/serverless-next.js/blob/145c16d9e163aca7b5f6a753f60404363c842b8f/packages/libs/s3-static-assets/src/index.ts#L67

The fix looks relatively straight forward and it works for my use case.

const { basePath } = this.routesManifest || {};
const normalizedBasePath = basePath && basePath.length > 0? basePath.slice(1) : "";
const assets = readAssetsDirectory({ assetsDirectory: path.join(assetsDirectory, normalizedBasePath) });

Contributor guide

Tech stack
typescriptnextjsnodejsaws
Domain
clouddevops
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic TypeScriptNext.js configuration basicsFamiliarity with serverless nextjs CDK
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Start by examining the two files linked in the issue: `packages/serverless components/nextjs cdk construct/src/index.ts` (line 404) and `packages/libs/s3 static assets/src/index.ts` (line 67). The fix involves reading the `basePath` from `routesManifest` and adjusting the asset directory path accordingly. The proposed code snippet in the issue is a good starting point. After making the change, ensure to test with a project that uses a custom `basePath` in `next.config.js`.