fix: config.json の validation 失敗時にわかりやすいログを出すように #1222

raa0121 · 2023-02-22T02:22:42Z

内容

config.json の validation に失敗した時にエラーが出るが、わかりにくいため、別途ログを出すようにしました。
Discord の経緯 https://discord.com/channels/879570910208733277/893889888208977960/1077566801602424963
折りたたみにエラー例を追加しておきました。

Error: Config schema violation: `defaultStyleIds/0/engineId` must match format "uuid"; `defaultStyleIds/0/engineId` must be equal to constant; `defaultStyleIds/0/engineId` must match a schema in anyOf; `defaultStyleIds/1/engineId` must match format "uuid"; `defaultStyleIds/
1/engineId` must be equal to constant; `defaultStyleIds/1/engineId` must match a schema in anyOf; `defaultStyleIds/2/engineId` must match format "uuid"; `defaultStyleIds/2/engineId` must be equal to constant; `defaultStyleIds/2/engineId` must match a schema in anyOf; `defau
ltStyleIds/3/engineId` must match format "uuid"; `defaultStyleIds/3/engineId` must be equal to constant; `defaultStyleIds/3/engineId` must match a schema in anyOf; `defaultStyleIds/4/engineId` must match format "uuid"; `defaultStyleIds/4/engineId` must be equal to constant;
 `defaultStyleIds/4/engineId` must match a schema in anyOf; `defaultStyleIds/5/engineId` must match format "uuid"; `defaultStyleIds/5/engineId` must be equal to constant; `defaultStyleIds/5/engineId` must match a schema in anyOf; `defaultStyleIds/6/engineId` must match form
at "uuid"; `defaultStyleIds/6/engineId` must be equal to constant; `defaultStyleIds/6/engineId` must match a schema in anyOf; `defaultStyleIds/7/engineId` must match format "uuid"; `defaultStyleIds/7/engineId` must be equal to constant; `defaultStyleIds/7/engineId` must mat
ch a schema in anyOf; `defaultStyleIds/8/engineId` must match format "uuid"; `defaultStyleIds/8/engineId` must be equal to constant; `defaultStyleIds/8/engineId` must match a schema in anyOf; `defaultStyleIds/9/engineId` must match format "uuid"; `defaultStyleIds/9/engineId
` must be equal to constant; `defaultStyleIds/9/engineId` must match a schema in anyOf; `defaultStyleIds/10/engineId` must match format "uuid"; `defaultStyleIds/10/engineId` must be equal to constant; `defaultStyleIds/10/engineId` must match a schema in anyOf; `defaultStyle
Ids/11/engineId` must match format "uuid"; `defaultStyleIds/11/engineId` must be equal to constant; `defaultStyleIds/11/engineId` must match a schema in anyOf; `defaultStyleIds/12/engineId` must match format "uuid"; `defaultStyleIds/12/engineId` must be equal to constant; `
defaultStyleIds/12/engineId` must match a schema in anyOf; `defaultStyleIds/13/engineId` must match format "uuid"; `defaultStyleIds/13/engineId` must be equal to constant; `defaultStyleIds/13/engineId` must match a schema in anyOf; `defaultStyleIds/14/engineId` must match f
ormat "uuid"; `defaultStyleIds/14/engineId` must be equal to constant; `defaultStyleIds/14/engineId` must match a schema in anyOf; `defaultStyleIds/15/engineId` must match format "uuid"; `defaultStyleIds/15/engineId` must be equal to constant; `defaultStyleIds/15/engineId` 
must match a schema in anyOf; `defaultStyleIds/16/engineId` must match format "uuid"; `defaultStyleIds/16/engineId` must be equal to constant; `defaultStyleIds/16/engineId` must match a schema in anyOf; `defaultStyleIds/17/engineId` must match format "uuid"; `defaultStyleId
s/17/engineId` must be equal to constant; `defaultStyleIds/17/engineId` must match a schema in anyOf; `defaultStyleIds/18/engineId` must match format "uuid"; `defaultStyleIds/18/engineId` must be equal to constant; `defaultStyleIds/18/engineId` must match a schema in anyOf
    at wL._validate (C:\msys64\home\raa0121\develop\voicevox\dist\background.js:18:37971)
    at get store [as store] (C:\msys64\home\raa0121\develop\voicevox\dist\background.js:18:36709)
    at new G (C:\msys64\home\raa0121\develop\voicevox\dist\background.js:18:34631)
    at new wL (C:\msys64\home\raa0121\develop\voicevox\dist\background.js:18:40682)
    at Object.<anonymous> (C:\msys64\home\raa0121\develop\voicevox\dist\background.js:539:1165)
    at Module._compile (node:internal/modules/cjs/loader:1120:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1175:10)
    at Module.load (node:internal/modules/cjs/loader:988:32)
    at Module._load (node:internal/modules/cjs/loader:829:12)
    at c._load (node:electron/js2c/asar_bundle:5:13343)
    at loadApplicationPackage (C:\msys64\home\raa0121\develop\voicevox\node_modules\electron\dist\resources\default_app.asar\main.js:121:16)
    at Object.<anonymous> (C:\msys64\home\raa0121\develop\voicevox\node_modules\electron\dist\resources\default_app.asar\main.js:233:9)
    at Module._compile (node:internal/modules/cjs/loader:1120:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1175:10)
    at Module.load (node:internal/modules/cjs/loader:988:32)
    at Module._load (node:internal/modules/cjs/loader:829:12)

