A config file that worked five seconds ago is now a 347-byte fragment of broken JSON. Your CLI tool will not start. The user, who simply pressed Ctrl-C because the update was taking longer than expected, is now staring at an error stack trace they did not ask for. The two kilobytes of valid configuration that existed before the write are gone, replaced by the digital equivalent of a half-printed receipt.
This happens because writeFile is not atomic. It opens the existing path, truncates it, streams data from Node into the kernel’s page cache, and eventually closes the file descriptor. The moment the truncation happens, the old content is already gone. Everything between that truncation and the final close is a window of vulnerability. A SIGINT, a power outage, or a laptop lid slamming shut during that window leaves the filesystem holding a truncated mess. Even if Node reports the Promise as resolved, the operating system may still be buffering writes in memory. Convenience methods hide that gap, but they do not remove it.
The fix is not to write in place. The fix is to separate the act of writing from the act of publishing.
Write to a sibling, then swap
The reliable pattern has five steps. None of them are complicated, but together they move the failure window from an entire streaming write down to a single filesystem metadata operation.
First, serialize the entire payload in memory. Do this before you create any temporary file. If JSON.stringify throws because someone passed a circular object, you want that exception to bubble up before you touch the disk.
Second, write the serialized data to a temporary file located in the same directory as the target. Use a randomized name so two concurrent runs do not collide. Keeping the temp file in the same directory matters because rename is only atomic within a single filesystem. If your temp file lives on a different partition, the operating system falls back to a copy-and-delete sequence, which introduces its own failure modes and is no longer atomic.
Third, ask the kernel to flush that temporary file to physical storage. Node’s fsync, exposed here as the sync method on a filehandle, blocks until the buffers are down on the metal. This is slow, but config writes happen rarely enough that the durability is worth the milliseconds.
Fourth, rename the temporary file over the original path. On both POSIX systems and Windows, this is the commit point. Readers opening the original path will see either the complete old file or the complete new file. There is no moment in time where a reader can open the path and observe a half-written buffer.
Fifth, sync the parent directory. This catches a subtle edge case. The rename updates the directory entry, but the directory metadata itself might sit in the kernel’s page cache. Sudden power loss after a successful rename can sometimes leave the filesystem in a state where the new inode reference was never recorded durably. Syncing the directory forces that metadata update to disk and seals the transaction.
A concrete Node.js implementation
Here is what that pattern looks like in practice using only the Node.js standard library:
import { open, rename, rm } from "node:fs/promises";
import { dirname, basename, join } from "node:path";
import { randomUUID } from "node:crypto";
export async function writeJsonAtomic(path, value) {
const directory = dirname(path);
const temporary = join(directory, `.${basename(path)}.${randomUUID()}.tmp`);
const body = `${JSON.stringify(value, null, 2)}\n`;
let handle;
try {
handle = await open(temporary, "wx", 0o600);
await handle.writeFile(body, "utf8");
await handle.sync();
await handle.close();
handle = undefined;
await rename(temporary, path);
const directoryHandle = await open(directory, "r");
try {
await directoryHandle.sync();
} finally {
await directoryHandle.close();
}
} catch (error) {
if (handle) await handle.close().catch(() => {});
await rm(temporary, { force: true }).catch(() => {});
throw error;
}
}
A few details in this code are worth attention.
The wx flag means “write, but fail if the file already exists.” This guards against a UUID collision or an abandoned temp file from a previous crashed process. If someone has dropped a malicious file where your temp file should be, you will hear about it immediately rather than overwriting whatever is there.
The 0o600 permission mask creates the temp file with owner-read and owner-write only. Config files frequently hold secrets, API tokens, or private repository URLs. There is no reason to let other users on the system peek at the temporary file while it is being prepared.
Notice the separate sync calls on the file and then on the directory. Many developers skip the directory sync because it feels redundant. It is not. Ext4, APFS, and NTFS all handle directory updates differently, but they share a common habit of batching metadata writes for performance. If you care about surviving power loss, the directory sync is the final seal.
Sprzątanie w bloku catch jest celowo defensywne. Jeśli cokolwiek wyrzuci wyjątek po otwarciu uchwytu do pliku, kod próbuje zamknąć uchwyt i usunąć tymczasowy plik, połykając wszelkie wtórne błędy, aby oryginalny wyjątek mógł zostać czysto przekazany dalej. Nie chcesz, aby błąd uprawnień podczas sprzątania zamaskował prawdziwy błąd, który spowodował awarię.
Kiedy ten wzorzec przestaje pomagać
Atomowa zamiana plików zapobiega niepełnym zapisom (torn writes). Nie zapobiega jednak utracie aktualizacji. Jeśli dwie instancje Twojego CLI odczytają tę samą konfigurację jednocześnie, obie wprowadzą edycje w pamięci, obie zapiszą nowe pliki tymczasowe i obie wykonają operację zmiany nazwy, wygra druga zmiana nazwy. Pierwszy proces nie zauważył zmian wprowadzonych przez drugi proces. W zależności od aplikacji może to oznaczać, że jeden użytkownik doda ustawienie w jednym terminalu, a inny użytkownik usunie je w innym, a końcowy plik będzie odzwierciedlał tylko zmiany ostatniego zapisującego.
Jeśli Twoje narzędzie musi obsługiwać współbieżne modyfikacje, potrzebujesz mechanizmu koordynacji nadrzędnego wobec atomowego zapisu. W prostych przypadkach sprawdza się plik blokady typu advisory lock. Wektory wersji lub monotoniczny numer rewizji wewnątrz samej konfiguracji mogą pomóc w wykrywaniu kolizji, dzięki czemu drugi zapisujący będzie mógł spróbować ponownie. Wprowadza to jednak złożoność, a to właśnie w złożoności kryją się błędy.
Dlatego ta granica jest istotna. Pojedynczy obiekt JSON, który proces aktualizuje sporadycznie, jest dobrym kandydatem do atomowego zapisu pliku. Gdy tylko zaczniesz zarządzać wieloma rekordami, wymuszać schematy lub martwić się o współbieżne mutacje, wyrośniesz poza możliwości systemu plików. SQLite istnieje właśnie w tym celu. Zapewnia atomowe transakcje, dzienniki wycofywania zmian (rollback journals) oraz właściwą obsługę współbieżnych czytelników i zapisujących, a wszystko to w ramach jednego pliku lokalnego. Sprytny protokół plików to nie baza danych i nie powinieneś marnować budżetu na utrzymanie, udając, że jest inaczej.
Najważniejsza lekcja
Następnym razem, gdy sięgniesz po writeFile wewnątrz narzędzia CLI, zatrzymaj się. Serializacja nie jest najtrudniejsza. Najtrudniejsza jest trwałość (durability). Pliki konfiguracyjne są zbyt małe, by je strumieniować, i zbyt ważne, by je skracać (truncate). Zapisz całą zawartość do ukrytego pliku obok, wykonaj operację flush, zatwierdź ją za pomocą zmiany nazwy i poinformuj o tym katalog. Twoi użytkownicy mogą nacisnąć Ctrl-C, wyciągnąć wtyczkę z gniazdka lub zamknąć klapę laptopa. Gdy maszyna wróci do życia, plik będzie zawierał albo stary stan, albo nowy. Nic pomiędzy.