Skip to content

Commit 994be8e

Browse files
lukasholzerlukasholzer
authoredFeb 9, 2024
feat: support nx integrated setups inside runtime (#251)
* feat: support nx integrated setups inside runtime * chore: update * chore: update * chore: fix last test
·
v5.10.2v5.0.0-beta.9
1 parent ece5542 commit 994be8e

29 files changed

+6180
-82
lines changed
 

‎src/build/content/server.ts

+11
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,17 @@ import { PluginContext } from '../plugin-context.js'
1212
* Copy App/Pages Router Javascript needed by the server handler
1313
*/
1414
export const copyNextServerCode = async (ctx: PluginContext): Promise<void> => {
15+
// update the dist directory inside the required-server-files.json to work with
16+
// nx monorepos and other setups where the dist directory is modified
17+
const reqServerFilesPath = join(ctx.standaloneDir, '.next/required-server-files.json')
18+
const reqServerFiles = JSON.parse(await readFile(reqServerFilesPath, 'utf-8'))
19+
20+
// only override it if it was set before to a different value
21+
if (reqServerFiles.config.distDir) {
22+
reqServerFiles.config.distDir = '.next'
23+
await writeFile(reqServerFilesPath, JSON.stringify(reqServerFiles))
24+
}
25+
1526
const srcDir = join(ctx.standaloneDir, '.next')
1627
const destDir = join(ctx.serverHandlerDir, '.next')
1728

‎src/build/functions/server.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ const getHandlerFile = async (ctx: PluginContext): Promise<string> => {
5353
const template = await readFile(join(templatesDir, 'handler-monorepo.tmpl.js'), 'utf-8')
5454

5555
return template
56-
.replaceAll('{{cwd}}', join('/var/task', ctx.packagePath))
56+
.replaceAll('{{cwd}}', ctx.lambdaWorkingDirectory)
5757
.replace('{{nextServerHandler}}', ctx.nextServerHandler)
5858
}
5959

‎src/build/plugin-context.ts

+23-4
Original file line numberDiff line numberDiff line change
@@ -65,11 +65,15 @@ export class PluginContext {
6565
/** Absolute path of the next runtime plugin directory */
6666
pluginDir = PLUGIN_DIR
6767

68+
get relPublishDir(): string {
69+
return this.constants.PUBLISH_DIR ?? '.next'
70+
}
71+
6872
/** Absolute path of the publish directory */
6973
get publishDir(): string {
7074
// Does not need to be resolved with the package path as it is always a repository absolute path
7175
// hence including already the `PACKAGE_PATH` therefore we don't use the `this.resolve`
72-
return resolve(this.constants.PUBLISH_DIR)
76+
return resolve(this.relPublishDir)
7377
}
7478

7579
/**
@@ -81,6 +85,13 @@ export class PluginContext {
8185
return this.constants.PACKAGE_PATH || ''
8286
}
8387

88+
/**
89+
* The working directory inside the lambda that is used for monorepos to execute the serverless function
90+
*/
91+
get lambdaWorkingDirectory(): string {
92+
return join('/var/task', this.relPublishDir.replace(/\.next$/, ''))
93+
}
94+
8495
/**
8596
* Retrieves the root of the `.next/standalone` directory
8697
*/
@@ -90,7 +101,12 @@ export class PluginContext {
90101

91102
/** Retrieves the `.next/standalone/` directory monorepo aware */
92103
get standaloneDir(): string {
93-
return join(this.standaloneRootDir, this.constants.PACKAGE_PATH || '')
104+
// the standalone directory mimics the structure of the publish directory
105+
// that said if the publish directory is `apps/my-app/.next` the standalone directory will be `.next/standalone/apps/my-app`
106+
// if the publish directory is .next the standalone directory will be `.next/standalone`
107+
// for nx workspaces where the publish directory is on the root of the repository
108+
// like `dist/apps/my-app/.next` the standalone directory will be `.next/standalone/dist/apps/my-app`
109+
return join(this.standaloneRootDir, this.relPublishDir.replace(/\.next$/, ''))
94110
}
95111

96112
/**
@@ -124,11 +140,14 @@ export class PluginContext {
124140
}
125141

126142
get serverHandlerDir(): string {
127-
return join(this.serverHandlerRootDir, this.constants.PACKAGE_PATH || '')
143+
return join(this.serverHandlerRootDir, this.relPublishDir.replace(/\.next$/, '') || '')
128144
}
129145

130146
get nextServerHandler(): string {
131-
return join(this.constants.PACKAGE_PATH || '', 'dist/run/handlers/server.js')
147+
if (this.packagePath.length !== 0) {
148+
return join(this.lambdaWorkingDirectory, 'dist/run/handlers/server.js')
149+
}
150+
return './dist/run/handlers/server.js'
132151
}
133152

134153
/**

‎src/build/templates/handler-monorepo.tmpl.js

+33-30
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import tracing, { trace } from '{{cwd}}/dist/run/handlers/tracing.js'
1+
import tracing, { trace } from '{{cwd}}dist/run/handlers/tracing.js'
22

33
process.chdir('{{cwd}}')
44

@@ -8,36 +8,39 @@ export default async function (req, context) {
88
tracing.start()
99
}
1010

11-
return trace
12-
.getTracer('Next.js Runtime')
13-
.startActiveSpan('Next.js Server Handler', async (span) => {
14-
try {
15-
span.setAttributes({
16-
'account.id': context.account.id,
17-
'deploy.id': context.deploy.id,
18-
'request.id': context.requestId,
19-
'site.id': context.site.id,
20-
'http.method': req.method,
21-
'http.target': req.url,
22-
monorepo: true,
23-
cwd: '{{cwd}}',
24-
})
25-
if (!cachedHandler) {
26-
const { default: handler } = await import('./{{nextServerHandler}}')
27-
cachedHandler = handler
28-
}
29-
const response = await cachedHandler(req, context)
30-
span.setAttributes({
31-
'http.status_code': response.status,
32-
})
33-
return response
34-
} catch (error) {
35-
span.recordException(error)
36-
throw error
37-
} finally {
38-
span.end()
11+
/** @type {import('@opentelemetry/api').Tracer} */
12+
const tracer = trace.getTracer('Next.js Runtime')
13+
return tracer.startActiveSpan('Next.js Server Handler', async (span) => {
14+
try {
15+
span.setAttributes({
16+
'account.id': context.account.id,
17+
'deploy.id': context.deploy.id,
18+
'request.id': context.requestId,
19+
'site.id': context.site.id,
20+
'http.method': req.method,
21+
'http.target': req.url,
22+
monorepo: true,
23+
cwd: '{{cwd}}',
24+
})
25+
if (!cachedHandler) {
26+
const { default: handler } = await import('{{nextServerHandler}}')
27+
cachedHandler = handler
3928
}
40-
})
29+
const response = await cachedHandler(req, context)
30+
span.setAttributes({
31+
'http.status_code': response.status,
32+
})
33+
return response
34+
} catch (error) {
35+
span.recordException(error)
36+
if (error instanceof Error) {
37+
span.addEvent({ name: error.name, message: error.message })
38+
}
39+
throw error
40+
} finally {
41+
span.end()
42+
}
43+
})
4144
}
4245

4346
export const config = {

‎src/build/templates/handler.tmpl.js

+29-23
Original file line numberDiff line numberDiff line change
@@ -5,30 +5,36 @@ export default async function handler(req, context) {
55
if (process.env.NETLIFY_OTLP_TRACE_EXPORTER_URL) {
66
tracing.start()
77
}
8-
return trace
9-
.getTracer('Next.js Runtime')
10-
.startActiveSpan('Next.js Server Handler', async (span) => {
11-
try {
12-
span.setAttributes({
13-
'account.id': context.account.id,
14-
'deploy.id': context.deploy.id,
15-
'request.id': context.requestId,
16-
'site.id': context.site.id,
17-
'http.method': req.method,
18-
'http.target': req.url,
19-
})
20-
const response = await serverHandler(req, context)
21-
span.setAttributes({
22-
'http.status_code': response.status,
23-
})
24-
return response
25-
} catch (error) {
26-
span.recordException(error)
27-
throw error
28-
} finally {
29-
span.end()
8+
9+
/** @type {import('@opentelemetry/api').Tracer} */
10+
const tracer = trace.getTracer('Next.js Runtime')
11+
return tracer.startActiveSpan('Next.js Server Handler', async (span) => {
12+
try {
13+
span.setAttributes({
14+
'account.id': context.account.id,
15+
'deploy.id': context.deploy.id,
16+
'request.id': context.requestId,
17+
'site.id': context.site.id,
18+
'http.method': req.method,
19+
'http.target': req.url,
20+
monorepo: false,
21+
cwd: process.cwd(),
22+
})
23+
const response = await serverHandler(req, context)
24+
span.setAttributes({
25+
'http.status_code': response.status,
26+
})
27+
return response
28+
} catch (error) {
29+
span.recordException(error)
30+
if (error instanceof Error) {
31+
span.addEvent({ name: error.name, message: error.message })
3032
}
31-
})
33+
throw error
34+
} finally {
35+
span.end()
36+
}
37+
})
3238
}
3339

3440
export const config = {

‎src/run/handlers/server.ts

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { toComputeResponse, toReqRes } from '@fastly/http-compute-js'
2-
import { trace } from '@opentelemetry/api'
2+
import { SpanStatusCode, trace } from '@opentelemetry/api'
33
import type { NextConfigComplete } from 'next/dist/server/config-shared.js'
44
import type { WorkerRequestHandler } from 'next/dist/server/lib/types.js'
55

@@ -59,6 +59,13 @@ export default async (request: Request) => {
5959
logger.withError(error).error('next handler error')
6060
console.error(error)
6161
resProxy.statusCode = 500
62+
span.recordException(error)
63+
span.setAttribute('http.status_code', 500)
64+
span.setStatus({
65+
code: SpanStatusCode.ERROR,
66+
message: error instanceof Error ? error.message : String(error),
67+
})
68+
span.end()
6269
resProxy.end('Internal Server Error')
6370
})
6471

‎tests/e2e/nx-integrated.test.ts

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
import { expect } from '@playwright/test'
2+
import { test } from '../utils/create-e2e-fixture.js'
3+
4+
test('Renders the Home page correctly', async ({ page, nxIntegrated }) => {
5+
await page.goto(nxIntegrated.url)
6+
7+
await expect(page).toHaveTitle('Welcome to next-app')
8+
9+
const h1 = page.locator('h1')
10+
await expect(h1).toHaveText('Hello there,\nWelcome next-app 👋')
11+
})

‎tests/fixtures/nx-integrated/.gitignore

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# See http://help.github.com/ignore-files/ for more about ignoring files.
2+
3+
# compiled output
4+
dist
5+
tmp
6+
/out-tsc
7+
8+
# dependencies
9+
node_modules
10+
11+
# IDEs and editors
12+
/.idea
13+
.project
14+
.classpath
15+
.c9/
16+
*.launch
17+
.settings/
18+
*.sublime-workspace
19+
20+
# IDE - VSCode
21+
.vscode/*
22+
!.vscode/settings.json
23+
!.vscode/tasks.json
24+
!.vscode/launch.json
25+
!.vscode/extensions.json
26+
27+
# misc
28+
/.sass-cache
29+
/connect.lock
30+
/coverage
31+
/libpeerconnection.log
32+
npm-debug.log
33+
yarn-error.log
34+
testem.log
35+
/typings
36+
37+
# System Files
38+
.DS_Store
39+
Thumbs.db
40+
41+
.nx/cache
42+
43+
# Next.js
44+
.next
45+
46+
# Local Netlify folder
47+
.netlify

‎tests/fixtures/nx-integrated/.npmrc

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
strict-peer-dependencies=false
2+
auto-install-peers=true
3+
public-hoist-pattern[]=*

‎tests/fixtures/nx-integrated/apps/next-app/app/api/hello/route.ts

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
export async function GET(request: Request) {
2+
return new Response('Hello, from API!');
3+
}

‎tests/fixtures/nx-integrated/apps/next-app/app/global.css

+409
Large diffs are not rendered by default.

‎tests/fixtures/nx-integrated/apps/next-app/app/layout.tsx

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
import './global.css';
2+
3+
export const metadata = {
4+
title: 'Welcome to next-app',
5+
description: 'Generated by create-nx-workspace',
6+
};
7+
8+
export default function RootLayout({
9+
children,
10+
}: {
11+
children: React.ReactNode;
12+
}) {
13+
return (
14+
<html lang="en">
15+
<body>{children}</body>
16+
</html>
17+
);
18+
}

‎tests/fixtures/nx-integrated/apps/next-app/app/page.module.css

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.page {
2+
}

‎tests/fixtures/nx-integrated/apps/next-app/app/page.tsx

+450
Large diffs are not rendered by default.

‎tests/fixtures/nx-integrated/apps/next-app/index.d.ts

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
/* eslint-disable @typescript-eslint/no-explicit-any */
2+
declare module '*.svg' {
3+
const content: any;
4+
export const ReactComponent: any;
5+
export default content;
6+
}

‎tests/fixtures/nx-integrated/apps/next-app/next-env.d.ts

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/// <reference types="next" />
2+
/// <reference types="next/image-types/global" />
3+
4+
// NOTE: This file should not be edited
5+
// see https://nextjs.org/docs/basic-features/typescript for more information.

‎tests/fixtures/nx-integrated/apps/next-app/next.config.js

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
//@ts-check
2+
3+
// eslint-disable-next-line @typescript-eslint/no-var-requires
4+
const { composePlugins, withNx } = require('@nx/next');
5+
6+
/**
7+
* @type {import('@nx/next/plugins/with-nx').WithNxOptions}
8+
**/
9+
const nextConfig = {
10+
nx: {
11+
// Set this to true if you would like to use SVGR
12+
// See: https://github.com/gregberge/svgr
13+
svgr: false,
14+
},
15+
};
16+
17+
const plugins = [
18+
// Add more Next.js plugins to this list if needed.
19+
withNx,
20+
];
21+
22+
module.exports = composePlugins(...plugins)(nextConfig);

‎tests/fixtures/nx-integrated/apps/next-app/project.json

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
{
2+
"name": "next-app",
3+
"$schema": "../../node_modules/nx/schemas/project-schema.json",
4+
"sourceRoot": "apps/next-app",
5+
"projectType": "application",
6+
"targets": {
7+
"build": {
8+
"executor": "@nx/next:build",
9+
"outputs": ["{options.outputPath}"],
10+
"defaultConfiguration": "production",
11+
"options": {
12+
"outputPath": "dist/apps/next-app"
13+
},
14+
"configurations": {
15+
"development": {
16+
"outputPath": "apps/next-app"
17+
},
18+
"production": {}
19+
}
20+
},
21+
"serve": {
22+
"executor": "@nx/next:server",
23+
"defaultConfiguration": "development",
24+
"options": {
25+
"buildTarget": "next-app:build",
26+
"dev": true
27+
},
28+
"configurations": {
29+
"development": {
30+
"buildTarget": "next-app:build:development",
31+
"dev": true
32+
},
33+
"production": {
34+
"buildTarget": "next-app:build:production",
35+
"dev": false
36+
}
37+
}
38+
},
39+
"export": {
40+
"executor": "@nx/next:export",
41+
"options": {
42+
"buildTarget": "next-app:build:production"
43+
}
44+
}
45+
},
46+
"tags": []
47+
}

‎tests/fixtures/nx-integrated/apps/next-app/public/.gitkeep

Whitespace-only changes.

‎tests/fixtures/nx-integrated/apps/next-app/public/favicon.ico

14.7 KB
Binary file not shown.

‎tests/fixtures/nx-integrated/apps/next-app/tsconfig.json

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
{
2+
"extends": "../../tsconfig.base.json",
3+
"compilerOptions": {
4+
"jsx": "preserve",
5+
"allowJs": true,
6+
"esModuleInterop": true,
7+
"allowSyntheticDefaultImports": true,
8+
"strict": true,
9+
"forceConsistentCasingInFileNames": true,
10+
"noEmit": true,
11+
"resolveJsonModule": true,
12+
"isolatedModules": true,
13+
"incremental": true,
14+
"plugins": [
15+
{
16+
"name": "next"
17+
}
18+
],
19+
"types": ["node"]
20+
},
21+
"include": [
22+
"**/*.ts",
23+
"**/*.tsx",
24+
"**/*.js",
25+
"**/*.jsx",
26+
"../../apps/next-app/.next/types/**/*.ts",
27+
"../../dist/apps/next-app/.next/types/**/*.ts",
28+
"next-env.d.ts",
29+
".next/types/**/*.ts"
30+
],
31+
"exclude": ["node_modules", "src/**/*.spec.ts", "src/**/*.test.ts"]
32+
}

‎tests/fixtures/nx-integrated/apps/next-app/tsconfig.spec.json

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"extends": "./tsconfig.json",
3+
"compilerOptions": {
4+
"outDir": "../../dist/out-tsc",
5+
"module": "commonjs",
6+
"types": ["jest", "node"],
7+
"jsx": "react"
8+
},
9+
"include": [
10+
"jest.config.ts",
11+
"src/**/*.test.ts",
12+
"src/**/*.spec.ts",
13+
"src/**/*.test.tsx",
14+
"src/**/*.spec.tsx",
15+
"src/**/*.test.js",
16+
"src/**/*.spec.js",
17+
"src/**/*.test.jsx",
18+
"src/**/*.spec.jsx",
19+
"src/**/*.d.ts"
20+
]
21+
}

‎tests/fixtures/nx-integrated/nx.json

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
{
2+
"$schema": "./node_modules/nx/schemas/nx-schema.json",
3+
"targetDefaults": {
4+
"build": {
5+
"cache": true,
6+
"dependsOn": ["^build"],
7+
"inputs": ["production", "^production"]
8+
},
9+
"lint": {
10+
"cache": true
11+
},
12+
"@nx/next:build": {
13+
"cache": true,
14+
"dependsOn": ["^build"],
15+
"inputs": ["production", "^production"]
16+
}
17+
},
18+
"namedInputs": {
19+
"default": ["{projectRoot}/**/*", "sharedGlobals"],
20+
"production": [
21+
"default",
22+
"!{projectRoot}/**/?(*.)+(spec|test).[jt]s?(x)?(.snap)",
23+
"!{projectRoot}/tsconfig.spec.json"
24+
],
25+
"sharedGlobals": []
26+
},
27+
"generators": {
28+
"@nx/next": {
29+
"application": {
30+
"style": "css",
31+
"linter": "eslint"
32+
}
33+
}
34+
}
35+
}

‎tests/fixtures/nx-integrated/package.json

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
"name": "@nx-latest/source",
3+
"version": "0.0.0",
4+
"license": "MIT",
5+
"scripts": {},
6+
"private": true,
7+
"dependencies": {
8+
"next": "14.0.4",
9+
"react": "18.2.0",
10+
"react-dom": "18.2.0",
11+
"tslib": "^2.3.0"
12+
},
13+
"devDependencies": {
14+
"@nx/js": "17.3.0",
15+
"@nx/next": "17.3.0",
16+
"@nx/workspace": "17.3.0",
17+
"@swc-node/register": "~1.6.7",
18+
"@swc/core": "~1.3.85",
19+
"@swc/helpers": "~0.5.2",
20+
"@types/node": "18.16.9",
21+
"@types/react": "18.2.33",
22+
"@types/react-dom": "18.2.14",
23+
"nx": "17.3.0",
24+
"ts-node": "10.9.1",
25+
"typescript": "~5.3.2"
26+
}
27+
}

‎tests/fixtures/nx-integrated/pnpm-lock.yaml

+4,878
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎tests/fixtures/nx-integrated/tsconfig.base.json

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"compileOnSave": false,
3+
"compilerOptions": {
4+
"rootDir": ".",
5+
"sourceMap": true,
6+
"declaration": false,
7+
"moduleResolution": "node",
8+
"emitDecoratorMetadata": true,
9+
"experimentalDecorators": true,
10+
"importHelpers": true,
11+
"target": "es2015",
12+
"module": "esnext",
13+
"lib": ["es2020", "dom"],
14+
"skipLibCheck": true,
15+
"skipDefaultLibCheck": true,
16+
"baseUrl": ".",
17+
"paths": {}
18+
},
19+
"exclude": ["node_modules", "tmp"]
20+
}

