writeAtomic, everywhere a file lands
the .part-then-rename rule was applied at two upload routes yesterday and by this morning the platform had a dozen other writes putting files in the same folders — an OCR result beside its image, a TTS clip, a download landing, a save from the editor — every one straight to the final name. a guarantee that holds for two of fourteen paths is not a guarantee, and the next person adding a fifteenth had nothing to copy. so it is a function now, and every durable write goes through it: the file browser, sendoff, task definitions, skill and tool files, bug reports, scraped attachments, the chat provider config. the failure it prevents is silent rather than loud. a truncated m4a decodes fine, it is simply short — a commander transcribing recordings as they land would produce a clean transcript of the first few seconds of a two-minute memo and report success. two things learned writing it. Bun.write creates the parent chain itself, so the mkdir option i added was dead weight and several callers were doing it twice. and Parameters<typeof Bun.write>[1] resolves to the first overload only — BunFile — which rejects the string and Buffer every caller actually passes. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Officer-Session: 656f5c85-e49a-4f1f-b9f3-042a04b4d043
This commit is contained in:
@@ -2,6 +2,7 @@ import { createRouter } from '../../create-router';
|
||||
import { mkdir } from 'node:fs/promises';
|
||||
import { join } from 'node:path';
|
||||
import { DATA_PATH } from '@@/data-path';
|
||||
import { writeAtomic } from '@@/write-atomic';
|
||||
|
||||
// Bug reports land on disk and nowhere else.
|
||||
//
|
||||
@@ -42,10 +43,10 @@ bugReportRouter.post('/', async (ctx) => {
|
||||
createdAt: new Date().toISOString(),
|
||||
};
|
||||
|
||||
await Bun.write(join(reportDir, 'report.json'), JSON.stringify(report, null, 2));
|
||||
await writeAtomic(join(reportDir, 'report.json'), JSON.stringify(report, null, 2));
|
||||
|
||||
if (screenshot instanceof File) {
|
||||
await Bun.write(join(reportDir, 'screenshot.png'), Buffer.from(await screenshot.arrayBuffer()));
|
||||
await writeAtomic(join(reportDir, 'screenshot.png'), Buffer.from(await screenshot.arrayBuffer()));
|
||||
}
|
||||
|
||||
return ctx.json({ ok: true, id: dirName });
|
||||
|
||||
@@ -4,6 +4,7 @@ import { readdir, stat, mkdir, rm, rename, readFile, cp } from 'node:fs/promises
|
||||
import { existsSync } from 'node:fs';
|
||||
import { getOwnerHomeDir, DATA_PATH } from '@@/data-path';
|
||||
import { resolveHomeDir } from '@@/user-home';
|
||||
import { writeAtomic } from '@@/write-atomic';
|
||||
import * as errors from '@@/custom-errors';
|
||||
import { readTtsConfig } from '@@/api/server-settings/tts';
|
||||
import { readOcrConfig } from '@@/api/server-settings/ocr';
|
||||
@@ -253,7 +254,7 @@ router.post('/write', async (ctx) => {
|
||||
|
||||
const absPath = resolveUserPath(rootDir, path);
|
||||
await mkdir(dirname(absPath), { recursive: true });
|
||||
await Bun.write(absPath, content);
|
||||
await writeAtomic(absPath, content);
|
||||
return ctx.json({ ok: true });
|
||||
});
|
||||
|
||||
@@ -306,16 +307,7 @@ router.post('/upload', async (ctx) => {
|
||||
if (!isInside(rootDir, filePath)) continue;
|
||||
await mkdir(dirname(filePath), { recursive: true });
|
||||
|
||||
const partPath = `${filePath}.part`;
|
||||
try {
|
||||
await Bun.write(partPath, file);
|
||||
await rename(partPath, filePath);
|
||||
} catch (err) {
|
||||
// Leave nothing half-named. Only an interrupted PROCESS leaves a fragment behind, which is
|
||||
// the case worth being able to see.
|
||||
await rm(partPath, { force: true }).catch(() => {});
|
||||
throw err;
|
||||
}
|
||||
await writeAtomic(filePath, file);
|
||||
}
|
||||
|
||||
return ctx.json({ ok: true });
|
||||
@@ -815,7 +807,7 @@ router.post('/tts', async (ctx) => {
|
||||
const siblingRel = dir ? `${dir}/${name}.mp3` : `${name}.mp3`;
|
||||
const siblingAbs = resolveUserPath(rootDir, siblingRel);
|
||||
const cached = await readFile(cacheAbs);
|
||||
await Bun.write(siblingAbs, cached);
|
||||
await writeAtomic(siblingAbs, cached);
|
||||
return ctx.json({ audioPath: `/${siblingRel}`, audioRoot: root ?? 'home', cached: true });
|
||||
}
|
||||
return ctx.json({ audioPath: cacheRel, audioRoot: 'user-data' });
|
||||
@@ -845,12 +837,12 @@ router.post('/tts', async (ctx) => {
|
||||
|
||||
await mkdir(dirname(cacheAbs), { recursive: true });
|
||||
const buffer = await res.arrayBuffer();
|
||||
await Bun.write(cacheAbs, buffer);
|
||||
await writeAtomic(cacheAbs, buffer);
|
||||
|
||||
if (saveNextTo) {
|
||||
const siblingRel = dir ? `${dir}/${name}.mp3` : `${name}.mp3`;
|
||||
const siblingAbs = resolveUserPath(rootDir, siblingRel);
|
||||
await Bun.write(siblingAbs, buffer);
|
||||
await writeAtomic(siblingAbs, buffer);
|
||||
return ctx.json({ audioPath: `/${siblingRel}`, audioRoot: root ?? 'home', cached: false });
|
||||
}
|
||||
|
||||
@@ -900,7 +892,7 @@ router.post('/tts-text', async (ctx) => {
|
||||
|
||||
await mkdir(dirname(cacheAbs), { recursive: true });
|
||||
const buffer = await res.arrayBuffer();
|
||||
await Bun.write(cacheAbs, buffer);
|
||||
await writeAtomic(cacheAbs, buffer);
|
||||
|
||||
return ctx.json({ audioPath: cacheRel, audioRoot: 'user-data' });
|
||||
});
|
||||
@@ -972,7 +964,7 @@ router.post('/ocr', async (ctx) => {
|
||||
if (saveNextTo) {
|
||||
const siblingRel = dir ? `${dir}/${name}.md` : `${name}.md`;
|
||||
const siblingAbs = resolveUserPath(rootDir, siblingRel);
|
||||
await Bun.write(siblingAbs, text);
|
||||
await writeAtomic(siblingAbs, text);
|
||||
return ctx.json({ ocrPath: `/${siblingRel}`, ocrRoot: root ?? 'home', cached: false });
|
||||
}
|
||||
|
||||
|
||||
@@ -2,6 +2,7 @@ import { createRouter } from '../create-router';
|
||||
import { readdir, mkdir, rm } from 'node:fs/promises';
|
||||
import { join, dirname } from 'node:path';
|
||||
import { itemsDir, type ItemType } from '../data-path';
|
||||
import { writeAtomic } from '@@/write-atomic';
|
||||
|
||||
// Shared router for the flat, file-based item types (skills, tools, processes). Each item is a
|
||||
// directory under $OFFICER_ITEMS_DIR/<type>/<dirName>/ holding a single markdown file (SKILL.md /
|
||||
@@ -114,8 +115,8 @@ export function createItemRouter({ type, fileName, label }: ItemRouterConfig) {
|
||||
const { sessionId, messages } = await ctx.req.json<{ sessionId: string; messages: unknown[] }>();
|
||||
|
||||
await mkdir(chatDir, { recursive: true });
|
||||
await Bun.write(join(chatDir, 'messages.json'), JSON.stringify(messages));
|
||||
if (sessionId) await Bun.write(join(chatDir, 'meta.json'), JSON.stringify({ id: sessionId }));
|
||||
await writeAtomic(join(chatDir, 'messages.json'), JSON.stringify(messages));
|
||||
if (sessionId) await writeAtomic(join(chatDir, 'meta.json'), JSON.stringify({ id: sessionId }));
|
||||
|
||||
return ctx.json({ ok: true });
|
||||
});
|
||||
@@ -140,7 +141,7 @@ export function createItemRouter({ type, fileName, label }: ItemRouterConfig) {
|
||||
if (await Bun.file(filePath).exists()) return ctx.text(`${label} already exists`, 409);
|
||||
|
||||
await mkdir(dirname(filePath), { recursive: true });
|
||||
await Bun.write(filePath, `---\nname: ${name.trim()}\ndescription: \n---\n`);
|
||||
await writeAtomic(filePath, `---\nname: ${name.trim()}\ndescription: \n---\n`);
|
||||
|
||||
return ctx.json({ name: name.trim(), dirName, filePath });
|
||||
});
|
||||
|
||||
@@ -3,6 +3,7 @@ import { mkdir } from 'node:fs/promises';
|
||||
import { join } from 'node:path';
|
||||
import { chromium, type Browser } from 'playwright';
|
||||
import { getTmpAttachmentsDir, getAttachmentsDir } from '@@/data-path';
|
||||
import { writeAtomic } from '@@/write-atomic';
|
||||
|
||||
const MAX_CONTENT_LENGTH = 100_000;
|
||||
|
||||
@@ -148,7 +149,7 @@ scrapeRouter.post('/', async (ctx) => {
|
||||
}
|
||||
|
||||
await mkdir(saveDir, { recursive: true });
|
||||
await Bun.write(join(saveDir, attachmentId), html);
|
||||
await writeAtomic(join(saveDir, attachmentId), html);
|
||||
|
||||
return ctx.json({ url, title, content, attachmentId });
|
||||
} catch (err) {
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { mkdir, rename, rm } from 'node:fs/promises';
|
||||
import { mkdir } from 'node:fs/promises';
|
||||
import { existsSync } from 'node:fs';
|
||||
import { extname, join } from 'node:path';
|
||||
import { createRouter } from '../../create-router';
|
||||
@@ -17,6 +17,7 @@ import {
|
||||
upsertSendoffDevice,
|
||||
} from 'officerdb';
|
||||
import { getNotifyServerUrl, notifyProducerHeaders } from '../notify/router';
|
||||
import { writeAtomic } from '@@/write-atomic';
|
||||
import { displayNameFor, folderNameFor, safeFilename, safeSegment, sendoffDirFor } from './paths';
|
||||
|
||||
/*
|
||||
@@ -152,19 +153,11 @@ sendoffRouter.post('/send', async (ctx) => {
|
||||
await mkdir(dir, { recursive: true });
|
||||
|
||||
const written: { name: string; size: number }[] = [];
|
||||
// Aside, then rename — the same reasoning as the file browser upload, and it matters more here
|
||||
// because this is a folder things ARRIVE in unattended. Neither a recipient watching it nor the
|
||||
// notification below may point at a name that is still being written.
|
||||
// `writeAtomic` matters more here than anywhere: this is a folder things ARRIVE in unattended.
|
||||
// Neither a recipient watching it nor the notification below may point at a name still being written.
|
||||
for (const file of files) {
|
||||
const path = freePath(dir, safeFilename(file.name));
|
||||
const partPath = `${path}.part`;
|
||||
try {
|
||||
await Bun.write(partPath, await file.arrayBuffer());
|
||||
await rename(partPath, path);
|
||||
} catch (err) {
|
||||
await rm(partPath, { force: true }).catch(() => {});
|
||||
throw err;
|
||||
}
|
||||
await writeAtomic(path, await file.arrayBuffer());
|
||||
written.push({ name: path.split('/').pop() ?? file.name, size: file.size });
|
||||
}
|
||||
|
||||
|
||||
@@ -4,6 +4,7 @@ import { AGENT_CONFIG_DIR } from '../../data-path';
|
||||
import { invalidateModelCache } from '../chat/list-models';
|
||||
import { logger } from '../chat/logger';
|
||||
import { readConfigValue, writeConfigValue } from 'officerdb';
|
||||
import { writeAtomic } from '@@/write-atomic';
|
||||
|
||||
export const chatProvidersRouter = createRouter();
|
||||
|
||||
@@ -69,7 +70,7 @@ async function readModelsConfig(): Promise<ModelConfig> {
|
||||
}
|
||||
|
||||
async function writeModelsConfig(config: ModelConfig): Promise<void> {
|
||||
await Bun.write(MODELS_FILE, JSON.stringify(config, null, 2));
|
||||
await writeAtomic(MODELS_FILE, JSON.stringify(config, null, 2));
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -342,7 +343,7 @@ async function readAuthJson(): Promise<AuthJson> {
|
||||
}
|
||||
|
||||
async function writeAuthJson(auth: AuthJson): Promise<void> {
|
||||
await Bun.write(AUTH_FILE, JSON.stringify(auth, null, 2));
|
||||
await writeAtomic(AUTH_FILE, JSON.stringify(auth, null, 2));
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -2,6 +2,7 @@ import { readdir, mkdir, rm } from 'node:fs/promises';
|
||||
import { join, dirname } from 'node:path';
|
||||
import { itemsDir, OFFICER_ITEMS_DIR } from '../../data-path';
|
||||
import { capabilitySources, type CapabilitySource } from '../../capability-sources';
|
||||
import { writeAtomic } from '@@/write-atomic';
|
||||
|
||||
// File-backed task store. Every task is a directory under $OFFICER_ITEMS_DIR/tasks/<dirName>/ with a
|
||||
// TASK.md (metadata + prose body) and, for script-mode tasks, a sibling implementation file. There are
|
||||
@@ -296,11 +297,11 @@ export async function createTask(input: CreateTaskInput): Promise<TaskSummary &
|
||||
const language = input.language ?? null;
|
||||
|
||||
await mkdir(taskDir(dirName), { recursive: true });
|
||||
await Bun.write(
|
||||
await writeAtomic(
|
||||
taskFile(dirName),
|
||||
buildTaskMd({ name, description: input.description ?? null, version: 1, mode, language }, ''),
|
||||
);
|
||||
if (mode === 'script') await Bun.write(join(taskDir(dirName), implFileName(language)), '');
|
||||
if (mode === 'script') await writeAtomic(join(taskDir(dirName), implFileName(language)), '');
|
||||
|
||||
return {
|
||||
dirName,
|
||||
@@ -327,10 +328,10 @@ export async function updateTask(
|
||||
|
||||
const merged: TaskFrontmatter = { ...existing, ...patch };
|
||||
const body = patch.body ?? existing.body;
|
||||
await Bun.write(taskFile(dirName), buildTaskMd(merged, body));
|
||||
await writeAtomic(taskFile(dirName), buildTaskMd(merged, body));
|
||||
|
||||
if (patch.implementation !== undefined && patch.implementation !== null) {
|
||||
await Bun.write(join(taskDir(dirName), implFileName(merged.language)), patch.implementation);
|
||||
await writeAtomic(join(taskDir(dirName), implFileName(merged.language)), patch.implementation);
|
||||
}
|
||||
|
||||
return getTaskByDirName(dirName);
|
||||
@@ -355,8 +356,8 @@ export async function importTask(
|
||||
record: Partial<TaskFrontmatter> & { body?: string; implementation?: string | null },
|
||||
): Promise<void> {
|
||||
await mkdir(taskDir(dirName), { recursive: true });
|
||||
await Bun.write(taskFile(dirName), buildTaskMd(record, record.body ?? ''));
|
||||
await writeAtomic(taskFile(dirName), buildTaskMd(record, record.body ?? ''));
|
||||
if (record.implementation != null && record.implementation !== '') {
|
||||
await Bun.write(join(taskDir(dirName), implFileName(record.language ?? null)), record.implementation);
|
||||
await writeAtomic(join(taskDir(dirName), implFileName(record.language ?? null)), record.implementation);
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user