store/audio.ts周りのリファクタリング

[thiramisu]

内容

リファクタリング案です。
適当に弄っていたらdiffが1000行を軽く超えたので以下に小分けにしてPRを出そうかと思っています。
一人で完走できるか分からないので、とりあえずまとめておきます。

• テキストファイル出力処理をwriteTextFile()としてファイル先頭に移動
  Refactor: 文字コード系のwriteText関連処理を一箇所にまとめる #1448
• 連番取得処理をchangeTailToNonExistent()としてファイル先頭に移動
  Refactor: 上書き防止処理を関数化し共通化 #1478
• キャラ名+スタイル名から${speakerName}(${styleName || DEFAULT_STYLE_NAME})を返す関数formatCharacterStyleNameを定義しutility.tsに移動
  UI・.mdファイルの括弧の全角と半角を統一する #1510
  • "ノーマル"を定数DEFAULT_STYLE_NAMEとして定義
    スタイルの"ノーマル"を定数にする #1520
• デフォルトファイル名系の処理をgetterに移動
  Refactor: デフォルトファイル名取得関数2つをgetterへ移動 #1490
  • buildFileName()をgetters.DEFAULT_AUDIO_FILE_NAME()に変更
  • buildProjectName()をstore/utilility.tsからstore/audio.tsに移しgetters.DEFAULT_PROJECT_FILE_NAME()に変更
• 保存先選択ダイアログ表示の処理をcomponents/Dialog.tsに移動し、filePathをオプション引数から必須にする
• getCacheOrFetchFromEngine？するGENERATE_AUDIO(audioItem) returns { audioKey, audioBlob }を根幹とする関連実装をstore/audioGenerator.tsへ分離
  • モーフィングエラーのエラーハンドリングもその中に関数としてまとめる
  • generateUniqueIdAndQuery()もその中に移動、また一部をutility.ts内generateUniqueId(serializable)に分離
  • GENERATE_LABもstoreを参照する必要がないのでgenerateLabFromAudioQuery(audioQuery)としてその中に移動？
• (PLAY|STOP)_AUDIO(audioKey)系のHTMLAudioElementに対する操作をstore/audioPlayer.tsへ分離
  Refactor: audioPlayer.tsを新規作成しaudio.tsの一部機能を移転 #1492
  →さらに分解をする方針に
  • audioElementsがRecordである意味がないので単体にする
    Refactor: audioElementsをRecordから単体にする #1525
  • state.audioStatesからnowPlayingを分離し単体にする
    Refactor: audioStatesからnowPlayingAudioKeyを独立させる #1530
  • audioElement系の処理を別のactionへ分離
    refactor: audioElement関連の処理を分離 #1553
  • audioPlayerへ移動
    refactor: audioPlayer.tsを新規作成しaudio.tsの一部機能を移転 #1579
  • その他雑多処理
    GENERATE_AUDIO_KEYをストアの外に出す #1548
• ACTIVE_AUDIO_KEY前提のものの引数をなくす？
• DirPath/FilePath/FileName/FileBaseName/FileExtensionを型から区別し、見通しを良くする
  • DEFAULT_FILE_NAME_TEMPLATEをDEFAULT_AUDIO_FILE_NAME_TEMPLATE = ${DEFAULT_AUDIO_FILE_BASE_NAME_TEMPLATE}.wavとする
    DEFAULT_FILE_NAME_TEMPLATEの拡張子無し版を定義 #1483
• getCharacterInfo()をgetters.CHARACTER_INFOに変更
  関連処理のmutationにデフォルト動作が定義されていてかつアプリ初期化付近で呼び出されているので一見して影響が不明だな、とか思った記憶があります。
• state.startPointが一見意味不明なので名前をselectedAccentPhraseIndexに変更
• accentPh"r"aseの脱字を直す
  変数名の脱字を修正 #1482
• HAVE_AUDIO_QUERYとIS_ACTIVEが未使用っぽいので削除
  refactor: store/audio.ts内の不要になっていたgetterを削除 #1580
• GET_AUDIO_QUERY_OR_ERRORを作る
• バグ修正: テキスト欄追加→元に戻す→連続再生で「エンジンの再起動を～」という不正確なエラーが出るのを修正
• 妥当な順番にソートしなおす(store/type.ts含め)

Pros 良くなる点

• 連続再生中に、再生する前に音声を生成する #254 をはじめとした、非同期の生成リクエストがしやすくなりそう。
• 音声試聴用の処理を共通化したい #1474 が達成できそう。

Cons 悪くなる点

• 変更が多岐にわたるため、コンフリクトしやすそう。

その他

細かい挙動について気づいた点を箇条書きにしておきます

• 上書きの防止時のファイル存在確認は.wavでしか走査されていない
• 再生/停止キー（連続埼栄/停止キーも）を長押しすると開発者ツール上でエラーが出る

[Hiroshiba]

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

コードって結構なんか未知の理由があってリファクタリングできていないという時もたまにあると思うので、こうやって先に列挙していただけるとその手戻りが防げるからとても良いなと思いました！！！

全部見ていったのですが、問題がありそうなものはありませんでした！！

ちょっと 妥当な順番にソートしなおす(store/type.ts含め) に関しては、別でそもそもVuexをやめるというのを今画策中↓なので、これはもしかしたら大々的にコンフリクトが発生してしまう可能性があるのでちょっと気をつけた方がいいかもと思いました･･･！！

• vuexをやめてpiniaにする #1004

[thiramisu]

確認ありがとうございます。pathモジュール周りは地雷っぽいのでできる限り回避しようかなと思っています！
実際にコードを書いたらまずかった、ということもあるかもしれないので、その時はまた言っていただけると助かります。

[cm-ayf]

getCacheOrFetchFromEngine？するGENERATE_AUDIO(audioItem) returns { audioKey, audioBlob }を根幹とする関連実装をstore/audioGenerator.tsへ分離

を試みます