serverless-nextjs/serverless-next.js

CDK Construct - S3 Deployment stage missing `basePath`

Open

Aperta il 2 set 2021

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)TypeScript (3998 star) (447 fork)batch import
good first issue

Descrizione

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) });

Guida contributor

Tech stack
typescriptnextjsnodejsaws
Dominio
clouddevops
Tipo issue
bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
under 1 hour
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
Basic TypeScriptNext.js configuration basicsFamiliarity with serverless nextjs CDK
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85
Direzione di ricerca
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`.