Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
# docker-compose-prd.yaml 配置
# 复制为 .env 后再按实际环境修改:cp .env.example .env
NEW_API_IMAGE=new-api:local
NEW_API_PORT=3001
SQL_DSN=postgresql://newapi:change-me@postgres.example.com:5432/new_api?sslmode=require
REDIS_PASSWORD=change-me-to-a-strong-password
TZ=Asia/Shanghai
ERROR_LOG_ENABLED=true
BATCH_UPDATE_ENABLED=true
NODE_NAME=new-api-node-1

# 端口号
# PORT=3000
# 前端基础URL
Expand Down
62 changes: 62 additions & 0 deletions docker-compose-prd.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Production deployment using an external PostgreSQL database.
#
# Required environment variables:
# SQL_DSN=postgresql://newapi:password@db.example.com:5432/new_api?sslmode=require
# REDIS_PASSWORD=replace-with-a-strong-password

services:
new-api:
image: ${NEW_API_IMAGE:-calciumion/new-api:latest}
container_name: new-api
restart: always
command: --log-dir /app/logs
env_file:
- .env
ports:
- "${NEW_API_PORT:-3001}:3000"
volumes:
- ./data:/data
- ./logs:/app/logs
environment:
SQL_DSN: ${SQL_DSN:?SQL_DSN is required}
REDIS_CONN_STRING: redis://:${REDIS_PASSWORD:?REDIS_PASSWORD is required}@redis:6379
TZ: ${TZ:-Asia/Shanghai}
ERROR_LOG_ENABLED: ${ERROR_LOG_ENABLED:-true}
BATCH_UPDATE_ENABLED: ${BATCH_UPDATE_ENABLED:-true}
NODE_NAME: ${NODE_NAME:-new-api-node-1}
depends_on:
redis:
condition: service_healthy
extra_hosts:
- "host.docker.internal:host-gateway"
networks:
- new-api-network
healthcheck:
test: ["CMD-SHELL", "wget -q -O - http://localhost:3000/api/status | grep -o '\"success\":\\s*true' || exit 1"]
interval: 30s
timeout: 10s
retries: 3

redis:
image: redis:latest
container_name: redis
restart: always
command: ["redis-server", "--requirepass", "${REDIS_PASSWORD:?REDIS_PASSWORD is required}"]
healthcheck:
test: ["CMD-SHELL", "redis-cli -a \"$$REDIS_PASSWORD\" ping | grep -q PONG"]
interval: 10s
timeout: 5s
retries: 5
environment:
REDIS_PASSWORD: ${REDIS_PASSWORD:?REDIS_PASSWORD is required}
volumes:
- redis_data:/data
networks:
- new-api-network

volumes:
redis_data:

networks:
new-api-network:
driver: bridge
2 changes: 1 addition & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ services:
restart: always
command: --log-dir /app/logs
ports:
- "3000:3000"
- "3001:3000"
volumes:
- ./data:/data
- ./logs:/app/logs
Expand Down
59 changes: 59 additions & 0 deletions relay/channel/openai/helper.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package openai

import (
"encoding/json"
"fmt"
"strings"

Expand Down Expand Up @@ -242,3 +243,61 @@ func sendResponsesStreamData(c *gin.Context, streamResponse dto.ResponsesStreamR
}
_ = helper.ResponseChunkData(c, streamResponse, data)
}

