prefs: General preference reads, merges and persistence

中文 · Parent architecture

Integration from other modules

Integration here means other Go packages in this repository. Go internal import rules restrict imports from outside the repository; HTTP clients use mounted gateway endpoints.

Mount with configuration and trusted storage. Merge YAML and database overlays on reads, update explicitly submitted fields on writes, and keep inference policy in route templates.

Integration demo

Use this integration helper during startup. The host must implement the required interfaces; reg can be a gateway Server. For a standard ServeMux, adapt Handle as in the health demo. The helper compiles but needs a complete host to execute; the HTTP demo below checks the mounted endpoint.

package demo

import (
	"github.com/sunqirui1987/xhub/internal/gateway/prefs"
	"github.com/sunqirui1987/xhub/internal/util"
)

// MountDemo 演示启动时挂载模块；h 提供真实宿主能力，reg 接收路由，返回无。
// 调用方须先初始化依赖；挂载会修改路由表，不执行 HTTP 请求。
func MountDemo(h prefs.Host, reg util.Registrar) { prefs.Module(h).Mount(reg) }

Start a configured local gateway first. Set XHUB_DEMO_TOKEN to a session token authorized for this endpoint. See wire.go and routes.go for complete host wiring; do not substitute nil dependencies.

Run the following commands from the repository root.

curl -sS -i "http://localhost:4000/config/list" \
  -H "Authorization: Bearer $XHUB_DEMO_TOKEN"

General preference page data; reading does not schedule inference.

Errors, state, and side effects

Missing and explicit-zero values differ; database values override YAML by key. Writes require management authorization; do not persist UI defaults unconditionally.

Responsibility

General preference reads, merges and persistence. No routing execution; absence differs from zero; merge order determines effective settings.

Review order

host.go / mount.go → settings.go / page.go → merge.go

Read injected interfaces or input contracts first, then entry points, helpers and adjacent tests. Inspect parent callers when changing request lifecycle behavior.

Dependencies

Host injects storage, authentication and configuration.

Verification

Adjacent tests: merge_test.go; cmd/regression/design_cleanup_test.go

From repository root: go test ./internal/gateway/prefs -count=1

Real HTTP/persistence contracts belong in cmd/regression; browser → gateway → local upstream flows belong in frontend/e2e. Private schemas and temporary fixtures are cleaned up. Offline tests do not assume paid vendor credentials.