Unverified Commit f3656691 authored by Hendrik Liebau's avatar Hendrik Liebau Committed by GitHub

[test] Use `--debug-build-paths` instead of `NEXT_PRIVATE_APP_PATHS` (#85504)

With `--debug-build-paths` being added in #85052, we can now use this
CLI flag in tests, instead of setting the private environment variable
`NEXT_PRIVATE_APP_PATHS`.

Related to this change, this PR fixes how we print the dev, start and
build commands during tests, by properly escaping the CLI arguments.
This ensures that the command is copy-pasteable even when the args
contain escaped characters.
parent e3b3b1a9
...@@ -165,6 +165,7 @@ ...@@ -165,6 +165,7 @@
"@types/react": "19.2.2", "@types/react": "19.2.2",
"@types/react-dom": "19.2.1", "@types/react-dom": "19.2.1",
"@types/relay-runtime": "14.1.13", "@types/relay-runtime": "14.1.13",
"@types/shell-quote": "1.7.1",
"@types/string-hash": "1.1.1", "@types/string-hash": "1.1.1",
"@types/trusted-types": "2.0.3", "@types/trusted-types": "2.0.3",
"@vercel/devlow-bench": "workspace:*", "@vercel/devlow-bench": "workspace:*",
......
...@@ -204,6 +204,9 @@ importers: ...@@ -204,6 +204,9 @@ importers:
'@types/relay-runtime': '@types/relay-runtime':
specifier: 14.1.13 specifier: 14.1.13
version: 14.1.13 version: 14.1.13
'@types/shell-quote':
specifier: 1.7.1
version: 1.7.1
'@types/string-hash': '@types/string-hash':
specifier: 1.1.1 specifier: 1.1.1
version: 1.1.1 version: 1.1.1
...@@ -119,9 +119,7 @@ describe.skip('cache-components - Console Dimming - Validation', () => { ...@@ -119,9 +119,7 @@ describe.skip('cache-components - Console Dimming - Validation', () => {
} else { } else {
try { try {
await next.build({ await next.build({
env: { args: ['--debug-build-paths', `app${path}/page.tsx`],
NEXT_PRIVATE_APP_PATHS: `["${path === '/' ? '' : path}/page.tsx"]`,
},
}) })
} catch (err) { } catch (err) {
const error = new Error( const error = new Error(
...@@ -309,9 +307,7 @@ describe.skip('cache-components - Logging after Abort', () => { ...@@ -309,9 +307,7 @@ describe.skip('cache-components - Logging after Abort', () => {
} else { } else {
try { try {
await next.build({ await next.build({
env: { args: ['--debug-build-paths', `app${path}/page.tsx`],
NEXT_PRIVATE_APP_PATHS: `["${path === '/' ? '' : path}/page.tsx"]`,
},
}) })
} catch (err) { } catch (err) {
const error = new Error( const error = new Error(
...@@ -480,9 +476,7 @@ describe.skip('cache-components - Logging after Abort', () => { ...@@ -480,9 +476,7 @@ describe.skip('cache-components - Logging after Abort', () => {
} else { } else {
try { try {
await next.build({ await next.build({
env: { args: ['--debug-build-paths', `app${path}/page.tsx`],
NEXT_PRIVATE_APP_PATHS: `["${path === '/' ? '' : path}/page.tsx"]`,
},
}) })
} catch (err) { } catch (err) {
const error = new Error( const error = new Error(
...@@ -632,9 +626,7 @@ describe.skip('cache-components - Logging after Abort', () => { ...@@ -632,9 +626,7 @@ describe.skip('cache-components - Logging after Abort', () => {
} else { } else {
try { try {
await next.build({ await next.build({
env: { args: ['--debug-build-paths', `app${path}/page.tsx`],
NEXT_PRIVATE_APP_PATHS: `["${path === '/' ? '' : path}/page.tsx"]`,
},
}) })
} catch (err) { } catch (err) {
const error = new Error( const error = new Error(
...@@ -728,9 +720,7 @@ describe.skip('cache-components - Logging after Abort', () => { ...@@ -728,9 +720,7 @@ describe.skip('cache-components - Logging after Abort', () => {
} else { } else {
try { try {
await next.build({ await next.build({
env: { args: ['--debug-build-paths', `app${path}/page.tsx`],
NEXT_PRIVATE_APP_PATHS: `["${path === '/' ? '' : path}/page.tsx"]`,
},
}) })
} catch (err) { } catch (err) {
const error = new Error( const error = new Error(
......
...@@ -64,18 +64,19 @@ describe('Cache Components Errors', () => { ...@@ -64,18 +64,19 @@ describe('Cache Components Errors', () => {
}) })
const prerender = async (pathname: string) => { const prerender = async (pathname: string) => {
const args = ['--experimental-build-mode', 'generate'] const args = [
'--experimental-build-mode',
'generate',
'--debug-build-paths',
// Escape square brackets for pathnames with dynamic segments.
`app${pathname.replace(/([[\]])/g, '\\$1')}/page.tsx`,
]
if (isDebugPrerender) { if (isDebugPrerender) {
args.push('--debug-prerender') args.push('--debug-prerender')
} }
await next.build({ await next.build({ args })
env: {
NEXT_PRIVATE_APP_PATHS: JSON.stringify([`${pathname}/page.tsx`]),
},
args,
})
} }
describe('Dynamic Metadata - Static Route', () => { describe('Dynamic Metadata - Static Route', () => {
......
...@@ -203,11 +203,7 @@ describe('use-cache-search-params', () => { ...@@ -203,11 +203,7 @@ describe('use-cache-search-params', () => {
it('should resume a cached page that does not access search params without hydration errors', async () => { it('should resume a cached page that does not access search params without hydration errors', async () => {
await next.build({ await next.build({
env: { args: ['--debug-build-paths', 'app/search-params-unused/page.tsx'],
NEXT_PRIVATE_APP_PATHS: JSON.stringify([
'/search-params-unused/page.tsx',
]),
},
}) })
await next.start({ skipBuild: true }) await next.start({ skipBuild: true })
......
...@@ -3,6 +3,7 @@ import { Span } from 'next/dist/trace' ...@@ -3,6 +3,7 @@ import { Span } from 'next/dist/trace'
import { NextInstance } from './base' import { NextInstance } from './base'
import { retry, waitFor } from 'next-test-utils' import { retry, waitFor } from 'next-test-utils'
import stripAnsi from 'strip-ansi' import stripAnsi from 'strip-ansi'
import { quote as shellQuote } from 'shell-quote'
export class NextDevInstance extends NextInstance { export class NextDevInstance extends NextInstance {
private _cliOutput: string = '' private _cliOutput: string = ''
...@@ -50,7 +51,7 @@ export class NextDevInstance extends NextInstance { ...@@ -50,7 +51,7 @@ export class NextDevInstance extends NextInstance {
} }
} }
console.log('running', startArgs.join(' ')) console.log('running', shellQuote(startArgs))
await new Promise<void>((resolve, reject) => { await new Promise<void>((resolve, reject) => {
try { try {
this.childProcess = spawn(startArgs[0], startArgs.slice(1), { this.childProcess = spawn(startArgs[0], startArgs.slice(1), {
...@@ -130,7 +131,7 @@ export class NextDevInstance extends NextInstance { ...@@ -130,7 +131,7 @@ export class NextDevInstance extends NextInstance {
} }
this.on('stdout', readyCb) this.on('stdout', readyCb)
} catch (err) { } catch (err) {
require('console').error(`Failed to run ${startArgs.join(' ')}`, err) require('console').error(`Failed to run ${shellQuote(startArgs)}`, err)
setTimeout(() => process.exit(1), 0) setTimeout(() => process.exit(1), 0)
} }
}) })
......
...@@ -4,6 +4,7 @@ import { NextInstance } from './base' ...@@ -4,6 +4,7 @@ import { NextInstance } from './base'
import spawn from 'cross-spawn' import spawn from 'cross-spawn'
import { Span } from 'next/dist/trace' import { Span } from 'next/dist/trace'
import stripAnsi from 'strip-ansi' import stripAnsi from 'strip-ansi'
import { quote as shellQuote } from 'shell-quote'
export class NextStartInstance extends NextInstance { export class NextStartInstance extends NextInstance {
private _buildId: string private _buildId: string
...@@ -64,7 +65,7 @@ export class NextStartInstance extends NextInstance { ...@@ -64,7 +65,7 @@ export class NextStartInstance extends NextInstance {
if (!options.skipBuild) { if (!options.skipBuild) {
const buildArgs = this.getBuildArgs() const buildArgs = this.getBuildArgs()
console.log('running', buildArgs.join(' ')) console.log('running', shellQuote(buildArgs))
await new Promise<void>((resolve, reject) => { await new Promise<void>((resolve, reject) => {
try { try {
this.childProcess = spawn(buildArgs[0], buildArgs.slice(1), spawnOpts) this.childProcess = spawn(buildArgs[0], buildArgs.slice(1), spawnOpts)
...@@ -80,7 +81,10 @@ export class NextStartInstance extends NextInstance { ...@@ -80,7 +81,10 @@ export class NextStartInstance extends NextInstance {
else resolve() else resolve()
}) })
} catch (err) { } catch (err) {
require('console').error(`Failed to run ${buildArgs.join(' ')}`, err) require('console').error(
`Failed to run ${shellQuote(buildArgs)}`,
err
)
setTimeout(() => process.exit(1), 0) setTimeout(() => process.exit(1), 0)
} }
}) })
...@@ -99,7 +103,7 @@ export class NextStartInstance extends NextInstance { ...@@ -99,7 +103,7 @@ export class NextStartInstance extends NextInstance {
).trim() ).trim()
} }
console.log('running', startArgs.join(' ')) console.log('running', shellQuote(startArgs))
await new Promise<void>((resolve, reject) => { await new Promise<void>((resolve, reject) => {
try { try {
this.childProcess = spawn(startArgs[0], startArgs.slice(1), spawnOpts) this.childProcess = spawn(startArgs[0], startArgs.slice(1), spawnOpts)
...@@ -141,7 +145,7 @@ export class NextStartInstance extends NextInstance { ...@@ -141,7 +145,7 @@ export class NextStartInstance extends NextInstance {
} }
this.on('stdout', readyCb) this.on('stdout', readyCb)
} catch (err) { } catch (err) {
require('console').error(`Failed to run ${startArgs.join(' ')}`, err) require('console').error(`Failed to run ${shellQuote(startArgs)}`, err)
setTimeout(() => process.exit(1), 0) setTimeout(() => process.exit(1), 0)
} }
}) })
...@@ -207,7 +211,7 @@ export class NextStartInstance extends NextInstance { ...@@ -207,7 +211,7 @@ export class NextStartInstance extends NextInstance {
const spawnOpts = this.getSpawnOpts(options.env) const spawnOpts = this.getSpawnOpts(options.env)
const buildArgs = this.getBuildArgs(options.args) const buildArgs = this.getBuildArgs(options.args)
console.log('running', buildArgs.join(' ')) console.log('running', shellQuote(buildArgs))
this.childProcess = spawn(buildArgs[0], buildArgs.slice(1), spawnOpts) this.childProcess = spawn(buildArgs[0], buildArgs.slice(1), spawnOpts)
this.handleStdio(this.childProcess) this.handleStdio(this.childProcess)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment