Internal Server Errorのレスポンスに含める情報を減らす

[sabonerune]

内容

例外発生時に例外の内容をdetailに載せて500エラーを返しているコードが複数あります。

voicevox_engine/voicevox_engine/app/routers/preset.py

Lines 35 to 36 in cf25ebf

	except PresetInternalError as err:
	raise HTTPException(status_code=500, detail=str(err))

500エラーは通常、エンジンの内部エラーでありエラーの内容をクライアントに送信してもクライアントには何もできません。
それどころかクライアントに伝えるべきではない情報を送ってしまうリスクにもなります。

detailに含める情報を最小限にして細かな内容はログに表示するようにするべきです。

• ref: FIX: プリセットマネージャーのエラーハンドリングを改善 #1489

Pros 良くなる点

セキュリティリスクの軽減

Cons 悪くなる点

クライアントのみから見た時エンジンのエラー内容がわかりにくくなる。

実現方法

500エラーのdetailに含める情報を最小限に減らす。
例外をprint_exc()等でログに表示するようにする。

[Hiroshiba]

issue作成ありがとうございます！！

仰るとおり、一律で500系エラーの場合は詳細を返さないのが良いと思いました。
もし返したほうが良い詳細がありそうであれば議論したいですね！