openai_gateway_chat_completions.go 43 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174
  1. package service
  2. import (
  3. "bufio"
  4. "context"
  5. "encoding/json"
  6. "errors"
  7. "fmt"
  8. "net/http"
  9. "strings"
  10. "sync/atomic"
  11. "time"
  12. "github.com/Wei-Shaw/sub2api/internal/pkg/apicompat"
  13. "github.com/Wei-Shaw/sub2api/internal/pkg/logger"
  14. "github.com/Wei-Shaw/sub2api/internal/pkg/openai_compat"
  15. "github.com/Wei-Shaw/sub2api/internal/util/responseheaders"
  16. "github.com/gin-gonic/gin"
  17. "github.com/tidwall/gjson"
  18. "github.com/tidwall/sjson"
  19. "go.uber.org/zap"
  20. )
  21. // cursorResponsesUnsupportedFields are top-level Responses API parameters that
  22. // Codex upstreams reject with "Unsupported parameter: ...". They must be
  23. // stripped when forwarding a raw client body through the Responses-shape
  24. // short-circuit in ForwardAsChatCompletions (see isResponsesShape branch).
  25. // The normal Chat Completions → Responses conversion path is unaffected
  26. // because ChatCompletionsRequest has no fields for these parameters — unknown
  27. // fields are dropped naturally by json.Unmarshal. Kept semantically in sync
  28. // with the list in openai_gateway_service.go:2034 used by the /v1/responses
  29. // passthrough path.
  30. var cursorResponsesUnsupportedFields = []string{
  31. "prompt_cache_retention",
  32. "safety_identifier",
  33. "metadata",
  34. "stream_options",
  35. }
  36. // ForwardAsChatCompletions accepts a Chat Completions request body, converts it
  37. // to OpenAI Responses API format, forwards to the OpenAI upstream, and converts
  38. // the response back to Chat Completions format.
  39. //
  40. // 历史背景:该函数原本对所有 OpenAI 账号无差别走 CC→Responses 转换 + /v1/responses
  41. // 端点——这在 OAuth(ChatGPT 内部 API 仅支持 Responses)和官方 APIKey 账号上是
  42. // 正确的,但 sub2api 接入 DeepSeek/Kimi/GLM 等第三方 OpenAI 兼容上游后假设破裂:
  43. // 这些上游普遍只支持 /v1/chat/completions,无 /v1/responses 端点。
  44. //
  45. // 当前路由策略:
  46. // - CN 账号以 credentials.api_protocol 为权威;adaptive/chat_completions 入站 Chat
  47. // 直转原生 CC,anthropic 走原生 Anthropic,responses 走 Responses
  48. // - 其他 APIKey 账号仍按覆盖模式/探测标记分流(详见
  49. // openai_compat.ShouldUseResponsesAPI)
  50. func (s *OpenAIGatewayService) ForwardAsChatCompletions(
  51. ctx context.Context,
  52. c *gin.Context,
  53. account *Account,
  54. body []byte,
  55. promptCacheKey string,
  56. defaultMappedModel string,
  57. ) (*OpenAIForwardResult, error) {
  58. return s.forwardAsChatCompletions(ctx, c, account, body, promptCacheKey, defaultMappedModel, false)
  59. }
  60. func (s *OpenAIGatewayService) forwardAsChatCompletions(
  61. ctx context.Context,
  62. c *gin.Context,
  63. account *Account,
  64. body []byte,
  65. promptCacheKey string,
  66. defaultMappedModel string,
  67. compatPromptCacheTenantIsolated bool,
  68. ) (*OpenAIForwardResult, error) {
  69. beginUpstreamResponseModelObservation(c)
  70. ClearActualOpenAIUpstreamEndpoint(c)
  71. if shouldForwardOpenAIResponsesViaRawChatCompletions(account) {
  72. SetActualOpenAIUpstreamEndpoint(c, "/v1/chat/completions")
  73. }
  74. setCodexToolNameReverse(c, nil)
  75. if _, err := s.prepareCodexAccountIdentitySource(ctx, c, account); err != nil {
  76. return nil, err
  77. }
  78. restrictionResult := s.detectCodexClientRestriction(c, account, body)
  79. logCodexCLIOnlyDetection(ctx, c, account, getAPIKeyIDFromContext(c), restrictionResult, body)
  80. if restrictionResult.Enabled && !restrictionResult.Matched {
  81. MarkOpsClientBusinessLimited(c, OpsClientBusinessLimitedReasonLocalPolicyDenied)
  82. c.JSON(http.StatusForbidden, gin.H{
  83. "error": gin.H{
  84. "type": "forbidden_error",
  85. "message": "This account only allows Codex official clients",
  86. },
  87. })
  88. return nil, errors.New("codex_cli_only restriction: only codex official clients are allowed")
  89. }
  90. if account.Platform == PlatformGrok {
  91. if account.IsGrokOAuth() {
  92. if eligible, reason := grokChatResponsesBridgeEligibility(body); eligible {
  93. return s.forwardGrokChatCompletionsViaResponses(ctx, c, account, body, promptCacheKey, defaultMappedModel)
  94. } else {
  95. logger.L().Debug("grok chat_completions: using raw fallback",
  96. zap.Int64("account_id", account.ID),
  97. zap.String("reason", reason),
  98. )
  99. }
  100. }
  101. return s.forwardAsRawChatCompletions(ctx, c, account, body, defaultMappedModel)
  102. }
  103. // Cursor compatibility: some clients send a Responses-shaped body to the
  104. // /v1/chat/completions URL. Detect it before adaptive routing so adaptive
  105. // accounts never forward the body unchanged to a Chat Completions endpoint.
  106. isResponsesShape := !gjson.GetBytes(body, "messages").Exists() && gjson.GetBytes(body, "input").Exists()
  107. // 自适应账号的标准 Chat Completions 入站使用供应商原生 CC 端点。
  108. // Responses 形状下,DeepSeek / Kimi 继续走下方原生 Responses 链;GLM
  109. // 没有 Responses 端点,先转换成 Chat Completions 再直转。
  110. if account.IsAdaptiveAPIProtocol() {
  111. if !isResponsesShape {
  112. return s.forwardAsRawChatCompletions(ctx, c, account, body, defaultMappedModel)
  113. }
  114. if !account.SupportsNativeCNResponses() {
  115. var responsesReq apicompat.ResponsesRequest
  116. if err := json.Unmarshal(body, &responsesReq); err != nil {
  117. return nil, fmt.Errorf("parse responses-shaped chat completions request: %w", err)
  118. }
  119. chatReq, err := apicompat.ResponsesToChatCompletionsRequestWithOptions(
  120. &responsesReq,
  121. &apicompat.ResponsesToChatOptions{ReasoningContentByID: s.reasoningContentByID},
  122. )
  123. if err != nil {
  124. return nil, fmt.Errorf("convert responses-shaped chat completions request: %w", err)
  125. }
  126. chatBody, err := json.Marshal(chatReq)
  127. if err != nil {
  128. return nil, fmt.Errorf("marshal converted chat completions request: %w", err)
  129. }
  130. return s.forwardAsRawChatCompletions(ctx, c, account, chatBody, defaultMappedModel)
  131. }
  132. // DeepSeek / Kimi 原生 Responses 请求继续走下方 Responses→Chat 回程转换。
  133. }
  134. // 入口分流(国产供应商 Anthropic 协议):上游为供应商原生 Anthropic 端点,
  135. // CC 入站请求经 CC→Responses→Anthropic 转换链直通该端点。必须先于
  136. // ShouldUseResponsesAPI 分流:该类账号经 probe 落标
  137. // openai_responses_supported=false,会先命中下方的 CC 直转分支。
  138. if account.IsAnthropicProtocol() {
  139. return s.forwardChatCompletionsViaNativeAnthropic(ctx, c, account, body, defaultMappedModel)
  140. }
  141. // 固定 chat_completions 的 CN 账号,以及强制或已探测确认不支持 Responses
  142. // 的其他 APIKey 账号,均走 CC 直转。
  143. if shouldForwardOpenAIResponsesViaRawChatCompletions(account) {
  144. return s.forwardAsRawChatCompletions(ctx, c, account, body, defaultMappedModel)
  145. }
  146. startTime := time.Now()
  147. // 1. Parse Chat Completions request
  148. var chatReq apicompat.ChatCompletionsRequest
  149. if err := json.Unmarshal(body, &chatReq); err != nil {
  150. return nil, fmt.Errorf("parse chat completions request: %w", err)
  151. }
  152. originalModel := chatReq.Model
  153. clientStream := chatReq.Stream
  154. // 2. Resolve model mapping early so compat prompt_cache_key injection can
  155. // derive a stable seed from the final upstream model family.
  156. billingModel := resolveOpenAIForwardModel(account, originalModel, defaultMappedModel)
  157. upstreamModel := normalizeOpenAIModelForUpstream(account, billingModel)
  158. promptCacheKey = strings.TrimSpace(promptCacheKey)
  159. compatPromptCacheInjected := false
  160. if promptCacheKey == "" && !isResponsesShape && (account.UsesOpenAICodexProtocol() || account.IsOpenAIApiKey()) && shouldAutoInjectPromptCacheKeyForCompat(upstreamModel) {
  161. promptCacheKey = deriveCompatPromptCacheKey(&chatReq, upstreamModel)
  162. compatPromptCacheInjected = promptCacheKey != ""
  163. if compatPromptCacheInjected && account.IsOpenAIApiKey() {
  164. promptCacheKey = isolateOpenAISessionID(getAPIKeyIDFromContext(c), promptCacheKey)
  165. compatPromptCacheTenantIsolated = true
  166. }
  167. }
  168. // 3. Build the upstream (Responses API) body.
  169. //
  170. // Cursor compatibility: some clients (notably Cursor cloud) send Responses
  171. // API shaped bodies — `input: [...]` with no `messages` field — to the
  172. // /v1/chat/completions URL. Running those through ChatCompletionsToResponses
  173. // would silently drop Cursor's `input` array (the struct has no Input field)
  174. // and produce `input: null`, which Codex upstreams reject with
  175. // "Invalid type for 'input': expected a string, but got an object".
  176. //
  177. // Forward that shape as-is, only rewriting `model`
  178. // to the resolved upstream model. The downstream codex OAuth transform will
  179. // still normalize store/stream/instructions/etc.
  180. var (
  181. responsesReq *apicompat.ResponsesRequest
  182. responsesBody []byte
  183. err error
  184. )
  185. if isResponsesShape {
  186. responsesBody, err = sjson.SetBytes(body, "model", upstreamModel)
  187. if err != nil {
  188. return nil, fmt.Errorf("rewrite model in responses-shape body: %w", err)
  189. }
  190. // Strip Responses API parameters that no Codex upstream accepts.
  191. // Because this branch forwards the raw body (the normal path rebuilds
  192. // it from ChatCompletionsRequest and drops unknown fields naturally),
  193. // we must filter these fields explicitly here — otherwise the upstream
  194. // rejects the request with "Unsupported parameter: ...".
  195. for _, field := range cursorResponsesUnsupportedFields {
  196. if stripped, derr := sjson.DeleteBytes(responsesBody, field); derr == nil {
  197. responsesBody = stripped
  198. }
  199. }
  200. var normalizedServiceTier string
  201. responsesBody, normalizedServiceTier, err = normalizeResponsesBodyServiceTier(responsesBody)
  202. if err != nil {
  203. return nil, fmt.Errorf("normalize service_tier in responses-shape body: %w", err)
  204. }
  205. // Minimal stub populated from the raw body so downstream billing
  206. // propagation (ServiceTier, ReasoningEffort) keeps working.
  207. responsesReq = &apicompat.ResponsesRequest{
  208. Model: upstreamModel,
  209. ServiceTier: normalizedServiceTier,
  210. }
  211. if effort := gjson.GetBytes(responsesBody, "reasoning.effort").String(); effort != "" {
  212. responsesReq.Reasoning = &apicompat.ResponsesReasoning{Effort: effort}
  213. }
  214. } else {
  215. // Normal path: convert Chat Completions → Responses.
  216. // ChatCompletionsToResponses always sets Stream=true (upstream always streams).
  217. responsesReq, err = apicompat.ChatCompletionsToResponses(&chatReq)
  218. if err != nil {
  219. return nil, fmt.Errorf("convert chat completions to responses: %w", err)
  220. }
  221. responsesReq.Model = upstreamModel
  222. normalizeResponsesRequestServiceTier(responsesReq)
  223. responsesBody, err = json.Marshal(responsesReq)
  224. if err != nil {
  225. return nil, fmt.Errorf("marshal responses request: %w", err)
  226. }
  227. }
  228. logFields := []zap.Field{
  229. zap.Int64("account_id", account.ID),
  230. zap.String("original_model", originalModel),
  231. zap.String("billing_model", billingModel),
  232. zap.String("upstream_model", upstreamModel),
  233. zap.Bool("stream", clientStream),
  234. zap.Bool("responses_shape", isResponsesShape),
  235. }
  236. if compatPromptCacheInjected {
  237. logFields = append(logFields,
  238. zap.Bool("compat_prompt_cache_key_injected", true),
  239. zap.String("compat_prompt_cache_key_sha256", hashSensitiveValueForLog(promptCacheKey)),
  240. )
  241. }
  242. logger.L().Debug("openai chat_completions: model mapping applied", logFields...)
  243. if account.UsesOpenAICodexProtocol() {
  244. var reqBody map[string]any
  245. if err := json.Unmarshal(responsesBody, &reqBody); err != nil {
  246. return nil, fmt.Errorf("unmarshal for codex transform: %w", err)
  247. }
  248. isJSONObjectFormat := strings.EqualFold(strings.TrimSpace(gjson.GetBytes(responsesBody, "text.format.type").String()), "json_object")
  249. codexResult := applyCodexOAuthTransformWithOptions(reqBody, codexOAuthTransformOptions{
  250. SkipDefaultInstructions: !isResponsesShape,
  251. OmitPromotedSystemMessagesFromInput: !isResponsesShape && !isJSONObjectFormat,
  252. })
  253. if codexResult.Error != nil {
  254. c.JSON(http.StatusBadRequest, gin.H{"error": gin.H{"type": "invalid_request_error", "message": codexResult.Error.Error()}})
  255. return nil, codexResult.Error
  256. }
  257. setCodexToolNameReverse(c, codexResult.ToolNameReverse)
  258. if !isResponsesShape {
  259. ensureCodexOAuthInstructionsField(reqBody)
  260. }
  261. if codexResult.NormalizedModel != "" {
  262. upstreamModel = codexResult.NormalizedModel
  263. }
  264. if codexResult.PromptCacheKey != "" {
  265. promptCacheKey = codexResult.PromptCacheKey
  266. } else if promptCacheKey != "" {
  267. reqBody["prompt_cache_key"] = promptCacheKey
  268. }
  269. applyCodexAccountIdentityClientMetadataMap(reqBody, codexAccountIdentitySource(c, account), getAPIKeyIDFromContext(c))
  270. responsesBody, err = json.Marshal(reqBody)
  271. if err != nil {
  272. return nil, fmt.Errorf("remarshal after codex transform: %w", err)
  273. }
  274. }
  275. // Codex transforms may normalize the model after the initial mapping pass;
  276. // record the final slug immediately before policy/auth/upstream dispatch.
  277. SetOpsUpstreamModel(c, upstreamModel)
  278. if account.Type == AccountTypeAPIKey {
  279. if trimmedKey := strings.TrimSpace(promptCacheKey); trimmedKey != "" {
  280. var reqBody map[string]any
  281. if err := json.Unmarshal(responsesBody, &reqBody); err != nil {
  282. return nil, fmt.Errorf("unmarshal for prompt cache key injection: %w", err)
  283. }
  284. if existing, ok := reqBody["prompt_cache_key"].(string); !ok || strings.TrimSpace(existing) == "" {
  285. reqBody["prompt_cache_key"] = trimmedKey
  286. responsesBody, err = json.Marshal(reqBody)
  287. if err != nil {
  288. return nil, fmt.Errorf("remarshal after prompt cache key injection: %w", err)
  289. }
  290. }
  291. }
  292. }
  293. // 4b. Apply OpenAI fast policy (may filter service_tier or block the request).
  294. updatedBody, policyErr := s.applyOpenAIFastPolicyToBody(ctx, account, upstreamModel, responsesBody)
  295. if policyErr != nil {
  296. var blocked *OpenAIFastBlockedError
  297. if errors.As(policyErr, &blocked) {
  298. MarkOpsClientBusinessLimited(c, OpsClientBusinessLimitedReasonLocalPolicyDenied)
  299. writeChatCompletionsError(c, http.StatusForbidden, "permission_error", blocked.Message)
  300. }
  301. return nil, policyErr
  302. }
  303. responsesBody = updatedBody
  304. responsesReq.ServiceTier = normalizedOpenAIServiceTierValue(gjson.GetBytes(responsesBody, "service_tier").String())
  305. // 5. Get access token
  306. token, _, err := s.GetAccessToken(ctx, account)
  307. if err != nil {
  308. return nil, fmt.Errorf("get access token: %w", err)
  309. }
  310. // 6. Build upstream request
  311. upstreamCtx, releaseUpstreamCtx := detachUpstreamContext(ctx)
  312. cancelUpstream := func() {}
  313. if clientStream {
  314. upstreamCtx, cancelUpstream = context.WithCancel(upstreamCtx)
  315. }
  316. defer cancelUpstream()
  317. upstreamReq, err := s.buildUpstreamRequest(upstreamCtx, c, account, responsesBody, token, true, promptCacheKey, false)
  318. releaseUpstreamCtx()
  319. if err != nil {
  320. return nil, fmt.Errorf("build upstream request: %w", err)
  321. }
  322. if promptCacheKey != "" {
  323. apiKeyID := getAPIKeyIDFromContext(c)
  324. sessionKey := promptCacheKey
  325. if !compatPromptCacheTenantIsolated {
  326. sessionKey = isolateOpenAIUpstreamSessionID(apiKeyID, codexAccountIdentitySource(c, account), promptCacheKey)
  327. }
  328. upstreamReq.Header.Set("session_id", generateSessionUUID(sessionKey))
  329. }
  330. // 7. Send request
  331. proxyURL := ""
  332. if account.ProxyID != nil && account.Proxy != nil {
  333. proxyURL = account.Proxy.URL()
  334. }
  335. resp, err := s.doOpenAIUpstream(upstreamReq, proxyURL, account)
  336. if err != nil {
  337. return nil, s.handleOpenAIUpstreamTransportError(ctx, c, account, err, false)
  338. }
  339. defer func() {
  340. cancelUpstream()
  341. _ = resp.Body.Close()
  342. }()
  343. // 8. Handle error response with failover
  344. if resp.StatusCode >= 400 {
  345. respBody, upstreamMsg := s.readOpenAIUpstreamError(resp)
  346. if !agentIdentityTaskRecoveryWasTried(ctx) && s.isAgentIdentityAccount(ctx, account) && isAgentIdentityTaskInvalidHTTPResponse(resp.StatusCode, respBody) {
  347. expectedTaskID := account.GetCredential("task_id")
  348. if err := s.recoverAgentIdentityTask(ctx, account, expectedTaskID); err != nil {
  349. return nil, fmt.Errorf("agent identity task recovery failed: %w", err)
  350. }
  351. return s.forwardAsChatCompletions(markAgentIdentityTaskRecoveryTried(ctx), c, account, body, promptCacheKey, defaultMappedModel, compatPromptCacheTenantIsolated)
  352. }
  353. if account.Type == AccountTypeAPIKey &&
  354. openai_compat.ResolveResponsesSupport(account.Extra) == openai_compat.ResponsesSupportUnknown &&
  355. !isResponsesEndpointSupportedByStatus(resp.StatusCode) {
  356. logger.L().Info("openai chat_completions: /responses unsupported, falling back to raw chat completions",
  357. zap.Int64("account_id", account.ID),
  358. zap.Int("upstream_status", resp.StatusCode),
  359. zap.String("upstream_message", upstreamMsg),
  360. )
  361. return s.forwardAsRawChatCompletions(ctx, c, account, body, defaultMappedModel)
  362. }
  363. if foErr := s.failoverOpenAIUpstreamHTTPError(ctx, c, account, resp, respBody, upstreamMsg, upstreamModel); foErr != nil {
  364. return nil, foErr
  365. }
  366. return s.handleChatCompletionsErrorResponse(resp, c, account, billingModel)
  367. }
  368. // 9. Handle normal response
  369. var result *OpenAIForwardResult
  370. var handleErr error
  371. if clientStream {
  372. result, handleErr = s.handleChatStreamingResponse(resp, c, account, originalModel, billingModel, upstreamModel, startTime, len(body))
  373. } else {
  374. result, handleErr = s.handleChatBufferedStreamingResponse(resp, c, account, originalModel, billingModel, upstreamModel, startTime)
  375. }
  376. // cyber_policy:标记已设、error 已按 Chat Completions 格式发给客户端。丢弃 result、
  377. // 返回哨兵,使 handler 落入 tokens=0 免费用量行(对齐 /v1/responses),不计费、不 failover。
  378. if GetOpsCyberPolicy(c) != nil {
  379. if handleErr == nil {
  380. handleErr = errOpenAICyberPolicyForwarded
  381. }
  382. return nil, handleErr
  383. }
  384. // Propagate ServiceTier and ReasoningEffort to result for billing.
  385. // 计费 tier 优先采用上游回显值;上游未回显时回退到最终出站 body(经过
  386. // fast policy filter/force 之后)里的 tier,policy filter 删掉字段后不再
  387. // 按原请求 Fast 计费。
  388. if handleErr == nil && result != nil {
  389. if tier := resolvedOpenAIUpstreamServiceTier(c, extractOpenAIServiceTierFromBody(responsesBody)); tier != nil {
  390. result.ServiceTier = tier
  391. }
  392. if responsesReq.Reasoning != nil && responsesReq.Reasoning.Effort != "" {
  393. re := responsesReq.Reasoning.Effort
  394. result.ReasoningEffort = &re
  395. }
  396. }
  397. // Extract and save Codex usage snapshot from response headers (for OAuth accounts).
  398. // 排除 spark 影子:其 codex_* 仅由 QueryUsage(/wham/usage bengalfox)更新(外审第7轮 P1)。
  399. if handleErr == nil && account.Type == AccountTypeOAuth && !account.IsShadow() {
  400. if snapshot := ParseCodexRateLimitHeaders(resp.Header); snapshot != nil {
  401. s.updateCodexUsageSnapshot(ctx, account.ID, snapshot)
  402. }
  403. } else if handleErr == nil && account.IsShadow() && account.ParentAccountID != nil {
  404. notifyOpenAIAutoReset(*account.ParentAccountID)
  405. }
  406. return result, handleErr
  407. }
  408. func normalizeResponsesRequestServiceTier(req *apicompat.ResponsesRequest) {
  409. if req == nil {
  410. return
  411. }
  412. req.ServiceTier = normalizedOpenAIServiceTierValue(req.ServiceTier)
  413. }
  414. func normalizeResponsesBodyServiceTier(body []byte) ([]byte, string, error) {
  415. if len(body) == 0 {
  416. return body, "", nil
  417. }
  418. rawServiceTier := gjson.GetBytes(body, "service_tier").String()
  419. if rawServiceTier == "" {
  420. return body, "", nil
  421. }
  422. normalizedServiceTier := normalizedOpenAIServiceTierValue(rawServiceTier)
  423. if normalizedServiceTier == "" {
  424. trimmed, err := sjson.DeleteBytes(body, "service_tier")
  425. return trimmed, "", err
  426. }
  427. if normalizedServiceTier == rawServiceTier {
  428. return body, normalizedServiceTier, nil
  429. }
  430. trimmed, err := sjson.SetBytes(body, "service_tier", normalizedServiceTier)
  431. return trimmed, normalizedServiceTier, err
  432. }
  433. func normalizedOpenAIServiceTierValue(raw string) string {
  434. normalized := normalizeOpenAIServiceTier(raw)
  435. if normalized == nil {
  436. return ""
  437. }
  438. return *normalized
  439. }
  440. func openAICompatFailedResponseMessage(resp *apicompat.ResponsesResponse) string {
  441. if resp == nil || resp.Error == nil {
  442. return ""
  443. }
  444. return strings.TrimSpace(resp.Error.Message)
  445. }
  446. // handleChatCompletionsErrorResponse reads an upstream error and returns it in
  447. // OpenAI Chat Completions error format.
  448. func (s *OpenAIGatewayService) handleChatCompletionsErrorResponse(
  449. resp *http.Response,
  450. c *gin.Context,
  451. account *Account,
  452. requestedModel ...string,
  453. ) (*OpenAIForwardResult, error) {
  454. return s.handleCompatErrorResponse(resp, c, account, writeChatCompletionsError, requestedModel...)
  455. }
  456. // handleChatBufferedStreamingResponse reads all Responses SSE events from the
  457. // upstream, finds the terminal event, converts to a Chat Completions JSON
  458. // response, and writes it to the client.
  459. func (s *OpenAIGatewayService) handleChatBufferedStreamingResponse(
  460. resp *http.Response,
  461. c *gin.Context,
  462. account *Account,
  463. originalModel string,
  464. billingModel string,
  465. upstreamModel string,
  466. startTime time.Time,
  467. ) (*OpenAIForwardResult, error) {
  468. requestID := resp.Header.Get("x-request-id")
  469. finalResponse, usage, acc, err := s.readOpenAICompatBufferedTerminal(resp, c, "openai chat_completions buffered", requestID)
  470. if err != nil {
  471. return nil, s.newOpenAICompatBufferedReadFailoverError(c, account, resp, requestID, err)
  472. }
  473. if finalResponse == nil {
  474. writeChatCompletionsError(c, http.StatusBadGateway, "api_error", "Upstream stream ended without a terminal response event")
  475. return nil, fmt.Errorf("upstream stream ended without terminal event")
  476. }
  477. observer := upstreamResponseModelObserverFromContext(c)
  478. if observer == nil {
  479. observer = beginUpstreamResponseModelObservation(c)
  480. }
  481. observer.Observe(finalResponse.Model, true)
  482. observer.ObserveServiceTier(finalResponse.ServiceTier, true)
  483. if strings.TrimSpace(finalResponse.Status) == "failed" {
  484. payload, _ := json.Marshal(gin.H{"type": "response.failed", "response": finalResponse})
  485. // cyber_policy 致命不可重试:不 failover,以 Chat Completions 错误格式回写(F4),
  486. // 标记供 handler 事后写风控/邮件/tokens=0 用量行。
  487. if hit, code, msg := detectOpenAICyberPolicy(payload); hit {
  488. MarkOpsCyberPolicy(c, CyberPolicyMark{
  489. Code: code,
  490. Message: msg,
  491. Body: truncateString(string(payload), 4096),
  492. UpstreamStatus: http.StatusOK,
  493. UpstreamInTok: usage.InputTokens,
  494. UpstreamOutTok: usage.OutputTokens,
  495. })
  496. clientMsg := msg
  497. if clientMsg == "" {
  498. clientMsg = "Request blocked by upstream cyber-security policy"
  499. }
  500. writeChatCompletionsError(c, http.StatusBadRequest, "invalid_request_error", clientMsg)
  501. return nil, fmt.Errorf("openai cyber_policy: %s", msg)
  502. }
  503. message := openAICompatFailedResponseMessage(finalResponse)
  504. if openAIStreamFailedEventShouldFailover(payload, message) {
  505. return nil, s.newOpenAIStreamFailoverErrorWithModel(c, account, false, requestID, payload, message, upstreamModel, resp.Header)
  506. }
  507. message = s.recordOpenAIStreamUpstreamError(c, account, false, requestID, "http_error", payload, message)
  508. // response.failed 到达在 HTTP 200 SSE 流上,无真实 HTTP 错误码;统一走语义
  509. // 状态推断 + body 归一化(与 /v1/responses 路径一致),使按错误码配置的规则可命中。
  510. if status, errType, errMsg, matched := applyOpenAIStreamFailedErrorPassthroughRule(
  511. c, account.Platform, payload, message,
  512. ); matched {
  513. if errMsg == "" {
  514. errMsg = message
  515. }
  516. MarkResponseCommitted(c)
  517. writeChatCompletionsError(c, status, errType, errMsg)
  518. return nil, fmt.Errorf("upstream response failed (passthrough): %s", errMsg)
  519. }
  520. writeChatCompletionsError(c, http.StatusBadGateway, "upstream_error", message)
  521. return nil, fmt.Errorf("upstream response failed: %s", message)
  522. }
  523. if strings.TrimSpace(finalResponse.Status) == "completed" {
  524. logOpenAISuccessMissingUsage(c.Request.Context(), c, account, resp, &usage, "response.completed", false)
  525. }
  526. if requiresBillableGrokChatUsage(account, billingModel, upstreamModel, finalResponse.Model) && !hasBillableGrokChatUsage(usage) {
  527. upstreamRequestID := firstNonEmpty(requestID, resp.Header.Get("xai-request-id"))
  528. return nil, newGrokMissingUsageFailoverError(c, account, upstreamRequestID)
  529. }
  530. // When the terminal event has an empty output array, reconstruct from
  531. // accumulated delta events so the client receives the full content.
  532. acc.SupplementResponseOutput(finalResponse)
  533. chatResp := apicompat.ResponsesToChatCompletions(finalResponse, originalModel)
  534. if s.responseHeaderFilter != nil {
  535. responseheaders.WriteFilteredHeaders(c.Writer.Header(), resp.Header, s.responseHeaderFilter)
  536. }
  537. // 非流式响应必须为标准 JSON。上游被强制流式,其响应头 Content-Type 为
  538. // text/event-stream,会经 WriteFilteredHeaders 透传进来;而 c.JSON 走 Gin 的
  539. // writeContentType 仅在头不存在时才设置,无法覆盖。这里显式 Set 强制改回 JSON,
  540. // 否则下游"看头判流式"的中间层(如 new-api)会把本应聚合的 JSON 当成 SSE 处理。
  541. c.Writer.Header().Set("Content-Type", "application/json; charset=utf-8")
  542. c.JSON(http.StatusOK, chatResp)
  543. result := &OpenAIForwardResult{
  544. RequestID: requestID,
  545. UpstreamHeaders: resp.Header,
  546. Usage: usage,
  547. Model: originalModel,
  548. BillingModel: billingModel,
  549. UpstreamModel: upstreamModel,
  550. UpstreamResponseModel: observedUpstreamResponseModel(c),
  551. UpstreamResponseModelConflict: observedUpstreamResponseModelConflict(c),
  552. UpstreamResponseServiceTier: observedUpstreamResponseServiceTier(c),
  553. Stream: false,
  554. Duration: time.Since(startTime),
  555. }
  556. // Grok chat bridge: bill native search tools found in the terminal Responses body.
  557. if account != nil && account.IsGrok() && finalResponse != nil {
  558. if body, err := json.Marshal(finalResponse); err == nil {
  559. if n := countGrokNativeSearchCallsFromJSONBytes(body); n > 0 {
  560. result.SearchCount = n
  561. }
  562. }
  563. }
  564. return result, nil
  565. }
  566. func (s *OpenAIGatewayService) newOpenAICompatBufferedReadFailoverError(
  567. c *gin.Context,
  568. account *Account,
  569. resp *http.Response,
  570. requestID string,
  571. err error,
  572. ) error {
  573. var readErr *openAICompatBufferedReadError
  574. if !errors.As(err, &readErr) || readErr == nil || errors.Is(readErr.cause, bufio.ErrTooLong) {
  575. return err
  576. }
  577. var requestContext context.Context
  578. if c != nil && c.Request != nil {
  579. requestContext = c.Request.Context()
  580. }
  581. if !shouldClassifyOpenAIUpstreamStreamReadError(readErr.cause, requestContext) {
  582. return err
  583. }
  584. classifiedErr := newOpenAIUpstreamStreamReadError(readErr.cause)
  585. code, message, ok := OpenAIUpstreamStreamReadErrorDetails(classifiedErr)
  586. if !ok {
  587. return err
  588. }
  589. payload, _ := json.Marshal(gin.H{
  590. "error": gin.H{
  591. "type": "upstream_error",
  592. "code": code,
  593. "message": message,
  594. },
  595. })
  596. var responseHeaders http.Header
  597. if resp != nil {
  598. responseHeaders = resp.Header
  599. }
  600. failoverErr := s.newOpenAIStreamFailoverError(c, account, false, requestID, payload, message, responseHeaders)
  601. // 保留稳定错误码,确保重试耗尽后客户端和错误透传规则仍能识别传输故障。
  602. failoverErr.ResponseBody = payload
  603. return failoverErr
  604. }
  605. // handleChatStreamingResponse reads Responses SSE events from upstream,
  606. // converts each to Chat Completions SSE chunks, and writes them to the client.
  607. func (s *OpenAIGatewayService) handleChatStreamingResponse(
  608. resp *http.Response,
  609. c *gin.Context,
  610. account *Account,
  611. originalModel string,
  612. billingModel string,
  613. upstreamModel string,
  614. startTime time.Time,
  615. requestBodyLen int,
  616. ) (*OpenAIForwardResult, error) {
  617. requestID := resp.Header.Get("x-request-id")
  618. writeStreamHeaders := s.newStreamHeaderWriter(c, resp.Header)
  619. state := apicompat.NewResponsesEventToChatState()
  620. state.Model = originalModel
  621. // 网关作为计费链路的一环,不能把下游 usage 输出绑定到客户端是否显式请求。
  622. // raw Chat Completions 直转路径已经强制透出 usage,这里保持同样行为,避免级联代理计费为 0。
  623. state.IncludeUsage = true
  624. var usage OpenAIUsage
  625. var firstTokenMs *int
  626. firstChunk := true
  627. clientDisconnected := false
  628. clientOutputStarted := false
  629. pendingSSE := make([]string, 0, 4)
  630. refusalDetector := newOpenAIChatSilentRefusalDetector(requestBodyLen)
  631. var streamFailoverErr *UpstreamFailoverError
  632. var streamNonFailoverErr error
  633. terminalEventType := ""
  634. // Grok chat bridge reuses Responses SSE; count native search tools for surcharge.
  635. searchCount := 0
  636. streamSearchSeen := make(map[string]struct{})
  637. countSearch := account != nil && account.IsGrok()
  638. observer := upstreamResponseModelObserverFromContext(c)
  639. if observer == nil {
  640. observer = beginUpstreamResponseModelObservation(c)
  641. }
  642. scanner := s.newUpstreamSSEScanner(resp.Body)
  643. streamInterval := time.Duration(0)
  644. if s.cfg != nil && s.cfg.Gateway.StreamDataIntervalTimeout > 0 {
  645. streamInterval = time.Duration(s.cfg.Gateway.StreamDataIntervalTimeout) * time.Second
  646. }
  647. var intervalTicker *time.Ticker
  648. if streamInterval > 0 {
  649. intervalTicker = time.NewTicker(streamInterval)
  650. defer intervalTicker.Stop()
  651. }
  652. var intervalCh <-chan time.Time
  653. if intervalTicker != nil {
  654. intervalCh = intervalTicker.C
  655. }
  656. resultWithUsage := func() *OpenAIForwardResult {
  657. out := &OpenAIForwardResult{
  658. RequestID: requestID,
  659. UpstreamHeaders: resp.Header,
  660. Usage: usage,
  661. Model: originalModel,
  662. BillingModel: billingModel,
  663. UpstreamModel: upstreamModel,
  664. UpstreamResponseModel: observedUpstreamResponseModel(c),
  665. UpstreamResponseModelConflict: observedUpstreamResponseModelConflict(c),
  666. UpstreamResponseServiceTier: observedUpstreamResponseServiceTier(c),
  667. Stream: true,
  668. Duration: time.Since(startTime),
  669. FirstTokenMs: firstTokenMs,
  670. }
  671. if searchCount > 0 {
  672. out.SearchCount = searchCount
  673. }
  674. return out
  675. }
  676. processDataLine := func(payload string) bool {
  677. payload = string(restoreCodexToolNamesFromContext(c, []byte(payload)))
  678. if firstChunk {
  679. firstChunk = false
  680. ms := int(time.Since(startTime).Milliseconds())
  681. firstTokenMs = &ms
  682. }
  683. if countSearch {
  684. searchCount += countGrokNativeSearchCallsInSSEDataDedup([]byte(payload), streamSearchSeen)
  685. }
  686. var event apicompat.ResponsesStreamEvent
  687. if err := json.Unmarshal([]byte(payload), &event); err != nil {
  688. logger.L().Warn("openai chat_completions stream: failed to parse event",
  689. zap.Error(err),
  690. zap.String("request_id", requestID),
  691. )
  692. return false
  693. }
  694. observer.ObserveOpenAI([]byte(payload), event.Type)
  695. refusalDetector.ObservePayload([]byte(payload))
  696. s.parseSSEUsageBytesWithType([]byte(payload), event.Type, &usage)
  697. isTerminalEvent := isOpenAICompatResponsesTerminalEvent(event.Type)
  698. if isTerminalEvent {
  699. terminalEventType = strings.TrimSpace(event.Type)
  700. if event.Usage != nil {
  701. usage = copyOpenAIUsageFromResponsesUsage(event.Usage)
  702. }
  703. if event.Response != nil && event.Response.Usage != nil {
  704. usage = copyOpenAIUsageFromResponsesUsage(event.Response.Usage)
  705. }
  706. }
  707. if strings.TrimSpace(event.Type) == "response.failed" || strings.TrimSpace(event.Type) == "error" {
  708. payloadBytes := []byte(payload)
  709. message := extractOpenAISSEErrorMessage(payloadBytes)
  710. if hit, code, msg := detectOpenAICyberPolicy(payloadBytes); hit {
  711. // cyber_policy 致命且不可重试:不 failover。下发标准 error chunk +
  712. // [DONE],让程序化客户端可感知并停止重试(F4);标记供 handler 事后
  713. // 写风控/邮件。
  714. MarkOpsCyberPolicy(c, CyberPolicyMark{
  715. Code: code,
  716. Message: msg,
  717. Body: truncateString(string(payloadBytes), 4096),
  718. UpstreamStatus: http.StatusOK,
  719. UpstreamInTok: usage.InputTokens,
  720. UpstreamOutTok: usage.OutputTokens,
  721. })
  722. if !clientDisconnected {
  723. // 被 refusal 检测扣留的 pendingSSE 有意丢弃——cyber 拦截优先于部分内容下发。
  724. writeStreamHeaders()
  725. clientMsg := msg
  726. if clientMsg == "" {
  727. clientMsg = "Request blocked by upstream cyber-security policy"
  728. }
  729. if _, err := fmt.Fprint(c.Writer, buildChatStreamErrorSSE(code, clientMsg)); err == nil {
  730. _, _ = fmt.Fprint(c.Writer, "data: [DONE]\n\n")
  731. if fl, ok := c.Writer.(http.Flusher); ok {
  732. fl.Flush()
  733. }
  734. }
  735. // 无条件置位:成功路径防 finalizeStream 重复 [DONE];写失败意味着连接已不可写,
  736. // finalizeStream 的 [DONE] 同样发不出去,统一抑制。
  737. clientDisconnected = true
  738. }
  739. return true
  740. }
  741. shouldFailover := openAIStreamFailedEventShouldFailover(payloadBytes, message)
  742. if strings.TrimSpace(event.Type) == "error" {
  743. shouldFailover = openAIStreamErrorEventShouldFailover(payloadBytes, message)
  744. }
  745. if !clientOutputStarted && shouldFailover {
  746. streamFailoverErr = s.newOpenAIStreamFailoverErrorWithModel(c, account, false, requestID, payloadBytes, message, upstreamModel, resp.Header)
  747. return true
  748. }
  749. message = s.recordOpenAIStreamUpstreamError(c, account, false, requestID, "http_error", payloadBytes, message)
  750. defaultStatus, defaultErrType, defaultMsg := http.StatusBadGateway, "upstream_error", message
  751. // 统一走语义状态推断 + body 归一化(与 /v1/responses 路径一致),
  752. // 使按错误码配置的透传规则可命中。
  753. if status, errType, errMsg, matched := applyOpenAIStreamFailedErrorPassthroughRule(
  754. c, account.Platform, payloadBytes, message,
  755. ); matched {
  756. if errMsg == "" {
  757. errMsg = defaultMsg
  758. }
  759. defaultStatus, defaultErrType, defaultMsg = status, errType, errMsg
  760. MarkResponseCommitted(c)
  761. }
  762. errorPayload, _ := json.Marshal(gin.H{
  763. "error": gin.H{
  764. "type": defaultErrType,
  765. "message": defaultMsg,
  766. },
  767. })
  768. if c != nil && c.Writer != nil && !c.Writer.Written() {
  769. writeChatCompletionsError(c, defaultStatus, defaultErrType, defaultMsg)
  770. clientOutputStarted = true
  771. } else if c != nil && c.Writer != nil && !clientDisconnected {
  772. if _, err := fmt.Fprintf(c.Writer, "data: %s\n\n", errorPayload); err != nil {
  773. clientDisconnected = true
  774. logger.L().Info("openai chat_completions stream: client disconnected while writing upstream error",
  775. zap.String("request_id", requestID),
  776. )
  777. }
  778. }
  779. if !clientDisconnected {
  780. c.Writer.Flush()
  781. }
  782. streamNonFailoverErr = fmt.Errorf("upstream response failed: %s", message)
  783. return true
  784. }
  785. chunks := apicompat.ResponsesEventToChatChunks(&event, state)
  786. if !clientDisconnected {
  787. for _, chunk := range chunks {
  788. refusalDetector.ObserveChatChunk(chunk)
  789. sse, err := apicompat.ChatChunkToSSE(chunk)
  790. if err != nil {
  791. logger.L().Warn("openai chat_completions stream: failed to marshal chunk",
  792. zap.Error(err),
  793. zap.String("request_id", requestID),
  794. )
  795. continue
  796. }
  797. if !clientOutputStarted && !refusalDetector.ShouldReleaseClientOutput() {
  798. pendingSSE = append(pendingSSE, sse)
  799. continue
  800. }
  801. if !clientOutputStarted {
  802. writeStreamHeaders()
  803. for _, pending := range pendingSSE {
  804. if _, err := fmt.Fprint(c.Writer, pending); err != nil {
  805. clientDisconnected = true
  806. logger.L().Info("openai chat_completions stream: client disconnected while flushing pending chunks",
  807. zap.String("request_id", requestID),
  808. )
  809. break
  810. }
  811. }
  812. pendingSSE = pendingSSE[:0]
  813. clientOutputStarted = !clientDisconnected
  814. if clientDisconnected {
  815. break
  816. }
  817. }
  818. if _, err := fmt.Fprint(c.Writer, sse); err != nil {
  819. clientDisconnected = true
  820. logger.L().Info("openai chat_completions stream: client disconnected, continuing to drain upstream for billing",
  821. zap.String("request_id", requestID),
  822. )
  823. break
  824. }
  825. }
  826. }
  827. if len(chunks) > 0 && !clientDisconnected && clientOutputStarted {
  828. c.Writer.Flush()
  829. }
  830. return isTerminalEvent
  831. }
  832. finalizeStream := func() (*OpenAIForwardResult, error) {
  833. if streamFailoverErr != nil {
  834. if c == nil || c.Writer == nil || !c.Writer.Written() {
  835. return nil, streamFailoverErr
  836. }
  837. return resultWithUsage(), streamFailoverErr
  838. }
  839. if streamNonFailoverErr != nil {
  840. return resultWithUsage(), streamNonFailoverErr
  841. }
  842. if finalChunks := apicompat.FinalizeResponsesChatStream(state); len(finalChunks) > 0 && !clientDisconnected {
  843. for _, chunk := range finalChunks {
  844. refusalDetector.ObserveChatChunk(chunk)
  845. sse, err := apicompat.ChatChunkToSSE(chunk)
  846. if err != nil {
  847. continue
  848. }
  849. if !clientOutputStarted && !refusalDetector.ShouldReleaseClientOutput() {
  850. pendingSSE = append(pendingSSE, sse)
  851. continue
  852. }
  853. if !clientOutputStarted {
  854. writeStreamHeaders()
  855. for _, pending := range pendingSSE {
  856. if _, err := fmt.Fprint(c.Writer, pending); err != nil {
  857. clientDisconnected = true
  858. logger.L().Info("openai chat_completions stream: client disconnected during pending final flush",
  859. zap.String("request_id", requestID),
  860. )
  861. break
  862. }
  863. }
  864. pendingSSE = pendingSSE[:0]
  865. clientOutputStarted = !clientDisconnected
  866. if clientDisconnected {
  867. break
  868. }
  869. }
  870. if _, err := fmt.Fprint(c.Writer, sse); err != nil {
  871. clientDisconnected = true
  872. logger.L().Info("openai chat_completions stream: client disconnected during final flush",
  873. zap.String("request_id", requestID),
  874. )
  875. break
  876. }
  877. }
  878. }
  879. if !clientDisconnected && !clientOutputStarted {
  880. if refusalDetector.IsSilentRefusal() {
  881. return nil, newOpenAISilentRefusalFailoverError(c, account, requestID)
  882. }
  883. if len(pendingSSE) > 0 {
  884. writeStreamHeaders()
  885. for _, pending := range pendingSSE {
  886. if _, err := fmt.Fprint(c.Writer, pending); err != nil {
  887. clientDisconnected = true
  888. logger.L().Info("openai chat_completions stream: client disconnected during final pending flush",
  889. zap.String("request_id", requestID),
  890. )
  891. break
  892. }
  893. }
  894. pendingSSE = pendingSSE[:0]
  895. clientOutputStarted = !clientDisconnected
  896. }
  897. }
  898. // Send [DONE] sentinel
  899. if !clientDisconnected {
  900. writeStreamHeaders()
  901. if _, err := fmt.Fprint(c.Writer, "data: [DONE]\n\n"); err != nil {
  902. clientDisconnected = true
  903. logger.L().Info("openai chat_completions stream: client disconnected during done flush",
  904. zap.String("request_id", requestID),
  905. )
  906. }
  907. clientOutputStarted = !clientDisconnected
  908. }
  909. if !clientDisconnected {
  910. c.Writer.Flush()
  911. }
  912. logOpenAISuccessMissingUsage(c.Request.Context(), c, account, resp, &usage, terminalEventType, clientDisconnected)
  913. return resultWithUsage(), nil
  914. }
  915. handleScanErr := func(err error) {
  916. if err != nil && !errors.Is(err, context.Canceled) && !errors.Is(err, context.DeadlineExceeded) {
  917. logger.FromContext(c.Request.Context()).Warn("openai chat_completions stream: read error",
  918. zap.Error(err),
  919. zap.String("upstream_request_id", requestID),
  920. )
  921. }
  922. }
  923. missingTerminalErr := func() (*OpenAIForwardResult, error) {
  924. return resultWithUsage(), fmt.Errorf("stream usage incomplete: missing terminal event")
  925. }
  926. processFrame := func(frame openAICompatSSEFrame) bool {
  927. payload := openAICompatPayloadWithEventType(frame.Data, frame.EventType)
  928. if strings.TrimSpace(payload) == "[DONE]" {
  929. return false
  930. }
  931. return processDataLine(payload)
  932. }
  933. // Determine keepalive interval
  934. keepaliveInterval := time.Duration(0)
  935. if s.cfg != nil && s.cfg.Gateway.StreamKeepaliveInterval > 0 {
  936. keepaliveInterval = time.Duration(s.cfg.Gateway.StreamKeepaliveInterval) * time.Second
  937. }
  938. // No keepalive: fast synchronous path
  939. if streamInterval <= 0 && keepaliveInterval <= 0 {
  940. var parser openAICompatSSEFrameParser
  941. for scanner.Scan() {
  942. line := scanner.Text()
  943. frame, ok := parser.AddLine(line)
  944. if !ok {
  945. continue
  946. }
  947. if strings.TrimSpace(frame.Data) == "[DONE]" {
  948. return missingTerminalErr()
  949. }
  950. if processFrame(frame) {
  951. return finalizeStream()
  952. }
  953. }
  954. if err := scanner.Err(); err != nil {
  955. handleScanErr(err)
  956. if clientDisconnected || errors.Is(err, context.Canceled) || errors.Is(err, context.DeadlineExceeded) {
  957. return resultWithUsage(), fmt.Errorf("stream usage incomplete: %w", err)
  958. }
  959. return resultWithUsage(), newOpenAIUpstreamStreamReadError(err)
  960. }
  961. if frame, ok := parser.Finish(); ok {
  962. if strings.TrimSpace(frame.Data) == "[DONE]" {
  963. return missingTerminalErr()
  964. }
  965. if processFrame(frame) {
  966. return finalizeStream()
  967. }
  968. }
  969. return missingTerminalErr()
  970. }
  971. // With keepalive: goroutine + channel + select
  972. type scanEvent struct {
  973. line string
  974. err error
  975. }
  976. events := make(chan scanEvent, 16)
  977. done := make(chan struct{})
  978. var lastReadAt int64
  979. atomic.StoreInt64(&lastReadAt, time.Now().UnixNano())
  980. sendEvent := func(ev scanEvent) bool {
  981. select {
  982. case events <- ev:
  983. return true
  984. case <-done:
  985. return false
  986. }
  987. }
  988. go func() {
  989. defer close(events)
  990. for scanner.Scan() {
  991. atomic.StoreInt64(&lastReadAt, time.Now().UnixNano())
  992. if !sendEvent(scanEvent{line: scanner.Text()}) {
  993. return
  994. }
  995. }
  996. if err := scanner.Err(); err != nil {
  997. _ = sendEvent(scanEvent{err: err})
  998. }
  999. }()
  1000. defer close(done)
  1001. var keepaliveTicker *time.Ticker
  1002. if keepaliveInterval > 0 {
  1003. keepaliveTicker = time.NewTicker(keepaliveInterval)
  1004. defer keepaliveTicker.Stop()
  1005. }
  1006. var keepaliveCh <-chan time.Time
  1007. if keepaliveTicker != nil {
  1008. keepaliveCh = keepaliveTicker.C
  1009. }
  1010. lastDataAt := time.Now()
  1011. var parser openAICompatSSEFrameParser
  1012. for {
  1013. select {
  1014. case ev, ok := <-events:
  1015. if !ok {
  1016. if frame, ok := parser.Finish(); ok {
  1017. if strings.TrimSpace(frame.Data) == "[DONE]" {
  1018. return missingTerminalErr()
  1019. }
  1020. if processFrame(frame) {
  1021. return finalizeStream()
  1022. }
  1023. }
  1024. return missingTerminalErr()
  1025. }
  1026. if ev.err != nil {
  1027. handleScanErr(ev.err)
  1028. if clientDisconnected || errors.Is(ev.err, context.Canceled) || errors.Is(ev.err, context.DeadlineExceeded) {
  1029. return resultWithUsage(), fmt.Errorf("stream usage incomplete: %w", ev.err)
  1030. }
  1031. return resultWithUsage(), newOpenAIUpstreamStreamReadError(ev.err)
  1032. }
  1033. lastDataAt = time.Now()
  1034. line := ev.line
  1035. frame, ok := parser.AddLine(line)
  1036. if !ok {
  1037. continue
  1038. }
  1039. if strings.TrimSpace(frame.Data) == "[DONE]" {
  1040. return missingTerminalErr()
  1041. }
  1042. if processFrame(frame) {
  1043. return finalizeStream()
  1044. }
  1045. case <-intervalCh:
  1046. lastRead := time.Unix(0, atomic.LoadInt64(&lastReadAt))
  1047. if time.Since(lastRead) < streamInterval {
  1048. continue
  1049. }
  1050. if clientDisconnected {
  1051. return resultWithUsage(), fmt.Errorf("stream usage incomplete after timeout")
  1052. }
  1053. logger.L().Warn("openai chat_completions stream: data interval timeout",
  1054. zap.String("request_id", requestID),
  1055. zap.String("model", originalModel),
  1056. zap.Duration("interval", streamInterval),
  1057. )
  1058. return resultWithUsage(), fmt.Errorf("stream data interval timeout")
  1059. case <-keepaliveCh:
  1060. if clientDisconnected {
  1061. continue
  1062. }
  1063. if refusalDetector.Enabled() && !clientOutputStarted {
  1064. continue
  1065. }
  1066. if time.Since(lastDataAt) < keepaliveInterval {
  1067. continue
  1068. }
  1069. // Send SSE comment as keepalive
  1070. writeStreamHeaders()
  1071. if _, err := fmt.Fprint(c.Writer, ":\n\n"); err != nil {
  1072. logger.L().Info("openai chat_completions stream: client disconnected during keepalive",
  1073. zap.String("request_id", requestID),
  1074. )
  1075. clientDisconnected = true
  1076. continue
  1077. }
  1078. c.Writer.Flush()
  1079. }
  1080. }
  1081. }
  1082. // writeChatCompletionsError writes an error response in OpenAI Chat Completions format.
  1083. func writeChatCompletionsError(c *gin.Context, statusCode int, errType, message string) {
  1084. MarkResponseCommitted(c)
  1085. c.JSON(statusCode, gin.H{
  1086. "error": gin.H{
  1087. "type": errType,
  1088. "message": message,
  1089. },
  1090. })
  1091. }
  1092. // buildChatStreamErrorSSE builds one SSE data frame carrying an OpenAI chat
  1093. // streaming error object. Used when the stream must terminate with a visible
  1094. // error (e.g. upstream cyber_policy), so programmatic clients stop retrying.
  1095. // Marshal 失败的兜底会丢弃 message 原文,仅保留 code 与固定提示。
  1096. func buildChatStreamErrorSSE(code, message string) string {
  1097. payload, err := json.Marshal(gin.H{
  1098. "error": gin.H{
  1099. "type": "invalid_request_error",
  1100. "code": code,
  1101. "message": message,
  1102. },
  1103. })
  1104. if err != nil {
  1105. return "data: {\"error\":{\"type\":\"invalid_request_error\",\"code\":\"" + code + "\",\"message\":\"upstream error\"}}\n\n"
  1106. }
  1107. return "data: " + string(payload) + "\n\n"
  1108. }