Unverified Commit 16760877 authored by Benjamin Woodruff's avatar Benjamin Woodruff Committed by GitHub

fix(experimental.lockDistDir): Acquire the lock in dev earlier (#85116)

Apparently I grabbed the lock too late, which led to the second process still managing the `distDir` before exiting... https://vercel.slack.com/archives/C03EWR7LGEN/p1760910025067089

This moves the acquisition earlier for dev, and extends the e2e test to cover this.

[Screen Recording 2025-10-20 at 10.42.49 AM.webm <span class="graphite__hidden">(uploaded via Graphite)</span> <img class="graphite__hidden" src="https://app.graphite.dev/user-attachments/thumbnails/68785bda-1dd5-437a-bf16-54de2d54a49c.webm" />](https://app.graphite.dev/user-attachments/video/68785bda-1dd5-437a-bf16-54de2d54a49c.webm)
parent 2346cfd6
......@@ -121,6 +121,7 @@ import { handlePageMetadataResponse } from '../mcp/tools/get-page-metadata'
import { setStackFrameResolver } from '../mcp/tools/utils/format-errors'
import { getFileLogger } from './browser-logs/file-logger'
import type { ServerCacheStatus } from '../../next-devtools/dev-overlay/cache-indicator'
import type { Lockfile } from '../../build/lockfile'
const wsServer = new ws.Server({ noServer: true })
const isTestMode = !!(
......@@ -182,7 +183,8 @@ export async function createHotReloaderTurbopack(
opts: SetupOpts & { isSrcDir: boolean },
serverFields: ServerFields,
distDir: string,
resetFetch: () => void
resetFetch: () => void,
lockfile: Lockfile | undefined
): Promise<NextJsHotReloaderInterface> {
const dev = true
const buildId = 'development'
......@@ -288,6 +290,7 @@ export async function createHotReloaderTurbopack(
opts.onDevServerCleanup?.(async () => {
setBundlerFindSourceMapImplementation(() => undefined)
await project.onExit()
await lockfile?.unlock()
})
const entrypointsSubscription = project.entrypointsSubscribe()
......
......@@ -111,6 +111,7 @@ import { getMcpMiddleware } from '../mcp/get-mcp-middleware'
import { setStackFrameResolver } from '../mcp/tools/utils/format-errors'
import { getFileLogger } from './browser-logs/file-logger'
import type { ServerCacheStatus } from '../../next-devtools/dev-overlay/cache-indicator'
import type { Lockfile } from '../../build/lockfile'
const MILLISECONDS_IN_NANOSECOND = BigInt(1_000_000)
......@@ -246,6 +247,7 @@ export default class HotReloaderWebpack implements NextJsHotReloaderInterface {
private appDir?: string
private telemetry: Telemetry
private resetFetch: () => void
private lockfile: Lockfile | undefined
private versionInfo: VersionInfo = {
staleness: 'unknown',
installed: '0.0.0',
......@@ -276,6 +278,8 @@ export default class HotReloaderWebpack implements NextJsHotReloaderInterface {
appDir,
telemetry,
resetFetch,
lockfile,
onDevServerCleanup,
}: {
config: NextConfigComplete
isSrcDir: boolean
......@@ -288,6 +292,8 @@ export default class HotReloaderWebpack implements NextJsHotReloaderInterface {
appDir?: string
telemetry: Telemetry
resetFetch: () => void
lockfile: Lockfile | undefined
onDevServerCleanup: ((listener: () => Promise<void>) => void) | undefined
}
) {
this.hasAppRouterEntrypoints = false
......@@ -306,6 +312,7 @@ export default class HotReloaderWebpack implements NextJsHotReloaderInterface {
this.serverPrevDocumentHash = null
this.telemetry = telemetry
this.resetFetch = resetFetch
this.lockfile = lockfile
this.config = config
this.previewProps = previewProps
......@@ -322,6 +329,10 @@ export default class HotReloaderWebpack implements NextJsHotReloaderInterface {
const mcpServerEnabled = !!config.experimental.mcpServer
const fileLogger = getFileLogger()
fileLogger.initialize(this.distDir, mcpServerEnabled)
onDevServerCleanup?.(async () => {
await lockfile?.unlock()
})
}
public async run(
......
......@@ -87,6 +87,7 @@ import {
} from './route-types-utils'
import { isParallelRouteSegment } from '../../../shared/lib/segment'
import { ensureLeadingSlash } from '../../../shared/lib/page-path/ensure-leading-slash'
import { Lockfile } from '../../../build/lockfile'
export type SetupOpts = {
renderServer: LazyRenderServerInstance
......@@ -175,6 +176,15 @@ async function startWatcher(
setGlobal('distDir', distDir)
setGlobal('phase', PHASE_DEVELOPMENT_SERVER)
let lockfile
if (opts.nextConfig.experimental.lockDistDir) {
fs.mkdirSync(distDir, { recursive: true })
lockfile = await Lockfile.acquireWithRetriesOrExit(
path.join(distDir, 'lock'),
'next dev'
)
}
const validFileMatcher = createValidFileMatcher(
nextConfig.pageExtensions,
appDir
......@@ -196,7 +206,8 @@ async function startWatcher(
opts,
serverFields,
distDir,
resetFetch
resetFetch,
lockfile
)
})()
: await (async () => {
......@@ -218,6 +229,8 @@ async function startWatcher(
rewrites: opts.fsChecker.rewrites,
previewProps: opts.fsChecker.prerenderManifest.preview,
resetFetch,
lockfile,
onDevServerCleanup: opts.onDevServerCleanup,
})
})()
......
......@@ -15,7 +15,6 @@ import type { default as NextNodeServer } from './next-server'
import * as log from '../build/output/log'
import loadConfig from './config'
import path from 'node:path'
import { mkdirSync } from 'node:fs'
import { NON_STANDARD_NODE_ENV } from '../lib/constants'
import {
PHASE_DEVELOPMENT_SERVER,
......@@ -32,7 +31,6 @@ import {
RouterServerContextSymbol,
routerServerGlobal,
} from './lib/router-utils/router-server-context'
import { Lockfile } from '../build/lockfile'
let ServerImpl: typeof NextNodeServer
......@@ -131,7 +129,6 @@ export class NextServer implements NextWrapperServer {
private reqHandler?: NodeRequestHandler
private reqHandlerPromise?: Promise<NodeRequestHandler>
private preparedAssetPrefix?: string
private lockfile?: Lockfile
public options: NextServerOptions
......@@ -261,9 +258,6 @@ export class NextServer implements NextWrapperServer {
if (this.server) {
await this.server.close()
}
if (this.lockfile !== undefined) {
await this.lockfile.unlock()
}
}
private async createServer(
......@@ -323,22 +317,7 @@ export class NextServer implements NextWrapperServer {
private async getServer() {
if (!this.serverPromise) {
this.serverPromise = this[SYMBOL_LOAD_CONFIG]().then(async (conf) => {
if (this.options.dev) {
if (conf.experimental.lockDistDir) {
const dir = path.resolve(
/* turbopackIgnore: true */ this.options.dir || '.'
)
const distDir = path.join(
/* turbopackIgnore: true */ dir,
conf.distDir
)
mkdirSync(distDir, { recursive: true })
this.lockfile = await Lockfile.acquireWithRetriesOrExit(
path.join(/* turbopackIgnore: true */ distDir, 'lock'),
'next dev'
)
}
} else {
if (!this.options.dev) {
if (conf.output === 'standalone') {
if (!process.env.__NEXT_PRIVATE_STANDALONE_CONFIG) {
log.warn(
......
......@@ -26,5 +26,9 @@ describe('lockfile', () => {
)
expect(stripAnsi(stdout + stderr)).toContain('Unable to acquire lock')
expect(exitCode).toBe(1)
// make sure the other instance of `next dev` didn't mess anything up
browser.refresh()
expect(await browser.elementByCss('p').text()).toBe('Page')
})
})
......@@ -240,21 +240,26 @@ describe('Dynamic Optional Routing', () => {
;(process.env.TURBOPACK_BUILD ? describe.skip : describe)(
'development mode',
() => {
beforeAll(async () => {
appPort = await findPort()
app = await launchApp(appDir, appPort)
describe('rendering', () => {
beforeAll(async () => {
appPort = await findPort()
app = await launchApp(appDir, appPort)
})
afterAll(() => killApp(app))
runTests()
})
afterAll(() => killApp(app))
runTests()
runInvalidPagesTests(async (appDir) => {
stderr = ''
await launchApp(appDir, await findPort(), {
onStderr: (msg) => {
stderr += msg
},
describe('invalid pages', () => {
runInvalidPagesTests(async (appDir) => {
stderr = ''
appPort = await findPort()
app = await launchApp(appDir, appPort, {
onStderr: (msg) => {
stderr += msg
},
})
})
afterEach(() => killApp(app))
})
}
)
......
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