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.
La pulizia nel blocco catch è intenzionalmente difensiva. Se viene lanciata un'eccezione dopo l'apertura dell'handle del file, il codice tenta di chiudere l'handle e rimuovere il file temporaneo, ignorando eventuali errori secondari in modo che l'eccezione originale si propaghi correttamente. Non si vuole che un errore di permessi durante la pulizia mascheri il vero bug che ha causato il fallimento.
Quando questo pattern smette di essere utile
La sostituzione atomica del file previene le scritture parziali (torn writes). Non previene gli aggiornamenti persi (lost updates). Se due istanze della tua CLI leggono la stessa configurazione simultaneamente, entrambe eseguono le modifiche in memoria, entrambe scrivono nuovi file temporanei e entrambe eseguono la rinomina, la seconda rinomina prevarrà. Il primo processo non ha osservato le modifiche del secondo. A seconda della tua applicazione, ciò potrebbe significare che un utente aggiunge un'impostazione in un terminale e un altro utente la rimuove in un altro, con il file finale che riflette solo l'ultimo scrittore.
Se il tuo strumento deve supportare mutatori concorrenti, hai bisogno di un meccanismo di coordinamento sopra la scrittura atomica. Un file di lock consultivo (advisory lock) funziona per i casi semplici. I vettori di versione o un numero di revisione monotono all'interno della configurazione stessa possono aiutare a rilevare le collisioni, consentendo al secondo scrittore di riprovare. Questi elementi aggiungono complessità, e la complessità è il luogo in cui si nascondono i bug.
Ecco perché il limite è importante. Un singolo blob JSON che un processo aggiorna occasionalmente è un ottimo candidato per una scrittura atomica del file. Una volta che ti ritrovi a gestire più record, imporre schemi o preoccuparti di mutazioni concorrenti, hai superato le capacità del filesystem. SQLite esiste esattamente per questo motivo. Ti offre transazioni atomiche, journal di rollback e una gestione corretta di lettori e scrittori concorrenti, il tutto all'interno di un singolo file locale all'host. Un protocollo di file ingegnoso non è un database, e non dovresti spendere il budget di manutenzione fingendo il contrario.
La vera lezione
La prossima volta che utilizzi writeFile all'interno di uno strumento CLI, fermati. La serializzazione non è la parte difficile. La durabilità lo è. I file di configurazione sono troppo piccoli per essere trasmessi in streaming e troppo importanti per essere troncati. Scrivi l'intero payload in un file "fratello" nascosto, esegui il flush, conferma con una rinomina e comunica la modifica alla directory. I tuoi utenti possono premere Ctrl-C, staccare la spina o chiudere il coperchio del laptop. Quando la macchina si riaccende, il file conterrà o il vecchio mondo o il nuovo. Niente di intermedio.