‎tests/integration/static.test.ts

+11-10
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ test<FixtureTestContext>('linked static resources are placed in correct place in
6666
} = await runPlugin(ctx)
6767

6868
const publishDirAfterBuild = (
69-
await glob('**/*', { cwd: PUBLISH_DIR, dot: true, absolute: true })
69+
await glob('**/*', { cwd: join(ctx.cwd, PUBLISH_DIR), dot: true, absolute: true })
7070
).sort()
7171

7272
await runPluginStep(ctx, 'onPostBuild')
@@ -98,14 +98,14 @@ test<FixtureTestContext>('linked static resources are placed in correct place in
9898

9999
// check if linked resources are accessible in publish dir in expected locations
100100
for (const path of resourcesPaths) {
101-
expect(existsSync(join(PUBLISH_DIR, path))).toBe(true)
101+
expect(existsSync(join(ctx.cwd, PUBLISH_DIR, path))).toBe(true)
102102
}
103103

104104
// check if we restore publish dir to its original state
105105
await runPluginStep(ctx, 'onEnd')
106-
expect((await glob('**/*', { cwd: PUBLISH_DIR, dot: true, absolute: true })).sort()).toEqual(
107-
publishDirAfterBuild,
108-
)
106+
expect(
107+
(await glob('**/*', { cwd: join(ctx.cwd, PUBLISH_DIR), dot: true, absolute: true })).sort(),
108+
).toEqual(publishDirAfterBuild)
109109
})
110110

