Merge pull request #159 from zeabur/yuaanlin/nodejs-layer-caching

perf(planner/node.js): Enable Node.js layer caching for install deps
zeabur · Oct 20, 2023 · d169c3d · d169c3d
2 parents 10630d3 + 403167c
commit d169c3d
Show file tree

Hide file tree

Showing 5 changed files with 41 additions and 32 deletions.
diff --git a/internal/nodejs/__snapshots__/template_test.snap b/internal/nodejs/__snapshots__/template_test.snap
@@ -6,10 +6,11 @@ ENV PORT=8080
 WORKDIR /src
 
 RUN corepack enable && corepack prepare --all
-COPY . .
 
 RUN yarn install
 
+COPY . .
+
 # Build if we can build it
 
 
@@ -25,10 +26,11 @@ ENV PORT=8080
 WORKDIR /src
 
 RUN corepack enable && corepack prepare --all
-COPY . .
 
 RUN yarn install
 
+COPY . .
+
 # Build if we can build it
 
 
@@ -44,10 +46,11 @@ ENV PORT=8080
 WORKDIR /src
 
 RUN corepack enable && corepack prepare --all
-COPY . .
 
 RUN yarn install
 
+COPY . .
+
 # Build if we can build it
 
 
@@ -63,10 +66,11 @@ ENV PORT=8080
 WORKDIR /src
 
 RUN corepack enable && corepack prepare --all
-COPY . .
 
 RUN yarn install
 
+COPY . .
+
 # Build if we can build it
 RUN yarn build
 
@@ -82,10 +86,11 @@ ENV PORT=8080
 WORKDIR /src
 
 RUN corepack enable && corepack prepare --all
-COPY . .
 
 RUN yarn install
 
+COPY . .
+
 # Build if we can build it
 RUN yarn build
 
@@ -107,10 +112,11 @@ COPY --from=bun-runtime /usr/local/bin/bun /usr/local/bin
 COPY --from=bun-runtime /usr/local/bin/bunx /usr/local/bin
 
 RUN corepack enable && corepack prepare --all
-COPY . .
 
 RUN bun install
 
+COPY . .
+
 # Build if we can build it
 
 

