Skip to content

use atomic writes to avoid seeing incomplete files #55424

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sokra merged 1 commit into from
Sep 15, 2023
Merged

use atomic writes to avoid seeing incomplete files #55424

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 37 additions & 31 deletions packages/next/src/server/lib/router-utils/setup-dev.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ import {
parseStack,
} from 'next/dist/compiled/@next/react-dev-overlay/dist/middleware'
import { BuildManifest } from '../../get-page-files'
import { mkdir, readFile, writeFile } from 'fs/promises'
import { mkdir, readFile, writeFile, rename, unlink } from 'fs/promises'
import { PagesManifest } from '../../../build/webpack/plugins/pages-manifest-plugin'
import { AppBuildManifest } from '../../../build/webpack/plugins/app-build-manifest-plugin'
import { PageNotFoundError } from '../../../shared/lib/utils'
Expand Down Expand Up @@ -692,14 +692,31 @@ async function startWatcher(opts: SetupOpts) {
return manifest
}

async function writeFileAtomic(
filePath: string,
content: string
): Promise<void> {
const tempPath = filePath + '.tmp.' + Math.random().toString(36).slice(2)
try {
await writeFile(tempPath, content, 'utf-8')
await rename(tempPath, filePath)
} catch (e) {
try {
await unlink(tempPath)
} catch {
// ignore
}
throw e
}
}

async function writeBuildManifest(): Promise<void> {
const buildManifest = mergeBuildManifests(buildManifests.values())
const buildManifestPath = path.join(distDir, BUILD_MANIFEST)
deleteCache(buildManifestPath)
await writeFile(
await writeFileAtomic(
buildManifestPath,
JSON.stringify(buildManifest, null, 2),
'utf-8'
JSON.stringify(buildManifest, null, 2)
)
const content = {
__rewrites: { afterFiles: [], beforeFiles: [], fallback: [] },
Expand All @@ -714,15 +731,13 @@ async function startWatcher(opts: SetupOpts) {
const buildManifestJs = `self.__BUILD_MANIFEST = ${JSON.stringify(
content
)};self.__BUILD_MANIFEST_CB && self.__BUILD_MANIFEST_CB()`
await writeFile(
await writeFileAtomic(
path.join(distDir, 'static', 'development', '_buildManifest.js'),
buildManifestJs,
'utf-8'
buildManifestJs
)
await writeFile(
await writeFileAtomic(
path.join(distDir, 'static', 'development', '_ssgManifest.js'),
srcEmptySsgManifest,
'utf-8'
srcEmptySsgManifest
)
}

Expand All @@ -737,10 +752,9 @@ async function startWatcher(opts: SetupOpts) {
`fallback-${BUILD_MANIFEST}`
)
deleteCache(fallbackBuildManifestPath)
await writeFile(
await writeFileAtomic(
fallbackBuildManifestPath,
JSON.stringify(fallbackBuildManifest, null, 2),
'utf-8'
JSON.stringify(fallbackBuildManifest, null, 2)
)
}

Expand All @@ -750,21 +764,19 @@ async function startWatcher(opts: SetupOpts) {
)
const appBuildManifestPath = path.join(distDir, APP_BUILD_MANIFEST)
deleteCache(appBuildManifestPath)
await writeFile(
await writeFileAtomic(
appBuildManifestPath,
JSON.stringify(appBuildManifest, null, 2),
'utf-8'
JSON.stringify(appBuildManifest, null, 2)
)
}

async function writePagesManifest(): Promise<void> {
const pagesManifest = mergePagesManifests(pagesManifests.values())
const pagesManifestPath = path.join(distDir, 'server', PAGES_MANIFEST)
deleteCache(pagesManifestPath)
await writeFile(
await writeFileAtomic(
pagesManifestPath,
JSON.stringify(pagesManifest, null, 2),
'utf-8'
JSON.stringify(pagesManifest, null, 2)
)
}

Expand All @@ -776,10 +788,9 @@ async function startWatcher(opts: SetupOpts) {
APP_PATHS_MANIFEST
)
deleteCache(appPathsManifestPath)
await writeFile(
await writeFileAtomic(
appPathsManifestPath,
JSON.stringify(appPathsManifest, null, 2),
'utf-8'
JSON.stringify(appPathsManifest, null, 2)
)
}

Expand All @@ -792,10 +803,9 @@ async function startWatcher(opts: SetupOpts) {
'server/middleware-manifest.json'
)
deleteCache(middlewareManifestPath)
await writeFile(
await writeFileAtomic(
middlewareManifestPath,
JSON.stringify(middlewareManifest, null, 2),
'utf-8'
JSON.stringify(middlewareManifest, null, 2)
)
}

Expand All @@ -808,7 +818,7 @@ async function startWatcher(opts: SetupOpts) {
NEXT_FONT_MANIFEST + '.json'
)
deleteCache(fontManifestPath)
await writeFile(
await writeFileAtomic(
fontManifestPath,
JSON.stringify(
{
Expand All @@ -829,11 +839,7 @@ async function startWatcher(opts: SetupOpts) {
'react-loadable-manifest.json'
)
deleteCache(loadableManifestPath)
await writeFile(
loadableManifestPath,
JSON.stringify({}, null, 2),
'utf-8'
)
await writeFileAtomic(loadableManifestPath, JSON.stringify({}, null, 2))
}

async function subscribeToHmrEvents(id: string, client: ws) {
Expand Down