-
Notifications
You must be signed in to change notification settings - Fork 72
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
本番リリース #274
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
ウォークスルーこのプルリクエストは、環境設定、ローカライゼーション、および音声合成機能に関する包括的な変更を導入しています。 変更点
関連する可能性のあるPR
Tip CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 7
🧹 Nitpick comments (7)
src/features/messages/synthesizeVoiceAivisSpeech.ts (2)
27-29
: エラー文言の補足があればユーザーの理解が向上
現状でも問題はありませんが、例外時に対処方法や問い合わせ先などが明記されていると、トラブルシューティングが容易になります。
33-38
: catch節のエラーハンドリングが適切
Errorクラスを明示的に区別できればさらなる保守性向上が望めますが、ひとまず実装としては問題ありません。src/features/messages/synthesizeVoiceVoicevox.ts (1)
27-29
: レスポンスが失敗した際のメッセージに補足があるとより親切
エラーコード別のガイダンスやトラブルシュートが追加されるとユーザー負担をさらに減らせます。.env.example (2)
94-95
: 新規パラメータの値範囲とデフォルト値の説明が必要新しく追加された感情レベルと音声持続時間パラメータについて、適切な値範囲とデフォルト値の説明を追加することを推奨します:
- NEXT_PUBLIC_NIJIVOICE_EMOTIONAL_LEVEL= - NEXT_PUBLIC_NIJIVOICE_SOUND_DURATION= + # 感情レベル (0.0 ~ 1.0, デフォルト: 0.5) + NEXT_PUBLIC_NIJIVOICE_EMOTIONAL_LEVEL= + # 音声持続時間 (0.5 ~ 2.0, デフォルト: 1.0) + NEXT_PUBLIC_NIJIVOICE_SOUND_DURATION=
133-141
: 音声モードパラメータの説明と検証が必要新しく追加された音声モードパラメータについて、有効な値とその使用方法の説明を追加することを推奨します:
- # Realtime API Mode Voice ('alloy', 'echo', 'shimmer') - NEXT_PUBLIC_REALTIME_API_MODE_VOICE="" + # Realtime API Mode Voice + # 利用可能な値: 'alloy', 'echo', 'shimmer' + # - alloy: ニュートラルな声 + # - echo: 深みのある声 + # - shimmer: 明るい声 + NEXT_PUBLIC_REALTIME_API_MODE_VOICE="" - # Audio Mode (true or false) + # Audio Mode + # 音声入出力の有効/無効を設定 + # 有効な値: 'true' または 'false' NEXT_PUBLIC_AUDIO_MODE="" - # Audio Mode Input Type ('input_text', 'input_audio') + # Audio Mode Input Type + # 音声入力の種類を設定 + # 有効な値: 'input_text' (テキスト入力), 'input_audio' (音声入力) NEXT_PUBLIC_AUDIO_MODE_INPUT_TYPE="" - # Audio Mode Voice ('alloy', 'echo', 'fable', 'onyx', 'nova', 'shimmer') + # Audio Mode Voice + # 利用可能な値: 'alloy', 'echo', 'fable', 'onyx', 'nova', 'shimmer' + # 各声質の特徴: + # - alloy: ニュートラル + # - echo: 深み + # - fable: 物語向き + # - onyx: 力強い + # - nova: 柔らかい + # - shimmer: 明るい NEXT_PUBLIC_AUDIO_MODE_VOICE=""docs/README_en.md (1)
92-96
: 環境変数の設定手順の説明を改善することを推奨します環境変数の設定手順は追加されていますが、以下の点について説明を追加することを推奨します:
- 必要な環境変数の一覧
- 各環境変数の目的と設定値の例
- どの機能がどの環境変数に依存しているか
src/components/settings/voice.tsx (1)
955-986
: インデントの一貫性を維持することを推奨しますこのセクションのインデントが他のコードと比較して一貫性がありません。以下の修正を提案します:
- <div className="mt-16 font-bold"> - {t('NijiVoiceEmotionalLevel')}: {nijivoiceEmotionalLevel} - </div> + <div className="mt-16 font-bold"> + {t('NijiVoiceEmotionalLevel')}: {nijivoiceEmotionalLevel} + </div>同様の修正を955-986行の範囲全体に適用することを推奨します。
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (21)
.env
(0 hunks).env.example
(3 hunks).gitignore
(1 hunks)README.md
(1 hunks)docs/README_en.md
(1 hunks)docs/README_ko.md
(1 hunks)docs/README_zh.md
(1 hunks)locales/en/translation.json
(1 hunks)locales/ja/translation.json
(1 hunks)locales/ko/translation.json
(1 hunks)locales/zh/translation.json
(1 hunks)src/components/settings/index.tsx
(1 hunks)src/components/settings/voice.tsx
(6 hunks)src/features/messages/speakCharacter.ts
(5 hunks)src/features/messages/synthesizeVoiceAivisSpeech.ts
(1 hunks)src/features/messages/synthesizeVoiceNijivoice.ts
(2 hunks)src/features/messages/synthesizeVoiceVoicevox.ts
(1 hunks)src/features/stores/settings.ts
(7 hunks)src/pages/api/tts-aivisspeech.ts
(1 hunks)src/pages/api/tts-nijivoice.ts
(2 hunks)src/pages/api/tts-voicevox.ts
(1 hunks)
💤 Files with no reviewable changes (1)
- .env
✅ Files skipped from review due to trivial changes (2)
- src/components/settings/index.tsx
- .gitignore
🔇 Additional comments (25)
src/features/messages/synthesizeVoiceAivisSpeech.ts (2)
8-9
: serverUrlパラメータの追加による柔軟性向上
複数サーバーやエンドポイントを切り替えたいケースに対応できるようになり、拡張性が高いです。
12-25
: 単一のfetch呼び出しでパラメータを正しく送信
全てのパラメータがJSONボディに正しく含まれており、可読性も高いです。
src/features/messages/synthesizeVoiceNijivoice.ts (2)
7-9
: 感情表現と音声長を制御する新パラメータの導入
ユーザー体験の幅が広がり、ボイス機能の拡張性が高いです。
22-23
: JSONボディへの新プロパティ追加を的確に処理
emotionalLevelとsoundDurationが適切にシリアライズされており、問題ありません。
src/features/messages/synthesizeVoiceVoicevox.ts (3)
8-9
: serverUrlパラメータの追加で接続先を自在に変更可能
外部設定に対応しやすい設計となっており、高い柔軟性が評価できます。
12-25
: 単一のfetchリクエストによりAPI呼び出しがシンプル化
以前の複数段階のAPIアクセスが統合され、可読性が向上しています。
Line range hint 33-38
: catch節の実装で一般的なエラーとErrorインスタンスを区別
エラー処理は明確で要件を満たしています。問題ありません。
src/pages/api/tts-nijivoice.ts (1)
13-14
: POSTボディを分割代入して読みやすく保守性が高い
scriptやemotionalLevelなどをまとめて取得する実装はシンプルでわかりやすいです。
src/features/messages/speakCharacter.ts (3)
94-95
: VOICEVOXパラメータの追加が適切に実装されています!
イントネーションとサーバーURLのパラメータが正しく追加され、音声合成の柔軟性が向上しています。
120-121
: AivisSpeechパラメータの追加が適切に実装されています!
イントネーションとサーバーURLのパラメータが正しく追加され、AivisSpeechの設定オプションが拡張されています。
159-161
: Nijivoiceパラメータの拡張が適切に実装されています!
速度、感情レベル、音声の長さを制御するパラメータが追加され、より細かな音声調整が可能になりました。
locales/zh/translation.json (2)
61-61
: サーバーURL関連の中国語翻訳が適切に追加されています!
VOICEVOXとAivisSpeechのサーバーURL設定に関する翻訳が正しく実装されています。
Also applies to: 68-68
72-75
: Nijivoice関連の中国語翻訳が適切に追加されています!
音声キャラクターID、速度、感情レベル、音声の長さに関する翻訳が明確に実装されています。
docs/README_zh.md (1)
91-95
: 環境設定手順が適切に追加されています!
.env
ファイルの作成手順が明確に記載され、.env.example
からのコピーコマンドも正しく提供されています。
locales/ja/translation.json (2)
61-61
: サーバーURL設定の追加について承認
VOICEVOXとAivisSpeechのサーバーURL設定が適切に追加されています。これにより、ユーザーが異なるサーバー環境を柔軟に設定できるようになります。
Also applies to: 68-68
72-75
: にじボイス関連の設定項目の改善について承認
以下の変更により、設定項目の表示がよりシンプルで分かりやすくなっています:
- 話者IDと話速の表示を簡潔に
- 感情レベルと音声の長さの設定を追加
locales/ko/translation.json (1)
61-61
: 韓国語翻訳の一貫性について承認
日本語ファイルの変更と完全に一致する形で、以下の翻訳が適切に実装されています:
- VOICEVOXとAivisSpeechのサーバーURL設定
- にじボイス関連の設定項目の更新
Also applies to: 68-68, 71-75
README.md (1)
91-95
: 環境設定手順の改善について承認
.env
ファイルの作成手順が明確に追加されており、以下の点で適切です:
- 必要に応じた設定が可能
- コマンド例の提供
- 既存の手順との自然な統合
docs/README_ko.md (1)
92-96
: 環境設定手順の改善を確認しました!
.env
ファイルの作成手順が追加され、セットアップの流れが分かりやすくなっています。他の言語版のドキュメントとも一貫性が保たれています。
src/features/stores/settings.ts (3)
56-56
: サーバーURL設定の追加を確認しました!
VOICEVOXとAivisSpeechのサーバーURL設定が追加され、より柔軟な環境設定が可能になっています。
Also applies to: 61-61
79-80
: NijiVoice設定の拡張を確認しました!
感情レベルと音声持続時間のパラメータが追加され、より細かな音声調整が可能になっています。
269-275
: NijiVoiceパラメータの初期化を確認しました!
環境変数からの値取得とフォールバック値の設定が適切に実装されています。
locales/en/translation.json (1)
67-67
: 翻訳キーの追加と更新を確認しました!
以下の改善点が見られます:
- サーバーURL設定の翻訳が追加
- NijiVoice関連の設定項目がより直感的な表現に更新
- 新しい音声パラメータの翻訳が追加
翻訳の一貫性が保たれており、ユーザーにとって分かりやすい表現になっています。
Also applies to: 71-75
src/components/settings/voice.tsx (2)
37-42
: サーバーURL設定の追加が適切に実装されています
settingsStoreからの状態変数の取得が適切に実装されており、命名規則も一貫性があります。
65-68
: にじボイスの新しい設定パラメータが適切に実装されています
感情レベルと音声持続時間のパラメータが適切に追加されており、既存のコードスタイルと一致しています。
emotionalLevel: emotionalLevel.toString(), | ||
soundDuration: soundDuration.toString(), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 Codebase verification
Based on the search results, I can now provide the final response:
emotionalLevelとsoundDurationのバリデーション追加を推奨
-
src/pages/api/tts-nijivoice.ts
にて、toString()変換前に以下のバリデーションが必要です:- emotionalLevelの有効範囲チェック(数値範囲の検証)
- soundDurationの有効範囲チェック(数値範囲の検証)
- 未定義値(undefined)や不正な型のチェック
-
src/features/messages/synthesizeVoiceNijivoice.ts
では型定義でnumber型を指定していますが、APIエンドポイントでの追加の防御的チェックが推奨されます。
🔗 Analysis chain
toString()変換の場面に追加バリデーションを検討
API仕様上、引数を文字列として送る必要があるようですが、範囲外や不正値のチェックがあると安心です。
下記スクリプトでemotionalLevelやsoundDurationの取り扱い箇所を網羅検索し、追加バリデーションが必要か確認できます:
Let me gather more information about any validation or type definitions for these parameters.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
rg -A 5 $'emotionalLevel|soundDuration'
Length of output: 1887
Script:
#!/bin/bash
# Check for any type definitions or interfaces related to these parameters
ast-grep --pattern 'interface $_ {
$$$
emotionalLevel: $_
$$$
}'
# Also check for any validation logic
rg -A 5 "validate.*emotionalLevel|validate.*soundDuration|check.*emotionalLevel|check.*soundDuration"
Length of output: 176
res.setHeader('Content-Type', 'audio/wav') | ||
synthesisResponse.data.pipe(res) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ストリームのエラーハンドリングが必要です
ストリーム処理時のエラーをキャッチし、適切に処理する必要があります:
res.setHeader('Content-Type', 'audio/wav')
- synthesisResponse.data.pipe(res)
+ synthesisResponse.data
+ .on('error', (error) => {
+ console.error('ストリーム処理エラー:', error)
+ if (!res.headersSent) {
+ res.status(500).json({ error: 'ストリーム処理中にエラーが発生しました' })
+ }
+ })
+ .pipe(res)
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
res.setHeader('Content-Type', 'audio/wav') | |
synthesisResponse.data.pipe(res) | |
res.setHeader('Content-Type', 'audio/wav') | |
synthesisResponse.data | |
.on('error', (error) => { | |
console.error('ストリーム処理エラー:', error) | |
if (!res.headersSent) { | |
res.status(500).json({ error: 'ストリーム処理中にエラーが発生しました' }) | |
} | |
}) | |
.pipe(res) |
const queryResponse = await axios.post( | ||
`${apiUrl}/audio_query?speaker=${speaker}&text=${encodeURIComponent(text)}`, | ||
null, | ||
{ | ||
headers: { | ||
'Content-Type': 'application/json', | ||
}, | ||
timeout: 30000, | ||
} | ||
) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
エラーメッセージの詳細化とリトライロジックの追加を推奨
外部APIコールの信頼性を向上させるため:
- より具体的なエラーメッセージ
- リトライメカニズム
- エラーログの強化
+ const MAX_RETRIES = 3
+ let retries = 0
+
+ const makeRequest = async () => {
+ try {
const queryResponse = await axios.post(
`${apiUrl}/audio_query?speaker=${speaker}&text=${encodeURIComponent(text)}`,
null,
{
headers: {
'Content-Type': 'application/json',
},
timeout: 30000,
}
)
+ return queryResponse
+ } catch (error) {
+ if (retries < MAX_RETRIES) {
+ retries++
+ return await makeRequest()
+ }
+ throw error
+ }
+ }
Committable suggestion skipped: line range outside the PR's diff.
const { text, speaker, speed, pitch, intonation, serverUrl } = req.body | ||
const apiUrl = | ||
serverUrl || process.env.VOICEVOX_SERVER_URL || 'http://localhost:50021' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
サーバーURLの検証と入力値のバリデーションが必要です
セキュリティ上の理由から、以下の対策を実装することを推奨します:
- サーバーURLのホワイトリスト検証
- 入力パラメータ(text、speaker、speed、pitch、intonation)の範囲チェック
+ const validServers = ['http://localhost:50021', process.env.VOICEVOX_SERVER_URL].filter(Boolean)
+ if (serverUrl && !validServers.includes(serverUrl)) {
+ return res.status(400).json({ error: '無効なサーバーURLです' })
+ }
+
+ // 入力値の検証
+ if (!text || typeof text !== 'string') {
+ return res.status(400).json({ error: 'テキストは必須です' })
+ }
Committable suggestion skipped: line range outside the PR's diff.
import type { NextApiRequest, NextApiResponse } from 'next' | ||
import axios from 'axios' | ||
|
||
type Data = { | ||
audio?: ArrayBuffer | ||
error?: string | ||
} | ||
|
||
export default async function handler( | ||
req: NextApiRequest, | ||
res: NextApiResponse<Data> | ||
) { | ||
const { text, speaker, speed, pitch, intonation, serverUrl } = req.body | ||
const apiUrl = | ||
serverUrl || process.env.AIVIS_SPEECH_SERVER_URL || 'http://localhost:10101' | ||
|
||
try { | ||
// 1. Audio Query の生成 | ||
const queryResponse = await axios.post( | ||
`${apiUrl}/audio_query?speaker=${speaker}&text=${encodeURIComponent(text)}`, | ||
null, | ||
{ | ||
headers: { | ||
'Content-Type': 'application/json', | ||
}, | ||
timeout: 30000, | ||
} | ||
) | ||
|
||
const queryData = queryResponse.data | ||
queryData.speedScale = speed | ||
queryData.pitchScale = pitch | ||
queryData.intonationScale = intonation | ||
|
||
// 2. 音声合成 | ||
const synthesisResponse = await axios.post( | ||
`${apiUrl}/synthesis?speaker=${speaker}`, | ||
queryData, | ||
{ | ||
headers: { | ||
'Content-Type': 'application/json', | ||
Accept: 'audio/wav', | ||
}, | ||
responseType: 'stream', | ||
timeout: 30000, | ||
} | ||
) | ||
|
||
res.setHeader('Content-Type', 'audio/wav') | ||
synthesisResponse.data.pipe(res) | ||
} catch (error) { | ||
console.error('Error in AivisSpeech TTS:', error) | ||
res.status(500).json({ error: 'Internal Server Error' }) | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
共通ロジックの抽出とコード再利用の推奨
VOICEVOXハンドラーとの重複が多いため、共通のユーティリティ関数として抽出することを推奨します:
+ // src/utils/tts-handler.ts
+ import type { NextApiRequest, NextApiResponse } from 'next'
+ import axios from 'axios'
+
+ export type TTSConfig = {
+ serverUrl: string
+ defaultUrl: string
+ serviceName: string
+ }
+
+ export async function handleTTSRequest(
+ req: NextApiRequest,
+ res: NextApiResponse,
+ config: TTSConfig
+ ) {
+ // 共通のTTS処理ロジック
+ }
+
+ // このファイルでは以下のように使用
+ import { handleTTSRequest } from '@/utils/tts-handler'
+
+ export default async function handler(req: NextApiRequest, res: NextApiResponse) {
+ return handleTTSRequest(req, res, {
+ serverUrl: process.env.AIVIS_SPEECH_SERVER_URL,
+ defaultUrl: 'http://localhost:10101',
+ serviceName: 'AivisSpeech'
+ })
+ }
また、VOICEVOXハンドラーと同様のセキュリティ対策とエラーハンドリングが必要です。
Committable suggestion skipped: line range outside the PR's diff.
@@ -41,12 +41,14 @@ NEXT_PUBLIC_VOICEVOX_SPEAKER="" | |||
NEXT_PUBLIC_VOICEVOX_SPEED="" | |||
NEXT_PUBLIC_VOICEVOX_PITCH="" | |||
NEXT_PUBLIC_VOICEVOX_INTONATION="" | |||
VOICEVOX_SERVER_URL="" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
サーバーURLのデフォルト値に関する注意点
本番環境でのセキュリティを考慮し、以下の対応を推奨します:
- デフォルトURLの使用に関する警告文の追加
- 本番環境での適切な設定方法の説明
- VOICEVOX_SERVER_URL=""
+ # 警告: 本番環境では適切なサーバーURLを設定してください
+ # 開発環境のデフォルト: http://localhost:50021
+ VOICEVOX_SERVER_URL=""
- AIVIS_SPEECH_SERVER_URL=http://localhost:10101
+ # 警告: 本番環境では適切なサーバーURLを設定してください
+ # 開発環境のデフォルト: http://localhost:10101
+ AIVIS_SPEECH_SERVER_URL=""
Also applies to: 51-51
@@ -157,6 +161,7 @@ const settingsStore = create<SettingsState>()( | |||
parseFloat(process.env.NEXT_PUBLIC_VOICEVOX_PITCH || '0.0') || 0.0, | |||
voicevoxIntonation: | |||
parseFloat(process.env.NEXT_PUBLIC_VOICEVOX_INTONATION || '1.0') || 1.0, | |||
voicevoxServerUrl: '', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 Codebase verification
サーバーURLのセキュリティ対策が必要です
コードベースの分析の結果、以下の問題が確認されました:
- VOICEVOXとAIVIS Speech両方のサーバーURLに対する入力バリデーションが実装されていません
- HTTPSの使用を強制する仕組みがありません
- URLの形式チェックが行われていません
以下の対策を推奨します:
- URLの形式バリデーションの実装
- HTTPSプロトコルの強制
- 信頼できるドメインのホワイトリスト化
🔗 Analysis chain
サーバーURLのデフォルト値設定を確認しました!
voicevoxServerUrl: '',
aivisSpeechServerUrl: '',
セキュリティの観点から、以下の点を確認することをお勧めします:
- サーバーURLのバリデーション
- 安全な接続(HTTPS)の推奨
Also applies to: 173-173
Let's check the implementation details of these files to verify URL validation and security measures.
Let's check if there are any URL validation functions or security measures implemented.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# URLバリデーションの実装を確認
rg -l 'voicevoxServerUrl|aivisSpeechServerUrl' src/
Length of output: 159
Script:
#!/bin/bash
# Check URL validation and security measures in the identified files
rg -A 5 -B 5 'voicevoxServerUrl|aivisSpeechServerUrl' src/components/settings/voice.tsx src/features/stores/settings.ts src/features/messages/speakCharacter.ts
Length of output: 10847
Script:
#!/bin/bash
# Check for URL validation or security-related functions
rg -A 5 'validateUrl|isValidUrl|https:|isSecure|sanitize|validate' src/
Length of output: 23853
Summary by CodeRabbit
新機能
ドキュメント
.env
ファイルの作成手順がREADMEに追加され、ライセンス条項が明確化されました。バグ修正