package advancedcustom import ( "bytes" "fmt" "io" "net/http" "net/http/httptest" "net/url" "strings" "testing" "github.com/QuantumNous/new-api/common" "github.com/QuantumNous/new-api/constant" relaycommon "github.com/QuantumNous/new-api/relay/common" relayconstant "github.com/QuantumNous/new-api/relay/constant" "github.com/QuantumNous/new-api/relaykit/dto" "github.com/QuantumNous/new-api/relaykit/relayconvert" "github.com/QuantumNous/new-api/relaykit/types" "github.com/QuantumNous/new-api/setting/model_setting" "github.com/gin-gonic/gin" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" "github.com/tidwall/gjson" ) func TestAdaptorUsesExactRouteAndQueryAuth(t *testing.T) { adaptor := &Adaptor{} info := advancedCustomRelayInfo(&dto.AdvancedCustomConfig{ Routes: []dto.AdvancedCustomRoute{ { IncomingPath: "/v1/messages", UpstreamPath: "https://upstream.example/v1/chat/completions?existing=1", Converter: relayconvert.ConverterClaudeMessagesToOpenAIChat, Auth: &dto.AdvancedCustomRouteAuth{ Type: dto.AdvancedCustomAuthTypeQuery, Name: "api_key", Value: "{api_key}", }, }, }, }) info.RequestURLPath = "/v1/messages?client=1" requestURL, err := adaptor.GetRequestURL(info) require.NoError(t, err) parsedURL, err := url.Parse(requestURL) require.NoError(t, err) assert.Equal(t, "https", parsedURL.Scheme) assert.Equal(t, "upstream.example", parsedURL.Host) assert.Equal(t, "/v1/chat/completions", parsedURL.Path) assert.Equal(t, "1", parsedURL.Query().Get("existing")) assert.Equal(t, "sk-test", parsedURL.Query().Get("api_key")) } // An absolute route sends the request to a host other than the channel base // URL, and a channel proxy is dialed before the upstream; a failed handshake // must hide both. func TestAdaptorMasksDialedHostsInDialFailure(t *testing.T) { upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) { w.WriteHeader(http.StatusForbidden) })) defer upstream.Close() upstreamURL, err := url.Parse(upstream.URL) require.NoError(t, err) for _, tc := range []struct { name string proxy string hidden string }{ {name: "absolute route host", hidden: "localhost"}, {name: "channel proxy host", proxy: "http://egress.private.invalid:8080", hidden: "egress.private.invalid"}, } { t.Run(tc.name, func(t *testing.T) { info := advancedCustomRelayInfo(&dto.AdvancedCustomConfig{ Routes: []dto.AdvancedCustomRoute{{IncomingPath: "/v1/realtime", UpstreamPath: "http://localhost:" + upstreamURL.Port() + "/v1/realtime", Converter: relayconvert.ConverterNone}}, }) info.RelayMode = relayconstant.RelayModeRealtime info.RequestURLPath = "/v1/realtime" info.ChannelSetting.Proxy = tc.proxy c := advancedCustomGinContext("/v1/realtime") common.SetContextKey(c, constant.ContextKeyChannelBaseUrl, info.ChannelBaseUrl) common.SetContextKey(c, constant.ContextKeyChannelSetting, info.ChannelSetting) _, err := (&Adaptor{}).DoRequest(c, info, nil) var apiErr *types.NewAPIError require.ErrorAs(t, err, &apiErr) require.Contains(t, apiErr.Error(), tc.hidden) message := apiErr.ToOpenAIError(common.UpstreamAddresses(c)...).Message assert.Contains(t, message, "dial failed to ws://***:"+upstreamURL.Port()+"/***/***") assert.NotContains(t, message, tc.hidden) }) } } func TestAdaptorJoinsUpstreamPathWithChannelBaseURL(t *testing.T) { adaptor := &Adaptor{} info := advancedCustomRelayInfo(&dto.AdvancedCustomConfig{ Routes: []dto.AdvancedCustomRoute{ { IncomingPath: "/v1/chat/completions", UpstreamPath: "/proxy/v1/chat/completions?existing=1", Converter: relayconvert.ConverterNone, Auth: &dto.AdvancedCustomRouteAuth{ Type: dto.AdvancedCustomAuthTypeQuery, Name: "api_key", Value: "{api_key}", }, }, }, }) info.ChannelBaseUrl = "https://gateway.example/base" requestURL, err := adaptor.GetRequestURL(info) require.NoError(t, err) parsedURL, err := url.Parse(requestURL) require.NoError(t, err) assert.Equal(t, "https", parsedURL.Scheme) assert.Equal(t, "gateway.example", parsedURL.Host) assert.Equal(t, "/base/proxy/v1/chat/completions", parsedURL.Path) assert.Equal(t, "1", parsedURL.Query().Get("existing")) assert.Equal(t, "sk-test", parsedURL.Query().Get("api_key")) } func TestAdaptorReturnsErrorWhenUpstreamPathNeedsMissingBaseURL(t *testing.T) { adaptor := &Adaptor{} info := advancedCustomRelayInfo(&dto.AdvancedCustomConfig{ Routes: []dto.AdvancedCustomRoute{ { IncomingPath: "/v1/chat/completions", UpstreamPath: "/v1/chat/completions", Converter: relayconvert.ConverterNone, }, }, }) info.ChannelBaseUrl = "" _, err := adaptor.GetRequestURL(info) require.Error(t, err) assert.Contains(t, err.Error(), "base URL is required") } func TestAdaptorSetupRequestHeaderUsesDefaultBearerAuth(t *testing.T) { adaptor := &Adaptor{} info := advancedCustomRelayInfo(&dto.AdvancedCustomConfig{ Routes: []dto.AdvancedCustomRoute{ { IncomingPath: "/v1/chat/completions", UpstreamPath: "https://upstream.example/v1/chat/completions", Converter: relayconvert.ConverterNone, }, }, }) c := advancedCustomGinContext("/v1/chat/completions") header := http.Header{} require.NoError(t, adaptor.SetupRequestHeader(c, &header, info)) assert.Equal(t, "Bearer sk-test", header.Get("Authorization")) } func TestAdaptorSetupRequestHeaderUsesConfiguredHeaderAuth(t *testing.T) { adaptor := &Adaptor{} info := advancedCustomRelayInfo(&dto.AdvancedCustomConfig{ Routes: []dto.AdvancedCustomRoute{ { IncomingPath: "/v1/chat/completions", UpstreamPath: "https://upstream.example/v1/chat/completions", Converter: relayconvert.ConverterNone, Auth: &dto.AdvancedCustomRouteAuth{ Type: dto.AdvancedCustomAuthTypeHeader, Name: "x-api-key", Value: "{api_key}", }, }, }, }) c := advancedCustomGinContext("/v1/chat/completions") header := http.Header{} require.NoError(t, adaptor.SetupRequestHeader(c, &header, info)) assert.Empty(t, header.Get("Authorization")) assert.Equal(t, "sk-test", header.Get("x-api-key")) } func TestAdaptorSetupRequestHeaderAddsClaudeDefaultHeaders(t *testing.T) { adaptor := &Adaptor{} info := advancedCustomRelayInfo(&dto.AdvancedCustomConfig{ Routes: []dto.AdvancedCustomRoute{ { IncomingPath: "/v1/messages", UpstreamPath: "https://api.anthropic.com/v1/messages", Converter: relayconvert.ConverterNone, Auth: &dto.AdvancedCustomRouteAuth{ Type: dto.AdvancedCustomAuthTypeHeader, Name: "x-api-key", Value: "{api_key}", }, }, }, }) info.RelayFormat = types.RelayFormatClaude c := advancedCustomGinContext("/v1/messages") header := http.Header{} require.NoError(t, adaptor.SetupRequestHeader(c, &header, info)) assert.Equal(t, "sk-test", header.Get("x-api-key")) assert.Equal(t, "2023-06-01", header.Get("anthropic-version")) } func TestAdaptorReturnsErrorWhenNoRouteMatchesPath(t *testing.T) { adaptor := &Adaptor{} info := advancedCustomRelayInfo(&dto.AdvancedCustomConfig{ Routes: []dto.AdvancedCustomRoute{ { IncomingPath: "/v1/messages", UpstreamPath: "https://upstream.example/v1/chat/completions", Converter: relayconvert.ConverterClaudeMessagesToOpenAIChat, }, }, }) info.RequestURLPath = "/v1/chat/completions" _, err := adaptor.GetRequestURL(info) require.Error(t, err) assert.Contains(t, err.Error(), "does not support request path") } func TestAdaptorReplacesModelPlaceholderInRouteURL(t *testing.T) { adaptor := &Adaptor{} info := advancedCustomRelayInfo(&dto.AdvancedCustomConfig{ Routes: []dto.AdvancedCustomRoute{ { IncomingPath: "/v1/chat/completions", UpstreamPath: "https://generativelanguage.googleapis.com/v1beta/models/{model}:generateContent", Converter: relayconvert.ConverterOpenAIChatToGeminiContent, Auth: &dto.AdvancedCustomRouteAuth{ Type: dto.AdvancedCustomAuthTypeQuery, Name: "key", Value: "{api_key}", }, }, }, }) info.UpstreamModelName = "gemini-2.5-flash" requestURL, err := adaptor.GetRequestURL(info) require.NoError(t, err) parsedURL, err := url.Parse(requestURL) require.NoError(t, err) assert.Equal(t, "/v1beta/models/gemini-2.5-flash:generateContent", parsedURL.Path) assert.Equal(t, "sk-test", parsedURL.Query().Get("key")) assert.Empty(t, parsedURL.Query().Get("alt")) } func TestAdaptorSwitchesGeminiGenerateContentURLForStream(t *testing.T) { adaptor := &Adaptor{} info := advancedCustomRelayInfo(&dto.AdvancedCustomConfig{ Routes: []dto.AdvancedCustomRoute{ { IncomingPath: "/v1/chat/completions", UpstreamPath: "https://generativelanguage.googleapis.com/v1beta/models/{model}:generateContent?existing=1", Converter: relayconvert.ConverterOpenAIChatToGeminiContent, Auth: &dto.AdvancedCustomRouteAuth{ Type: dto.AdvancedCustomAuthTypeQuery, Name: "key", Value: "{api_key}", }, }, }, }) info.UpstreamModelName = "gemini-2.5-pro" info.IsStream = true requestURL, err := adaptor.GetRequestURL(info) require.NoError(t, err) parsedURL, err := url.Parse(requestURL) require.NoError(t, err) assert.Equal(t, "/v1beta/models/gemini-2.5-pro:streamGenerateContent", parsedURL.Path) assert.Equal(t, "sse", parsedURL.Query().Get("alt")) assert.Equal(t, "1", parsedURL.Query().Get("existing")) assert.Equal(t, "sk-test", parsedURL.Query().Get("key")) } func TestAdaptorMatchesGeminiIncomingPathTemplate(t *testing.T) { tests := []struct { name string requestURLPath string wantRequestPath string }{ { name: "generate content", requestURLPath: "/v1beta/models/gemini-2.5-flash:generateContent", wantRequestPath: "/v1/chat/completions", }, { name: "stream generate content", requestURLPath: "/v1beta/models/gemini-2.5-flash:streamGenerateContent?alt=sse", wantRequestPath: "/v1/chat/completions", }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { adaptor := &Adaptor{} info := advancedCustomRelayInfo(&dto.AdvancedCustomConfig{ Routes: []dto.AdvancedCustomRoute{ { IncomingPath: "/v1beta/models/{model}:generateContent", UpstreamPath: "https://upstream.example/v1/chat/completions", Converter: relayconvert.ConverterGeminiContentToOpenAIChat, }, }, }) info.RequestURLPath = tt.requestURLPath requestURL, err := adaptor.GetRequestURL(info) require.NoError(t, err) parsedURL, err := url.Parse(requestURL) require.NoError(t, err) assert.Equal(t, tt.wantRequestPath, parsedURL.Path) }) } } func TestAdaptorBuildModelListRequestUsesConfiguredRouteAuth(t *testing.T) { adaptor := &Adaptor{} info := advancedCustomRelayInfo(&dto.AdvancedCustomConfig{ Routes: []dto.AdvancedCustomRoute{ { IncomingPath: "/v1/models", UpstreamPath: "/provider/models", Converter: relayconvert.ConverterNone, Auth: &dto.AdvancedCustomRouteAuth{ Type: dto.AdvancedCustomAuthTypeHeader, Name: "x-api-key", Value: "token {api_key}", }, }, }, }) info.RequestURLPath = "/v1/models" requestURL, header, err := adaptor.BuildModelListRequest(info) require.NoError(t, err) parsedURL, err := url.Parse(requestURL) require.NoError(t, err) assert.Equal(t, "fallback.example", parsedURL.Host) assert.Equal(t, "/provider/models", parsedURL.Path) assert.Equal(t, "token sk-test", header.Get("x-api-key")) assert.Empty(t, header.Get("Authorization")) } func TestAdaptorBuildModelListRequestUsesConfiguredQueryAuth(t *testing.T) { adaptor := &Adaptor{} info := advancedCustomRelayInfo(&dto.AdvancedCustomConfig{ Routes: []dto.AdvancedCustomRoute{ { IncomingPath: "/v1/models", UpstreamPath: "https://upstream.example/v1/models?existing=1", Converter: relayconvert.ConverterNone, Auth: &dto.AdvancedCustomRouteAuth{ Type: dto.AdvancedCustomAuthTypeQuery, Name: "key", Value: "{api_key}", }, }, }, }) info.RequestURLPath = "/v1/models" requestURL, header, err := adaptor.BuildModelListRequest(info) require.NoError(t, err) parsedURL, err := url.Parse(requestURL) require.NoError(t, err) assert.Equal(t, "upstream.example", parsedURL.Host) assert.Equal(t, "/v1/models", parsedURL.Path) assert.Equal(t, "1", parsedURL.Query().Get("existing")) assert.Equal(t, "sk-test", parsedURL.Query().Get("key")) assert.Empty(t, header.Get("Authorization")) } func TestAdaptorBuildModelListRequestDefaultAndNoAuth(t *testing.T) { tests := []struct { name string auth *dto.AdvancedCustomRouteAuth wantAuthorization string }{ { name: "default bearer", wantAuthorization: "Bearer sk-test", }, { name: "no authentication", auth: &dto.AdvancedCustomRouteAuth{ Type: dto.AdvancedCustomAuthTypeNone, }, }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { info := advancedCustomRelayInfo(&dto.AdvancedCustomConfig{ Routes: []dto.AdvancedCustomRoute{ { IncomingPath: dto.AdvancedCustomModelListPath, UpstreamPath: "/provider/models", Auth: tt.auth, }, }, }) info.RequestURLPath = "/unrelated/path" requestURL, header, err := (&Adaptor{}).BuildModelListRequest(info) require.NoError(t, err) assert.Equal(t, "https://fallback.example/provider/models", requestURL) assert.Equal(t, tt.wantAuthorization, header.Get("Authorization")) }) } } func TestAdaptorBuildModelListRequestDoesNotReuseRelayRoute(t *testing.T) { adaptor := &Adaptor{} info := advancedCustomRelayInfo(&dto.AdvancedCustomConfig{ Routes: []dto.AdvancedCustomRoute{ { IncomingPath: "/v1/chat/completions", UpstreamPath: "/chat", }, { IncomingPath: dto.AdvancedCustomModelListPath, UpstreamPath: "/provider/models", }, }, }) chatURL, err := adaptor.GetRequestURL(info) require.NoError(t, err) assert.Equal(t, "https://fallback.example/chat", chatURL) modelURL, header, err := adaptor.BuildModelListRequest(info) require.NoError(t, err) assert.Equal(t, "https://fallback.example/provider/models", modelURL) assert.Equal(t, "Bearer sk-test", header.Get("Authorization")) } func TestAdaptorBuildModelListRequestRequiresConfiguredRoute(t *testing.T) { info := advancedCustomRelayInfo(&dto.AdvancedCustomConfig{ Routes: []dto.AdvancedCustomRoute{ { IncomingPath: "/v1/chat/completions", UpstreamPath: "/v1/chat/completions", }, }, }) _, _, err := (&Adaptor{}).BuildModelListRequest(info) require.Error(t, err) assert.Contains(t, err.Error(), "does not configure a /v1/models route") } func TestAdaptorBuildBalanceRequestUsesConfiguredRoute(t *testing.T) { info := advancedCustomRelayInfo(&dto.AdvancedCustomConfig{ Routes: []dto.AdvancedCustomRoute{ { IncomingPath: dto.AdvancedCustomModelListPath, UpstreamPath: "/provider/models", }, { IncomingPath: dto.AdvancedCustomBalancePath, UpstreamPath: "/provider/balance?existing=1", Auth: &dto.AdvancedCustomRouteAuth{ Type: dto.AdvancedCustomAuthTypeQuery, Name: "token", Value: "prefix-{api_key}", }, }, }, }) requestURL, header, err := (&Adaptor{}).BuildBalanceRequest(info) require.NoError(t, err) parsedURL, err := url.Parse(requestURL) require.NoError(t, err) assert.Equal(t, "/provider/balance", parsedURL.Path) assert.Equal(t, "1", parsedURL.Query().Get("existing")) assert.Equal(t, "prefix-sk-test", parsedURL.Query().Get("token")) assert.Empty(t, header.Get("Authorization")) } func TestAdaptorBuildBalanceRequestRequiresConfiguredRoute(t *testing.T) { info := advancedCustomRelayInfo(&dto.AdvancedCustomConfig{ Routes: []dto.AdvancedCustomRoute{{ IncomingPath: dto.AdvancedCustomModelListPath, UpstreamPath: "/provider/models", }}, }) _, _, err := (&Adaptor{}).BuildBalanceRequest(info) require.Error(t, err) assert.Contains(t, err.Error(), "does not configure a /v1/dashboard/billing/credit_grants route") } func TestAdaptorConvertsResponsesRequestToOpenAIChatUpstream(t *testing.T) { adaptor := &Adaptor{} info := advancedCustomRelayInfo(&dto.AdvancedCustomConfig{ Routes: []dto.AdvancedCustomRoute{ { IncomingPath: "/v1/responses", UpstreamPath: "/v1/chat/completions", Converter: relayconvert.ConverterOpenAIResponsesToOpenAIChat, }, }, }) info.RelayMode = relayconstant.RelayModeResponses info.RequestURLPath = "/v1/responses" gin.SetMode(gin.TestMode) recorder := httptest.NewRecorder() c, _ := gin.CreateTestContext(recorder) c.Request = httptest.NewRequest(http.MethodPost, "/v1/responses", nil) c.Request.Header.Set("Content-Type", "application/json") converted, err := adaptor.ConvertOpenAIResponsesRequest(c, info, dto.OpenAIResponsesRequest{ Model: "gpt-test", Instructions: mustAdvancedCustomRawMessage(t, "system rules"), Input: mustAdvancedCustomRawMessage(t, "hello"), }) require.NoError(t, err) chatReq, ok := converted.(*dto.GeneralOpenAIRequest) require.True(t, ok) assert.Equal(t, "gpt-test", chatReq.Model) require.Len(t, chatReq.Messages, 2) assert.Equal(t, "system", chatReq.Messages[0].Role) assert.Equal(t, "system rules", chatReq.Messages[0].StringContent()) assert.Equal(t, "user", chatReq.Messages[1].Role) assert.Equal(t, "hello", chatReq.Messages[1].StringContent()) requestURL, err := adaptor.GetRequestURL(info) require.NoError(t, err) parsedURL, err := url.Parse(requestURL) require.NoError(t, err) assert.Equal(t, "/v1/chat/completions", parsedURL.Path) } func TestAdaptorSelectsDuplicateResponsesRoutesByModel(t *testing.T) { config := &dto.AdvancedCustomConfig{ Routes: []dto.AdvancedCustomRoute{ { IncomingPath: "/v1/responses", UpstreamPath: "/v1/chat/completions", Converter: relayconvert.ConverterOpenAIResponsesToOpenAIChat, Models: []string{"gpt-test"}, }, { IncomingPath: "/v1/responses", UpstreamPath: "/v1beta/models/{model}:generateContent", Converter: relayconvert.ConverterOpenAIResponsesToGemini, Models: []string{"gemini-test"}, }, }, } chatAdaptor := &Adaptor{} chatInfo := advancedCustomRelayInfo(config) chatInfo.RelayFormat = types.RelayFormatOpenAIResponses chatInfo.RelayMode = relayconstant.RelayModeResponses chatInfo.RequestURLPath = "/v1/responses" chatInfo.OriginModelName = "gpt-test" chatInfo.UpstreamModelName = "gpt-test" chatConverted, err := chatAdaptor.ConvertOpenAIResponsesRequest(advancedCustomGinContext("/v1/responses"), chatInfo, dto.OpenAIResponsesRequest{ Model: "gpt-test", Input: mustAdvancedCustomRawMessage(t, "hello"), }) require.NoError(t, err) _, ok := chatConverted.(*dto.GeneralOpenAIRequest) require.True(t, ok) geminiAdaptor := &Adaptor{} geminiInfo := advancedCustomRelayInfo(config) geminiInfo.RelayFormat = types.RelayFormatOpenAIResponses geminiInfo.RelayMode = relayconstant.RelayModeResponses geminiInfo.RequestURLPath = "/v1/responses" geminiInfo.OriginModelName = "gemini-test" geminiInfo.UpstreamModelName = "gemini-test" geminiInfo.IsStream = true geminiConverted, err := geminiAdaptor.ConvertOpenAIResponsesRequest(advancedCustomGinContext("/v1/responses"), geminiInfo, dto.OpenAIResponsesRequest{ Model: "gemini-test", Input: mustAdvancedCustomRawMessage(t, "hello"), }) require.NoError(t, err) _, ok = geminiConverted.(*dto.GeminiChatRequest) require.True(t, ok) requestURL, err := geminiAdaptor.GetRequestURL(geminiInfo) require.NoError(t, err) parsedURL, err := url.Parse(requestURL) require.NoError(t, err) assert.Equal(t, "/v1beta/models/gemini-test:streamGenerateContent", parsedURL.Path) assert.Equal(t, "sse", parsedURL.Query().Get("alt")) } func TestAdaptorResponsesToGeminiUsesResponsesBridge(t *testing.T) { adaptor := &Adaptor{} info := advancedCustomRelayInfo(&dto.AdvancedCustomConfig{ Routes: []dto.AdvancedCustomRoute{ { IncomingPath: "/v1/responses", UpstreamPath: "/v1beta/models/{model}:generateContent", Converter: relayconvert.ConverterOpenAIResponsesToGemini, Models: []string{"gemini-test"}, }, }, }) info.RelayFormat = types.RelayFormatOpenAIResponses info.RelayMode = relayconstant.RelayModeResponses info.RequestURLPath = "/v1/responses" info.OriginModelName = "gemini-test" info.UpstreamModelName = "gemini-test" gin.SetMode(gin.TestMode) recorder := httptest.NewRecorder() c, _ := gin.CreateTestContext(recorder) c.Request = httptest.NewRequest(http.MethodPost, "/v1/responses", nil) c.Request.Header.Set("Content-Type", "application/json") payload := dto.GeminiChatResponse{ Candidates: []dto.GeminiChatCandidate{ { Content: dto.GeminiChatContent{ Role: "model", Parts: []dto.GeminiPart{ {Text: "hello"}, }, }, }, }, UsageMetadata: dto.GeminiUsageMetadata{ PromptTokenCount: 2, CandidatesTokenCount: 3, TotalTokenCount: 5, }, } body, err := common.Marshal(payload) require.NoError(t, err) usage, newAPIError := adaptor.DoResponse(c, &http.Response{ Body: io.NopCloser(bytes.NewReader(body)), }, info) require.Nil(t, newAPIError) require.NotNil(t, usage) got := recorder.Body.String() assert.Contains(t, got, `"object":"response"`) assert.Contains(t, got, `"type":"output_text"`) assert.Contains(t, got, `"text":"hello"`) assert.NotContains(t, got, `"candidates"`) } func TestAdaptorResponsesToGeminiAddsThoughtSignatureForFunctionCallHistory(t *testing.T) { geminiSettings := model_setting.GetGeminiSettings() originalThoughtSignatureEnabled := geminiSettings.FunctionCallThoughtSignatureEnabled geminiSettings.FunctionCallThoughtSignatureEnabled = true t.Cleanup(func() { geminiSettings.FunctionCallThoughtSignatureEnabled = originalThoughtSignatureEnabled }) adaptor := &Adaptor{} info := advancedCustomRelayInfo(&dto.AdvancedCustomConfig{ Routes: []dto.AdvancedCustomRoute{ { IncomingPath: "/v1/responses", UpstreamPath: "/v1beta/models/{model}:generateContent", Converter: relayconvert.ConverterOpenAIResponsesToGemini, Models: []string{"gemini-test"}, }, }, }) info.RelayFormat = types.RelayFormatOpenAIResponses info.RelayMode = relayconstant.RelayModeResponses info.RequestURLPath = "/v1/responses" info.OriginModelName = "gemini-test" info.UpstreamModelName = "gemini-test" converted, err := adaptor.ConvertOpenAIResponsesRequest(advancedCustomGinContext("/v1/responses"), info, dto.OpenAIResponsesRequest{ Model: "gemini-test", Input: mustAdvancedCustomRawMessage(t, []map[string]any{ { "role": "user", "content": "hi", }, { "type": "function_call", "call_id": "call_1", "name": "glob", "arguments": map[string]any{"query": "*"}, }, { "type": "function_call_output", "call_id": "call_1", "output": []map[string]any{{"path": "report.md"}}, }, }), Tools: mustAdvancedCustomRawMessage(t, []map[string]any{ {"type": "function", "name": "glob", "parameters": map[string]any{"type": "object"}}, }), }) require.NoError(t, err) geminiReq, ok := converted.(*dto.GeminiChatRequest) require.True(t, ok) require.Len(t, geminiReq.Contents, 3) require.Len(t, geminiReq.Contents[1].Parts, 1) require.NotNil(t, geminiReq.Contents[1].Parts[0].FunctionCall) assert.NotEmpty(t, geminiReq.Contents[1].Parts[0].ThoughtSignature) require.Len(t, geminiReq.Contents[2].Parts, 1) require.NotNil(t, geminiReq.Contents[2].Parts[0].FunctionResponse) assert.Empty(t, geminiReq.Contents[2].Parts[0].ThoughtSignature) } func TestAdaptorConvertsOpenAIChatRequestToResponsesUpstream(t *testing.T) { adaptor := &Adaptor{} info := advancedCustomRelayInfo(&dto.AdvancedCustomConfig{ Routes: []dto.AdvancedCustomRoute{ { IncomingPath: "/v1/chat/completions", UpstreamPath: "/v1/responses", Converter: relayconvert.ConverterOpenAIChatToOpenAIResponses, }, }, }) c := advancedCustomGinContext("/v1/chat/completions") converted, err := adaptor.ConvertOpenAIRequest(c, info, &dto.GeneralOpenAIRequest{ Model: "gpt-test", Messages: []dto.Message{ {Role: "user", Content: "hello"}, }, }) require.NoError(t, err) responsesReq, ok := converted.(*dto.OpenAIResponsesRequest) require.True(t, ok) assert.Equal(t, "gpt-test", responsesReq.Model) assert.NotEmpty(t, responsesReq.Input) } func TestAdaptorConvertsOpenAIChatRequestToClaudeUpstream(t *testing.T) { adaptor := &Adaptor{} info := advancedCustomRelayInfo(&dto.AdvancedCustomConfig{ Routes: []dto.AdvancedCustomRoute{ { IncomingPath: "/v1/chat/completions", UpstreamPath: "/v1/messages", Converter: relayconvert.ConverterOpenAIChatToClaudeMessages, }, }, }) c := advancedCustomGinContext("/v1/chat/completions") converted, err := adaptor.ConvertOpenAIRequest(c, info, &dto.GeneralOpenAIRequest{ Model: "claude-test", Messages: []dto.Message{ {Role: "user", Content: "hello"}, }, }) require.NoError(t, err) claudeReq, ok := converted.(*dto.ClaudeRequest) require.True(t, ok) assert.Equal(t, "claude-test", claudeReq.Model) require.Len(t, claudeReq.Messages, 1) assert.Equal(t, "user", claudeReq.Messages[0].Role) } func TestAdaptorConvertsOpenAIChatRequestToGeminiUpstream(t *testing.T) { adaptor := &Adaptor{} info := advancedCustomRelayInfo(&dto.AdvancedCustomConfig{ Routes: []dto.AdvancedCustomRoute{ { IncomingPath: "/v1/chat/completions", UpstreamPath: "/v1beta/models/{model}:generateContent", Converter: relayconvert.ConverterOpenAIChatToGeminiContent, }, }, }) info.UpstreamModelName = "gemini-2.5-flash" c := advancedCustomGinContext("/v1/chat/completions") converted, err := adaptor.ConvertOpenAIRequest(c, info, &dto.GeneralOpenAIRequest{ Model: "gemini-2.5-flash", Messages: []dto.Message{ {Role: "user", Content: "hello"}, }, }) require.NoError(t, err) geminiReq, ok := converted.(*dto.GeminiChatRequest) require.True(t, ok) require.Len(t, geminiReq.Contents, 1) assert.Equal(t, "user", geminiReq.Contents[0].Role) } func TestAdaptorConvertsClaudeRequestToOpenAIChatUpstream(t *testing.T) { adaptor := &Adaptor{} info := advancedCustomRelayInfo(&dto.AdvancedCustomConfig{ Routes: []dto.AdvancedCustomRoute{ { IncomingPath: "/v1/messages", UpstreamPath: "/v1/chat/completions", Converter: relayconvert.ConverterClaudeMessagesToOpenAIChat, }, }, }) info.RelayFormat = types.RelayFormatClaude info.RequestURLPath = "/v1/messages" c := advancedCustomGinContext("/v1/messages") converted, err := adaptor.ConvertClaudeRequest(c, info, &dto.ClaudeRequest{ Model: "gpt-test", Messages: []dto.ClaudeMessage{ {Role: "user", Content: "hello"}, }, }) require.NoError(t, err) chatReq, ok := converted.(*dto.GeneralOpenAIRequest) require.True(t, ok) assert.Equal(t, "gpt-test", chatReq.Model) require.Len(t, chatReq.Messages, 1) assert.Equal(t, "user", chatReq.Messages[0].Role) } func TestAdaptorConvertsGeminiRequestToOpenAIChatUpstream(t *testing.T) { adaptor := &Adaptor{} info := advancedCustomRelayInfo(&dto.AdvancedCustomConfig{ Routes: []dto.AdvancedCustomRoute{ { IncomingPath: "/v1beta/models/{model}:generateContent", UpstreamPath: "/v1/chat/completions", Converter: relayconvert.ConverterGeminiContentToOpenAIChat, }, }, }) info.RelayFormat = types.RelayFormatGemini info.RequestURLPath = "/v1beta/models/gemini-2.5-flash:generateContent" info.UpstreamModelName = "gpt-test" c := advancedCustomGinContext("/v1beta/models/gemini-2.5-flash:generateContent") converted, err := adaptor.ConvertGeminiRequest(c, info, &dto.GeminiChatRequest{ Contents: []dto.GeminiChatContent{ { Role: "user", Parts: []dto.GeminiPart{ {Text: "hello"}, }, }, }, }) require.NoError(t, err) chatReq, ok := converted.(*dto.GeneralOpenAIRequest) require.True(t, ok) assert.Equal(t, "gpt-test", chatReq.Model) require.Len(t, chatReq.Messages, 1) assert.Equal(t, "user", chatReq.Messages[0].Role) } func TestAdaptorCrossProtocolChatUpstreamRequestsStreamUsage(t *testing.T) { claudeReq := &dto.ClaudeRequest{ Model: "gpt-test", Messages: []dto.ClaudeMessage{{Role: "user", Content: "hello"}}, } geminiReq := &dto.GeminiChatRequest{ Contents: []dto.GeminiChatContent{{Role: "user", Parts: []dto.GeminiPart{{Text: "hello"}}}}, } responsesReq := dto.OpenAIResponsesRequest{ Model: "gpt-test", Input: mustAdvancedCustomRawMessage(t, "hello"), } tests := []struct { name string route dto.AdvancedCustomRoute relayFormat types.RelayFormat relayMode int requestPath string convert func(*Adaptor, *gin.Context, *relaycommon.RelayInfo) (any, error) isStream bool supportUsage bool wantUsage bool }{ { name: "claude stream requests usage", route: dto.AdvancedCustomRoute{ IncomingPath: "/v1/messages", UpstreamPath: "/v1/chat/completions", Converter: relayconvert.ConverterClaudeMessagesToOpenAIChat, }, relayFormat: types.RelayFormatClaude, relayMode: relayconstant.RelayModeChatCompletions, requestPath: "/v1/messages", convert: func(a *Adaptor, c *gin.Context, info *relaycommon.RelayInfo) (any, error) { return a.ConvertClaudeRequest(c, info, claudeReq) }, isStream: true, supportUsage: true, wantUsage: true, }, { name: "gemini stream requests usage", route: dto.AdvancedCustomRoute{ IncomingPath: "/v1beta/models/{model}:generateContent", UpstreamPath: "/v1/chat/completions", Converter: relayconvert.ConverterGeminiContentToOpenAIChat, }, relayFormat: types.RelayFormatGemini, relayMode: relayconstant.RelayModeGemini, requestPath: "/v1beta/models/gpt-test:generateContent", convert: func(a *Adaptor, c *gin.Context, info *relaycommon.RelayInfo) (any, error) { return a.ConvertGeminiRequest(c, info, geminiReq) }, isStream: true, supportUsage: true, wantUsage: true, }, { name: "responses stream requests usage", route: dto.AdvancedCustomRoute{ IncomingPath: "/v1/responses", UpstreamPath: "/v1/chat/completions", Converter: relayconvert.ConverterOpenAIResponsesToOpenAIChat, }, relayFormat: types.RelayFormatOpenAIResponses, relayMode: relayconstant.RelayModeResponses, requestPath: "/v1/responses", convert: func(a *Adaptor, c *gin.Context, info *relaycommon.RelayInfo) (any, error) { return a.ConvertOpenAIResponsesRequest(c, info, responsesReq) }, isStream: true, supportUsage: true, wantUsage: true, }, { name: "claude non-stream leaves stream options unset", route: dto.AdvancedCustomRoute{ IncomingPath: "/v1/messages", UpstreamPath: "/v1/chat/completions", Converter: relayconvert.ConverterClaudeMessagesToOpenAIChat, }, relayFormat: types.RelayFormatClaude, relayMode: relayconstant.RelayModeChatCompletions, requestPath: "/v1/messages", convert: func(a *Adaptor, c *gin.Context, info *relaycommon.RelayInfo) (any, error) { return a.ConvertClaudeRequest(c, info, claudeReq) }, isStream: false, supportUsage: true, wantUsage: false, }, { name: "claude stream without stream options support", route: dto.AdvancedCustomRoute{ IncomingPath: "/v1/messages", UpstreamPath: "/v1/chat/completions", Converter: relayconvert.ConverterClaudeMessagesToOpenAIChat, }, relayFormat: types.RelayFormatClaude, relayMode: relayconstant.RelayModeChatCompletions, requestPath: "/v1/messages", convert: func(a *Adaptor, c *gin.Context, info *relaycommon.RelayInfo) (any, error) { return a.ConvertClaudeRequest(c, info, claudeReq) }, isStream: true, supportUsage: false, wantUsage: false, }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { adaptor := &Adaptor{} info := advancedCustomRelayInfo(&dto.AdvancedCustomConfig{Routes: []dto.AdvancedCustomRoute{tt.route}}) info.RelayFormat = tt.relayFormat info.RelayMode = tt.relayMode info.RequestURLPath = tt.requestPath info.IsStream = tt.isStream info.SupportStreamOptions = tt.supportUsage c := advancedCustomGinContext(tt.requestPath) converted, err := tt.convert(adaptor, c, info) require.NoError(t, err) chatReq, ok := converted.(*dto.GeneralOpenAIRequest) require.True(t, ok) if !tt.wantUsage { assert.Nil(t, chatReq.StreamOptions) return } require.NotNil(t, chatReq.StreamOptions) assert.True(t, chatReq.StreamOptions.IncludeUsage) }) } } // Claude Messages and Gemini Generate Content clients on an OpenAI Responses // upstream: the request carries the hosted web search as a Responses tool and // the Responses answer, JSON or stream, is converted back to the client format. func TestAdaptorConvertsClaudeAndGeminiRequestsToResponsesUpstream(t *testing.T) { oldTimeout := constant.StreamingTimeout constant.StreamingTimeout = 30 t.Cleanup(func() { constant.StreamingTimeout = oldTimeout }) const responsesJSON = `{"id":"resp_1","object":"response","model":"gpt-test","status":"completed","output":[{"type":"message","id":"msg_1","role":"assistant","status":"completed","content":[{"type":"output_text","text":"Go 1.25","annotations":[]}]}],"usage":{"input_tokens":12,"output_tokens":4,"total_tokens":16}}` responsesStream := "data: " + `{"type":"response.created","sequence_number":0,"response":{"id":"resp_1","object":"response","model":"gpt-test","status":"in_progress","output":[]}}` + "\n\n" + "data: " + `{"type":"response.output_item.added","sequence_number":1,"output_index":0,"item":{"type":"message","id":"msg_1","role":"assistant","status":"in_progress","content":[]}}` + "\n\n" + "data: " + `{"type":"response.output_text.delta","sequence_number":2,"output_index":0,"item_id":"msg_1","content_index":0,"delta":"Go 1.25"}` + "\n\n" + "data: " + `{"type":"response.completed","sequence_number":3,"response":` + responsesJSON + `}` + "\n\n" tests := []struct { name string route dto.AdvancedCustomRoute relayFormat types.RelayFormat requestPath string convert func(*Adaptor, *gin.Context, *relaycommon.RelayInfo) (any, error) wantResponse map[bool]string // stream -> marker in the client body }{ { name: "claude", route: dto.AdvancedCustomRoute{IncomingPath: "/v1/messages", UpstreamPath: "/v1/responses", Converter: relayconvert.ConverterClaudeMessagesToOpenAIResponses}, relayFormat: types.RelayFormatClaude, requestPath: "/v1/messages", convert: func(a *Adaptor, c *gin.Context, info *relaycommon.RelayInfo) (any, error) { return a.ConvertClaudeRequest(c, info, &dto.ClaudeRequest{ Model: "gpt-test", Messages: []dto.ClaudeMessage{{Role: "user", Content: "Latest Go?"}}, Tools: []any{map[string]any{"type": "web_search_20250305", "name": "web_search"}}, }) }, wantResponse: map[bool]string{false: `"type":"message"`, true: "event: message_stop"}, }, { name: "gemini", route: dto.AdvancedCustomRoute{IncomingPath: "/v1beta/models/{model}:generateContent", UpstreamPath: "/v1/responses", Converter: relayconvert.ConverterGeminiContentToOpenAIResponses}, relayFormat: types.RelayFormatGemini, requestPath: "/v1beta/models/gpt-test:generateContent", convert: func(a *Adaptor, c *gin.Context, info *relaycommon.RelayInfo) (any, error) { return a.ConvertGeminiRequest(c, info, &dto.GeminiChatRequest{ Contents: []dto.GeminiChatContent{{Role: "user", Parts: []dto.GeminiPart{{Text: "Latest Go?"}}}}, Tools: mustAdvancedCustomRawMessage(t, []map[string]any{{"googleSearch": map[string]any{}}}), }) }, wantResponse: map[bool]string{false: `"candidates"`, true: `"candidates"`}, }, } for _, tt := range tests { for _, stream := range []bool{false, true} { t.Run(fmt.Sprintf("%s stream=%v", tt.name, stream), func(t *testing.T) { adaptor := &Adaptor{} info := advancedCustomRelayInfo(&dto.AdvancedCustomConfig{Routes: []dto.AdvancedCustomRoute{tt.route}}) info.RelayFormat = tt.relayFormat info.RequestURLPath = tt.requestPath info.IsStream = stream info.DisablePing = true info.ClaudeConvertInfo = &relaycommon.ClaudeConvertInfo{LastMessagesType: relaycommon.LastMessageTypeNone} recorder := httptest.NewRecorder() c, _ := gin.CreateTestContext(recorder) c.Request = httptest.NewRequest(http.MethodPost, tt.requestPath, nil) converted, err := tt.convert(adaptor, c, info) require.NoError(t, err) wire, err := common.Marshal(converted) require.NoError(t, err) assert.JSONEq(t, `[{"type":"web_search"}]`, gjson.GetBytes(wire, "tools").Raw) url, err := adaptor.GetRequestURL(info) require.NoError(t, err) assert.Equal(t, "https://fallback.example/v1/responses", url) upstream, contentType := responsesJSON, "application/json" if stream { upstream, contentType = responsesStream, "text/event-stream" } usage, apiErr := adaptor.DoResponse(c, &http.Response{ StatusCode: http.StatusOK, Header: http.Header{"Content-Type": []string{contentType}}, Body: io.NopCloser(strings.NewReader(upstream)), }, info) require.Nil(t, apiErr) assert.Equal(t, 12, usage.(*dto.Usage).PromptTokens) assert.Contains(t, recorder.Body.String(), "Go 1.25") assert.Contains(t, recorder.Body.String(), tt.wantResponse[stream]) }) } } } func advancedCustomRelayInfo(config *dto.AdvancedCustomConfig) *relaycommon.RelayInfo { return &relaycommon.RelayInfo{ RelayFormat: types.RelayFormatOpenAI, RelayMode: relayconstant.RelayModeChatCompletions, RequestURLPath: "/v1/chat/completions", OriginModelName: "gpt-test", ChannelMeta: &relaycommon.ChannelMeta{ ApiKey: "sk-test", ChannelBaseUrl: "https://fallback.example", ChannelType: constant.ChannelTypeAdvancedCustom, UpstreamModelName: "gpt-test", ChannelOtherSettings: dto.ChannelOtherSettings{ AdvancedCustom: config, }, }, } } func advancedCustomGinContext(path string) *gin.Context { gin.SetMode(gin.TestMode) c, _ := gin.CreateTestContext(httptest.NewRecorder()) c.Request = httptest.NewRequest(http.MethodPost, path, nil) c.Request.Header.Set("Content-Type", "application/json") return c } func mustAdvancedCustomRawMessage(t *testing.T, value any) []byte { t.Helper() raw, err := common.Marshal(value) require.NoError(t, err) return raw }