jianf/homeagent-sdk
1
0
Fork 0
mirror of https://gitcode.com/JianFeeeee/homeagent-sdk.git synced 2026-09-30 14:23:00 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
a176cc3e20ce31f2fc9cc6f15b6d131e77f41baa
homeagent-sdk/docs/api/stages.md
JianFeeeee a176cc3e20 feat(sdk): 反代声明（ProxyDef / RegisterProxy）—— 插件声明服务，HomeAgent 反代出去 
配套核心仓「webui 通用反向代理」。SDK 1.4.0 尚未发布，接口未冻结，
本次按开发期自由变更处理（正式发版时并入版本号推进）。

## 声明契约

plugin.json 的 proxies 字段（声明式，静态可发现）或 RegisterProxy
（运行期，供没有 plugin.json 的内置插件用）：

    {"name":"ui","host":"myapp","path":"/p/myapp","strip_path":true,
     "target":"127.0.0.1:12100","auth":"homeagent"}

命名与既有能力对齐（ToolDef / ChannelDef / ConfigDef / RegisterTool /
ToolRegistrar）——第一版写成 ProxyDecl / DeclareProxy / ProxyDeclarer
被评审指出「跟 SDK 其他接口不是一个风格」，已全面改名。

## strip_path：Path 的两种语义

Path 不能一刀切成「原样保留」，真实需求有两种且**不能自动判定**
（同一个 path 在两种语义下都说得通，猜错即全部 404 且像上游故障）：

  strip_path 缺省/false（别名模式）—— path 是上游真实路径的一部分
    /api/v1/device/ws + path=/api/v1/device → 上游收到原样
    适用：客户端**已硬编码**路径的机器接口（设备网关即如此）

  strip_path=true（前缀模式）—— path 只是门户上的挂载点
    /p/myapp/api/status + path=/p/myapp → 上游收到 /api/status
    适用：自带 UI 的服务（前端用相对路径）

非法组合（strip_path 而无 path）被 ValidateProxyDef 挡住。

## 单一入口原则（契约级要求）

一个声明 = 一个入口。两种挂载形态对「根路径」处理截然不同：
Host 形态下根路径是插件的根（fetch('/api/x') 天然正确）；
Path 形态下根路径**属于门户**，同样代码会打到门户自己身上
（静默错路由：页面能开、功能全坏）。

故被反代的插件必须**一律使用相对路径**，绝不硬编码以 / 开头的绝对路径。
这样同一份前端在两种形态下都正确，插件不必知道自己被挂在哪，
反代层也能按外部条件（子域是否有证书/放行）自由选择形态。

## 判据

sdk/proxy_test.go：两种语义的映射、非法组合、单一入口原则的契约存在性。
hmapdev proxy_config_test.go：schema 漂移保护（新增字段忘了同步就判红）、
非法声明在**打包时**就被拒（不必装到 HomeAgent 才看到）。

两模块 go test 全绿；文档站已重新生成（ProxyDef 与单一入口原则进入
docs/api/misc.md 与 llms-full.txt）。

## 顺带修回的一处（此前随工作树丢失）

writePluginJSON 漏写 proxies 键 —— 漏写的话插件装得上、启动正常、
就是不出现，没有任何报错。该 bug 曾在核心仓侧出现过（判据抓到过），
这次移植时由 TestWritePluginJSONPreservesProxies 再次判红并修复。
2026-09-26 14:08:30 +08:00

4.4 KiB
Raw Blame History

阶段钩子（Stages）

在消息处理管道的固定点位插入自己的逻辑。阶段比工具更底层：工具是模型主动调用的，阶段是流程经过时必然触发的。

StageContext.IsResponded

func (c *StageContext) IsResponded() bool

plugin.go:172

StageContext.Lock

func (c *StageContext) Lock()

示例插件里的真实用法

插件 位置 代码
a2a example/a2a/plugin.go:158 p.sessMu.Lock()
acp example/acp/plugin.go:128 p.srvMu.Lock()
browser example/browser/plugin.go:427 p.mu.Lock()
calendar example/calendar/plugin.go:433 p.mu.Lock()

plugin.go:170

StageContext.RLock

func (c *StageContext) RLock()

示例插件里的真实用法

插件 位置 代码
acp example/acp/plugin.go:267 p.mu.RLock()
calendar example/calendar/plugin.go:649 p.mu.RLock()
memo example/memo/plugin.go:224 p.mu.RLock()
qq example/qq/plugin.go:1152 ctx.RLock()

plugin.go:168

StageContext.RUnlock

func (c *StageContext) RUnlock()

示例插件里的真实用法

插件 位置 代码
acp example/acp/plugin.go:273 p.mu.RUnlock()
calendar example/calendar/plugin.go:650 defer p.mu.RUnlock()
memo example/memo/plugin.go:229 p.mu.RUnlock()
qq example/qq/plugin.go:1155 ctx.RUnlock()

plugin.go:169

PluginSDK.RegisterStage

func (s *PluginSDK) RegisterStage(stage Stage, handler StageHandler, scope ...StageScope)

RegisterStage registers a handler for a pipeline stage.

scope: StageScopeGlobal (default) — receives all stage events.
       StageScopeOwnTools — only before_toolcall/after_toolcall for this plugin's tools.

示例插件里的真实用法

插件 位置 代码
memo example/memo/plugin.go:152 s.RegisterStage(sdk.StagePreAction, p.stagePreAction)
qq example/qq/plugin.go:719 s.RegisterStage(sdk.StageOnInput, p.onInputAuthContext, sdk.StageScopeGlobal)
sanitizer example/sanitizer/plugin.go:52 s.RegisterStage(sdk.StageOnInput, func(ctx *sdk.StageContext) error {
weather example/weather/plugin.go:94 s.RegisterStage(sdk.StageAfterToolcall, func(ctx *sdk.StageContext) error {

plugin.go:472

Stage

type Stage string

Stage represents a point in the message processing pipeline.

plugin.go:26

StageContext

type StageContext struct { mu sync.RWMutex RawMessage string UserID string GroupID string ContextMsgs []map[string]interface{} L …

StageContext provides context for stage handlers.

plugin.go:148

StageHandler

type StageHandler func(ctx *StageContext) error

StageHandler is a function that handles a pipeline stage event.

plugin.go:23

StageRegistrar

type StageRegistrar func(stage Stage, handler StageHandler)

StageRegistrar registers a stage handler.

plugin.go:308

StageScope

type StageScope int

StageScope controls which events a stage handler receives.

plugin.go:294

StageContext.Unlock

func (c *StageContext) Unlock()

示例插件里的真实用法

插件 位置 代码
a2a example/a2a/plugin.go:164 p.sessMu.Unlock()
acp example/acp/plugin.go:129 defer p.srvMu.Unlock()
browser example/browser/plugin.go:432 p.mu.Unlock()
calendar example/calendar/plugin.go:523 p.mu.Unlock()

plugin.go:171