Files
Sam PoderandGitHub dcf4607f8f Improve root detection to handle worktrees, more workspaces & stray lockfiles (#96159)
Watching too many files can hurt performance, and impacts how much work
Turbopack is doing. See for example the conversation around
https://github.com/vercel/next.js/pull/94597.

This PR handles the following four cases:

- Git worktrees: we can include a guard to prevent exiting a worktree
(by looking at the `.git` file).
- Git repository boundaries: we can include a guard to prevent us from
exiting a checked-out repository and watching the repository’s parent
directory.
    - We will log a warning if this happens.
- Empty / bogus `package.lock` files & `package-lock.json` files (and
equivalents using other package managers): if we spot a
`package-lock.json` file but it has no packages or a `package-lock.json`
w/o an associated `package.json` file. We can ignore them. This handles
the case of accidentally running `npm install` in any directory.
- Home directory detection: we can detect if we’re going to start
watching your home dir and rollback up if this is the case.
    - We will log a warning if this happens.
- If your Next config is in your home dir, we will still run your app
there as Next config is the furthest we can rollback
- NPM, Yarn, Lerna & Bun workspaces: based on the `workspaces` field in
the `package.json` or `lerna.json`

I would recommend using split-view to review. I also cleaned up the
`warnDuplicatedLockFiles()` function because it was a bit unnecessary to
repeat the full message.

Closes https://github.com/vercel/next.js/issues/92978
2026-07-28 13:35:17 -07:00

52 lines
1.7 KiB
TypeScript

import { join } from 'path'
import { FileRef, nextTestSetup } from 'e2e-utils'
import { retry } from 'next-test-utils'
describe('multiple-lockfiles', () => {
const { next, skipped, isTurbopack } = nextTestSetup({
files: {
app: new FileRef(join(__dirname, 'app')),
// Write a package-lock.json file to the parent directory to simulate
// multiple lockfiles.
'../package.json': JSON.stringify({
name: 'parent-workspace',
version: '1.0.0',
}),
'../package-lock.json': JSON.stringify({
name: 'parent-workspace',
version: '1.0.0',
lockfileVersion: 3,
packages: { '': { name: 'parent-workspace', version: '1.0.0' } },
}),
},
// So that ../package-lock.json doesn't leave the isolated testDir
subDir: 'test',
skipDeployment: true,
// The workspace file would be treated as the root and suppress the
// warning.
deleteWorkspaceFile: true,
})
if (skipped) {
return
}
it('should have multiple lockfiles warnings', async () => {
await retry(async () => {
expect(next.cliOutput).toMatch(
/We detected multiple lockfiles and selected the directory of .+ as the root directory\./
)
if (isTurbopack) {
expect(next.cliOutput).toMatch(
/To silence this warning, set `turbopack\.root` in your Next\.js config, or consider removing one of the lockfiles if it's not needed\./
)
} else {
expect(next.cliOutput).toMatch(
/To silence this warning, set `outputFileTracingRoot` in your Next\.js config, or consider removing one of the lockfiles if it's not needed\./
)
}
})
})
})