111111
test<FixtureTestContext>('linked static resources are placed in correct place in publish directory (with basePath)', async (ctx) => {
@@ -114,8 +114,9 @@ test<FixtureTestContext>('linked static resources are placed in correct place in
114114
constants: { PUBLISH_DIR },
115115
} = await runPlugin(ctx)
116116

117+
console.log(PUBLISH_DIR)
117118
const publishDirAfterBuild = (
118-
await glob('**/*', { cwd: PUBLISH_DIR, dot: true, absolute: true })
119+
await glob('**/*', { cwd: join(ctx.cwd, PUBLISH_DIR), dot: true, absolute: true })
119120
).sort()
120121

121122
await runPluginStep(ctx, 'onPostBuild')
@@ -147,11 +148,11 @@ test<FixtureTestContext>('linked static resources are placed in correct place in
147148

148149
// check if linked resources are accessible in publish dir in expected locations
149150
for (const path of resourcesPaths) {
150-
expect(existsSync(join(PUBLISH_DIR, path))).toBe(true)
151+
expect(existsSync(join(ctx.cwd, PUBLISH_DIR, path))).toBe(true)
151152
}
152153
// check if we restore publish dir to its original state
153154
await runPluginStep(ctx, 'onEnd')
154-
expect((await glob('**/*', { cwd: PUBLISH_DIR, dot: true, absolute: true })).sort()).toEqual(
155-
publishDirAfterBuild,
156-
)
155+
expect(
156+
(await glob('**/*', { cwd: join(ctx.cwd, PUBLISH_DIR), dot: true, absolute: true })).sort(),
157+
).toEqual(publishDirAfterBuild)
157158
})

‎tests/utils/create-e2e-fixture.ts

+26-10
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import { execaCommand } from 'execa'
22
import fg from 'fast-glob'
33
import { exec } from 'node:child_process'
4+
import { existsSync } from 'node:fs'
45
import { copyFile, mkdir, mkdtemp, readFile, rm, writeFile } from 'node:fs/promises'
56
import { tmpdir } from 'node:os'
67
import { dirname, join } from 'node:path'
@@ -32,6 +33,7 @@ export const createE2EFixture = async (
3233
packageManger?: PackageManager
3334
packagePath?: string
3435
buildCommand?: string
36+
publishDirectory?: string
3537
} = {},
3638
) => {
3739
const cwd = await mkdtemp(join(tmpdir(), 'netlify-next-runtime-'))
@@ -55,7 +57,7 @@ export const createE2EFixture = async (
5557
}
5658
try {
5759
const [packageName] = await Promise.all([
58-
buildAndPackRuntime(cwd, config.packagePath, config.buildCommand),
60+
buildAndPackRuntime({ ...config, dest: cwd }),
5961
copyFixture(fixture, cwd),
6062
])
6163
await installRuntime(packageName, cwd, config.packageManger || 'npm', config.packagePath)
@@ -94,11 +96,13 @@ async function copyFixture(fixtureName: string, dest: string): Promise<void> {
9496
}
9597

9698
/** Creates a tarball of the packed npm package at the provided destination */
97-
async function buildAndPackRuntime(
98-
dest: string,
99-
packagePath: string = '',
100-
buildCommand = 'next build',
101-
): Promise<string> {
99+
async function buildAndPackRuntime(config: {
100+
dest: string
101+
packagePath?: string
102+
buildCommand?: string
103+
publishDirectory?: string
104+
}): Promise<string> {
105+
const { dest, packagePath = '', buildCommand = 'next build', publishDirectory } = config
102106
console.log(`📦 Creating tarball with 'npm pack'...`)
103107

104108
const { stdout } = await execaCommand(
@@ -111,7 +115,7 @@ async function buildAndPackRuntime(
111115
join(join(dest, packagePath), 'netlify.toml'),
112116
`[build]
113117
command = "${buildCommand}"
114-
publish = "${join(packagePath, '.next')}"
118+
publish = "${publishDirectory ?? join(packagePath, '.next')}"
115119
116120
[[plugins]]
117121
package = "${name}"
@@ -129,16 +133,21 @@ async function installRuntime(
129133
): Promise<void> {
130134
console.log(`🐣 Installing runtime from '${packageName}'...`)
131135

136+
let filter = ''
137+
// only add the filter if a package.json exits in the packagePath
138+
// some monorepos like nx don't have a package.json in the app folder
139+
if (packagePath && existsSync(join(cwd, packagePath, 'package.json'))) {
140+
filter = `--filter ./${packagePath}`
141+
}
142+
132143
let command: string = `npm install --ignore-scripts --no-audit ${packageName}`
133144

134145
switch (packageManger) {
135146
case 'yarn':
136147
command = `yarn add file:${join(cwd, packageName)} --ignore-scripts`
137148
break
138149
case 'pnpm':
139-
command = `pnpm add file:${join(cwd, packageName)} ${
140-
packagePath ? `--filter ./${packagePath}` : ''
141-
} --ignore-scripts`
150+
command = `pnpm add file:${join(cwd, packageName)} ${filter} --ignore-scripts`
142151
break
143152
case 'bun':
144153
command = `bun install ./${packageName}`
@@ -212,6 +221,7 @@ export const test = base.extend<
212221
simpleNextAppBun: Fixture
213222
middleware: Fixture
214223
pageRouter: Fixture
224+
nxIntegrated: Fixture
215225
turborepo: Fixture
216226
turborepoNPM: Fixture
217227
}
@@ -232,6 +242,12 @@ export const test = base.extend<
232242
packagePath: 'apps/page-router',
233243
buildCommand: 'turbo build --filter page-router',
234244
}),
245+
nxIntegrated: makeE2EFixture('nx-integrated', {
246+
packageManger: 'pnpm',
247+
packagePath: 'apps/next-app',
248+
buildCommand: 'nx run next-app:build',
249+
publishDirectory: 'dist/apps/next-app/.next',
250+
}),
235251

236252
takeScreenshot: [
237253
async ({ page }, use, testInfo) => {

‎tests/utils/fixture.ts

+2-3
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ export async function runPluginStep(
168168
SITE_ID: ctx.siteID,
169169
NETLIFY_API_TOKEN: BLOB_TOKEN,
170170
NETLIFY_API_HOST: ctx.blobStoreHost,
171-
PUBLISH_DIR: join(ctx.cwd, constants.PACKAGE_PATH || '', '.next'),
171+
PUBLISH_DIR: join(constants.PACKAGE_PATH || '', '.next'),
172172
...(constants || {}),
173173
// TODO: figure out if we need them
174174
// CONFIG_PATH: 'netlify.toml',
@@ -219,8 +219,7 @@ export async function runPlugin(
219219
constants: Partial<NetlifyPluginConstants> = {},
220220
) {
221221
// imitate netlify/build here
222-
constants.PUBLISH_DIR =
223-
constants.PUBLISH_DIR || join(ctx.cwd, constants.PACKAGE_PATH || '', '.next')
222+
constants.PUBLISH_DIR = constants.PUBLISH_DIR || join(constants.PACKAGE_PATH || '', '.next')
224223
const options = await runPluginStep(ctx, 'onBuild', constants)
225224

226225
const base = new PluginContext(options)

0 commit comments

Comments
 (0)
Please sign in to comment.