Files
new-api/relaykit/relayconvert/text_converter_registry.go
T
Calcium-Ion 86ac0f7745 refactor: extract protocol conversion layer into standalone relaykit module (#6369)
* test(relayconvert): add golden snapshot matrix and relaykit boundary guard

Phase 0 of the relaykit extraction plan: pin byte-level output of every
registered (from,to) request/response/stream conversion route, and
forbid kit-bound packages from growing host-only imports.

* wip(relayconvert): drop gin.Context from converter signatures; add convmeta draft

Phase 1 in progress: relayconvert now takes context.Context; host media
resolver adapts gin.Context back at the service boundary.

* refactor(relayconvert): decouple converters from RelayInfo, gin, and settings

Phase 1 of the relaykit extraction plan:
- converters now depend on convmeta.Meta (implemented by RelayInfo) instead
  of *relaycommon.RelayInfo; ClaudeConvertInfo and the format guesser move
  to convmeta with aliases left behind
- host settings reach converters via a convmeta.Options snapshot built in
  RelayInfo.ConvOptions; no more model_setting/reasoning global reads inside
  the conversion layer
- effort-suffix helpers move to service/relayconvert/reasoning (old package
  forwards); chat-to-responses upgrade policy moves to service (host routing
  logic, not conversion)
- golden conversion matrix unchanged

* test(relayconvert): tighten boundary — kit packages now free of gin/setting imports

* refactor(dto): drop gin and logger dependencies

Phase 2 (part 1): dto.Request.IsStream now takes *http.Request instead of
*gin.Context (Gemini's impl reads query/path off the std request); dto's
three logger calls become common.SysError. Boundary test allowlist is now
empty — kit-bound packages import no gin/setting/logger/model.

* refactor(kit): extract dependency-free kitutil; dto/types/relayconvert stop importing common

Phase 2 of the relaykit extraction plan:
- new service/relayconvert/kitutil holds the pure helpers the kit needs
  (JSON wrappers, pointer/string/uuid/timestamp utils, MaskSensitiveInfo,
  pluggable LogInfo/LogError hooks, Debug flag)
- dto, types, and all relayconvert packages now use kitutil; their only
  remaining internal deps are dto/types/constant
- common keeps every original symbol (MaskSensitiveInfo delegates to
  kitutil) so host code is untouched; main.go routes kit logging into
  common.SysLog/SysError and mirrors DebugEnabled
- golden conversion matrix unchanged

* refactor(kit): move EndpointType/FinishReason to types; OpenRouter dialect via Options

Kit packages (dto/types/relayconvert/reasonmap) no longer import constant:
- EndpointType and finish-reason values live in types; constant re-exports
- the OpenRouter special-case in claude->openai request conversion reads
  Options.OpenRouterDialect, set by the host from the channel type;
  InitChannelMeta invalidates the cached snapshot on channel switch

* refactor: extract relaykit submodule (dto/types/relayconvert/reasonmap)

Phase 3 of the relaykit extraction plan:
- new go module github.com/QuantumNous/new-api/relaykit containing dto
  (minus task family), types, relayconvert (with convmeta/kitutil/reasoning),
  and reasonmap; host consumes it via require + replace, go.work for dev
- task-family dto (task/suno/midjourney/video) stays in the host dto
  package; dual-consumer host files alias it as taskdto
- relaykit builds and tests standalone (GOWORK=off): no host imports,
  no gin, no DB, no settings
- golden conversion matrix unchanged

* build(docker): copy relaykit/go.mod before go mod download

The local-replace submodule's go.mod must exist inside the build context
for the main module graph to resolve.

* fix: address relaykit extraction regressions

* fix: address relaykit review regressions

* docs: document Meta nil receiver contract

* fix(relaykit): fail OpenAI→Claude conversion without max_tokens; reject negative default_max_tokens

The Claude Messages API requires max_tokens (omitting it is a 400
"Field required"), but with a nil Options.Claude.DefaultMaxTokens hook
the converters silently emitted a request the upstream is guaranteed to
reject. Both OpenAI Chat and Responses → Claude conversions now return
sharedclaude.ErrMissingMaxTokens when no path (client value, default
hook, thinking-adapter floor) supplied one. Unreachable in the host,
which always configures the hook.

Host side, claude.default_max_tokens now rejects negative values at the
option API before persisting — they would wrap into huge unsigned values
during conversion. Zero stays allowed: the current API treats
max_tokens: 0 as cache pre-warming.

* fix: make Gemini safety settings read path race-free
2026-07-27 15:56:21 +08:00

373 lines
11 KiB
Go

package relayconvert
import (
"fmt"
"strings"
"sync"
"github.com/QuantumNous/new-api/relaykit/types"
)
type TextConverterQuality string
const (
TextConverterQualityGood TextConverterQuality = "good"
TextConverterQualityFair TextConverterQuality = "fair"
TextConverterQualityDiscouraged TextConverterQuality = "discouraged"
)
type TextRequestSide struct {
Convert RequestConverterFunc
StepConverters []string
}
type TextResponseSide struct {
Convert ResponseConverterFunc
ConvertStream ResponseStreamConverterFunc
NewStreamState ResponseStreamStateFactory
ConvertStreamChunk ResponseStreamChunkConverterFunc
FinalizeStream ResponseStreamFinalizerFunc
StepConverters []string
Aliases []string
}
type TextConverterSpec struct {
ID string
From types.RelayFormat
To types.RelayFormat
Quality TextConverterQuality
Req TextRequestSide
Resp TextResponseSide
}
var (
textConverterMu sync.RWMutex
textConverters = make(map[string]TextConverterSpec)
textConverterAliases = make(map[string]string)
)
var builtinTextConverters = []TextConverterSpec{
{
ID: ConverterClaudeMessagesToOpenAIChat,
From: types.RelayFormatClaude,
To: types.RelayFormatOpenAI,
Quality: TextConverterQualityFair,
Req: TextRequestSide{
Convert: convertClaudeRequestToOpenAI,
},
Resp: TextResponseSide{
Convert: convertClaudeMessagesResponseToOAIChat,
ConvertStream: convertClaudeMessagesStreamResponseToOAIChat,
Aliases: []string{ResponseConverterClaudeMessagesToOAIChat},
},
},
{
ID: ConverterOpenAIChatToClaudeMessages,
From: types.RelayFormatOpenAI,
To: types.RelayFormatClaude,
Quality: TextConverterQualityFair,
Req: TextRequestSide{
Convert: convertOpenAIRequestToClaude,
},
Resp: TextResponseSide{
Convert: convertOAIChatResponseToClaudeMessages,
ConvertStream: convertOAIChatStreamResponseToClaudeMessages,
Aliases: []string{ResponseConverterOAIChatToClaudeMessages},
},
},
{
ID: ConverterGeminiContentToOpenAIChat,
From: types.RelayFormatGemini,
To: types.RelayFormatOpenAI,
Quality: TextConverterQualityFair,
Req: TextRequestSide{
Convert: convertGeminiRequestToOpenAI,
},
Resp: TextResponseSide{
Convert: convertGeminiChatResponseToOAIChat,
ConvertStream: convertGeminiChatStreamResponseToOAIChat,
Aliases: []string{ResponseConverterGeminiChatToOAIChat},
},
},
{
ID: ConverterOpenAIChatToGeminiContent,
From: types.RelayFormatOpenAI,
To: types.RelayFormatGemini,
Quality: TextConverterQualityFair,
Req: TextRequestSide{
Convert: convertOpenAIRequestToGemini,
},
Resp: TextResponseSide{
Convert: convertOAIChatResponseToGeminiChat,
ConvertStream: convertOAIChatStreamResponseToGeminiChat,
Aliases: []string{ResponseConverterOAIChatToGeminiChat},
},
},
{
ID: ConverterOpenAIChatToOpenAIResponses,
From: types.RelayFormatOpenAI,
To: types.RelayFormatOpenAIResponses,
Quality: TextConverterQualityGood,
Req: TextRequestSide{
Convert: convertChatRequestToResponses,
},
Resp: TextResponseSide{
Convert: convertOAIChatResponseToOAIResponses,
NewStreamState: newOAIChatToOAIResponsesStreamState,
ConvertStreamChunk: convertOAIChatStreamResponseToOAIResponses,
FinalizeStream: finalizeOAIChatStreamResponseToOAIResponses,
Aliases: []string{ResponseConverterOAIChatToOAIResponses},
},
},
{
ID: ConverterOpenAIResponsesToOpenAIChat,
From: types.RelayFormatOpenAIResponses,
To: types.RelayFormatOpenAI,
Quality: TextConverterQualityGood,
Req: TextRequestSide{
Convert: convertResponsesRequestToChat,
},
Resp: TextResponseSide{
Convert: convertOAIResponsesResponseToOAIChat,
NewStreamState: newOAIResponsesToOAIChatStreamState,
ConvertStreamChunk: convertOAIResponsesStreamResponseToOAIChat,
FinalizeStream: finalizeOAIResponsesStreamResponseToOAIChat,
Aliases: []string{ResponseConverterOAIResponsesToOAIChat},
},
},
{
ID: requestConverterClaudeToGemini,
From: types.RelayFormatClaude,
To: types.RelayFormatGemini,
Quality: TextConverterQualityDiscouraged,
Req: TextRequestSide{
StepConverters: []string{
ConverterClaudeMessagesToOpenAIChat,
ConverterOpenAIChatToGeminiContent,
},
},
Resp: TextResponseSide{
StepConverters: []string{
ConverterClaudeMessagesToOpenAIChat,
ConverterOpenAIChatToGeminiContent,
},
Aliases: []string{responseConverterClaudeToGemini},
},
},
{
ID: requestConverterClaudeToResponses,
From: types.RelayFormatClaude,
To: types.RelayFormatOpenAIResponses,
Quality: TextConverterQualityFair,
Req: TextRequestSide{
StepConverters: []string{
ConverterClaudeMessagesToOpenAIChat,
ConverterOpenAIChatToOpenAIResponses,
},
},
Resp: TextResponseSide{
StepConverters: []string{
ConverterClaudeMessagesToOpenAIChat,
ConverterOpenAIChatToOpenAIResponses,
},
Aliases: []string{responseConverterClaudeToResponses},
},
},
{
ID: requestConverterGeminiToClaude,
From: types.RelayFormatGemini,
To: types.RelayFormatClaude,
Quality: TextConverterQualityDiscouraged,
Req: TextRequestSide{
StepConverters: []string{
ConverterGeminiContentToOpenAIChat,
ConverterOpenAIChatToClaudeMessages,
},
},
Resp: TextResponseSide{
StepConverters: []string{
ConverterGeminiContentToOpenAIChat,
ConverterOpenAIChatToClaudeMessages,
},
Aliases: []string{responseConverterGeminiToClaude},
},
},
{
ID: requestConverterGeminiToResponses,
From: types.RelayFormatGemini,
To: types.RelayFormatOpenAIResponses,
Quality: TextConverterQualityFair,
Req: TextRequestSide{
StepConverters: []string{
ConverterGeminiContentToOpenAIChat,
ConverterOpenAIChatToOpenAIResponses,
},
},
Resp: TextResponseSide{
StepConverters: []string{
ConverterGeminiContentToOpenAIChat,
ConverterOpenAIChatToOpenAIResponses,
},
Aliases: []string{responseConverterGeminiToResponses},
},
},
{
ID: requestConverterResponsesToClaude,
From: types.RelayFormatOpenAIResponses,
To: types.RelayFormatClaude,
Quality: TextConverterQualityFair,
Req: TextRequestSide{
Convert: convertOpenAIResponsesRequestToClaudeMessages,
},
Resp: TextResponseSide{
StepConverters: []string{
ConverterOpenAIResponsesToOpenAIChat,
ConverterOpenAIChatToClaudeMessages,
},
Aliases: []string{responseConverterResponsesToClaude},
},
},
{
ID: ConverterOpenAIResponsesToGemini,
From: types.RelayFormatOpenAIResponses,
To: types.RelayFormatGemini,
Quality: TextConverterQualityFair,
Req: TextRequestSide{
Convert: convertOpenAIResponsesRequestToGeminiChat,
},
Resp: TextResponseSide{
StepConverters: []string{
ConverterOpenAIResponsesToOpenAIChat,
ConverterOpenAIChatToGeminiContent,
},
Aliases: []string{responseConverterResponsesToGemini},
},
},
}
func init() {
for _, spec := range builtinTextConverters {
registerBuiltinTextConverter(spec)
}
}
func LookupTextConverter(converter string) (TextConverterSpec, bool) {
textConverterMu.RLock()
defer textConverterMu.RUnlock()
converterID := resolveTextConverterID(converter)
spec, ok := textConverters[converterID]
if !ok {
return TextConverterSpec{}, false
}
return cloneTextConverterSpec(spec), true
}
func registerBuiltinTextConverter(spec TextConverterSpec) {
spec.ID = strings.TrimSpace(spec.ID)
if spec.ID == "" {
panic("text converter ID is required")
}
if spec.From == "" || spec.To == "" {
panic(fmt.Sprintf("text converter %q must declare from and to formats", spec.ID))
}
if spec.Quality == "" {
panic(fmt.Sprintf("text converter %q must declare quality", spec.ID))
}
if !textRequestSideConfigured(spec.Req) {
panic(fmt.Sprintf("text converter %q must declare request conversion", spec.ID))
}
if !textResponseSideConfigured(spec.Resp) {
panic(fmt.Sprintf("text converter %q must declare response conversion", spec.ID))
}
if _, exists := textConverters[spec.ID]; exists {
panic(fmt.Sprintf("text converter %q is already registered", spec.ID))
}
registerBuiltinRequestConverter(RequestConverterSpec{
ID: spec.ID,
From: spec.From,
To: spec.To,
Quality: RequestConverterQuality(spec.Quality),
Convert: spec.Req.Convert,
StepConverters: cloneTextConverterStrings(spec.Req.StepConverters),
})
registerBuiltinResponseConverter(ResponseConverterSpec{
ID: spec.ID,
From: spec.From,
To: spec.To,
Quality: ResponseConverterQuality(spec.Quality),
Convert: spec.Resp.Convert,
ConvertStream: spec.Resp.ConvertStream,
NewStreamState: spec.Resp.NewStreamState,
ConvertStreamChunk: spec.Resp.ConvertStreamChunk,
FinalizeStream: spec.Resp.FinalizeStream,
StepConverters: cloneTextConverterStrings(spec.Resp.StepConverters),
})
textConverters[spec.ID] = cloneTextConverterSpec(spec)
for _, alias := range spec.Resp.Aliases {
registerResponseConverterAlias(alias, spec.ID)
registerTextConverterAlias(alias, spec.ID)
}
}
func registerTextConverterAlias(alias string, converter string) {
alias = strings.TrimSpace(alias)
converter = strings.TrimSpace(converter)
if alias == "" {
panic("text converter alias is required")
}
if converter == "" {
panic(fmt.Sprintf("text converter alias %q target is required", alias))
}
if alias == converter {
return
}
if _, exists := textConverters[alias]; exists {
panic(fmt.Sprintf("text converter alias %q conflicts with registered converter", alias))
}
if _, exists := textConverters[converter]; !exists {
panic(fmt.Sprintf("text converter alias %q references unknown converter %q", alias, converter))
}
if existing, exists := textConverterAliases[alias]; exists && existing != converter {
panic(fmt.Sprintf("text converter alias %q is already registered for %q", alias, existing))
}
textConverterAliases[alias] = converter
}
func textRequestSideConfigured(side TextRequestSide) bool {
return side.Convert != nil || len(side.StepConverters) > 0
}
func textResponseSideConfigured(side TextResponseSide) bool {
return side.Convert != nil ||
side.ConvertStream != nil ||
side.NewStreamState != nil ||
side.ConvertStreamChunk != nil ||
side.FinalizeStream != nil ||
len(side.StepConverters) > 0
}
func resolveTextConverterID(converter string) string {
converter = strings.TrimSpace(converter)
if canonical, ok := textConverterAliases[converter]; ok {
return canonical
}
return converter
}
func cloneTextConverterSpec(spec TextConverterSpec) TextConverterSpec {
spec.Req.StepConverters = cloneTextConverterStrings(spec.Req.StepConverters)
spec.Resp.StepConverters = cloneTextConverterStrings(spec.Resp.StepConverters)
spec.Resp.Aliases = cloneTextConverterStrings(spec.Resp.Aliases)
return spec
}
func cloneTextConverterStrings(values []string) []string {
if len(values) == 0 {
return nil
}
return append([]string{}, values...)
}