Help with build args

[corbinabeebe]

Hi!

I am running into an error where the docker build can't find the package-lock.json file. Im wondering if I have the build context url wrong or if I am passing in the wrong relative path.

Can someone help me understand what the buildContext and relativePathToWorkspace path are referring to so I can ensure to set these appropriately?

Thanks!

[corbinabeebe]

Wow, rookie mistake. Found that I was up too many directories!

[coltenkrauter]

Ah ya, that will get you. 🥇

[corbinabeebe]

@coltenkrauter, ok, I think this might be another build path issue but failing at the RUN cd $RELATIVE_PATH_TO_WORKSPACE && $BUILD_COMMAND command.

I have tried to set relativePathToWorkspace='./my-next-project I also tried using ../my-next-project. But the same erorr persists:

This is the error:

 => ERROR [7/8] RUN cd ./my-next-project && npm run build                                                                                                            0.2s 
------                                                                                                                                                                      
 > [7/8] RUN cd ./my-next-project && npm run build:                                                                                                                       
0.174                                                                                                                                                                       
0.174 > [email protected] build                                                                                                                                       
0.174 > next build
0.174 
0.178 sh: next: not found
------
builder.Dockerfile:23
--------------------
  21 |     ARG RELATIVE_PATH_TO_WORKSPACE
  22 |     RUN if [ -f ./cdk-nextjs-load-env-vars.sh ]; then chmod u+x ./cdk-nextjs-load-env-vars.sh && . ./cdk-nextjs-load-env-vars.sh; fi
  23 | >>> RUN cd $RELATIVE_PATH_TO_WORKSPACE && $BUILD_COMMAND
  24 |     # after building, node_modules aren't needed anymore. this reduces image size by over 50mb
  25 |     RUN rm -rf node_modules
--------------------
ERROR: failed to solve: process "/bin/sh -c cd $RELATIVE_PATH_TO_WORKSPACE && $BUILD_COMMAND" did not complete successfully: exit code: 127
node:internal/errors:984
  const err = new Error(message);
              ^

Error: Command failed: docker build  --file builder.Dockerfile --tag cdk-nextjs/builder-a7104880f665  --build-arg BUILD_COMMAND="npm run build" --build-arg RELATIVE_PATH_TO_WORKSPACE="./my-next-project" .
    at genericNodeError (node:internal/errors:984:15)
    at wrappedFn (node:internal/errors:538:14)
    at checkExecSyncError (node:child_process:891:11)
    at execSync (node:child_process:963:15)
    at NextjsBuild.createBuilderImage (/Users/username/code/monorepo/cdk/node_modules/cdk-nextjs/src/nextjs-build/nextjs-build.ts:227:17)
    at new NextjsBuild (/Users/username/code/monorepo/cdk/node_modules/cdk-nextjs/src/nextjs-build/nextjs-build.ts:157:34)
    at NextjsGlobalContainers.createNextjsBuild (/Users/username/code/monorepo/cdk/node_modules/cdk-nextjs/src/root-constructs/nextjs-global-containers.ts:111:12)
    at new NextjsGlobalContainers (/Users/username/code/monorepo/cdk/node_modules/cdk-nextjs/src/root-constructs/nextjs-global-containers.ts:96:29)
    at new GlobalContainersStack (/Users/username/code/monorepo/cdk/app.ts:21:20)
    at <anonymous> (/Users/username/code/monorepo/cdk/app.ts:90:15) {
  status: 1,
  signal: null,
  output: [ null, null, null ],
  pid: 43191,
  stdout: null,
  stderr: null
}

Node.js v20.18.1
[11:34:33] failed command: pnpm tsx app.ts
[11:34:33] Reading cached notices from /Users/username/.cdk/cache/notices.json
Subprocess exited with error 1
[11:34:33] Error: Subprocess exited with error 1
    at ChildProcess.<anonymous> (/opt/homebrew/lib/node_modules/aws-cdk/lib/index.js:571:49342)
    at ChildProcess.emit (node:events:518:28)
    at ChildProcess.emit (node:domain:489:12)
    at ChildProcess._handle.onexit (node:internal/child_process:293:12)

I am a bit at a loss on how to move forward. If you need me to open a new discussion/issue just let me know!

Thanks!

[coltenkrauter]

Looks like you got it sorted per the lower comment. 🥳

[coltenkrauter]

The buildContext should point to the root directory of your Next.js app (where package.json and package-lock.json are located).

This is the base directory Docker uses to build your application. In the case of NextjsGlobalFunctions, the buildContext ensures Docker can locate the app's source files for packaging and deployment.

---

Examples

Monorepo Example

project/  
├── infra/            # Infrastructure code  
│   ├── deploy-app.ts # CDK file to deploy the app  
├── app/              # Next.js app  
│   ├── package.json  
│   ├── package-lock.json  
│   ├── Dockerfile  

deploy-app.ts:

// ESM example
import { Stack, StackProps } from 'aws-cdk-lib'
import { Construct } from 'constructs'
import { NextjsGlobalFunctions } from 'cdk-nextjs'
import { fileURLToPath } from 'url'

export class DeployAppStack extends Stack {
    constructor(scope: Construct, id: string, props?: StackProps) {
        super(scope, id, props)

        new NextjsGlobalFunctions(this, 'NextApp', {
            buildContext: fileURLToPath(new URL('../app', import.meta.url)),
            healthCheckPath: '/api/health',
        })
    }
}

In this case:

• buildContext: ../app (relative to the deploy-app.ts file)

Non-Monorepo Example

infra/               # Infrastructure code  
├── deploy-app.ts    # CDK file to deploy the app  
app/             # Next.js app  
├── package.json  
├── package-lock.json  

deploy-app.ts:

// ESM example
import { Stack, StackProps } from 'aws-cdk-lib'
import { Construct } from 'constructs'
import { NextjsGlobalFunctions } from 'cdk-nextjs'
import { fileURLToPath } from 'url'

export class DeployAppStack extends Stack {
    constructor(scope: Construct, id: string, props?: StackProps) {
        super(scope, id, props)

        new NextjsGlobalFunctions(this, 'NextApp', {
            buildContext: fileURLToPath(new URL('../app', import.meta.url)),
            healthCheckPath: '/api/health',
        })
    }
}

In this case:

• buildContext: ../app (relative to the deploy-app.ts file)

---

These examples are loosely based on what I am doing. That said, obviously with a different directory structure, a different relative path may be necessary.

[corbinabeebe]

Ahh! I see what was wrong, I dont need to set: relativePathToWorkspace b/c I am not using mono repo. This was very helpful Ty!