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.

De cleanup in het catch-blok is opzettelijk defensief. Als er een fout optreedt nadat de filehandle is geopend, probeert de code de handle te sluiten en het tijdelijke bestand te verwijderen, waarbij eventuele secundaire fouten worden genegeerd zodat de oorspronkelijke uitzondering netjes wordt doorgegeven. Je wilt niet dat een permissiefout tijdens de cleanup de werkelijke bug maskeert die de fout heeft veroorzaakt.

Waar dit patroon ophoudt te helpen

Atomaire bestandvervanging voorkomt 'torn writes'. Het voorkomt geen 'lost updates'. Als twee instanties van je CLI tegelijkertijd dezelfde configuratie lezen, beide hun bewerkingen in het geheugen uitvoeren, beide nieuwe tijdelijke bestanden schrijven en beide hun hernoemingen uitvoeren, wint de tweede hernoeming. Het eerste proces heeft de wijzigingen van het tweede proces niet waargenomen. Afhankelijk van je applicatie kan dit betekenen dat een gebruiker een instelling toevoegt in de ene terminal en een andere gebruiker deze verwijdert in een andere, waarbij het uiteindelijke bestand alleen de laatste schrijver reflecteert.

Als je tool gelijktijdige mutaties moet ondersteunen, heb je een coördinatiemechanisme nodig bovenop de atomaire schrijfactie. Een 'advisory lock file' werkt voor eenvoudige gevallen. Version vectors of een monotoon revisienummer in de configuratie zelf kunnen helpen bij het detecteren van botsingen, zodat de tweede schrijver het opnieuw kan proberen. Dit voegt complexiteit toe, en complexiteit is waar bugs zich verschuilen.

Daarom is de grens belangrijk. Een enkele JSON-blob die af en toe door één proces wordt bijgewerkt, is een prima kandidaat voor een atomaire bestandsschrijfactie. Zodra je merkt dat je meerdere records moet beheren, schema's moet afdwingen of je zorgen moet maken over gelijktijdige mutaties, ben je het bestandssysteem ontgroeid. SQLite bestaat om precies deze reden. Het biedt atomaire transacties, rollback-journals en een goede afhandeling van gelijktijdige lezers en schrijvers, allemaal binnen één enkel lokaal bestand. Een slim bestandsprotocol is geen database, en je moet je onderhoudsbudget niet verspillen aan het doen alsof het wel zo is.

De belangrijkste les

De volgende keer dat je naar writeFile grijpt in een CLI-tool, pauzeer dan even. Serialisatie is niet het moeilijke deel. Duurzaamheid (durability) wel. Configuratiebestanden zijn te klein om te streamen en te belangrijk om te truncaten. Schrijf de volledige payload naar een verborgen 'sibling'-bestand, flush het, commit het met een hernoeming en laat het aan de directory weten. Je gebruikers kunnen op Ctrl-C drukken, de stekker eruit trekken of hun laptop dichtklappen. Wanneer de machine weer aan gaat, bevat het bestand ofwel de oude wereld, ofwel de nieuwe. Niets daartussenin.