diff --git a/internal/nodejs/node_test.go b/internal/nodejs/node_test.go
@@ -11,14 +11,14 @@ import (
 func TestGetContextBasedOnMeta_MapShouldBeCorrect(t *testing.T) {
 	meta := getContextBasedOnMeta(types.PlanMeta{
 		"nodeVersion": "16",
-		"installCmd":  "npm install",
+		"installCmd":  "RUN npm install",
 		"buildCmd":    "npm run build",
 		"startCmd":    "npm run start",
 	})
 
 	assert.Equal(t, meta, TemplateContext{
 		NodeVersion: "16",
-		InstallCmd:  "npm install",
+		InstallCmd:  "RUN npm install",
 		BuildCmd:    "npm run build",
 		StartCmd:    "npm run start",
 	})
@@ -27,7 +27,7 @@ func TestGetContextBasedOnMeta_MapShouldBeCorrect(t *testing.T) {
 func TestGetContextBasedOnMeta_WithOutputdirAndSPAFramework(t *testing.T) {
 	meta := getContextBasedOnMeta(types.PlanMeta{
 		"nodeVersion": "16",
-		"installCmd":  "npm install",
+		"installCmd":  "RUN npm install",
 		"buildCmd":    "npm run build",
 		"startCmd":    "npm run start",
 		"outputDir":   "dist",
@@ -36,7 +36,7 @@ func TestGetContextBasedOnMeta_WithOutputdirAndSPAFramework(t *testing.T) {
 
 	assert.Equal(t, meta, TemplateContext{
 		NodeVersion: "16",
-		InstallCmd:  "npm install",
+		InstallCmd:  "RUN npm install",
 		BuildCmd:    "npm run build",
 		StartCmd:    "npm run start",
 	})
@@ -45,7 +45,7 @@ func TestGetContextBasedOnMeta_WithOutputdirAndSPAFramework(t *testing.T) {
 func TestGetContextBasedOnMeta_WithOutputdirAndMPAFramework(t *testing.T) {
 	meta := getContextBasedOnMeta(types.PlanMeta{
 		"nodeVersion": "16",
-		"installCmd":  "npm install",
+		"installCmd":  "RUN npm install",
 		"buildCmd":    "npm run build",
 		"startCmd":    "npm run start",
 		"outputDir":   "dist",
@@ -54,7 +54,7 @@ func TestGetContextBasedOnMeta_WithOutputdirAndMPAFramework(t *testing.T) {
 
 	assert.Equal(t, meta, TemplateContext{
 		NodeVersion: "16",
-		InstallCmd:  "npm install",
+		InstallCmd:  "RUN npm install",
 		BuildCmd:    "npm run build",
 		StartCmd:    "npm run start",
 	})

diff --git a/internal/nodejs/plan.go b/internal/nodejs/plan.go
@@ -439,34 +439,36 @@ func GetInstallCmd(ctx *nodePlanContext) string {
 	}
 
 	pkgManager := DeterminePackageManager(ctx)
-	var installCmd string
+	cmds := []string{"COPY package.json* tsconfig.json* .npmrc* ."}
 	switch pkgManager {
 	case types.NodePackageManagerNpm:
-		installCmd = "npm install"
+		cmds = append(cmds, "COPY package-lock.json* .", "RUN npm install")
 	case types.NodePackageManagerPnpm:
-		installCmd = "pnpm install"
+		cmds = append(cmds, "COPY pnpm-lock.yaml* .", "RUN pnpm install")
 	case types.NodePackageManagerBun:
-		installCmd = "bun install"
+		cmds = append(cmds, "COPY bun.lockb* .", "RUN bun install")
 	case types.NodePackageManagerYarn:
-		fallthrough
+		cmds = append(cmds, "COPY yarn.lock* .", "RUN yarn install")
 	default:
-		installCmd = "yarn install"
+		cmds = append(cmds, "RUN yarn install")
 	}
 
 	needPlaywright := DetermineNeedPlaywright(ctx)
 	if needPlaywright {
-		installCmd = `apt-get update && apt-get install -y libnss3 libatk1.0-0 libatk-bridge2.0-0 libcups2 libdbus-1-3 libdrm2 libxkbcommon-x11-0 libxcomposite-dev libxdamage1 libxfixes-dev libxrandr2 libgbm-dev libasound2 && ` + installCmd
+		cmds = append([]string{
+			"RUN apt-get update && apt-get install -y libnss3 libatk1.0-0 libatk-bridge2.0-0 libcups2 libdbus-1-3 libdrm2 libxkbcommon-x11-0 libxcomposite-dev libxdamage1 libxfixes-dev libxrandr2 libgbm-dev libasound2",
+		}, cmds...)
 	}
 
 	needPuppeteer := DetermineNeedPuppeteer(ctx)
 	if needPuppeteer {
-		installCmd = `apt-get update
-RUN apt-get install -y libnss3 libatk1.0-0 libatk-bridge2.0-0 libcups2 libgbm1 libasound2 libpangocairo-1.0-0 libxss1 libgtk-3-0 libxshmfence1 libglu1
-ENV PUPPETEER_CACHE_DIR=/src/.cache/puppeteer
-RUN ` + installCmd
+		cmds = append([]string{
+			"RUN apt-get update && apt-get install -y libnss3 libatk1.0-0 libatk-bridge2.0-0 libcups2 libgbm1 libasound2 libpangocairo-1.0-0 libxss1 libgtk-3-0 libxshmfence1 libglu1",
+			"ENV PUPPETEER_CACHE_DIR=/src/.cache/puppeteer",
+		}, cmds...)
 	}
 
-	*cmd = optional.Some(installCmd)
+	*cmd = optional.Some(strings.Join(cmds, "\n"))
 	return cmd.Unwrap()
 }
 

diff --git a/internal/nodejs/template_test.go b/internal/nodejs/template_test.go
@@ -12,7 +12,7 @@ func TestTemplate_NBuildCmd_NOutputDir(t *testing.T) {
 	ctx := nodejs.TemplateContext{
 		NodeVersion: "18",
 
-		InstallCmd: "yarn install",
+		InstallCmd: "RUN yarn install",
 		BuildCmd:   "",
 		StartCmd:   "yarn start",
 	}
@@ -26,7 +26,7 @@ func TestTemplate_NBuildCmd_OutputDir_NSPA(t *testing.T) {
 	ctx := nodejs.TemplateContext{
 		NodeVersion: "18",
 
-		InstallCmd: "yarn install",
+		InstallCmd: "RUN yarn install",
 		BuildCmd:   "",
 		StartCmd:   "yarn start",
 	}
@@ -40,7 +40,7 @@ func TestTemplate_NBuildCmd_OutputDir_SPA(t *testing.T) {
 	ctx := nodejs.TemplateContext{
 		NodeVersion: "18",
 
-		InstallCmd: "yarn install",
+		InstallCmd: "RUN yarn install",
 		BuildCmd:   "",
 		StartCmd:   "yarn start",
 	}
@@ -54,7 +54,7 @@ func TestTemplate_BuildCmd_NOutputDir(t *testing.T) {
 	ctx := nodejs.TemplateContext{
 		NodeVersion: "18",
 
-		InstallCmd: "yarn install",
+		InstallCmd: "RUN yarn install",
 		BuildCmd:   "yarn build",
 		StartCmd:   "yarn start",
 	}
@@ -68,7 +68,7 @@ func TestTemplate_BuildCmd_OutputDir(t *testing.T) {
 	ctx := nodejs.TemplateContext{
 		NodeVersion: "18",
 
-		InstallCmd: "yarn install",
+		InstallCmd: "RUN yarn install",
 		BuildCmd:   "yarn build",
 		StartCmd:   "yarn start",
 	}
@@ -82,7 +82,7 @@ func TestTemplate_BuildCmd_Bun(t *testing.T) {
 	ctx := nodejs.TemplateContext{
 		Bun:         true,
 		NodeVersion: "18",
-		InstallCmd:  "bun install",
+		InstallCmd:  "RUN bun install",
 		StartCmd:    "bun start main.ts",
 	}
 

diff --git a/internal/nodejs/templates/template.Dockerfile b/internal/nodejs/templates/template.Dockerfile
@@ -15,9 +15,10 @@ COPY --from=bun-runtime /usr/local/bin/bunx /usr/local/bin
 {{- end }}
 
 RUN corepack enable && corepack prepare --all
-COPY . .
 
-RUN {{ .InstallCmd }}
+{{ .InstallCmd }}
+
+COPY . .
 
 # Build if we can build it
 {{ if .BuildCmd }}RUN {{ .BuildCmd }}{{ end }}