electron-storeのマイグレーション処理を自前で行う

[Hiroshiba]

内容

electron-storeのマイグレーションは、まず過去のjsonオブジェクトを現在のjsonスキーマでバリデーションする仕様になっています。

• validate after migration. sindresorhus/conf#173

この影響で、過去のjsonオブジェクトが現在のjsonスキーマに合わなかった場合、マイグレーション前にエラーが出ます。

• 複数エンジン対応: テキスト読み込みを複数エンジンに対応 #1119 (comment)

なので、設定ファイルのマイグレーションはelectron-storeに頼らず、jsonオブジェクトを更新する形で自前実装したほうが楽になりそうです。

Pros 良くなる点

electron-storeの仕様に付き合わなくて良くなる

Cons 悪くなる点

自前実装が必要

実現方法

プロジェクトファイルのマイグレーションと同じ流れになりそうです。
こんな感じで、semverでsatisfyしてobjを書き換えるだけで良いかなと思います。

voicevox/src/store/project.ts

Lines 112 to 131 in 4a84ac7

	if (
	semver.satisfies(projectAppVersion, "<0.4", semverSatisfiesOptions)
	) {
	for (const audioItemsKey in obj.audioItems) {
	if ("charactorIndex" in obj.audioItems[audioItemsKey]) {
	obj.audioItems[audioItemsKey].characterIndex =
	obj.audioItems[audioItemsKey].charactorIndex;
	delete obj.audioItems[audioItemsKey].charactorIndex;
	}
	}
	for (const audioItemsKey in obj.audioItems) {
	if (obj.audioItems[audioItemsKey].query != null) {
	obj.audioItems[audioItemsKey].query.volumeScale = 1;
	obj.audioItems[audioItemsKey].query.prePhonemeLength = 0.1;
	obj.audioItems[audioItemsKey].query.postPhonemeLength = 0.1;
	obj.audioItems[audioItemsKey].query.outputSamplingRate =
	DEFAULT_SAMPLING_RATE;
	}
	}
	}

問題としては、たしかelectron-storeは設定jsonオブジェクトを受け取れないはずです。
勝手にconfig.jsonを読み込むので、どのタイミングでどうやってマイグレーションした結果を反映すれば良いのかが若干見えないでいます。
（いっそelectron-storeから脱却したほうが良いかも･･･？）

[Hiroshiba]

こちらのプルリクエストで解決しました！（thx @sevenc-nanashi !!!）

• electron-storeから離脱する #1610