トーク：テキスト処理し忘れなくする仕組みを実装したい

[Hiroshiba]

内容

トークのテキストにはルビ機能やメモ機能があり、テキストからそれらの記号を取り外した後、エンジンに音声をリクエストするっていう経路になっています。

ただテキストを読み込む経路も3種類ぐらいあり、それぞれに実装しなくちゃいけなかったり、そもそも実装し忘れてたりということがどうしても発生します。
読み込む経路だけではなく書き込む経路も同様で、経路が多数存在して同じようなことが起こりやすいです。

いくら気をつけていてもどうしても気づかないので、可能であれば仕組みとして解決したいです。
誰か良い実装方針などはないでしょうか。

実現方法

例えばただのテキストだと変更前などが変更後なのかがわからないので、stringをブランド型にしてしまうという手があるかもしれません。
ブランド型はこんな感じで実装できます。

voicevox/src/plugins/hotkeyPlugin.ts

Line 38 in 6801519

type BindingKey = string & { __brand: "BindingKey" }; // BindingKey専用のブランド型

同じようにしてstring & __brandにし、テキストの変更前と変更後、保存用テキストをそれぞれ型を付けてあげて、専用の変換関数を通さないと型を変換できないようにすれば、間違えてしまうのを防げるかもしれません。

その他

現状とソースコードを読める力とTypeScriptの力が必要そうですが、実装者募集中です！

[sevenc-nanashi]

https://www.typescriptlang.org/play/?#code/C4TwDgpgBAggNnACgJwPYGMIGcsQCZQC8UWwyAlgHYDmUAZFAN5QD6LyArgEYgthqYc+AFxQyHCAG5WLALYRZqPgOy48o8dAC+AKFCQoAJW4gUGVfiIkyVWg2ZtOPZeaHqxnbXvDQAsgtQzQTUrUgoaeiYZeUUXYJEPCShdHXRUSlIoADMqAEM4KwAKYAgAD2BReCQVNwBKIgA+JhS0jOAoflcsYx4rAB4AFSgykso8LGtw6gbikdEB2vnIntMakMIm5mQIYA5kSjERqFyJoYYVoIsCXVbMzuD-RX6hkYgxibDbGZLy+cWoM5QR6BNaWDZRba7faHcrHU6RYGXNzJKA6HQ5Sj5QoAIh+wGxtXReTghXuqhWOLxBMJGKxZJwwMpI2pRMxJPp3RMpLWjNxzNqAqAA

試作してみました。頑張れば良い感じにできそう？

[weweweok]

こちらで、話題に上がった方法をメモします。

• fix: テキスト読み込みでルビ文字列を削除 #2084 (review)

テキストを無視する処理は、audio_queryや、accent_phrasesを生成する処理の直前に行った方が、記述ミスが減りそうな気がしました。

と私が言って、

場所によっては無視しない方がいい気もするので、変換を行うかの引数を作るのとかどうでしょうか？

と、ヒホさんが仰った流れです。

audio_queryの場合、この辺りの引数を変える必要がありそうです。

voicevox/src/store/audio.ts

Lines 946 to 954 in 279ab2c

	FETCH_AUDIO_QUERY: {
	action(
	{ dispatch },
	{
	text,
	engineId,
	styleId,
	}: { text: string; engineId: EngineId; styleId: StyleId },
	) {