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.

Очистка в блоке catch намеренно сделана защитной. Если после открытия дескриптора файла произойдет исключение, код попытается закрыть дескриптор и удалить временный файл, подавляя любые вторичные ошибки, чтобы исходное исключение пробросилось без помех. Вы не захотите, чтобы ошибка доступа при очистке скрыла реальный баг, ставший причиной сбоя.

Где этот паттерн перестает помогать

Атомарная замена файла предотвращает частичную запись (torn writes). Она не предотвращает потерю обновлений. Если два экземпляра вашего CLI одновременно прочитают один и тот же конфиг, оба внесут правки в памяти, оба запишут новые временные файлы и оба выполнят переименование, победит второе переименование. Первый процесс не «увидел» изменений второго процесса. В зависимости от вашего приложения, это может означать, что один пользователь добавит настройку в одном терминале, а другой пользователь удалит её в другом, и в итоге файл будет отражать изменения только последнего автора.

Если вашему инструменту нужна поддержка параллельного изменения данных, вам потребуется механизм координации поверх атомарной записи. Для простых случаев подойдет рекомендательный файл блокировки (advisory lock file). Векторы версий или монотонный номер ревизии внутри самого конфига могут помочь обнаружить коллизии, чтобы второй автор мог повторить попытку. Это усложняет систему, а именно в сложностях и прячутся баги.

Вот почему важна эта граница. Один JSON-объект, который процесс обновляет время от времени, — отличный кандидат для атомарной записи в файл. Как только вы начнете управлять множеством записей, внедрять схемы или беспокоиться о параллельных изменениях, вы поймете, что переросли файловую систему. SQLite существует именно для этого. Он предоставляет атомарные транзакции, журналы отката и корректную обработку параллельных читателей и писателей — и всё это внутри одного локального файла. Умный протокол работы с файлами — это не база данных, и не стоит тратить бюджет на поддержку, делая вид иначе.

Главный вывод

В следующий раз, когда вы решите использовать writeFile внутри CLI-инструмента, остановитесь. Сериализация — это не самая сложная часть. Сложность заключается в обеспечении сохранности (durability). Конфигурационные файлы слишком малы для потоковой передачи и слишком важны, чтобы их можно было просто обрезать. Запишите всю полезную нагрузку в скрытый соседний файл, сбросьте буфер, зафиксируйте изменения через переименование и сообщите об этом директории. Ваши пользователи могут нажать Ctrl-C, выдернуть шнур питания или закрыть крышку ноутбука. Когда компьютер снова включится, файл будет содержать либо старый мир, либо новый. Ничего промежуточного.