From ddaa9ddbff4bb488aa0ab3bc2ade08078ba6a4f6 Mon Sep 17 00:00:00 2001 From: ihipop Date: Mon, 16 Nov 2026 20:26:53 +0800 Subject: [PATCH] =?UTF-8?q?feat(headers):=20=E7=94=A8=E9=80=9A=E7=94=A8?= =?UTF-8?q?=E5=85=9C=E5=BA=95=E8=A7=84=E5=88=99=E6=9B=BF=E4=BB=A3=20UA=20?= =?UTF-8?q?=E4=B8=93=E7=94=A8=E9=85=8D=E7=BD=AE?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .env.example | 4 - README.md | 3 +- README_CN.md | 3 +- README_JP.md | 3 +- internal/container/container.go | 4 +- internal/control/discover_executor.go | 5 ++ internal/control/group_detail.go | 12 ++- internal/control/header_defaults_test.go | 43 ++++++++++ internal/control/settings.go | 17 +++- internal/control/validation.go | 12 +++ internal/execution/bifrost/executor.go | 4 +- .../execution/bifrost/newapi_runtime_test.go | 7 +- internal/execution/bifrost/runtime.go | 7 +- .../execution/bifrost/test_runtime_test.go | 2 - internal/execution/bifrost/user_agent.go | 9 +- internal/execution/bifrost/user_agent_test.go | 62 ++------------ internal/execution/bifrost/websocket.go | 2 +- internal/gateway/execution_forward.go | 12 +++ internal/gateway/header_defaults_test.go | 65 +++++++++++++++ internal/gateway/request_log.go | 4 + internal/platform/config/config.go | 12 +-- internal/platform/config/config_test.go | 34 -------- internal/scheduler/scheduler.go | 1 + internal/state/header_defaults_test.go | 51 ++++++++++++ internal/state/runtime_settings.go | 83 +++++++++++-------- internal/state/snapshot.go | 12 ++- .../frontends/classic/api/control/types.ts | 1 + .../frontends/classic/app/resources/groups.ts | 13 ++- .../classic/app/resources/settings.ts | 12 ++- .../components/config/HeaderRulesEditor.vue | 34 +++++++- .../config/header-rules-validation.ts | 2 +- .../groups/settings/GroupSettingsTab.vue | 10 ++- .../groups/settings/group-settings-patch.ts | 13 ++- .../settings/BrowserAccessSection.vue | 5 +- .../features/settings/settings-patch.ts | 32 ++++++- .../classic/i18n/locales/en-US/core.ts | 1 + .../classic/i18n/locales/en-US/group.ts | 2 +- .../classic/i18n/locales/ja-JP/core.ts | 1 + .../classic/i18n/locales/ja-JP/group.ts | 2 +- .../classic/i18n/locales/zh-CN/core.ts | 1 + .../classic/i18n/locales/zh-CN/group.ts | 2 +- web/src/frontends/modern/api/group-detail.ts | 7 +- web/src/frontends/modern/api/settings.ts | 7 ++ .../features/groups/GroupAdvancedPanel.vue | 53 ++++++++++-- .../settings/SettingsHeadersEditor.vue | 9 +- .../features/settings/settings-draft.ts | 19 ++++- .../modern/i18n/locales/settings-form.ts | 3 + 47 files changed, 502 insertions(+), 200 deletions(-) create mode 100644 internal/control/header_defaults_test.go create mode 100644 internal/gateway/header_defaults_test.go create mode 100644 internal/state/header_defaults_test.go diff --git a/.env.example b/.env.example index d56ba4e96a..f13fe48532 100644 --- a/.env.example +++ b/.env.example @@ -37,10 +37,6 @@ TRUSTED_PROXIES= # HTTPS_PROXY=http://proxy.example.com:8080 # NO_PROXY=localhost,127.0.0.1,.internal.example.com -# Ordinary-channel UA fallback; restart after changes. Empty keeps GPT-Load/. -# Nonempty request-header rules or client UA take precedence; subscription UA is unchanged. -# UPSTREAM_USER_AGENT_FALLBACK=Go-http-client/1.1 - # Logging LOG_LEVEL=info LOG_FORMAT=text diff --git a/README.md b/README.md index 59c1ef5364..51c5859a3a 100644 --- a/README.md +++ b/README.md @@ -203,6 +203,8 @@ Installing a newer Setup stops the service gracefully before updating it. Window ### Environment configuration +System and group upstream request-header rules support **Set**, **Remove**, and **Default**. Default fills only missing, empty, or whitespace-only headers, preserving nonempty client values; credential probes and model discovery use the same rules. For example, default `User-Agent` to `Go-http-client/1.1`. The API accepts a `header_rules.default` object; a header may appear in only one of `set`, `remove`, or `default`, and a group override still replaces the whole ruleset. Without a custom default, ordinary channels retain the built-in `GPT-Load/` UA. + At startup, the application reads `.env` in the current directory; existing process environment variables take precedence. Unless noted otherwise, changes require restarting the process or container; see [`.env.example`](.env.example) for the common configuration template.
@@ -229,7 +231,6 @@ At startup, the application reads `.env` in the current directory; existing proc | `HTTP_PROXY` | Empty | Environment proxy for HTTP upstream requests. | | `HTTPS_PROXY` | Empty | Environment proxy for HTTPS upstream requests. | | `NO_PROXY` | Empty | Comma-separated hosts, domains, or IPs that bypass the environment proxy. | -| `UPSTREAM_USER_AGENT_FALLBACK` | Empty, uses `GPT-Load/` | Fallback User-Agent for ordinary-channel API requests, credential probes, model discovery, and Responses WebSocket handshakes. Used only when the final UA is missing, empty, or whitespace-only after header rules; nonempty rule/client values take precedence. Example: `Go-http-client/1.1` (fixed, not protocol-dependent). Subscription adapter identities are unchanged. Restart after changes. | | `LOG_LEVEL` | `info` | Supports `panic`, `fatal`, `error`, `warn`, `warning`, `info`, `debug`, and `trace`; invalid values warn and fall back to `info`. | | `LOG_FORMAT` | `text` | Supports `text` and `json`; any other value fails startup. | | `MODELS_DEV_AUTO_SYNC_ENABLED` | Unset, initial default `true` | When unset, uses the persisted management UI setting; when set, forces Models.dev auto-sync on or off and makes the same UI option read-only. | diff --git a/README_CN.md b/README_CN.md index 40f3573cfb..8e2b2b735a 100644 --- a/README_CN.md +++ b/README_CN.md @@ -203,6 +203,8 @@ Windows 普通用户可改为下载 `gpt-load-windows-setup.exe`。双击并确 ### 环境配置 +系统和分组的上游请求头规则支持“设置”“移除”和“兜底”。兜底仅在请求头缺失、为空或仅含空白时补值,保留客户端的非空值;凭据探测和模型发现同样生效。例如设置 `User-Agent` 的兜底值为 `Go-http-client/1.1`。API 使用 `header_rules.default` 对象,与 `set`、`remove` 一样,同一请求头不能重复配置多个操作;分组覆盖仍替换整套规则。未配置自定义兜底时,普通渠道的内置 UA 仍为 `GPT-Load/`。 + 应用启动时读取当前目录的 `.env`,已有的进程环境变量优先。除特别说明外,修改后需要重启进程或容器;常用配置模板见 [`.env.example`](.env.example)。
@@ -229,7 +231,6 @@ Windows 普通用户可改为下载 `gpt-load-windows-setup.exe`。双击并确 | `HTTP_PROXY` | 空 | HTTP 上游请求的环境代理。 | | `HTTPS_PROXY` | 空 | HTTPS 上游请求的环境代理。 | | `NO_PROXY` | 空 | 逗号分隔的不经过环境代理的主机、域名或 IP。 | -| `UPSTREAM_USER_AGENT_FALLBACK` | 空,使用 `GPT-Load/` | 普通渠道 API 请求、凭据探测、模型发现和 Responses WebSocket 握手的兜底 User-Agent。仅在请求头规则应用后最终 UA 缺失、为空或全是空白时生效,不覆盖规则或客户端提供的非空 UA。例如 `Go-http-client/1.1`(固定值,不随 HTTP 协议变化)。不改变订阅适配器身份。修改后重启。 | | `LOG_LEVEL` | `info` | 支持 `panic`、`fatal`、`error`、`warn`、`warning`、`info`、`debug`、`trace`;无效值会告警并回退到 `info`。 | | `LOG_FORMAT` | `text` | 支持 `text`、`json`;其他值会导致启动失败。 | | `MODELS_DEV_AUTO_SYNC_ENABLED` | 未设置,初始默认 `true` | 未设置时使用管理界面的持久化设置;设置后强制开启或关闭 Models.dev 自动同步,并使管理界面中的同名选项变为只读。 | diff --git a/README_JP.md b/README_JP.md index a04e2421d9..263f9fe346 100644 --- a/README_JP.md +++ b/README_JP.md @@ -203,6 +203,8 @@ Windows の一般ユーザーは代わりに `gpt-load-windows-setup.exe` を利 ### 環境設定 +システムとグループの上流リクエストヘッダールールは「設定」「削除」「既定値」をサポートします。既定値はヘッダーが未指定、空、または空白のみの場合に適用され、クライアントの空でない値を保持します。認証情報の検証とモデル検出にも適用されます。例えば `User-Agent` の既定値を `Go-http-client/1.1` に設定できます。API は `header_rules.default` オブジェクトを使用し、同一ヘッダーを `set`、`remove`、`default` に重複指定できません。グループ設定は従来どおりルール全体を置き換えます。独自の既定値がない通常チャネルでは、組み込みの `GPT-Load/` UA が維持されます。 + アプリケーションは起動時にカレントディレクトリの `.env` を読み込み、既存のプロセス環境変数を優先します。特記がない限り、変更後はプロセスまたはコンテナを再起動してください。一般的な設定テンプレートは [`.env.example`](.env.example) を参照してください。
@@ -229,7 +231,6 @@ Windows の一般ユーザーは代わりに `gpt-load-windows-setup.exe` を利 | `HTTP_PROXY` | 空 | HTTP アップストリームリクエストの環境プロキシ。 | | `HTTPS_PROXY` | 空 | HTTPS アップストリームリクエストの環境プロキシ。 | | `NO_PROXY` | 空 | 環境プロキシをバイパスするホスト、ドメイン、IP のカンマ区切りリスト。 | -| `UPSTREAM_USER_AGENT_FALLBACK` | 空、`GPT-Load/` を使用 | 通常チャネルの API リクエスト、認証情報テスト、モデル検出、Responses WebSocket ハンドシェイク用のフォールバック User-Agent。ヘッダールール適用後の UA が未指定・空・空白のみの場合に使用し、ルールやクライアントの空でない UA は維持します。例:`Go-http-client/1.1`(HTTP プロトコルに依存しない固定値)。サブスクリプションアダプターの識別情報は変更しません。変更後は再起動が必要です。 | | `LOG_LEVEL` | `info` | `panic`、`fatal`、`error`、`warn`、`warning`、`info`、`debug`、`trace` に対応します。無効な値は警告を出して `info` に戻ります。 | | `LOG_FORMAT` | `text` | `text` と `json` に対応します。それ以外の値では起動に失敗します。 | | `MODELS_DEV_AUTO_SYNC_ENABLED` | 未設定、初期既定値 `true` | 未設定時は管理画面に保存された設定を使用します。設定時は Models.dev の自動同期を強制的に有効または無効にし、管理画面の同名オプションを読み取り専用にします。 | diff --git a/internal/container/container.go b/internal/container/container.go index 4b6654caf2..888f6cc8f8 100644 --- a/internal/container/container.go +++ b/internal/container/container.go @@ -193,8 +193,8 @@ func BuildContainer(configure ...func(*dig.Container) error) (*dig.Container, er audioSpeech, mistral, ) }, - func(registry *channel.Registry, cfg *config.Config) (*bifrostexecutor.RuntimeManager, error) { - return bifrostexecutor.NewManagedRuntime(registry, cfg.UpstreamUserAgentFallback) + func(registry *channel.Registry) (*bifrostexecutor.RuntimeManager, error) { + return bifrostexecutor.NewManagedRuntime(registry) }, func(adapters *provideradapter.Registry, quotaRuntime *accessquota.Runtime, credentials *state.CredentialRegistry) *state.Manager { manager := state.NewManager() diff --git a/internal/control/discover_executor.go b/internal/control/discover_executor.go index 2065b099e5..2bb89fe9d7 100644 --- a/internal/control/discover_executor.go +++ b/internal/control/discover_executor.go @@ -164,6 +164,11 @@ func applyControlHeaderRules(rules state.HeaderRules, apiKey string) http.Header for _, name := range rules.Remove { headers.Del(name) } + for name, value := range rules.Default { + if strings.TrimSpace(headers.Get(name)) == "" { + headers.Set(name, strings.ReplaceAll(value, "${API_KEY}", apiKey)) + } + } headers.Set("Accept-Encoding", "identity") return headers } diff --git a/internal/control/group_detail.go b/internal/control/group_detail.go index be9ec6819e..5f77c6cec8 100644 --- a/internal/control/group_detail.go +++ b/internal/control/group_detail.go @@ -80,6 +80,13 @@ func effectiveGroupConfig( return GroupEffectiveConfigResponse{}, err } set := make(map[string]string, len(resolved.HeaderRules.Set)) + var defaults map[string]string + if len(resolved.HeaderRules.Default) > 0 { + defaults = make(map[string]string, len(resolved.HeaderRules.Default)) + for name, value := range resolved.HeaderRules.Default { + defaults[name] = value + } + } for name, value := range resolved.HeaderRules.Set { set[name] = value } @@ -89,8 +96,9 @@ func effectiveGroupConfig( RequestTimeout: durationSeconds(resolved.Timeouts.Request), StreamIdleTimeout: durationSeconds(resolved.Timeouts.StreamIdle), HeaderRules: HeaderRulesResponse{ - Set: set, - Remove: append([]string{}, resolved.HeaderRules.Remove...), + Set: set, + Default: defaults, + Remove: append([]string{}, resolved.HeaderRules.Remove...), }, BlacklistThreshold: resolved.BlacklistThreshold, AffinityEnabled: resolved.AffinityEnabled, diff --git a/internal/control/header_defaults_test.go b/internal/control/header_defaults_test.go new file mode 100644 index 0000000000..8eb18ef27c --- /dev/null +++ b/internal/control/header_defaults_test.go @@ -0,0 +1,43 @@ +package control + +import ( + "encoding/json" + "testing" + + "gpt-load/internal/protocol" + "gpt-load/internal/state" +) + +func TestControlHeaderDefaults(t *testing.T) { + rules := state.HeaderRules{Default: map[string]string{"User-Agent": "Go-http-client/1.1", "X-Template": "${API_KEY}"}} + headers := applyControlHeaderRules(rules, "fixture-token") + if headers.Get("User-Agent") != "Go-http-client/1.1" || headers.Get("X-Template") != "fixture-token" { + t.Fatal(headers) + } +} + +func TestHeaderDefaultsSettingsRoundTrip(t *testing.T) { + fixture := newServiceFixture(t) + updated, err := fixture.service.UpdateSettings(t.Context(), SettingsUpdateRequest{Settings: map[string]json.RawMessage{ + state.SettingHeaderRules: json.RawMessage(`{"default":{"user-agent":"Go-http-client/1.1"}}`), + }}) + if err != nil { + t.Fatal(err) + } + if updated.Values.HeaderRules.Default["User-Agent"] != "Go-http-client/1.1" { + t.Fatal(updated.Values.HeaderRules) + } + read, err := fixture.service.GetSettings(t.Context()) + if err != nil { + t.Fatal(err) + } + if read.Values.HeaderRules.Default["User-Agent"] != "Go-http-client/1.1" { + t.Fatal(read.Values.HeaderRules) + } + group := validationSignatureGroup() + before := computeGroupValidationSignature(group, protocol.OpenAICompletions, "fixture-model") + group.HeaderRules.Default = map[string]string{"User-Agent": "fallback/1.0"} + if after := computeGroupValidationSignature(group, protocol.OpenAICompletions, "fixture-model"); after == before { + t.Fatal("defaults missing from probe signature") + } +} diff --git a/internal/control/settings.go b/internal/control/settings.go index 6ce8cad243..3eeb998e08 100644 --- a/internal/control/settings.go +++ b/internal/control/settings.go @@ -31,8 +31,9 @@ import ( ) type HeaderRulesResponse struct { - Set map[string]string `json:"set"` - Remove []string `json:"remove"` + Set map[string]string `json:"set"` + Remove []string `json:"remove"` + Default map[string]string `json:"default,omitempty"` } type CORSConfigResponse struct { @@ -395,6 +396,13 @@ func mapSettingsResponse( set[name] = value } remove := append([]string{}, settings.HeaderRules.Remove...) + var defaults map[string]string + if len(settings.HeaderRules.Default) > 0 { + defaults = make(map[string]string, len(settings.HeaderRules.Default)) + for name, value := range settings.HeaderRules.Default { + defaults[name] = value + } + } responseSet := make(map[string]string, len(settings.ResponseHeaderRules.Set)) for name, value := range settings.ResponseHeaderRules.Set { responseSet[name] = value @@ -456,8 +464,9 @@ func mapSettingsResponse( RequestTimeout: durationSeconds(settings.RequestTimeout), StreamIdleTimeout: durationSeconds(settings.StreamIdleTimeout), HeaderRules: HeaderRulesResponse{ - Set: set, - Remove: remove, + Set: set, + Default: defaults, + Remove: remove, }, CORS: CORSConfigResponse{ Enabled: settings.CORS.Enabled, diff --git a/internal/control/validation.go b/internal/control/validation.go index 9960ce069a..cf4e6067ce 100644 --- a/internal/control/validation.go +++ b/internal/control/validation.go @@ -445,6 +445,18 @@ func computeGroupValidationSignature( } var signature groupValidationSignature + defaultParts := make([]headerSetPart, 0, len(group.HeaderRules.Default)) + for name, value := range group.HeaderRules.Default { + defaultParts = append(defaultParts, headerSetPart{name: normalizeValidationHeaderName(name), value: value}) + } + sort.Slice(defaultParts, func(i, j int) bool { return defaultParts[i].name < defaultParts[j].name }) + if len(defaultParts) > 0 { + writeValidationSignatureUint64(hasher, uint64(len(defaultParts))) + } + for _, part := range defaultParts { + writeValidationSignaturePart(hasher, []byte(part.name)) + writeValidationSignaturePart(hasher, []byte(part.value)) + } copy(signature[:], hasher.Sum(nil)) return signature } diff --git a/internal/execution/bifrost/executor.go b/internal/execution/bifrost/executor.go index 8747db5f1f..23a64549f7 100644 --- a/internal/execution/bifrost/executor.go +++ b/internal/execution/bifrost/executor.go @@ -71,7 +71,7 @@ type streamSDKResult struct { // Execute executes one non-streaming attempt. func (r *Runtime) Execute(parent context.Context, spec execution.AttemptSpec) (result execution.AttemptResult) { - spec = withUserAgent(spec, r.userAgentFallback) + spec = withUserAgent(spec) defer func() { normalizeImagesAttemptResult(spec, &result) normalizeEmbeddingsAttemptResult(spec, &result) @@ -197,7 +197,7 @@ func (r *Runtime) ExecuteStream( spec execution.AttemptSpec, sink execution.StreamSink, ) (result execution.StreamResult) { - spec = withUserAgent(spec, r.userAgentFallback) + spec = withUserAgent(spec) defer func() { normalizeImagesStreamResult(spec, &result) }() diff --git a/internal/execution/bifrost/newapi_runtime_test.go b/internal/execution/bifrost/newapi_runtime_test.go index 06b89ba832..baa3b079c8 100644 --- a/internal/execution/bifrost/newapi_runtime_test.go +++ b/internal/execution/bifrost/newapi_runtime_test.go @@ -505,11 +505,6 @@ func TestNewAPINativeStreamsKeepProtocolWireAndUsage(t *testing.T) { func newNewAPIManagerForTest(t *testing.T, baseURL string) (*RuntimeManager, channel.ResolvedTarget) { t.Helper() - return newNewAPIManagerWithOptionsForTest(t, baseURL, runtimeOptions{allowPrivateNetwork: true}) -} - -func newNewAPIManagerWithOptionsForTest(t *testing.T, baseURL string, options runtimeOptions) (*RuntimeManager, channel.ResolvedTarget) { - t.Helper() registry := channel.NewRegistry() resolved, err := registry.Resolve( @@ -519,7 +514,7 @@ func newNewAPIManagerWithOptionsForTest(t *testing.T, baseURL string, options ru if err != nil { t.Fatal(err) } - manager, err := newRuntimeManager(options, registry) + manager, err := newRuntimeManager(runtimeOptions{allowPrivateNetwork: true}, registry) if err != nil { t.Fatal(err) } diff --git a/internal/execution/bifrost/runtime.go b/internal/execution/bifrost/runtime.go index a9a7f5d326..a5ec96d275 100644 --- a/internal/execution/bifrost/runtime.go +++ b/internal/execution/bifrost/runtime.go @@ -30,7 +30,6 @@ var errKeyPoolDisabled = errors.New("Bifrost key pool is disabled; DirectKey is // Runtime owns one long-lived Bifrost Core and executes attempts with explicit credentials. type Runtime struct { - userAgentFallback string core *core.Bifrost account *directAccount registry *channel.Registry @@ -72,7 +71,6 @@ func newConfiguredRuntime( } type runtimeOptions struct { - userAgentFallback string allowPrivateNetwork bool maxUnaryResponseBodyBytes int64 logger schemas.Logger @@ -100,8 +98,8 @@ func NewRuntime(ctx context.Context, registry *channel.Registry) (*RuntimeManage // NewManagedRuntime creates an unstarted production runtime manager. The // application lifecycle must call Start before accepting requests. -func NewManagedRuntime(registry *channel.Registry, userAgentFallback string) (*RuntimeManager, error) { - return newRuntimeManager(runtimeOptions{allowPrivateNetwork: true, userAgentFallback: userAgentFallback}, registry) +func NewManagedRuntime(registry *channel.Registry) (*RuntimeManager, error) { + return newRuntimeManager(runtimeOptions{allowPrivateNetwork: true}, registry) } func newRuntimeShell(options runtimeOptions, registry *channel.Registry) (*Runtime, error) { @@ -110,7 +108,6 @@ func newRuntimeShell(options runtimeOptions, registry *channel.Registry) (*Runti return nil, fmt.Errorf("initialize execution runtime: channel registry is required") } return &Runtime{ - userAgentFallback: options.userAgentFallback, account: newDirectAccount(), registry: registry, allowPrivate: options.allowPrivateNetwork, diff --git a/internal/execution/bifrost/test_runtime_test.go b/internal/execution/bifrost/test_runtime_test.go index 04023ec869..9235037922 100644 --- a/internal/execution/bifrost/test_runtime_test.go +++ b/internal/execution/bifrost/test_runtime_test.go @@ -10,7 +10,6 @@ import ( ) type testRuntimeOptions struct { - userAgentFallback string allowPrivateNetwork bool openAIBaseURL string anthropicBaseURL string @@ -28,7 +27,6 @@ func newRuntimeForTest(t *testing.T, options testRuntimeOptions) *testRuntime { t.Helper() registry := channel.NewRegistry() manager, err := newRuntimeManager(runtimeOptions{ - userAgentFallback: options.userAgentFallback, allowPrivateNetwork: options.allowPrivateNetwork, maxUnaryResponseBodyBytes: options.maxUnaryResponseBodyBytes, }, registry) diff --git a/internal/execution/bifrost/user_agent.go b/internal/execution/bifrost/user_agent.go index 2c20c1490d..4783d8bcc2 100644 --- a/internal/execution/bifrost/user_agent.go +++ b/internal/execution/bifrost/user_agent.go @@ -9,7 +9,7 @@ import ( ) // withUserAgent 仅为普通渠道补齐出站身份;订阅渠道由各自适配器处理。 -func withUserAgent(spec execution.AttemptSpec, fallback string) execution.AttemptSpec { +func withUserAgent(spec execution.AttemptSpec) execution.AttemptSpec { // 系统或分组规则已先应用,保留其配置值或客户端原始身份。 if strings.TrimSpace(spec.Header.Get("User-Agent")) != "" { return spec @@ -18,10 +18,7 @@ func withUserAgent(spec execution.AttemptSpec, fallback string) execution.Attemp if spec.Header == nil { spec.Header = make(http.Header) } - // 环境配置仅影响兜底;未配置时保留项目身份,包括规则明确删除或留空的情况。 - if fallback == "" { - fallback = "GPT-Load/" + version.Version - } - spec.Header.Set("User-Agent", fallback) + // 没有有效 UA 时使用项目身份,包括规则明确删除或留空的情况。 + spec.Header.Set("User-Agent", "GPT-Load/"+version.Version) return spec } diff --git a/internal/execution/bifrost/user_agent_test.go b/internal/execution/bifrost/user_agent_test.go index 6d2ee1b93b..442c3bbca8 100644 --- a/internal/execution/bifrost/user_agent_test.go +++ b/internal/execution/bifrost/user_agent_test.go @@ -16,33 +16,20 @@ import ( ) func TestNewAPIModelDiscoveryUserAgentOnWire(t *testing.T) { - for _, fallback := range []string{"", "Go-http-client/1.1"} { - t.Run("fallback="+fallback, func(t *testing.T) { - testNewAPIModelDiscoveryUserAgentOnWire(t, fallback) - }) - } -} - -func testNewAPIModelDiscoveryUserAgentOnWire(t *testing.T, fallback string) { - t.Helper() - wantDefault := fallback - if wantDefault == "" { - wantDefault = "GPT-Load/" + version.Version - } for _, test := range []struct { name string header http.Header configured []string want string }{ - {name: "system default", want: wantDefault}, + {name: "system default", want: "GPT-Load/" + version.Version}, {name: "preserve client", header: http.Header{"User-Agent": {"client/1.0"}}, want: "client/1.0"}, - {name: "empty client", header: http.Header{"User-Agent": {""}}, want: wantDefault}, - {name: "whitespace client", header: http.Header{"User-Agent": {" \t "}}, want: wantDefault}, + {name: "empty client", header: http.Header{"User-Agent": {""}}, want: "GPT-Load/" + version.Version}, + {name: "whitespace client", header: http.Header{"User-Agent": {" \t "}}, want: "GPT-Load/" + version.Version}, {name: "configured override", header: http.Header{"User-Agent": {"operator/2.0"}}, configured: []string{"user-agent"}, want: "operator/2.0"}, - {name: "explicit removal", configured: []string{"User-Agent"}, want: wantDefault}, - {name: "explicit empty", header: http.Header{"User-Agent": {""}}, configured: []string{"User-Agent"}, want: wantDefault}, - {name: "explicit whitespace", header: http.Header{"User-Agent": {" \t "}}, configured: []string{"User-Agent"}, want: wantDefault}, + {name: "explicit removal", configured: []string{"User-Agent"}, want: "GPT-Load/" + version.Version}, + {name: "explicit empty", header: http.Header{"User-Agent": {""}}, configured: []string{"User-Agent"}, want: "GPT-Load/" + version.Version}, + {name: "explicit whitespace", header: http.Header{"User-Agent": {" \t "}}, configured: []string{"User-Agent"}, want: "GPT-Load/" + version.Version}, } { t.Run(test.name, func(t *testing.T) { seen := make(chan http.Header, 1) @@ -52,9 +39,7 @@ func testNewAPIModelDiscoveryUserAgentOnWire(t *testing.T, fallback string) { _, _ = w.Write([]byte(`{"success":true,"data":[{"id":"model-one"}]}`)) })) defer server.Close() - manager, target := newNewAPIManagerWithOptionsForTest(t, server.URL, runtimeOptions{ - allowPrivateNetwork: true, userAgentFallback: fallback, - }) + manager, target := newNewAPIManagerForTest(t, server.URL) spec := utilitySpec(channel.NewAPI, protocol.OpenAICompletions, execution.OperationListModels, http.MethodGet, "/v1/models", nil) spec.TargetConfig = target.TargetConfig spec.Header = test.header.Clone() @@ -77,23 +62,11 @@ func testNewAPIModelDiscoveryUserAgentOnWire(t *testing.T, fallback string) { } func TestRequestUserAgentOnWire(t *testing.T) { - for _, fallback := range []string{"", "Go-http-client/1.1"} { - t.Run("fallback="+fallback, func(t *testing.T) { - testRequestUserAgentOnWire(t, fallback) - }) - } -} - -func testRequestUserAgentOnWire(t *testing.T, fallback string) { - t.Helper() for _, route := range []string{"native", "typed"} { for _, operation := range []string{"unary", "stream", "probe"} { for _, policy := range []string{"default", "client", "configured", "removed", "empty", "whitespace"} { name := route + "/" + operation + "/" + policy want := "GPT-Load/" + version.Version - if fallback != "" { - want = fallback - } if policy == "configured" { want = "operator/2.0" } else if policy == "client" { @@ -111,10 +84,7 @@ func testRequestUserAgentOnWire(t *testing.T, fallback string) { writeSuccess(w, "ok") })) defer server.Close() - runtime := newRuntimeForTest(t, testRuntimeOptions{ - allowPrivateNetwork: true, - userAgentFallback: fallback, - }) + runtime := newTestRuntime(t) spec := compatibleSpec(server.URL) if route == "typed" { // 非 /v1 前缀走 SDK typed fallback,覆盖不同的 HTTP 构造路径。 @@ -164,20 +134,8 @@ func testRequestUserAgentOnWire(t *testing.T, fallback string) { } func TestWebsocketUserAgentOnWire(t *testing.T) { - for _, fallback := range []string{"", "Go-http-client/1.1"} { - t.Run("fallback="+fallback, func(t *testing.T) { - testWebsocketUserAgentOnWire(t, fallback) - }) - } -} - -func testWebsocketUserAgentOnWire(t *testing.T, fallback string) { - t.Helper() for _, policy := range []string{"default", "client", "configured", "removed", "empty", "whitespace"} { want := "GPT-Load/" + version.Version - if fallback != "" { - want = fallback - } if policy == "configured" { want = "operator/2.0" } else if policy == "client" { @@ -196,9 +154,7 @@ func testWebsocketUserAgentOnWire(t *testing.T, fallback string) { _, _, _ = conn.ReadMessage() })) defer server.Close() - manager, _ := newNewAPIManagerWithOptionsForTest(t, server.URL, runtimeOptions{ - allowPrivateNetwork: true, userAgentFallback: fallback, - }) + manager, _ := newNewAPIManagerForTest(t, server.URL) spec := compatibleSpec(server.URL) spec.ChannelID = string(channel.OpenAI) spec.ClientProtocol = protocol.OpenAIResponses diff --git a/internal/execution/bifrost/websocket.go b/internal/execution/bifrost/websocket.go index f05f249db5..7a7e1da14c 100644 --- a/internal/execution/bifrost/websocket.go +++ b/internal/execution/bifrost/websocket.go @@ -13,7 +13,7 @@ import ( // OpenWebsocket 复用目标、凭据和代理合同,原生 WS 不进入 HTTP SDK 的重试链。 func (manager *RuntimeManager) OpenWebsocket(ctx context.Context, spec execution.AttemptSpec) (execution.WebsocketSession, execution.WebsocketResult) { - spec = withUserAgent(spec, manager.options.userAgentFallback) + spec = withUserAgent(spec) reject := func() (execution.WebsocketSession, execution.WebsocketResult) { failure := notSentUnaryFailure(execution.ErrorKindInvalidRequest, "unsupported native websocket request") return nil, execution.WebsocketResult{DispatchState: execution.DispatchNotSent, Error: failure.Error} diff --git a/internal/gateway/execution_forward.go b/internal/gateway/execution_forward.go index 9586532297..745b483168 100644 --- a/internal/gateway/execution_forward.go +++ b/internal/gateway/execution_forward.go @@ -977,6 +977,18 @@ func newExecutionAttemptSpec(input ForwardInput) (execution.AttemptSpec, error) for _, name := range input.Group.HeaderRules.Remove { headers.Del(name) } + for name, value := range input.Group.HeaderRules.Default { + hasValue := false + for _, existing := range headers.Values(name) { + if strings.TrimSpace(existing) != "" { + hasValue = true + break + } + } + if !hasValue { + headers.Set(name, strings.ReplaceAll(value, "${API_KEY}", input.APIKey)) + } + } sanitizeUpstreamRequestHeaders(headers) headers.Set("Accept-Encoding", "identity") spec := execution.NewAttemptSpec(execution.AttemptSpec{ diff --git a/internal/gateway/header_defaults_test.go b/internal/gateway/header_defaults_test.go new file mode 100644 index 0000000000..7d867ed51d --- /dev/null +++ b/internal/gateway/header_defaults_test.go @@ -0,0 +1,65 @@ +package gateway + +import ( + "slices" + "testing" + + "gpt-load/internal/state" +) + +func TestRequestHeaderDefaultsPreserveNonemptyClientValues(t *testing.T) { + for _, test := range []struct{ name, value, want string }{ + {"missing", "", "Go-http-client/1.1"}, + {"whitespace", " \t", "Go-http-client/1.1"}, + {"client", "client/1.0", "client/1.0"}, + } { + t.Run(test.name, func(t *testing.T) { + input := executionForwardInput() + input.Request.Header.Set("User-Agent", test.value) + input.Group.HeaderRules = state.HeaderRules{Default: map[string]string{"User-Agent": "Go-http-client/1.1", "X-Template": "${API_KEY}"}} + spec, err := newExecutionAttemptSpec(input) + if err != nil { + t.Fatal(err) + } + if got := spec.Header.Get("User-Agent"); got != test.want { + t.Fatalf("UA = %q, want %q", got, test.want) + } + if got := spec.Header.Get("X-Template"); got != input.APIKey { + t.Fatalf("template = %q", got) + } + if got := input.Request.Header.Get("User-Agent"); got != test.value { + t.Fatal("mutated client headers") + } + }) + } +} + +func TestHeaderDefaultsAreIncludedInErrorSummaryRedaction(t *testing.T) { + secrets := resolvedErrorSummarySecretValues("fixture-token", state.HeaderRules{Default: map[string]string{ + "X-Private": "fixture-private", "X-Template": "Bearer ${API_KEY}", + }}) + for _, want := range []string{"fixture-private", "Bearer fixture-token"} { + if !slices.Contains(secrets, want) { + t.Fatalf("missing redaction value %q", want) + } + } +} + +func TestHeaderDefaultsPreserveRepeatedClientValues(t *testing.T) { + for _, values := range [][]string{{"", "client-value"}, {"client-value", ""}, {"", " \t"}} { + input := executionForwardInput() + input.Request.Header["X-Tenant"] = values + input.Group.HeaderRules = state.HeaderRules{Default: map[string]string{"X-Tenant": "fallback"}} + spec, err := newExecutionAttemptSpec(input) + if err != nil { + t.Fatal(err) + } + want := values + if !slices.Contains(values, "client-value") { + want = []string{"fallback"} + } + if got := spec.Header.Values("X-Tenant"); !slices.Equal(got, want) { + t.Fatalf("values %q: got %q, want %q", values, got, want) + } + } +} diff --git a/internal/gateway/request_log.go b/internal/gateway/request_log.go index 02bc0267ae..bdda5c760c 100644 --- a/internal/gateway/request_log.go +++ b/internal/gateway/request_log.go @@ -975,6 +975,10 @@ func resolvedErrorSummarySecretValues( appendSecret(value) appendSecret(strings.ReplaceAll(value, "${API_KEY}", apiKey)) } + for _, value := range rules.Default { + appendSecret(value) + appendSecret(strings.ReplaceAll(value, "${API_KEY}", apiKey)) + } sort.SliceStable(secrets, func(left, right int) bool { return len(secrets[left]) > len(secrets[right]) }) diff --git a/internal/platform/config/config.go b/internal/platform/config/config.go index a648174057..759dd159ee 100644 --- a/internal/platform/config/config.go +++ b/internal/platform/config/config.go @@ -13,7 +13,6 @@ import ( "github.com/joho/godotenv" "github.com/pion/stun/v3" - "golang.org/x/net/http/httpguts" "gpt-load/internal/platform/authkey" "gpt-load/internal/platform/securefile" @@ -128,7 +127,6 @@ type CodexLiveICEServer struct { // Config contains static environment configuration for the application process. type Config struct { - UpstreamUserAgentFallback string ClientIPHeader string TrustedProxies []string Server ServerConfig @@ -155,11 +153,6 @@ type Settings = map[string]any // .env file is loaded when present, but existing environment variables always win. func Load() (*Config, error) { _ = godotenv.Load() - upstreamUserAgentFallback := os.Getenv("UPSTREAM_USER_AGENT_FALLBACK") - if !httpguts.ValidHeaderFieldValue(upstreamUserAgentFallback) { - return nil, fmt.Errorf("UPSTREAM_USER_AGENT_FALLBACK must be a valid HTTP header value") - } - upstreamUserAgentFallback = strings.TrimSpace(upstreamUserAgentFallback) clientIPHeader := strings.TrimSpace(os.Getenv("CLIENT_IP_HEADER")) var trustedProxies []string if value := strings.TrimSpace(os.Getenv("TRUSTED_PROXIES")); value != "" { @@ -284,9 +277,8 @@ func Load() (*Config, error) { } return &Config{ - UpstreamUserAgentFallback: upstreamUserAgentFallback, - ClientIPHeader: clientIPHeader, - TrustedProxies: trustedProxies, + ClientIPHeader: clientIPHeader, + TrustedProxies: trustedProxies, Server: ServerConfig{ Host: valueOrDefault("HOST", defaultHost), Port: port, diff --git a/internal/platform/config/config_test.go b/internal/platform/config/config_test.go index fa4bbfec76..46c789165a 100644 --- a/internal/platform/config/config_test.go +++ b/internal/platform/config/config_test.go @@ -10,39 +10,6 @@ import ( "gpt-load/internal/platform/encryption" ) -func TestLoadUpstreamUserAgentFallback(t *testing.T) { - for _, test := range []struct { - name, value, want string - invalid bool - }{ - {name: "unset"}, - {name: "explicit", value: "Go-http-client/1.1", want: "Go-http-client/1.1"}, - {name: "trim whitespace", value: " custom/1.0\t", want: "custom/1.0"}, - {name: "blank uses default", value: " \t "}, - {name: "header injection", value: "agent\r\nX-Injected: yes", invalid: true}, - {name: "trailing newline", value: "agent\n", invalid: true}, - {name: "control character", value: "agent\x01", invalid: true}, - } { - t.Run(test.name, func(t *testing.T) { - clearEnvironment(t) - t.Setenv("UPSTREAM_USER_AGENT_FALLBACK", test.value) - cfg, err := Load() - if test.invalid { - if err == nil || !strings.Contains(err.Error(), "UPSTREAM_USER_AGENT_FALLBACK") { - t.Fatalf("expected configuration error, got %v", err) - } - return - } - if err != nil { - t.Fatal(err) - } - if cfg.UpstreamUserAgentFallback != test.want { - t.Fatalf("fallback = %q, want %q", cfg.UpstreamUserAgentFallback, test.want) - } - }) - } -} - func TestLoadUsesDefaultConfiguration(t *testing.T) { clearEnvironment(t) t.Setenv("AUTH_KEY", "test-auth-key") @@ -557,7 +524,6 @@ func clearEnvironment(t *testing.T) { "CODEX_LIVE_PUBLIC_IP", "CODEX_LIVE_UDP_PORT_MIN", "CODEX_LIVE_UDP_PORT_MAX", "CODEX_LIVE_MAX_SESSIONS", "CODEX_LIVE_ICE_SERVERS", "CLIENT_IP_HEADER", "TRUSTED_PROXIES", - "UPSTREAM_USER_AGENT_FALLBACK", } { t.Setenv(key, "") } diff --git a/internal/scheduler/scheduler.go b/internal/scheduler/scheduler.go index 18d436054c..df18794027 100644 --- a/internal/scheduler/scheduler.go +++ b/internal/scheduler/scheduler.go @@ -503,6 +503,7 @@ func cloneGroupView(group state.GroupView) state.GroupView { group.Models = append([]state.ModelConfig(nil), group.Models...) group.WeightManual = cloneWeight(group.WeightManual) group.HeaderRules.Set = cloneStringMap(group.HeaderRules.Set) + group.HeaderRules.Default = cloneStringMap(group.HeaderRules.Default) group.HeaderRules.Remove = append([]string(nil), group.HeaderRules.Remove...) group.ResolvedTarget.TargetConfig = append([]byte(nil), group.ResolvedTarget.TargetConfig...) group.ParameterOverrides = group.ParameterOverrides.Clone() diff --git a/internal/state/header_defaults_test.go b/internal/state/header_defaults_test.go new file mode 100644 index 0000000000..e909d235fc --- /dev/null +++ b/internal/state/header_defaults_test.go @@ -0,0 +1,51 @@ +package state + +import ( + "testing" + + "gpt-load/internal/platform/config" +) + +func TestHeaderDefaultsValidationAndInheritance(t *testing.T) { + settings, err := ResolveRuntimeSettings(config.Settings{SettingHeaderRules: map[string]any{ + "default": map[string]any{"user-agent": "Go-http-client/1.1"}, + }}) + if err != nil { + t.Fatal(err) + } + if settings.HeaderRules.Default["User-Agent"] != "Go-http-client/1.1" { + t.Fatal(settings.HeaderRules) + } + inherited, err := ResolveGroupRuntimeSettings(settings, nil) + if err != nil { + t.Fatal(err) + } + inherited.HeaderRules.Default["User-Agent"] = "changed" + if settings.HeaderRules.Default["User-Agent"] != "Go-http-client/1.1" { + t.Fatal("shared default map") + } + overridden, err := ResolveGroupRuntimeSettings(settings, config.Settings{SettingHeaderRules: map[string]any{"set": map[string]any{"X-Group": "own"}}}) + if err != nil { + t.Fatal(err) + } + if len(overridden.HeaderRules.Default) != 0 { + t.Fatal("group override merged system defaults") + } + for _, rules := range []map[string]any{ + {"default": "invalid"}, + {"default": map[string]any{"Authorization": "secret"}}, + {"default": map[string]any{"Connection": "close"}}, + {"default": map[string]any{"X-Test": "bad\r\nvalue"}}, + {"default": map[string]any{"X-Test": 1}}, + {"default": map[string]any{"X-Test": "one", "x-test": "two"}}, + {"default": map[string]any{"X-Test": "one"}, "set": map[string]any{"x-test": "two"}}, + {"default": map[string]any{"X-Test": "one"}, "remove": []any{"x-test"}}, + } { + if err := ValidateRuntimeSetting(SettingHeaderRules, rules); err == nil { + t.Fatalf("accepted invalid rules: %#v", rules) + } + } + if err := ValidateRuntimeSetting(SettingResponseHeaderRules, map[string]any{"default": map[string]any{"X-Test": "one"}}); err == nil { + t.Fatal("response defaults are out of scope") + } +} diff --git a/internal/state/runtime_settings.go b/internal/state/runtime_settings.go index 28cb3c50d5..6cba732006 100644 --- a/internal/state/runtime_settings.go +++ b/internal/state/runtime_settings.go @@ -600,45 +600,56 @@ func parseHeaderRulesWithPolicy( return HeaderRules{}, fmt.Errorf("%s must be an object", settingName) } for key := range object { - if key != "set" && key != "remove" { + if key != "set" && key != "remove" && !(key == "default" && settingName == SettingHeaderRules) { return HeaderRules{}, fmt.Errorf("unknown %s field %q", settingName, key) } } seen := make(map[string]struct{}) - if rawSet, exists := object["set"]; exists { - set, ok := rawSet.(map[string]any) - if !ok { - return HeaderRules{}, fmt.Errorf("%s.set must be an object", settingName) - } - for name, rawValue := range set { - if !validHTTPHeaderName(name) { - return HeaderRules{}, fmt.Errorf("%s.set contains invalid header name %q", settingName, name) - } - canonicalName := textproto.CanonicalMIMEHeaderKey(name) - if forbidden != nil && forbidden(canonicalName) { - return HeaderRules{}, fmt.Errorf( - "%s.set cannot set forbidden header %q", - settingName, - canonicalName, - ) - } - identity := strings.ToLower(name) - if _, duplicate := seen[identity]; duplicate { - return HeaderRules{}, fmt.Errorf( - "%s.set contains duplicate header %q", - settingName, - canonicalName, - ) - } - seen[identity] = struct{}{} - text, ok := rawValue.(string) + for _, action := range []string{"set", "default"} { + if rawSet, exists := object[action]; exists { + set, ok := rawSet.(map[string]any) if !ok { - return HeaderRules{}, fmt.Errorf("%s.set.%s must be a string", settingName, name) - } - if !validHTTPHeaderValue(text) { - return HeaderRules{}, fmt.Errorf("%s.set.%s contains invalid header value", settingName, name) + return HeaderRules{}, fmt.Errorf("%s.%s must be an object", settingName, action) + } + for name, rawValue := range set { + if !validHTTPHeaderName(name) { + return HeaderRules{}, fmt.Errorf("%s.%s contains invalid header name %q", settingName, action, name) + } + canonicalName := textproto.CanonicalMIMEHeaderKey(name) + if forbidden != nil && forbidden(canonicalName) { + return HeaderRules{}, fmt.Errorf( + "%s.%s cannot set forbidden header %q", + settingName, + action, + canonicalName, + ) + } + identity := strings.ToLower(name) + if _, duplicate := seen[identity]; duplicate { + return HeaderRules{}, fmt.Errorf( + "%s.%s contains duplicate header %q", + settingName, + action, + canonicalName, + ) + } + seen[identity] = struct{}{} + text, ok := rawValue.(string) + if !ok { + return HeaderRules{}, fmt.Errorf("%s.%s.%s must be a string", settingName, action, name) + } + if !validHTTPHeaderValue(text) { + return HeaderRules{}, fmt.Errorf("%s.%s.%s contains invalid header value", settingName, action, name) + } + if action == "default" { + if rules.Default == nil { + rules.Default = make(map[string]string) + } + rules.Default[canonicalName] = text + } else { + rules.Set[canonicalName] = text + } } - rules.Set[canonicalName] = text } } if rawRemove, exists := object["remove"]; exists { @@ -689,6 +700,12 @@ func cloneHeaderRules(source HeaderRules) HeaderRules { cloned.Set[name] = value } cloned.Remove = append([]string(nil), source.Remove...) + if source.Default != nil { + cloned.Default = make(map[string]string, len(source.Default)) + for name, value := range source.Default { + cloned.Default[name] = value + } + } return cloned } diff --git a/internal/state/snapshot.go b/internal/state/snapshot.go index 74c725c293..6831ce4152 100644 --- a/internal/state/snapshot.go +++ b/internal/state/snapshot.go @@ -142,19 +142,23 @@ type TimeoutConfig struct { } type HeaderRules struct { - Set map[string]string - Remove []string + Set map[string]string + Remove []string + Default map[string]string } -// ConfiguredNames 标记显式设置或移除的字段,区分规则与客户端原始请求头。 +// ConfiguredNames 标记规则管理的字段,区分规则与客户端原始请求头。 func (rules HeaderRules) ConfiguredNames() []string { - if len(rules.Set)+len(rules.Remove) == 0 { + if len(rules.Set)+len(rules.Remove)+len(rules.Default) == 0 { return nil } names := make([]string, 0, len(rules.Set)+len(rules.Remove)) for name := range rules.Set { names = append(names, name) } + for name := range rules.Default { + names = append(names, name) + } return append(names, rules.Remove...) } diff --git a/web/src/frontends/classic/api/control/types.ts b/web/src/frontends/classic/api/control/types.ts index ad5bffe8c3..a4287a1d23 100644 --- a/web/src/frontends/classic/api/control/types.ts +++ b/web/src/frontends/classic/api/control/types.ts @@ -99,6 +99,7 @@ export interface GroupSummaryDto { } export interface HeaderRulesDto { + default?: Record set: Record remove: string[] } diff --git a/web/src/frontends/classic/app/resources/groups.ts b/web/src/frontends/classic/app/resources/groups.ts index ad9c416887..7e28973b56 100644 --- a/web/src/frontends/classic/app/resources/groups.ts +++ b/web/src/frontends/classic/app/resources/groups.ts @@ -141,6 +141,7 @@ const groupRuntimeSettingFields = [...runtimeSettingFields, 'parameter_overrides export interface HeaderRulesDto { set: Record remove: string[] + default?: Record } export interface GroupRuntimeConfigDto { @@ -307,7 +308,7 @@ function projectChannelParams(value: unknown): ChannelParamsDto { function projectHeaderRules(value: unknown): HeaderRulesDto { const record = projectRecord(value) - assertNoSecretLikeFields(record, ['set', 'remove']) + assertNoSecretLikeFields(record, ['set', 'remove', 'default']) const setRecord = projectRecord(record.set) const set: Record = {} for (const [name, headerValue] of Object.entries(setRecord)) { @@ -316,6 +317,16 @@ function projectHeaderRules(value: unknown): HeaderRulesDto { } return { set, + ...(record.default === undefined + ? {} + : { + default: Object.fromEntries( + Object.entries(projectRecord(record.default)).map(([name, value]) => [ + name, + projectString(value, { allowEmpty: true }), + ]), + ), + }), remove: projectArray(record.remove, projectNonBlankString), } } diff --git a/web/src/frontends/classic/app/resources/settings.ts b/web/src/frontends/classic/app/resources/settings.ts index 9ba06ff04c..931c933266 100644 --- a/web/src/frontends/classic/app/resources/settings.ts +++ b/web/src/frontends/classic/app/resources/settings.ts @@ -205,7 +205,7 @@ function invalidResponse(): never { function projectHeaderRules(value: unknown): HeaderRulesDto { const record = projectRecord(value) - assertNoSecretLikeFields(record, ['set', 'remove']) + assertNoSecretLikeFields(record, ['set', 'remove', 'default']) const setRecord = projectRecord(record.set) const set: Record = {} for (const [name, headerValue] of Object.entries(setRecord)) { @@ -214,6 +214,16 @@ function projectHeaderRules(value: unknown): HeaderRulesDto { } return { set, + ...(record.default === undefined + ? {} + : { + default: Object.fromEntries( + Object.entries(projectRecord(record.default)).map(([name, value]) => [ + name, + projectString(value, { allowEmpty: true }), + ]), + ), + }), remove: projectArray(record.remove, (name) => { const projected = projectString(name) if (projected.trim().length === 0 || projected !== projected.trim()) invalidResponse() diff --git a/web/src/frontends/classic/components/config/HeaderRulesEditor.vue b/web/src/frontends/classic/components/config/HeaderRulesEditor.vue index b2efdc8330..696d35f1ab 100644 --- a/web/src/frontends/classic/components/config/HeaderRulesEditor.vue +++ b/web/src/frontends/classic/components/config/HeaderRulesEditor.vue @@ -63,11 +63,21 @@ function normalizeRules(value: HeaderRulesDto): HeaderRulesDto { Object.entries(value.set).sort(([left], [right]) => compareHeaderNames(left, right)), ) const remove = [...value.remove].sort(compareHeaderNames) - return { set, remove } + const defaults = Object.fromEntries( + Object.entries(value.default ?? {}).sort(([left], [right]) => compareHeaderNames(left, right)), + ) + return { set, remove, ...(Object.keys(defaults).length ? { default: defaults } : {}) } } function createRows(value: HeaderRulesDto): RuleRow[] { return [ + ...Object.entries(value.default ?? {}).map(([name, headerValue]) => ({ + key: nextKey++, + action: 'default' as const, + name, + value: headerValue, + revealed: false, + })), ...Object.entries(value.set).map(([name, headerValue]) => ({ key: nextKey++, action: 'set' as const, @@ -89,6 +99,7 @@ function rulesFromRows(): HeaderRulesDto { const rules: HeaderRulesDto = { set: {}, remove: [] } for (const row of rows.value) { if (row.action === 'set') rules.set[row.name] = row.value + else if (row.action === 'default') (rules.default ??= {})[row.name] = row.value else rules.remove.push(row.name) } return rules @@ -100,6 +111,11 @@ function sameRules(left: HeaderRulesDto, right: HeaderRulesDto): boolean { function rowsMatchRules(rows: readonly RuleRow[], rules: HeaderRulesDto): boolean { const expected = [ + ...Object.entries(rules.default ?? {}).map(([name, value]) => ({ + action: 'default' as const, + name, + value, + })), ...Object.entries(rules.set).map(([name, value]) => ({ action: 'set' as const, name, value })), ...rules.remove.map((name) => ({ action: 'remove' as const, name, value: '' })), ] @@ -273,6 +289,15 @@ function rowError(row: RuleRow, field: 'name' | 'value'): string | undefined { > {{ t('common.headerRules.set') }} +