Hiroshiba

PRありがとうございます！！

src/background.ts

Hiroshiba

LGTM！！

ありがとうございます、結構いろんな方が詰まるポイントだったので助かります！！
一点だけコメントしてみました！

sevenc-nanashi · 2023-02-22T07:28:56Z

src/background.ts

+  log.error(
+    `設定ファイルの読み込みに失敗しました。${app.getPath(
+      "userData"
+    )}にあるconfig.json の名前を変えることで解決することがあります（ただし設定がすべてリセットされます）。`


フォルダを開くボタン（またはリネームして再起動ボタン）を追加してあげると親切なような気がしました。

electron 自体が起動する前なので、ウィンドウを出すのも厳しい気がします。
検証はしてみますが。

https://www.electronjs.org/ja/docs/latest/api/dialog#dialogshowerrorboxtitle-content

app モジュールで ready イベントが発生する前でも、このAPIは安全に呼び出すことができます。これは、起動の初期段階でのエラーを報告するのによく使用されます。

これが使えそう？
選択はできませんが

あ、僕もちょっと思いました。ダイアログにしたら良さそうだなと。
たしかにdialog.showErrorBox使えそうですね！！
他にもdialog.showErrorBox使ってる所あるので参考になるかもです。

dialog.showErrorBox を出した後に、shell.openPath や shell.showItemInFolder でフォルダを開けないか試してみましたが、流石に ready 前なので動かなそうでした。
ひとまず dialog.showErrorBox にしますね。

個人的には依存増やしてまで（メンテコスト増やしてまで）ディレクトリ開く機能を付けるのはしなくても良いかも？と思いました。
まあ、@raa0121 さんのやりたいように…！

私も同じく、依存を増やすほどじゃないかなと思いました。

どうでしょう？ @sevenc-nanashi
まあ良いかと思える感じであればapproveいただけると！！

依存を増やしたくない、なるほど（そういう考えをしたことが無かった）

まぁ大丈夫だと思います。
（ボタンを提案した理由はファイルパスを手打ちしなくてもいいから。エラーダイアログはコピペが出来ないので）

手打ちが面倒なのはめちゃわかります。
そもそも開発者向けには、やはりconfig.jsonをクリアする方法を提供するのが一番いいかなと思いました。
（そしてそれは結構実装が大変。electron-storeの仕様が。。。 😇 ）

src/background.ts

sevenc-nanashi

🚀

Hiroshiba · 2023-02-23T16:27:58Z

レビューありです！！　マージします！！

fix: config.json の validation 失敗時にわかりやすいログを出すように

c4b17c2

raa0121 requested a review from a team as a code owner February 22, 2023 02:22

raa0121 requested review from Hiroshiba and removed request for a team February 22, 2023 02:22

Hiroshiba reviewed Feb 22, 2023

View reviewed changes

src/background.ts Show resolved Hide resolved

src/background.ts Outdated Show resolved Hide resolved

raa0121 added 2 commits February 22, 2023 11:49

catch 後にprocess.exit(1)するようにし、ログの文章を提案されたものに

60e6867

fmt

8f36e1e

Hiroshiba reviewed Feb 22, 2023

View reviewed changes

src/background.ts Outdated Show resolved Hide resolved

Hiroshiba approved these changes Feb 22, 2023

View reviewed changes

sevenc-nanashi reviewed Feb 22, 2023

View reviewed changes

log.error からダイアログに変更して、process.exit から上位へ throw するように

bdbc440

sevenc-nanashi requested changes Feb 23, 2023

View reviewed changes

src/background.ts Show resolved Hide resolved

app.exit してから throw するように

ff5d5ac

sevenc-nanashi approved these changes Feb 23, 2023

View reviewed changes

Hiroshiba merged commit eb11467 into VOICEVOX:main Feb 23, 2023

raa0121 deleted the fix-config-json-validation branch February 24, 2023 12:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: config.json の validation 失敗時にわかりやすいログを出すように #1222

fix: config.json の validation 失敗時にわかりやすいログを出すように #1222

raa0121 commented Feb 22, 2023

Hiroshiba left a comment

Hiroshiba left a comment

sevenc-nanashi Feb 22, 2023

raa0121 Feb 22, 2023

sevenc-nanashi Feb 22, 2023 •

edited

Loading

Hiroshiba Feb 22, 2023 •

edited

Loading

raa0121 Feb 22, 2023

Hiroshiba Feb 23, 2023 •

edited

Loading

raa0121 Feb 23, 2023

Hiroshiba Feb 23, 2023

sevenc-nanashi Feb 23, 2023 •

edited

Loading

Hiroshiba Feb 23, 2023

sevenc-nanashi left a comment

Hiroshiba commented Feb 23, 2023

fix: config.json の validation 失敗時にわかりやすいログを出すように #1222

fix: config.json の validation 失敗時にわかりやすいログを出すように #1222

Conversation

raa0121 commented Feb 22, 2023

内容

Hiroshiba left a comment

Choose a reason for hiding this comment

Hiroshiba left a comment

Choose a reason for hiding this comment

sevenc-nanashi Feb 22, 2023

Choose a reason for hiding this comment

raa0121 Feb 22, 2023

Choose a reason for hiding this comment

sevenc-nanashi Feb 22, 2023 • edited Loading

Choose a reason for hiding this comment

Hiroshiba Feb 22, 2023 • edited Loading

Choose a reason for hiding this comment

raa0121 Feb 22, 2023

Choose a reason for hiding this comment

Hiroshiba Feb 23, 2023 • edited Loading

Choose a reason for hiding this comment

raa0121 Feb 23, 2023

Choose a reason for hiding this comment

Hiroshiba Feb 23, 2023

Choose a reason for hiding this comment

sevenc-nanashi Feb 23, 2023 • edited Loading

Choose a reason for hiding this comment

Hiroshiba Feb 23, 2023

Choose a reason for hiding this comment

sevenc-nanashi left a comment

Choose a reason for hiding this comment

Hiroshiba commented Feb 23, 2023

sevenc-nanashi Feb 22, 2023 •

edited

Loading

Hiroshiba Feb 22, 2023 •

edited

Loading

Hiroshiba Feb 23, 2023 •

edited

Loading

sevenc-nanashi Feb 23, 2023 •

edited

Loading