mirror of
https://github.com/router-for-me/CLIProxyAPI.git
synced 2026-06-23 04:30:21 +08:00
* feat(plugin): add ModelRouter before auth with single-slot routing targets ## Motivation Plugins that need to change execution based on the **original inbound request** (protocol format, raw body, headers, query, stream flag, metadata, etc.) often resorted to virtual/trampoline models or routing inside interceptors. This commit adds **ModelRouter**: a pluggable layer **before** model-to-provider resolution and AuthManager credential selection, so plugins can declare who executes a request without spoofing the client model name. This is a **new capability**, not a bugfix on the existing chain. With no ModelRouter plugins loaded, behavior matches upstream. ## Pipeline placement - `execute`, `stream`, and `count` (and image paths via AuthManager) call `applyModelRouter()` before building `coreexecutor.Request`. - Routing runs **before** the request interceptor (before auth), so routers see the client’s original context. After a plugin executor is chosen, the existing **after-auth interceptor → response/stream interceptor** chain still applies. - Internal `ExecuteModel` / `ExecuteModelStream` (host callbacks) support `SkipRouterPluginID` so nested calls do not re-enter the same router. ## Routing API (single slot, mutually exclusive) `ModelRouteResponse` uses **one target slot** to avoid ambiguity when both `TargetExecutorPluginID` and `TargetProvider` were set and the host ignored one: | Field | Meaning | |-------|---------| | `Handled` | `false`: this router declines; try the next router or default path | | `TargetKind` | `self` \| `executor` \| `provider` (pick one) | | `Target` | `self`/`executor`: plugin ID; `provider`: built-in provider key | | `TargetModel` | Optional on `provider` only; empty keeps client `RequestedModel` | | `Reason` | Optional diagnostic text | - **self**: the router plugin’s own executor (`Target` normalized to the router’s plugin ID). - **executor**: another plugin’s executor; host pre-checks with `executorPluginReady()` (executor declared and provider identifier resolvable) to avoid handled routes that 500 at execution. - **provider**: skip registry model resolution; fixed built-in AuthManager path; optional `TargetModel` for execution model only—**does not** change outward requested-model metadata. Routers run in **descending plugin priority** (tie-break: ascending plugin ID). Panic, error, invalid target, or unavailable executor/provider → log and **fall through to the next router**; if none handle, use the original provider+auth flow. ## Context exposed to routers `ModelRouteRequest` includes: - `SourceFormat`, `RequestedModel`, `Stream` - `Headers`, `Query`, `Body` (defensive copies) - `Metadata` (best-effort read-only context snapshot) - `AvailableProviders`: built-in provider keys with at least one **non-disabled** auth (`AuthManager.AvailableProviders()`). **Does not** reflect per-model cooldown or transient unavailability—treat as an optimistic snapshot. Adds `AuthManager.HasProviderAuth()` and `AvailableProviders()`, excluding `Disabled` and `StatusDisabled` auths consistently with credential selection. ## Host and RPC - Go plugins: `pluginapi.ModelRouter` + `RouteModel()`. - RPC plugins: `pluginabi.MethodModelRoute` (`model.route`), capability flag `model_router`. - `pluginhost.Host` implements `RouteModel` / `RouteModelExcept`; handlers use `SetModelRouterHost` or a `PluginHost` type assertion; **direct executor** paths use `ExecutePluginExecutor*` / `CountPluginExecutor`. - No bundled example ModelRouter plugin; capability is active only when a third-party plugin declares `model_router` and loads. ## Plugin RPC schema (policy A, upstream-aligned) - `pluginabi.SchemaVersion` stays **1**: capability additions (`model_router`, `model.route`) do not bump the number; increment only on breaking RPC JSON changes. - Host sends `schema_version` at register; reject only if the plugin declares a **higher** version than the host. - No unpublished “ModelRouter requires schema ≥ 3” gate (v3 single-slot API was never public). - Existing plugins and examples without `model_router` (`schema_version: 1`) need no changes. - RPC ModelRouter: `schema_version: 1` + `model_router: true` + implement `model.route`. ## Path consistency within this commit - Provider routes reuse image-only model checks (e.g. `gpt-image-2`) on the normalized model, same as the default AuthManager path. - `count` aligned with execute/stream: `SkipRouterPluginID`, query/headers injection, interceptor skip semantics. - Handlers: `modelRoutersEnabled` treats hosts without `HasModelRouters` as disabled (same as before ModelRouter existed); `pluginhost.Host` implements the detector. - API docs: `ModelRouter` explicitly includes built-in **provider** targets (in addition to plugin executors and the router’s own executor). ## Testing go test ./internal/pluginhost ./sdk/api/handlers ./sdk/pluginapi ./sdk/pluginabi ./sdk/cliproxy/auth go build -o test-output ./cmd/server && rm test-output go test ./... * fix(handlers): address ModelRouter review feedback - Use modelExecutionQuery for plugin executor and AuthManager paths so inbound URL query matches router/header behavior - Guard queryFromContext when gin Request.URL is nil - Read plugin executor stream chunks via nextStreamChunk to exit on cancel - Drop redundant clonePluginMetadata on capability record meta Tests cover query propagation, stream cancel, and nil URL safety. * feat(plugin): add Claude web search router example Add a Claude Code web_search ModelRouter example that can route matching Claude requests through Antigravity, Codex, xAI, or Tavily. The plugin includes executor orchestration, backend fallback/penalty handling, Tavily API key support, Claude-compatible response assembly, stream forwarding, and focused unit coverage for detection, fallback routing, model resolution, penalties, stream forwarding, and Tavily behavior. Verification: go test -count=1 ./... in examples/plugin/claude-web-search-router/go; go build -buildmode=c-shared for the plugin; go build ./cmd/server; live local CPA curl coverage for plugin load, four explicit routes, fallback, and Codex spark routing. * fix(pluginhost): validate executor routes before fallback * fix(pluginhost): skip oauth-only executor routes
357 lines
11 KiB
Go
357 lines
11 KiB
Go
package pluginhost
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/router-for-me/CLIProxyAPI/v7/internal/interfaces"
|
|
"github.com/router-for-me/CLIProxyAPI/v7/internal/logging"
|
|
"github.com/router-for-me/CLIProxyAPI/v7/sdk/api/handlers"
|
|
"github.com/router-for-me/CLIProxyAPI/v7/sdk/pluginabi"
|
|
"github.com/router-for-me/CLIProxyAPI/v7/sdk/pluginapi"
|
|
log "github.com/sirupsen/logrus"
|
|
)
|
|
|
|
type rpcHostHTTPRequest struct {
|
|
HTTPClientID string `json:"http_client_id,omitempty"`
|
|
HostCallbackID string `json:"host_callback_id,omitempty"`
|
|
Method string `json:"method,omitempty"`
|
|
URL string `json:"url,omitempty"`
|
|
Headers httpHeader `json:"headers,omitempty"`
|
|
Body []byte `json:"body,omitempty"`
|
|
Request *httpRequest `json:"request,omitempty"`
|
|
}
|
|
|
|
type httpHeader map[string][]string
|
|
|
|
type httpRequest struct {
|
|
Method string `json:"method,omitempty"`
|
|
URL string `json:"url,omitempty"`
|
|
Headers httpHeader `json:"headers,omitempty"`
|
|
Body []byte `json:"body,omitempty"`
|
|
}
|
|
|
|
type rpcHostHTTPStreamResponse struct {
|
|
StatusCode int `json:"status_code"`
|
|
Headers httpHeader `json:"headers,omitempty"`
|
|
StreamID string `json:"stream_id,omitempty"`
|
|
Chunks []pluginapi.HTTPStreamChunk `json:"chunks,omitempty"`
|
|
}
|
|
|
|
type rpcHostHTTPStreamReadRequest struct {
|
|
StreamID string `json:"stream_id"`
|
|
}
|
|
|
|
type rpcHostHTTPStreamReadResponse struct {
|
|
Payload []byte `json:"payload,omitempty"`
|
|
Error string `json:"error,omitempty"`
|
|
Done bool `json:"done,omitempty"`
|
|
}
|
|
|
|
type rpcHostHTTPStreamCloseRequest struct {
|
|
StreamID string `json:"stream_id"`
|
|
}
|
|
|
|
type rpcHostLogRequest struct {
|
|
HostCallbackID string `json:"host_callback_id,omitempty"`
|
|
Level string `json:"level,omitempty"`
|
|
Message string `json:"message,omitempty"`
|
|
Fields map[string]any `json:"fields,omitempty"`
|
|
}
|
|
|
|
type rpcHostModelExecutionRequest struct {
|
|
pluginapi.HostModelExecutionRequest
|
|
HostCallbackID string `json:"host_callback_id,omitempty"`
|
|
}
|
|
|
|
type dynamicHostCallbackEntry struct {
|
|
host *Host
|
|
pluginID string
|
|
}
|
|
|
|
type hostCallbackPluginIDKey struct{}
|
|
|
|
func withHostCallbackPluginID(ctx context.Context, pluginID string) context.Context {
|
|
pluginID = strings.TrimSpace(pluginID)
|
|
if pluginID == "" {
|
|
if ctx == nil {
|
|
return context.Background()
|
|
}
|
|
return ctx
|
|
}
|
|
if ctx == nil {
|
|
ctx = context.Background()
|
|
}
|
|
return context.WithValue(ctx, hostCallbackPluginIDKey{}, pluginID)
|
|
}
|
|
|
|
func hostCallbackPluginIDFromContext(ctx context.Context) string {
|
|
if ctx == nil {
|
|
return ""
|
|
}
|
|
pluginID, _ := ctx.Value(hostCallbackPluginIDKey{}).(string)
|
|
return strings.TrimSpace(pluginID)
|
|
}
|
|
|
|
func (h *Host) callFromPlugin(ctx context.Context, method string, request []byte) ([]byte, error) {
|
|
switch method {
|
|
case pluginabi.MethodHostModelExecute:
|
|
return h.callHostModelExecute(ctx, request)
|
|
case pluginabi.MethodHostModelExecuteStream:
|
|
return h.callHostModelExecuteStream(ctx, request)
|
|
case pluginabi.MethodHostModelStreamRead:
|
|
return h.callHostModelStreamRead(ctx, request)
|
|
case pluginabi.MethodHostModelStreamClose:
|
|
return h.callHostModelStreamClose(request)
|
|
case pluginabi.MethodHostHTTPDo:
|
|
return h.callHostHTTPDo(ctx, request)
|
|
case pluginabi.MethodHostHTTPDoStream:
|
|
return h.callHostHTTPDoStream(ctx, request)
|
|
case pluginabi.MethodHostHTTPStreamRead:
|
|
return h.callHostHTTPStreamRead(ctx, request)
|
|
case pluginabi.MethodHostHTTPStreamClose:
|
|
return h.callHostHTTPStreamClose(request)
|
|
case pluginabi.MethodHostStreamEmit:
|
|
return h.callHostStreamEmit(ctx, request)
|
|
case pluginabi.MethodHostStreamClose:
|
|
return h.callHostStreamClose(request)
|
|
case pluginabi.MethodHostLog:
|
|
return h.callHostLog(ctx, request)
|
|
case pluginabi.MethodHostAuthList:
|
|
return h.callHostAuthList(ctx, request)
|
|
case pluginabi.MethodHostAuthGet:
|
|
return h.callHostAuthGet(ctx, request)
|
|
case pluginabi.MethodHostAuthGetRuntime:
|
|
return h.callHostAuthGetRuntime(ctx, request)
|
|
case pluginabi.MethodHostAuthSave:
|
|
return h.callHostAuthSave(ctx, request)
|
|
default:
|
|
return nil, fmt.Errorf("unsupported host callback %s", method)
|
|
}
|
|
}
|
|
|
|
func (h *Host) callbackCallerPluginID(ctx context.Context, callbackID string) string {
|
|
if pluginID := hostCallbackPluginIDFromContext(ctx); pluginID != "" {
|
|
return pluginID
|
|
}
|
|
return h.callbackContextPluginID(callbackID)
|
|
}
|
|
|
|
func (h *Host) callHostHTTPDo(ctx context.Context, request []byte) ([]byte, error) {
|
|
httpReq, callbackID, errDecode := decodeHostHTTPRequestWithCallbackID(request)
|
|
if errDecode != nil {
|
|
return nil, errDecode
|
|
}
|
|
ctx = h.resolveCallbackContext(callbackID, ctx)
|
|
resp, errDo := h.newHTTPClient(nil).Do(ctx, httpReq)
|
|
if errDo != nil {
|
|
return nil, errDo
|
|
}
|
|
return marshalRPCResult(resp)
|
|
}
|
|
|
|
func (h *Host) callHostHTTPDoStream(ctx context.Context, request []byte) ([]byte, error) {
|
|
httpReq, callbackID, errDecode := decodeHostHTTPRequestWithCallbackID(request)
|
|
if errDecode != nil {
|
|
return nil, errDecode
|
|
}
|
|
ctx = h.resolveCallbackContext(callbackID, ctx)
|
|
if ctx == nil {
|
|
ctx = context.Background()
|
|
}
|
|
streamCtx, cancel := context.WithCancel(ctx)
|
|
resp, errDo := h.newHTTPClient(nil).DoStream(streamCtx, httpReq)
|
|
if errDo != nil {
|
|
cancel()
|
|
return nil, errDo
|
|
}
|
|
streamID := ""
|
|
if h != nil && h.httpStreams != nil {
|
|
streamID = h.httpStreams.open(resp.Chunks, cancel)
|
|
}
|
|
if streamID == "" {
|
|
cancel()
|
|
return nil, fmt.Errorf("host http stream bridge is unavailable")
|
|
}
|
|
return marshalRPCResult(rpcHostHTTPStreamResponse{
|
|
StatusCode: resp.StatusCode,
|
|
Headers: httpHeader(resp.Headers),
|
|
StreamID: streamID,
|
|
})
|
|
}
|
|
|
|
func (h *Host) callHostHTTPStreamRead(ctx context.Context, request []byte) ([]byte, error) {
|
|
var req rpcHostHTTPStreamReadRequest
|
|
if errUnmarshal := json.Unmarshal(request, &req); errUnmarshal != nil {
|
|
return nil, fmt.Errorf("decode host http stream read request: %w", errUnmarshal)
|
|
}
|
|
if h == nil || h.httpStreams == nil {
|
|
return nil, fmt.Errorf("host http stream bridge is unavailable")
|
|
}
|
|
chunk, done, errRead := h.httpStreams.read(ctx, req.StreamID)
|
|
if errRead != nil {
|
|
return nil, errRead
|
|
}
|
|
resp := rpcHostHTTPStreamReadResponse{
|
|
Payload: append([]byte(nil), chunk.Payload...),
|
|
Done: done,
|
|
}
|
|
if chunk.Err != nil {
|
|
resp.Error = chunk.Err.Error()
|
|
resp.Done = true
|
|
}
|
|
return marshalRPCResult(resp)
|
|
}
|
|
|
|
func (h *Host) callHostHTTPStreamClose(request []byte) ([]byte, error) {
|
|
var req rpcHostHTTPStreamCloseRequest
|
|
if errUnmarshal := json.Unmarshal(request, &req); errUnmarshal != nil {
|
|
return nil, fmt.Errorf("decode host http stream close request: %w", errUnmarshal)
|
|
}
|
|
if h != nil && h.httpStreams != nil {
|
|
h.httpStreams.close(req.StreamID)
|
|
}
|
|
return marshalRPCResult(rpcEmptyResponse{})
|
|
}
|
|
|
|
func decodeHostHTTPRequest(raw []byte) (pluginapi.HTTPRequest, error) {
|
|
httpReq, _, errDecode := decodeHostHTTPRequestWithCallbackID(raw)
|
|
return httpReq, errDecode
|
|
}
|
|
|
|
func decodeHostHTTPRequestWithCallbackID(raw []byte) (pluginapi.HTTPRequest, string, error) {
|
|
var req rpcHostHTTPRequest
|
|
if errUnmarshal := json.Unmarshal(raw, &req); errUnmarshal != nil {
|
|
return pluginapi.HTTPRequest{}, "", fmt.Errorf("decode host http request: %w", errUnmarshal)
|
|
}
|
|
if req.Request != nil {
|
|
return pluginapi.HTTPRequest{
|
|
Method: req.Request.Method,
|
|
URL: req.Request.URL,
|
|
Headers: map[string][]string(req.Request.Headers),
|
|
Body: append([]byte(nil), req.Request.Body...),
|
|
}, req.HostCallbackID, nil
|
|
}
|
|
return pluginapi.HTTPRequest{
|
|
Method: req.Method,
|
|
URL: req.URL,
|
|
Headers: map[string][]string(req.Headers),
|
|
Body: append([]byte(nil), req.Body...),
|
|
}, req.HostCallbackID, nil
|
|
}
|
|
|
|
func (h *Host) callHostStreamEmit(ctx context.Context, request []byte) ([]byte, error) {
|
|
var req rpcStreamEmitRequest
|
|
if errUnmarshal := json.Unmarshal(request, &req); errUnmarshal != nil {
|
|
return nil, fmt.Errorf("decode stream emit request: %w", errUnmarshal)
|
|
}
|
|
chunk := pluginapi.ExecutorStreamChunk{Payload: append([]byte(nil), req.Payload...)}
|
|
if req.Error != "" {
|
|
chunk.Err = fmt.Errorf("%s", req.Error)
|
|
}
|
|
if errEmit := h.streams.emit(ctx, req.StreamID, chunk); errEmit != nil {
|
|
return nil, errEmit
|
|
}
|
|
return marshalRPCResult(rpcEmptyResponse{})
|
|
}
|
|
|
|
func (h *Host) callHostStreamClose(request []byte) ([]byte, error) {
|
|
var req rpcStreamCloseRequest
|
|
if errUnmarshal := json.Unmarshal(request, &req); errUnmarshal != nil {
|
|
return nil, fmt.Errorf("decode stream close request: %w", errUnmarshal)
|
|
}
|
|
h.streams.close(req.StreamID, req.Error)
|
|
return marshalRPCResult(rpcEmptyResponse{})
|
|
}
|
|
|
|
func (h *Host) callHostModelExecute(ctx context.Context, request []byte) ([]byte, error) {
|
|
var req rpcHostModelExecutionRequest
|
|
if errUnmarshal := json.Unmarshal(request, &req); errUnmarshal != nil {
|
|
return nil, fmt.Errorf("decode host model execution request: %w", errUnmarshal)
|
|
}
|
|
if req.Stream {
|
|
return nil, fmt.Errorf("host.model.execute requires stream=false")
|
|
}
|
|
executor := h.currentModelExecutor()
|
|
if executor == nil {
|
|
return nil, fmt.Errorf("host model executor is unavailable")
|
|
}
|
|
skipPluginID := h.callbackCallerPluginID(ctx, req.HostCallbackID)
|
|
ctx = h.resolveCallbackContext(req.HostCallbackID, ctx)
|
|
resp, errMsg := executor.ExecuteModel(ctx, modelExecutionRequestFromPlugin(req.HostModelExecutionRequest, skipPluginID))
|
|
if errMsg != nil {
|
|
return nil, modelExecutionError(errMsg)
|
|
}
|
|
return marshalRPCResult(pluginapi.HostModelExecutionResponse{
|
|
StatusCode: resp.StatusCode,
|
|
Headers: cloneHeader(resp.Headers),
|
|
Body: append([]byte(nil), resp.Body...),
|
|
})
|
|
}
|
|
|
|
func modelExecutionRequestFromPlugin(req pluginapi.HostModelExecutionRequest, skipPluginID string) handlers.ModelExecutionRequest {
|
|
return handlers.ModelExecutionRequest{
|
|
EntryProtocol: req.EntryProtocol,
|
|
ExitProtocol: req.ExitProtocol,
|
|
Model: req.Model,
|
|
Stream: req.Stream,
|
|
Body: append([]byte(nil), req.Body...),
|
|
Headers: cloneHeader(req.Headers),
|
|
Query: cloneValues(req.Query),
|
|
Alt: req.Alt,
|
|
SkipInterceptorPluginID: skipPluginID,
|
|
SkipRouterPluginID: skipPluginID,
|
|
}
|
|
}
|
|
|
|
func modelExecutionError(errMsg *interfaces.ErrorMessage) error {
|
|
if errMsg == nil {
|
|
return nil
|
|
}
|
|
if errMsg.Error != nil {
|
|
return errMsg.Error
|
|
}
|
|
if errMsg.StatusCode > 0 {
|
|
return fmt.Errorf("model execution failed with status %d", errMsg.StatusCode)
|
|
}
|
|
return fmt.Errorf("model execution failed")
|
|
}
|
|
|
|
func (h *Host) callHostLog(ctx context.Context, request []byte) ([]byte, error) {
|
|
var req rpcHostLogRequest
|
|
if errUnmarshal := json.Unmarshal(request, &req); errUnmarshal != nil {
|
|
return nil, fmt.Errorf("decode host log request: %w", errUnmarshal)
|
|
}
|
|
ctx = h.resolveCallbackContext(req.HostCallbackID, ctx)
|
|
message := strings.TrimSpace(req.Message)
|
|
if message == "" {
|
|
message = "plugin log"
|
|
}
|
|
fields := log.Fields{}
|
|
for key, value := range req.Fields {
|
|
key = strings.TrimSpace(key)
|
|
if key != "" {
|
|
fields[key] = value
|
|
}
|
|
}
|
|
if requestID := logging.GetRequestID(ctx); requestID != "" {
|
|
fields["request_id"] = requestID
|
|
}
|
|
entry := log.WithFields(fields)
|
|
switch strings.ToLower(strings.TrimSpace(req.Level)) {
|
|
case "trace":
|
|
entry.Trace(message)
|
|
case "info":
|
|
entry.Info(message)
|
|
case "warn", "warning":
|
|
entry.Warn(message)
|
|
case "error":
|
|
entry.Error(message)
|
|
default:
|
|
entry.Debug(message)
|
|
}
|
|
return marshalRPCResult(rpcEmptyResponse{})
|
|
}
|