ファイル保存全般をアトミックにする #2308
ファイル保存全般をアトミックにする #2308
Conversation
tsunekazuomija
requested review from
Hiroshiba
and removed request for
a team
|
ビルドに失敗してますね... |
src/helpers/fileHelper.ts
Outdated
There was a problem hiding this comment.
fileHelper.tsはレンダラープロセスで使用されています。
そのためnodeAPI(fsやmove-file)をインポートするとバンドルに失敗してビルドが失敗しているのではないかと思います。
There was a problem hiding this comment.
webアプリ全般に詳しくなく、見当がついていない状況だったので、レビュー大変助かります！
fileHelper.tsはレンダラープロセスで使用されています。
そのためnodeAPI(fsやmove-file)をインポートするとバンドルに失敗してビルドが失敗しているのではないかと思います。
なるほどです。であれば、追加するヘルパー関数はsrc/backend/electron以下に別途ファイルを作るなどして、メインプロセスからのみ使用するファイルに記載する必要がありそうですね。
メインプロセス、レンダラープロセスについて理解していない部分があるので、調べつつ修正してみます！
There was a problem hiding this comment.
あっ！！！ なるほど、すみませんでした！！！！
とりあえず一旦の解決策としては、electron用のディレクトリにヘルパー関数を置くのが良さそうだと思います！！
（と言おうとしたら既にそう提案されてますね！！！ 非常に良いと思います！！！）
ちなみに取っ掛かりとしてelectronの仕組みをちょっとだけご説明すると。
electronはchromiumブラウザでGUIを表示するプロセス（レンダラー側）と、あとはそのGUIを起動したり、ブラウザではできないことをする用のメインプロセスに分かれていて、ファイル操作はメインプロセスじゃないとできないようになっている感じです！
なのでレンダラー側からファイル操作の処理をimportしたときに、そんなものがないのでエラーになる感じかなと･･･！！
There was a problem hiding this comment.
お気になさらず…！むしろ、勉強になってよかったなと
electronについても教えていただき、ありがとうございます！
修正してみるので、お待ちいただければです！
|
修正してみました！ |
src/backend/electron/fileHelper.ts
Outdated
| const temp_path = `${path}.tmp`; | ||
| await fs.promises.writeFile(temp_path, data); | ||
|
|
||
| await moveFile(temp_path, path, { |
There was a problem hiding this comment.
あ、これ元コードで気づかなかったけどsnake_caseになってますね！
ちょっとついでにcamelCaseに直しちゃえると！！
| const temp_path = `${path}.tmp`; | |
| await fs.promises.writeFile(temp_path, data); | |
| await moveFile(temp_path, path, { | |
| const tempPath = `${path}.tmp`; | |
| await fs.promises.writeFile(tempPath, data); | |
| await moveFile(tempPath, path, { |
src/backend/electron/fileHelper.ts
Outdated
| export async function writeFileSafely( | ||
| path: string, | ||
| data: string | NodeJS.ArrayBufferView, | ||
| ) { | ||
| // ファイル書き込みに失敗したときに設定が消えないように、tempファイル書き込み後上書き移動する |
There was a problem hiding this comment.
コメントはこう書いておくと、VSCodeで関数をマウスオーバーした時にドキュメントが表示されてちょっと便利だったりします！
/** ファイル書き込みに失敗したときに設定が消えないように、tempファイル書き込み後上書き移動する */
| export async function writeFileSafely( | |
| path: string, | |
| data: string | NodeJS.ArrayBufferView, | |
| ) { | |
| // ファイル書き込みに失敗したときに設定が消えないように、tempファイル書き込み後上書き移動する | |
| export async function writeFileSafely( | |
| path: string, | |
| data: string | NodeJS.ArrayBufferView, | |
| ) { |
|
あっとすみません！
|
|
ああ、こちらリポジトリの設定でお手数をお掛けしてすみません！ |
の3点を修正してみました！ |
ファイル保存全般をアトミックにする
@RikitoNoto さんが #2098 で作成してくださったファイル保存を
src/helpers/fileHelper.tsにヘルパー関数として切り出しました。上記のファイルはレンダラープロセスからも参照されるため、
src/backend/electron/fileHelper.tsにヘルパー関数として切り出しました。それに伴い、
src/backend/electron/electronConfig.tsのElectronConfigManager.savesrc/backend/electron/main.tsのWRITE_FILE部分src/backend/electron/manager/RuntimeInfoManager.tsのexportFile関数のファイル保存処理をヘルパー関数で置き換えました。
それぞれ、
設定/ツールバーのカスタマイズから設定を変更し、保存ボタンを押した時にwriteFileSafelyのmoveFile呼び出しの前でelectronを停止したときにtmpファイルが存在しており、electronを再起動してファイルが正しく開ける/正しく起動できることを確認しました。
関連 Issue
ref #2103 #2098
close #2103
その他
src/backend/electron/main.tsのWRITE_FILE部分を非同期関数に変えてしまったのですが、こちらで問題ないでしょうか？