func rewriteResponsesServerOverload(data string) (string, bool, error) {
if !strings.Contains(data, `"server_is_overloaded"`) {
return data, false, nil
}

var event map[string]json.RawMessage
if err := common.UnmarshalJsonStr(data, &event); err != nil {
return "", false, err
}

responseData, ok := event["response"]
if !ok {
return data, false, nil
}
var response map[string]json.RawMessage
if err := common.Unmarshal(responseData, &response); err != nil {
return data, false, nil
}

errorData, ok := response["error"]
if !ok {
return data, false, nil
}
var errorFields map[string]json.RawMessage
if err := common.Unmarshal(errorData, &errorFields); err != nil {
return data, false, nil
}
codeData, ok := errorFields["code"]
if !ok {
return data, false, nil
}
var code string
if err := common.Unmarshal(codeData, &code); err != nil || code != "server_is_overloaded" {
return data, false, nil
}

codeData, err := common.Marshal("server_error")
if err != nil {
return "", false, err
}
errorFields["code"] = codeData
errorData, err = common.Marshal(errorFields)
if err != nil {
return "", false, err
}
response["error"] = errorData
responseData, err = common.Marshal(response)
if err != nil {
return "", false, err
}
event["response"] = responseData
eventData, err := common.Marshal(event)
if err != nil {
return "", false, err
}
return string(eventData), true, nil
}
14 changes: 13 additions & 1 deletion relay/channel/openai/relay_responses.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,10 @@ func OaiResponsesHandler(c *gin.Context, info *relaycommon.RelayInfo, resp *http
if err != nil {
return nil, types.NewOpenAIError(err, types.ErrorCodeBadResponseBody, http.StatusInternalServerError)
}
if oaiError := responsesResponse.GetOpenAIError(); oaiError != nil && oaiError.Type != "" {
if oaiError := responsesResponse.GetOpenAIError(); oaiError != nil && (oaiError.Type != "" || oaiError.Message != "" || oaiError.Code != nil) {
if service.NormalizeServerOverloadError(oaiError) {
logger.LogWarn(c, "intercepted upstream server_is_overloaded and rewrote error code to server_error for client retry")
}
return nil, types.WithOpenAIError(*oaiError, resp.StatusCode)
}

Expand Down Expand Up @@ -86,6 +89,15 @@ func OaiResponsesStreamHandler(c *gin.Context, info *relaycommon.RelayInfo, resp
imageCommitted := false

helper.StreamScannerHandler(c, resp, info, func(data string, sr *helper.StreamResult) {
data, rewritten, err := rewriteResponsesServerOverload(data)
if err != nil {
logger.LogError(c, "failed to rewrite responses overload error: "+err.Error())
sr.Error(err)
return
}
if rewritten {
logger.LogWarn(c, "intercepted upstream server_is_overloaded SSE event and rewrote error code to server_error for client retry")
}

// 检查当前数据是否包含 completed 状态和 usage 信息
var streamResponse dto.ResponsesStreamResponse
Expand Down
83 changes: 83 additions & 0 deletions relay/channel/openai/relay_responses_billing_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,40 @@ func TestOaiResponsesHandlerIncompleteStatusCommitsZeroImageGeneration(t *testin
assert.Equal(t, 0, info.ResponsesUsageInfo.BuiltInTools[dto.BuildInToolImageGeneration].CallCount)
}

func TestOaiResponsesHandlerRewritesServerOverloadWithoutErrorType(t *testing.T) {
gin.SetMode(gin.TestMode)
body := []byte(`{"status":"failed","error":{"code":"server_is_overloaded","message":"Selected model is at capacity."}}`)
var logBuffer bytes.Buffer
common.LogWriterMu.Lock()
oldWriter := gin.DefaultErrorWriter
gin.DefaultErrorWriter = &logBuffer
common.LogWriterMu.Unlock()
t.Cleanup(func() {
common.LogWriterMu.Lock()
gin.DefaultErrorWriter = oldWriter
common.LogWriterMu.Unlock()
})
w := httptest.NewRecorder()
c, _ := gin.CreateTestContext(w)
c.Request = httptest.NewRequest(http.MethodPost, "/v1/responses", nil)
c.Set(common.RequestIdKey, "responses-overload-non-stream-test")
info := &relaycommon.RelayInfo{OriginModelName: "gpt-5.6-sol"}
resp := &http.Response{
StatusCode: http.StatusOK,
Body: io.NopCloser(bytes.NewReader(body)),
Header: http.Header{"Content-Type": []string{"application/json"}},
}

_, apiErr := OaiResponsesHandler(c, info, resp)

require.NotNil(t, apiErr)
assert.Equal(t, "server_error", string(apiErr.GetErrorCode()))
assert.Equal(t, "Selected model is at capacity.", apiErr.Error())
assert.Empty(t, w.Body.String())
assert.Contains(t, logBuffer.String(), "intercepted upstream server_is_overloaded")
assert.Contains(t, logBuffer.String(), "responses-overload-non-stream-test")
}

func runResponsesImageBillingStream(t *testing.T, events ...string) *relaycommon.RelayInfo {
t.Helper()
gin.SetMode(gin.TestMode)
Expand Down Expand Up @@ -265,3 +299,52 @@ func TestOaiResponsesStreamHandlerDoesNotCountPartialImageEvent(t *testing.T) {

assert.Equal(t, 0, info.ResponsesUsageInfo.BuiltInTools[dto.BuildInToolImageGeneration].CallCount)
}

func TestOaiResponsesStreamHandlerRewritesServerOverloadForCodexRetry(t *testing.T) {
gin.SetMode(gin.TestMode)
oldTimeout := constant.StreamingTimeout
constant.StreamingTimeout = 30
t.Cleanup(func() {
constant.StreamingTimeout = oldTimeout
})

body := "data: " + `{"type":"response.failed","sequence_number":3,"response":{"id":"resp_overloaded","status":"failed","error":{"code":"server_is_overloaded","message":"Selected model is at capacity."}}}` + "\n\n"
var logBuffer bytes.Buffer
common.LogWriterMu.Lock()
oldWriter := gin.DefaultErrorWriter
gin.DefaultErrorWriter = &logBuffer
common.LogWriterMu.Unlock()
t.Cleanup(func() {
common.LogWriterMu.Lock()
gin.DefaultErrorWriter = oldWriter
common.LogWriterMu.Unlock()
})
w := httptest.NewRecorder()
c, _ := gin.CreateTestContext(w)
c.Request = httptest.NewRequest(http.MethodPost, "/v1/responses", nil)
c.Set(common.RequestIdKey, "responses-overload-rewrite-test")
info := &relaycommon.RelayInfo{
OriginModelName: "gpt-5.6-sol",
DisablePing: true,
ChannelMeta: &relaycommon.ChannelMeta{
UpstreamModelName: "gpt-5.6-sol",
},
}
resp := &http.Response{
StatusCode: http.StatusOK,
Body: io.NopCloser(strings.NewReader(body)),
Header: http.Header{"Content-Type": []string{"text/event-stream"}},
}

_, apiErr := OaiResponsesStreamHandler(c, info, resp)

require.Nil(t, apiErr)
assert.Contains(t, w.Body.String(), `"code":"server_error"`)
assert.Contains(t, w.Body.String(), `"sequence_number":3`)
assert.Contains(t, w.Body.String(), "Selected model is at capacity.")
assert.NotContains(t, w.Body.String(), "server_is_overloaded")
assert.NotContains(t, w.Body.String(), `"type":""`)
assert.NotContains(t, w.Body.String(), `"param":""`)
assert.Contains(t, logBuffer.String(), "intercepted upstream server_is_overloaded SSE event")
assert.Contains(t, logBuffer.String(), "responses-overload-rewrite-test")
}
7 changes: 7 additions & 0 deletions relay/responses_handler.go
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,13 @@ func ResponsesHelper(c *gin.Context, info *relaycommon.RelayInfo) (newAPIError *

if httpResp.StatusCode != http.StatusOK {
newAPIError = service.RelayErrorHandler(c.Request.Context(), httpResp, false)
if newAPIError != nil {
openAIError := newAPIError.ToOpenAIError()
if service.NormalizeServerOverloadError(&openAIError) {
newAPIError = types.WithOpenAIError(openAIError, newAPIError.StatusCode)
logger.LogWarn(c, "intercepted upstream server_is_overloaded and rewrote error code to server_error for client retry")
}
}
// reset status code 重置状态码
service.ResetStatusCode(newAPIError, statusCodeMappingStr)
return newAPIError
Expand Down
16 changes: 16 additions & 0 deletions service/error.go
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,22 @@ func RelayErrorHandler(ctx context.Context, resp *http.Response, showBodyWhenFai
return
}

// NormalizeServerOverloadError converts the Codex-specific, non-retryable
// overload marker into a generic transient server error. Codex retries
// response.failed events and HTTP failures carrying server_error, while it
// intentionally stops immediately for server_is_overloaded.
func NormalizeServerOverloadError(openAIError *types.OpenAIError) bool {
if openAIError == nil {
return false
}
code, ok := openAIError.Code.(string)
if !ok || code != "server_is_overloaded" {
return false
}
openAIError.Code = "server_error"
return true
}

func ResetStatusCode(newApiErr *types.NewAPIError, statusCodeMappingStr string) {
if newApiErr == nil {
return
Expand Down
21 changes: 21 additions & 0 deletions service/error_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,27 @@ func TestRelayErrorHandlerKeepsOpenAIErrorMessage(t *testing.T) {
require.Equal(t, message, newAPIError.Error())
}

func TestNormalizeServerOverloadError(t *testing.T) {
body := `{"error":{"message":"Selected model is at capacity.","type":"server_error","code":"server_is_overloaded"}}`
resp := &http.Response{
StatusCode: http.StatusServiceUnavailable,
Body: io.NopCloser(strings.NewReader(body)),
}

upstreamError := RelayErrorHandler(context.Background(), resp, false)
require.NotNil(t, upstreamError)
require.Equal(t, types.ErrorCode("server_is_overloaded"), upstreamError.GetErrorCode())

openAIError := upstreamError.ToOpenAIError()
rewritten := NormalizeServerOverloadError(&openAIError)
normalizedError := types.WithOpenAIError(openAIError, upstreamError.StatusCode)

require.True(t, rewritten)
require.Equal(t, types.ErrorCode("server_error"), normalizedError.GetErrorCode())
require.Equal(t, "server_error", normalizedError.ToOpenAIError().Code)
require.Equal(t, "Selected model is at capacity.", normalizedError.Error())
}

func TestRelayErrorHandlerKeepsInvalidJSONBodyInDebugLog(t *testing.T) {
withDebugEnabled(t, true)

Expand Down