新增: - installer/lock.go: lock 文件检测/创建/删除(原子写入);ErrLockExists sentinel - installer/bootstrap.go: Detect() 启动期判定 ModeSetup/ModeNormal, 损坏自愈(自动备份 db.corrupt-<ts> + 删 lock + 回退安装模式) - middleware/installguard.go: 安装模式白名单(/setup /api/setup /health /metrics), 中间件顺序: SecurityHeaders → InstallGuard → RateLimit → ...(避免限流计数污染) - controller/setup.go: GET /api/setup/status + /api/setup/prefill + POST /api/setup; token 校验用常量时间比较防计时攻击;安装后端点永久 404 - router/setup.html: Vue3 + axios CDN,4 字段表单 + 动态音色行, 调用 /api/setup/prefill 自动从旧 env 预填(API key 永不预填) 改造: - main.go: 启动期 store.Open → installer.Detect → 注入 setup 控制器 - controller/tts.go: 安装模式双保险(/v1/audio/speech 即便漏过中间件也 503) - controller/health.go (via dto): 加 installed + mode 字段,部署探针可识别 - router/router.go: 挂载 /setup + /api/setup/*,根路径安装模式跳 /setup - setting/config.go: InitSetupToken 读 TTS_ADMIN_KEY 或随机生成 32 字符 hex (公网部署建议设 env;空时启动日志一次性打印) 删除: - router/dashboard.go: 内容并入 router/router.go .gitignore: tts.db / tts.db-* / installed.lock 加入(运行时产物) 验收(端到端跑通,见 scripts/ 已删除): 1. 删 lock → /v1/audio/speech 503 + /setup 200 HTML 2. POST /api/setup 错 token → 401;对 token → 200 + 写 lock + 写 db 3. 重复 POST → 404(端点永久关闭) 4. /health: 安装期 installed=false,装后 installed=true 5. 损坏 db header: 自动备份 tts.db.corrupt-<ts> + 删 lock + 回安装模式 测试: - installer: 6 个 test, 覆盖 lock 生命周期 + Detect 三态 + 损坏自愈 - middleware: 3 个 test, 覆盖白名单/denylist/自定义 - store(M0): 仍 27/27 绿, 70.7% 覆盖率 二进制大小: 9.77 → 15.87 MB (+6MB,大部分是 setup.html embed + 新包)
278 lines
9.0 KiB
Go
278 lines
9.0 KiB
Go
package controller
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"io"
|
|
"log"
|
|
"net/http"
|
|
"runtime"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/volcano-tts/tts-api/adapter/volcano"
|
|
"github.com/volcano-tts/tts-api/common"
|
|
"github.com/volcano-tts/tts-api/dto"
|
|
"github.com/volcano-tts/tts-api/installer"
|
|
"github.com/volcano-tts/tts-api/metrics"
|
|
"github.com/volcano-tts/tts-api/middleware"
|
|
"github.com/volcano-tts/tts-api/setting"
|
|
"github.com/volcano-tts/tts-api/telemetry"
|
|
"github.com/volcano-tts/tts-api/version"
|
|
)
|
|
|
|
var (
|
|
volcanoClient *volcano.HTTPClient
|
|
adapterRec volcano.MetricsRecorder = metrics.AdapterRecorder{}
|
|
)
|
|
|
|
func InitController() {
|
|
volcanoClient = volcano.NewHTTPClient()
|
|
}
|
|
|
|
func truncateForLog(b []byte, max int) string {
|
|
if len(b) > max {
|
|
return string(b[:max]) + fmt.Sprintf("...(truncated, total %d bytes)", len(b))
|
|
}
|
|
return string(b)
|
|
}
|
|
|
|
// resolveClientFormat 把 OpenAI 风格的 response_format 映射为最终输出格式;
|
|
// 不识别或未指定时回退到 setting.TTSOptions.Format。
|
|
func resolveClientFormat(reqFmt string) string {
|
|
switch strings.ToLower(reqFmt) {
|
|
case "mp3", "wav", "opus", "pcm", "aac", "flac":
|
|
if reqFmt == "opus" {
|
|
return "ogg_opus"
|
|
}
|
|
return strings.ToLower(reqFmt)
|
|
}
|
|
return setting.TTSOptions.Format
|
|
}
|
|
|
|
// OpenaiTTSHandler 是 /v1/audio/speech 的入口。
|
|
func OpenaiTTSHandler(w http.ResponseWriter, r *http.Request) {
|
|
start := time.Now()
|
|
|
|
if r.Method != http.MethodPost {
|
|
log.Printf("警告: 错误的方法 - 方法=%s 期望=POST 路径=%s 客户端=%s",
|
|
r.Method, r.URL.Path, middleware.GetClientIP(r))
|
|
metrics.RequestTotal.Inc(telemetry.Labels{"status": "method_not_allowed", "format": "", "speaker": "", "model": ""})
|
|
http.Error(w, "Method not allowed", http.StatusMethodNotAllowed)
|
|
return
|
|
}
|
|
|
|
// 安装模式双保险:即使 InstallGuard 中间件没拦住,这里也 503 + 引导跳转
|
|
if installer.GetMode() == installer.ModeSetup {
|
|
log.Printf("[tts] 安装模式下拒绝 /v1/audio/speech - 客户端=%s", middleware.GetClientIP(r))
|
|
w.Header().Set("Content-Type", "application/json; charset=utf-8")
|
|
w.WriteHeader(http.StatusServiceUnavailable)
|
|
_, _ = w.Write([]byte(`{"error":"not installed","code":"install_required","redirect":"/setup"}`))
|
|
return
|
|
}
|
|
|
|
if !middleware.ValidateAPIKey(r) {
|
|
metrics.AuthFailed.Inc(telemetry.Labels{})
|
|
log.Printf("警告: API Key 鉴权失败 - 路径=%s 客户端=%s 远端=%s",
|
|
r.URL.Path, middleware.GetClientIP(r), r.RemoteAddr)
|
|
middleware.SendJSONError(w, http.StatusUnauthorized, "Invalid API key provided.", "invalid_request_error", "invalid_api_key")
|
|
return
|
|
}
|
|
|
|
if setting.TTSConfigErr != nil {
|
|
log.Printf("警告: TTS配置未就绪,拒绝请求 - 错误=%v 路径=%s 客户端=%s",
|
|
setting.TTSConfigErr, r.URL.Path, middleware.GetClientIP(r))
|
|
middleware.SendJSONError(w, http.StatusServiceUnavailable, "TTS service configuration error. Please check environment variables and restart the service.", "configuration_error", "service_unavailable")
|
|
return
|
|
}
|
|
|
|
r.Body = http.MaxBytesReader(w, r.Body, common.MaxRequestBodySize)
|
|
body, err := io.ReadAll(r.Body)
|
|
if err != nil {
|
|
if strings.Contains(err.Error(), "request body too large") {
|
|
log.Printf("警告: 请求体过大 - 路径=%s 客户端=%s 限制=%d字节",
|
|
r.URL.Path, middleware.GetClientIP(r), common.MaxRequestBodySize)
|
|
http.Error(w, "Request body too large", http.StatusRequestEntityTooLarge)
|
|
return
|
|
}
|
|
log.Printf("警告: 读取请求体失败 - 路径=%s 客户端=%s 错误=%v",
|
|
r.URL.Path, middleware.GetClientIP(r), err)
|
|
http.Error(w, "Failed to read request body", http.StatusBadRequest)
|
|
return
|
|
}
|
|
|
|
var req dto.OpenAITTSRequest
|
|
if err := json.Unmarshal(body, &req); err != nil {
|
|
log.Printf("警告: JSON 解析失败 - 路径=%s 客户端=%s 错误=%v body前200字节=%q",
|
|
r.URL.Path, middleware.GetClientIP(r), err, truncateForLog(body, 200))
|
|
http.Error(w, "Invalid JSON", http.StatusBadRequest)
|
|
return
|
|
}
|
|
|
|
if req.Model != "" {
|
|
if len(req.Model) > common.MaxModelNameLength {
|
|
log.Printf("警告: Model 名过长 - 路径=%s 客户端=%s 长度=%d 限制=%d",
|
|
r.URL.Path, middleware.GetClientIP(r), len(req.Model), common.MaxModelNameLength)
|
|
http.Error(w, fmt.Sprintf("Model name too long (max %d characters)", common.MaxModelNameLength), http.StatusBadRequest)
|
|
return
|
|
}
|
|
if strings.ContainsAny(req.Model, "\x00\n\r\t") {
|
|
log.Printf("警告: Model 名含非法字符 - 路径=%s 客户端=%s model前50字节=%q",
|
|
r.URL.Path, middleware.GetClientIP(r), truncateForLog([]byte(req.Model), 50))
|
|
http.Error(w, "Model name contains invalid characters", http.StatusBadRequest)
|
|
return
|
|
}
|
|
}
|
|
|
|
if req.Input == "" {
|
|
log.Printf("警告: input 字段为空 - 路径=%s 客户端=%s", r.URL.Path, middleware.GetClientIP(r))
|
|
http.Error(w, "Input text is required", http.StatusBadRequest)
|
|
return
|
|
}
|
|
if len(req.Input) > common.MaxTextLength {
|
|
log.Printf("警告: input 文本过长 - 路径=%s 客户端=%s 长度=%d 限制=%d",
|
|
r.URL.Path, middleware.GetClientIP(r), len(req.Input), common.MaxTextLength)
|
|
http.Error(w, fmt.Sprintf("Input text too long (max %d characters)", common.MaxTextLength), http.StatusBadRequest)
|
|
return
|
|
}
|
|
|
|
speed := req.Speed
|
|
if speed <= 0 {
|
|
speed = common.DefaultSpeed
|
|
}
|
|
if speed < common.MinSpeed {
|
|
speed = common.MinSpeed
|
|
}
|
|
if speed > common.MaxSpeed {
|
|
speed = common.MaxSpeed
|
|
}
|
|
|
|
clientFormat := resolveClientFormat(req.ResponseFormat)
|
|
|
|
opts := setting.TTSOptions
|
|
opts.Text = req.Input
|
|
|
|
ctx, cancel := context.WithTimeout(r.Context(), setting.TTSTimeout)
|
|
defer cancel()
|
|
|
|
result, err := volcano.Synthesis(ctx, volcanoClient, opts, req.Input, clientFormat, speed, adapterRec)
|
|
duration := time.Since(start)
|
|
|
|
finalLabels := telemetry.Labels{
|
|
"format": clientFormat,
|
|
"speaker": opts.Speaker,
|
|
"model": opts.Model,
|
|
}
|
|
if err != nil {
|
|
finalLabels["status"] = classifyStatus(err)
|
|
metrics.RequestTotal.Inc(finalLabels)
|
|
metrics.RequestDuration.Observe(duration.Seconds(), telemetry.Labels{"status": finalLabels["status"], "format": clientFormat})
|
|
log.Printf("警告: TTS 合成失败 - 路径=%s 客户端=%s 文本长度=%d 耗时=%v 错误=%v",
|
|
r.URL.Path, middleware.GetClientIP(r), len(req.Input), duration, err)
|
|
middleware.SendJSONError(w, http.StatusInternalServerError, "TTS synthesis failed.", "server_error", "synthesis_failed")
|
|
return
|
|
}
|
|
|
|
finalLabels["status"] = "ok"
|
|
metrics.RequestTotal.Inc(finalLabels)
|
|
metrics.RequestDuration.Observe(duration.Seconds(), telemetry.Labels{"status": "ok", "format": clientFormat})
|
|
|
|
w.Header().Set("Content-Type", contentTypeFor(result.Format))
|
|
w.Header().Set("Content-Length", fmt.Sprintf("%d", len(result.AudioData)))
|
|
w.Header().Set("X-Request-Id", result.ReqID)
|
|
w.WriteHeader(http.StatusOK)
|
|
w.Write(result.AudioData)
|
|
}
|
|
|
|
func classifyStatus(err error) string {
|
|
if ue, ok := err.(*volcano.UpstreamError); ok {
|
|
switch ue.Stage {
|
|
case "request":
|
|
return "request_error"
|
|
case "http":
|
|
return fmt.Sprintf("http_%d", ue.Code)
|
|
case "stream":
|
|
return "upstream_error"
|
|
case "wrap":
|
|
return "wrap_error"
|
|
}
|
|
}
|
|
return "internal_error"
|
|
}
|
|
|
|
func contentTypeFor(format string) string {
|
|
switch strings.ToLower(format) {
|
|
case "wav":
|
|
return "audio/wav"
|
|
case "mp3":
|
|
return "audio/mpeg"
|
|
case "ogg_opus", "opus":
|
|
return "audio/ogg"
|
|
case "pcm":
|
|
return "audio/L16"
|
|
case "aac":
|
|
return "audio/aac"
|
|
case "flac":
|
|
return "audio/flac"
|
|
}
|
|
return "application/octet-stream"
|
|
}
|
|
|
|
// HealthHandler 暴露运行期状态;无鉴权。
|
|
func HealthHandler(w http.ResponseWriter, r *http.Request) {
|
|
w.Header().Set("Content-Type", "application/json")
|
|
|
|
// 安装模式下 /health 仍然 200,但通过 installed 字段让探针/运维识别
|
|
// (Kubernetes readiness probe 可以用 installed=false 决定是否放流量)
|
|
mode := installer.GetMode()
|
|
if mode == installer.ModeSetup {
|
|
w.WriteHeader(http.StatusOK) // 200,因为进程活着,只是还没初始化
|
|
} else if setting.TTSConfigErr != nil {
|
|
w.WriteHeader(http.StatusServiceUnavailable)
|
|
} else {
|
|
w.WriteHeader(http.StatusOK)
|
|
}
|
|
|
|
env := setting.CheckEnvironmentVariables()
|
|
allRequired := env["all_required_vars_set"].(bool)
|
|
|
|
status := "ok"
|
|
if mode == installer.ModeSetup {
|
|
status = "not_installed"
|
|
} else if !allRequired {
|
|
status = "configuration_error"
|
|
}
|
|
|
|
resp := dto.HealthResponse{
|
|
Status: status,
|
|
Service: "ByteDance TTS to OpenAI API Adapter",
|
|
Version: version.Version,
|
|
Commit: version.Commit,
|
|
Uptime: fmt.Sprintf("%.0f seconds", time.Since(startTime).Seconds()),
|
|
StartTime: startTime.Format(time.RFC3339),
|
|
Memory: collectMemorySnapshot(),
|
|
ConfigStatus: dto.ConfigStatusResponse{
|
|
AllRequiredVarsSet: allRequired,
|
|
ConfigError: setting.TTSConfigErr != nil,
|
|
},
|
|
Installed: mode == installer.ModeNormal,
|
|
Mode: mode.String(),
|
|
}
|
|
json.NewEncoder(w).Encode(resp)
|
|
}
|
|
|
|
var startTime time.Time
|
|
|
|
func SetStartTime(t time.Time) { startTime = t }
|
|
|
|
func collectMemorySnapshot() map[string]interface{} {
|
|
var ms runtime.MemStats
|
|
runtime.ReadMemStats(&ms)
|
|
return map[string]interface{}{
|
|
"heap_alloc": ms.HeapAlloc,
|
|
"heap_inuse": ms.HeapInuse,
|
|
"goroutines": runtime.NumGoroutine(),
|
|
}
|
|
}
|