ファイル保存全般をアトミック操作にする

[Hiroshiba]

内容

VOICEVOXでファイル保存する時、大体はファイルに直接書き込む形で実装されています。

voicevox/src/backend/electron/main.ts

Lines 998 to 1007 in bba1060

	ipcMainHandle("WRITE_FILE", (_, { filePath, buffer }) => {
	try {
	fs.writeFileSync(filePath, new DataView(buffer));
	return success(undefined);
	} catch (e) {
	// throwだと`.code`の情報が消えるのでreturn
	const a = e as SystemError;
	return failure(a.code, a);
	}
	});

この操作は割と危なくて、何かしらの原因で途中で書き込みが中断してしまうことがあると、中途半端な値が保存されて設定ファイルが壊れます。
特にプロジェクトファイルは膨大な作業量の賜物なので、慎重に上書きしてあげたいです。

このissueは↑のWRITE_FILEと、あとRuntimeInfoManager.tsにあるwriteFileがアトミック操作になれば完了だと思います。

voicevox/src/backend/electron/manager/RuntimeInfoManager.ts

Lines 89 to 92 in bba1060

	await fs.promises.writeFile(
	this.runtimeInfoPath,
	JSON.stringify(runtimeInfoFormatFor3rdParty), // FIXME: zod化する
	);

Pros 良くなる点

意図しないデータの削除が発生しにくくなる

Cons 悪くなる点

ないはず

実現方法

同じディレクトリに一時ファイルを書き出し、mvするのが安全だと思います。
アトミック操作にする処理は @RikitoNoto さんが↓で実装してくださいました！

• 設定ファイルの保存をアトミック操作に変更 #2098

この操作を関数切り出ししていろんなところで使えるようにし、いろんなところで使えば解決かもしれません。

その他

不明な点があれば何でもお聞きください！

[tsunekazuomija]

こんにちは！
こちらのタスクに取り組んで見たいのですが、よろしいでしょうか？

また、タスクについて一点質問なのですが、
切り出した関数はsrc/helpersフォルダ下にファイルを作成して保存する
という形で良いでしょうか？

[Hiroshiba]

@tsunekazuomija もちろんです、ぜひぜひ！！

切り出した関数はsrc/helpersフォルダ下にファイルを作成して保存する
という形で良いでしょうか？

とても良いと思います！
今見てみたらすでにfileHelper.tsファイルがあったので、切り出す関数によってはとりあえずここに書いても良いかもですね･･･！
https://github.com/VOICEVOX/voicevox/blob/b0d8c2e8aa843f380c36352fdcc6e6c1b8bfb66f/src/helpers/fileHelper.ts

なにかあればかなり気軽にお聞きいただければ 🙏

[tsunekazuomija]

ありがとうございます！
確かにfileHelper.tsにまとまっていたほうが良さそうです！
その方針で進めてみます！

[Hiroshiba]

ぜひぜひ！！