mirror of
https://gitcode.com/JianFeeeee/homeagent-sdk.git
synced 2026-09-21 09:28:04 +00:00
Compare commits
14 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| da046b2520 | |||
| 4cb3a0bda4 | |||
| e50bffa34f | |||
| 934eb4da7d | |||
| 4f4a03d368 | |||
| 4482235312 | |||
| 4cf2df5be6 | |||
| ebd700eaf9 | |||
| 7c0b7a1fb0 | |||
| 8c10b7ecc7 | |||
| fcb7490f63 | |||
| 9206353858 | |||
| 83a54f321e | |||
| b93fe6b878 |
59
README.md
59
README.md
@ -84,11 +84,15 @@ type Plugin interface {
|
||||
|
||||
通过 `Start(sdk *PluginSDK)` 注入的 SDK 实例提供以下方法:
|
||||
|
||||
> **通道的方向契约**:入站与出站是分开登记的两件事。凡是用 `InjectText*/InjectInput*/InjectInterrupt*`
|
||||
> 注入的通道名都要 `RegisterInputChannel` —— inputch 是内核最基本的**输入路由单位**,
|
||||
> 只有登记过的通道才能被"划给驻留子";只登记出站通道时内核会兜底登记同名 inputch 并告警(兼容老插件)。
|
||||
|
||||
| 分类 | 方法 | 说明 |
|
||||
|------|------|------|
|
||||
| 阶段钩子 | `RegisterStage(stage, handler, scope...)` | 注册阶段回调,scope 可选:`StageScopeGlobal`(全局,默认)或 `StageScopeOwnTools`(仅自己工具) |
|
||||
| 输入通道 | `RegisterInputChannel(name, def)` | 注册输入通道,def 为 `ChannelDef`(NoMemory/Cleaner) |
|
||||
| 输出通道 | `RegisterOutputChannel(name, caps, desc, def, handler)` | 注册输出通道,def 为 `ChannelDef`,caps 为能力位掩码 |
|
||||
| 输入通道 | `RegisterInputChannel(name, def)` | 注册输入通道(**入站**:谁会往这个通道注入输入),def 为 `ChannelDef`(NoMemory/Cleaner) |
|
||||
| 输出通道 | `RegisterOutputChannel(name, caps, desc, def, handler)` | 注册输出通道(**出站**:`output_send__<name>` 的回复发给谁),def 为 `ChannelDef`,caps 为能力位掩码 |
|
||||
| 工具注册 | `RegisterTool(name, def, handler)` | 注册工具供 LLM 调用 |
|
||||
| 插件 API | `RegisterPluginAPI(name)` | 注册插件 API 供其他插件访问 |
|
||||
| 图记忆 | `Memory()` | 访问图记忆 API(实体-关系存储) |
|
||||
@ -473,6 +477,57 @@ ctx.Unlock()
|
||||
|
||||
内部插件(平台内置)拥有完整 SDK 访问权限,包括 SocialAPI 写操作和 EventPublisher。
|
||||
|
||||
## 项目声明 SDK 版本(plg.json 的 `sdk` 字段)
|
||||
|
||||
`hmapdev init` 生成的工程里,`plg.json` 会带一个 `sdk` 字段:
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "MyPlugin",
|
||||
"version": "0.1.0",
|
||||
"entry": "plugin.bin",
|
||||
"sdk": "1.2.0"
|
||||
}
|
||||
```
|
||||
|
||||
它的语义是**本插件针对的 SDK 版本**,工具链据此在本地 SDK 存储里选择版本:
|
||||
命中就用它,并把 `go.mod` 的 `require`/`replace` 同步到该版本;未命中则**明确报错**
|
||||
(列出已装版本 + `hmapdev sdk install vX.Y.Z`),**绝不静默退化成 `current`**。
|
||||
|
||||
```bash
|
||||
$ hmapdev build
|
||||
[hmapdev] SDK 1.2.0(项目声明 sdk=1.2.0)
|
||||
```
|
||||
|
||||
为什么要这个字段:以前项目里没有任何「我要哪版 SDK」的声明,工具链只能用存储里的
|
||||
`current`——谁改过 `current` 就拿谁的版本编,出错时表现为一堆看不懂的编译错误
|
||||
(例如存储里只有陈旧的 `v0.8.0` 时,模板项目首次构建会报 `undefined: sdk.InjectOptions`)。
|
||||
|
||||
**写法必须是完整版本号(`1.2.0`),不接受区间写法(`1.2`)。** 原因见上文的版本纪律:
|
||||
SDK 版本跟随内核中版本、patch 位恒为 `.0`,一条内核线只对应一个 SDK 版本;
|
||||
写区间会让人误以为同一条线里还能挑不同 SDK(工具链会直接拒绝并说明这条规矩)。
|
||||
|
||||
- 显式 `--sdk-path` 或 `plg.json` 的 `sdk_path` 优先(本机改 SDK 联调时用);
|
||||
- 存量工程(`plg.json` 没有 `sdk` 字段)行为不变,仍按 `current` 构建;
|
||||
- 产物 `.hmap` 里的 `plugin.json` 会记录**实际选中的 SDK 版本**,便于事后追溯。
|
||||
|
||||
## IDE 支持:VSCode 扩展(`tools/vscode-hmapdev`)
|
||||
|
||||
调试插件的实操回路是「构建 → 运行 → 看内核日志」,这三步都在 IDE 之外很别扭,
|
||||
所以仓库里带了一个 VSCode 扩展([tools/vscode-hmapdev](tools/vscode-hmapdev)):
|
||||
|
||||
- **plg.json 诊断**:必需字段、`sdk` 是否是完整版本号、声明的 SDK 是否已安装(直接给安装命令);
|
||||
- **状态栏**:`插件 · SDK <声明> · hmapdev <版本>`,工具链缺失或工程有错时变色;
|
||||
- **命令 / 任务**:build / build(全部目标)/ clean / debug(解释执行),编译错误进 Problems;
|
||||
- **跟随内核日志**:读 `<dataDir>/log` 下最新的 `homed_*.log` 并按插件名过滤。
|
||||
|
||||
```bash
|
||||
cd tools/vscode-hmapdev && npm install && npm run compile # 然后在 VSCode 里按 F5
|
||||
```
|
||||
|
||||
它不是源码级调试器(没有断点/单步):插件要么编译成产物在内核里跑、要么用
|
||||
`hmapdev debug` 解释执行,两条路都没有 DAP 会话;扩展做的是构建、运行、看日志与清单校验。
|
||||
|
||||
## 示例插件
|
||||
|
||||
| 插件 | 类型 | 说明 |
|
||||
|
||||
@ -24,8 +24,8 @@ type Plugin struct {
|
||||
|
||||
// 会话表:session_id → 上下文前缀。A2A 无状态协议下由插件侧维护
|
||||
// 多轮上下文:同 session 的后续请求会把之前的对话拼进注入文本。
|
||||
sessMu sync.Mutex
|
||||
sessions map[string]*a2aSession
|
||||
sessMu sync.Mutex
|
||||
sessions map[string]*a2aSession
|
||||
}
|
||||
|
||||
// a2aSession 记录一个会话的轮次历史,用于延续上下文。
|
||||
@ -47,6 +47,9 @@ func (p *Plugin) Start(s *sdk.PluginSDK) error {
|
||||
s.SetAutoRestart(true)
|
||||
p.sdk = s
|
||||
p.sessions = make(map[string]*a2aSession)
|
||||
// 入站通道:本插件用 p.name 通道注入输入(见 InjectInputSync 调用),
|
||||
// 输入侧必须显式登记 —— 否则"把该 inputch 划给驻留子"会报 `inputch 未注册`。
|
||||
_ = s.RegisterInputChannel(p.name, sdk.ChannelDef{})
|
||||
tp := p.name + "_"
|
||||
|
||||
// 注册自身为输出通道:agent 回复 emit 到本通道时有落点,
|
||||
@ -66,7 +69,7 @@ func (p *Plugin) Start(s *sdk.PluginSDK) error {
|
||||
Key: "listen", Default: "127.0.0.1:12000",
|
||||
Type: "string", DisplayName: "监听地址",
|
||||
Description: "A2A 服务端监听地址,设为空可禁用 HTTP 服务",
|
||||
Category: p.name,
|
||||
Category: p.name,
|
||||
})
|
||||
|
||||
// Outbound: query + discover
|
||||
@ -75,10 +78,10 @@ func (p *Plugin) Start(s *sdk.PluginSDK) error {
|
||||
Parameters: map[string]interface{}{
|
||||
"type": "object",
|
||||
"properties": map[string]interface{}{
|
||||
"agent_url": map[string]interface{}{"type": "string", "description": "目标 Agent 的 A2A 端点 URL"},
|
||||
"query": map[string]interface{}{"type": "string", "description": "发送给目标 Agent 的文本查询"},
|
||||
"agent_url": map[string]interface{}{"type": "string", "description": "目标 Agent 的 A2A 端点 URL"},
|
||||
"query": map[string]interface{}{"type": "string", "description": "发送给目标 Agent 的文本查询"},
|
||||
"session_id": map[string]interface{}{"type": "string", "description": "可选。上次调用返回的 session_id,传入可延续与该 agent 的多轮对话上下文"},
|
||||
"timeout": map[string]interface{}{"type": "integer", "description": "超时时间(秒),默认 60"},
|
||||
"timeout": map[string]interface{}{"type": "integer", "description": "超时时间(秒),默认 60"},
|
||||
},
|
||||
"required": []string{"agent_url", "query"},
|
||||
},
|
||||
@ -287,7 +290,7 @@ func (p *Plugin) handleIncomingA2A(w http.ResponseWriter, r *http.Request) {
|
||||
Query string `json:"query,omitempty"`
|
||||
SessionID string `json:"session_id,omitempty"`
|
||||
Limit int `json:"limit,omitempty"`
|
||||
Message *struct {
|
||||
Message *struct {
|
||||
Role string `json:"role"`
|
||||
Parts []struct {
|
||||
Text string `json:"text,omitempty"`
|
||||
@ -347,7 +350,7 @@ func (p *Plugin) handleIncomingA2A(w http.ResponseWriter, r *http.Request) {
|
||||
if sess := p.sessions[sessionID]; sess != nil {
|
||||
sess.History = append(sess.History, "用户: "+queryText, "助手: "+reply)
|
||||
if len(sess.History) > maxSessionTurns*2 {
|
||||
sess.History = sess.History[len(sess.History)-maxSessionTurns*2 :]
|
||||
sess.History = sess.History[len(sess.History)-maxSessionTurns*2:]
|
||||
}
|
||||
sess.LastUsed = time.Now()
|
||||
}
|
||||
@ -357,11 +360,11 @@ func (p *Plugin) handleIncomingA2A(w http.ResponseWriter, r *http.Request) {
|
||||
"jsonrpc": "2.0",
|
||||
"id": req.ID,
|
||||
"result": map[string]interface{}{
|
||||
"id": fmt.Sprintf("task_%d", time.Now().UnixNano()),
|
||||
"status": "completed",
|
||||
"id": fmt.Sprintf("task_%d", time.Now().UnixNano()),
|
||||
"status": "completed",
|
||||
"session_id": sessionID,
|
||||
"message": map[string]interface{}{
|
||||
"role": "agent",
|
||||
"role": "agent",
|
||||
"parts": []map[string]string{{"type": "text", "text": reply}},
|
||||
},
|
||||
},
|
||||
@ -457,10 +460,10 @@ type A2AResponse struct {
|
||||
}
|
||||
|
||||
type A2AResult struct {
|
||||
TaskID string `json:"id,omitempty"`
|
||||
Status string `json:"status,omitempty"`
|
||||
SessionID string `json:"session_id,omitempty"`
|
||||
Message *A2AMessage `json:"message,omitempty"`
|
||||
TaskID string `json:"id,omitempty"`
|
||||
Status string `json:"status,omitempty"`
|
||||
SessionID string `json:"session_id,omitempty"`
|
||||
Message *A2AMessage `json:"message,omitempty"`
|
||||
AgentCard *A2AAgentCard `json:"agent_card,omitempty"`
|
||||
}
|
||||
|
||||
|
||||
@ -47,6 +47,9 @@ func (p *Plugin) Start(s *sdk.PluginSDK) error {
|
||||
s.SetAutoRestart(true)
|
||||
p.sdk = s
|
||||
p.sessions = make(map[string]*sessionState)
|
||||
// 入站通道:本插件用 p.name 通道注入输入(见 InjectInputSync 调用),
|
||||
// 输入侧必须显式登记 —— 否则"把该 inputch 划给驻留子"会报 `inputch 未注册`。
|
||||
_ = s.RegisterInputChannel(p.name, sdk.ChannelDef{})
|
||||
tp := p.name + "_"
|
||||
|
||||
// 注册自身为输出通道:agent 回复 emit 到本通道时有落点。
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
"name": "browser",
|
||||
"name_zh": "浏览器",
|
||||
"name_en": "Browser",
|
||||
"version": "2.3.0",
|
||||
"version": "2.4.1",
|
||||
"description": "统一浏览器插件:搜索、HTTP抓取(quick)、无头渲染(normal)、交互式浏览器(interactive/CDP)",
|
||||
"author": "HomeAgent",
|
||||
"entry": "plugin.so",
|
||||
|
||||
@ -6,6 +6,7 @@ import (
|
||||
"encoding/base64"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"html"
|
||||
"io"
|
||||
"log"
|
||||
"net"
|
||||
@ -45,20 +46,20 @@ type Plugin struct {
|
||||
// 登录态/cookies 跨 agent、跨会话、跨插件重启保留),每个 start 创建一个
|
||||
// 新标签页(CDP Target)。同 source 复用自己的标签页。浏览器进程在
|
||||
// 最后一个标签页关闭后保留(避免反复冷启动),仅插件 Stop 时回收。
|
||||
sharedAllocCtx context.Context
|
||||
sharedAllocCtx context.Context
|
||||
sharedAllocCancel context.CancelFunc
|
||||
sharedMu sync.Mutex
|
||||
sharedMu sync.Mutex
|
||||
}
|
||||
|
||||
type BrowserSession struct {
|
||||
id string
|
||||
allocCtx context.Context // 共享浏览器进程上下文(shared=true 时指向全局单例)
|
||||
cancel context.CancelFunc
|
||||
ctx context.Context // 本会话的 Target 上下文(一个标签页)
|
||||
createdAt time.Time
|
||||
timeout time.Duration
|
||||
closed bool
|
||||
mu sync.Mutex
|
||||
id string
|
||||
allocCtx context.Context // 共享浏览器进程上下文(shared=true 时指向全局单例)
|
||||
cancel context.CancelFunc
|
||||
ctx context.Context // 本会话的 Target 上下文(一个标签页)
|
||||
createdAt time.Time
|
||||
timeout time.Duration
|
||||
closed bool
|
||||
mu sync.Mutex
|
||||
currentURL string
|
||||
shared bool // true=共享浏览器的一个标签页;false=独占浏览器实例
|
||||
profileDir string // 非空表示使用持久化 profile(关闭时不删目录)
|
||||
@ -159,6 +160,18 @@ func errResult(msg string) map[string]interface{} {
|
||||
return map[string]interface{}{"isError": true, "content": msg}
|
||||
}
|
||||
|
||||
func parseBrowserSessionTimeout(args map[string]interface{}) (time.Duration, error) {
|
||||
raw := strings.TrimSpace(readArg(args, "timeout", ""))
|
||||
if raw == "" {
|
||||
return 0, fmt.Errorf("timeout is required;创建浏览器会话时必须明确指定关闭时长,如 15m 或 2h")
|
||||
}
|
||||
timeout, err := time.ParseDuration(raw)
|
||||
if err != nil || timeout <= 0 {
|
||||
return 0, fmt.Errorf("invalid timeout %q;请使用大于 0 的时长,如 15m 或 2h", raw)
|
||||
}
|
||||
return timeout, nil
|
||||
}
|
||||
|
||||
func newHTTPClient(timeout int, proxyURL string) *http.Client {
|
||||
transport := &http.Transport{
|
||||
DialContext: (&net.Dialer{
|
||||
@ -191,6 +204,9 @@ func newHTTPClient(timeout int, proxyURL string) *http.Client {
|
||||
func (p *Plugin) Start(s *sdk.PluginSDK) error {
|
||||
p.sdk = s
|
||||
s.SetAutoRestart(true)
|
||||
// 入站通道:本插件用 p.name 通道注入输入(见 InjectInputSync 调用),
|
||||
// 输入侧必须显式登记 —— 否则"把该 inputch 划给驻留子"会报 `inputch 未注册`。
|
||||
_ = s.RegisterInputChannel(p.name, sdk.ChannelDef{})
|
||||
|
||||
s.Settings().RegisterDef(sdk.ConfigDef{
|
||||
Key: "timeout", Default: "30", Type: "int",
|
||||
@ -276,14 +292,15 @@ func (p *Plugin) Start(s *sdk.PluginSDK) error {
|
||||
|
||||
s.RegisterTool(tp+"start", sdk.ToolDef{
|
||||
Name: tp + "start",
|
||||
Description: "启动交互式浏览器会话。优先连接 systemd 托管的共享浏览器后端(登录态全机共享、各 agent 独立标签页);后端未安装时返回 need_install 引导(调 browser_install);无法安装时自动降级本地临时模式。同来源复用已有标签页。",
|
||||
Description: "启动交互式浏览器会话。Agent 必须在创建时明确指定 timeout;到期后插件关闭标签页。同来源复用已有标签页时,也按本次 timeout 重新设定关闭时间。",
|
||||
Parameters: map[string]interface{}{
|
||||
"type": "object",
|
||||
"properties": map[string]interface{}{
|
||||
"url": map[string]interface{}{"type": "string", "description": "初始导航 URL(可选)"},
|
||||
"timeout": map[string]interface{}{"type": "string", "description": "会话超时(如 5m, 10m,默认 10m)"},
|
||||
"timeout": map[string]interface{}{"type": "string", "description": "必填,会话关闭前的存活时长,如 15m、2h;必须大于 0"},
|
||||
"profile": map[string]interface{}{"type": "string", "description": "持久化档案名(可选,如 main)。同名档案共享登录态与浏览历史;不指定则为一次性临时会话"},
|
||||
},
|
||||
"required": []string{"timeout"},
|
||||
},
|
||||
}, p.handleBrowserStart)
|
||||
|
||||
@ -471,7 +488,9 @@ type searchResult struct {
|
||||
}
|
||||
|
||||
func (p *Plugin) bingSearch(query string, count int) ([]searchResult, error) {
|
||||
u := fmt.Sprintf("https://www.bing.com/search?q=%s&count=%d", url.QueryEscape(query), count)
|
||||
// 用 cn.bing.com:www.bing.com 对程序化请求常回 302(同意/重定向页),拿不到结果块。
|
||||
// 另:Bing 忽略 count 参数,翻页靠 first=,这里保留 count 只为兼容旧调用语义。
|
||||
u := fmt.Sprintf("https://cn.bing.com/search?q=%s&first=1&count=%d&setlang=zh-CN", url.QueryEscape(query), count)
|
||||
req, _ := http.NewRequest("GET", u, nil)
|
||||
req.Header.Set("User-Agent", "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36")
|
||||
req.Header.Set("Accept-Language", "zh-CN,zh;q=0.9,en;q=0.8")
|
||||
@ -481,38 +500,112 @@ func (p *Plugin) bingSearch(query string, count int) ([]searchResult, error) {
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
body, _ := io.ReadAll(resp.Body)
|
||||
return parseBingResults(string(body), count), nil
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
return nil, fmt.Errorf("Bing 返回 HTTP %d(%d 字节)", resp.StatusCode, len(body))
|
||||
}
|
||||
results := parseBingResults(string(body), count)
|
||||
if len(results) == 0 {
|
||||
// 关键:把「解析不出来」与「真的没结果」区分开。
|
||||
// 以前两者都变成 "No results found.",版式一变就静默退化成「搜不到」。
|
||||
return nil, fmt.Errorf("Bing 返回 %d 字节但未解析出结果(可能被反爬或版式变更,可改用 deepsearch 插件)", len(body))
|
||||
}
|
||||
return results, nil
|
||||
}
|
||||
|
||||
func parseBingResults(html string, count int) []searchResult {
|
||||
var (
|
||||
bingBlockRe = regexp.MustCompile(`<li class="b_algo"`)
|
||||
bingTitleRe = regexp.MustCompile(`(?s)<h2[^>]*>\s*<a[^>]+href="([^"]+)"[^>]*>(.*?)</a>`)
|
||||
bingAnyLinkRe = regexp.MustCompile(`(?s)<a[^>]+href="([^"]+)"[^>]*>(.*?)</a>`)
|
||||
bingSnipRe = regexp.MustCompile(`(?s)<p class="b_lineclamp[^"]*"[^>]*>(.*?)</p>`)
|
||||
bingCaptionRe = regexp.MustCompile(`(?s)<div class="b_caption"[^>]*>(.*?)</div>`)
|
||||
)
|
||||
|
||||
// splitBingBlocks 按块标记切分,每块内容延伸到下一个块标记为止。
|
||||
//
|
||||
// 不用 `<li class="b_algo"(?s)(.*?)</li>`:结果块内部可能嵌套 <li>(deep links),
|
||||
// 非贪婪匹配会在错误位置截断;而且块内第一个 <a> 往往是 Bing 的「来源行」,
|
||||
// 取到的是 `deepin.orghttps://www.deepin.org` 这种垃圾标题。
|
||||
func splitBingBlocks(pageHTML string) []string {
|
||||
locs := bingBlockRe.FindAllStringIndex(pageHTML, -1)
|
||||
if len(locs) == 0 {
|
||||
return nil
|
||||
}
|
||||
blocks := make([]string, 0, len(locs))
|
||||
for i, loc := range locs {
|
||||
end := len(pageHTML)
|
||||
if i+1 < len(locs) {
|
||||
end = locs[i+1][0]
|
||||
}
|
||||
blocks = append(blocks, pageHTML[loc[1]:end])
|
||||
}
|
||||
return blocks
|
||||
}
|
||||
|
||||
func parseBingResults(pageHTML string, count int) []searchResult {
|
||||
if count <= 0 {
|
||||
count = 5
|
||||
}
|
||||
var results []searchResult
|
||||
re := regexp.MustCompile(`<li class="b_algo"(?s)(.*?)</li>`)
|
||||
matches := re.FindAllStringSubmatch(html, -1)
|
||||
for _, m := range matches {
|
||||
for _, block := range splitBingBlocks(pageHTML) {
|
||||
if len(results) >= count {
|
||||
break
|
||||
}
|
||||
block := m[1]
|
||||
var r searchResult
|
||||
hrefRe := regexp.MustCompile(`<a[^>]+href="([^"]+)"[^>]*>`)
|
||||
if hm := hrefRe.FindStringSubmatch(block); len(hm) > 1 {
|
||||
r.URL = hm[1]
|
||||
// 标题:现代 Bing 是 <h2><a href=...>标题</a></h2>;没有 h2 时才退回到块内第一个链接。
|
||||
var href, title string
|
||||
if m := bingTitleRe.FindStringSubmatch(block); m != nil {
|
||||
href, title = m[1], html.UnescapeString(stripTags(m[2]))
|
||||
} else if m := bingAnyLinkRe.FindStringSubmatch(block); m != nil {
|
||||
href, title = m[1], html.UnescapeString(stripTags(m[2]))
|
||||
}
|
||||
titleRe := regexp.MustCompile(`<a[^>]+href="[^"]+"[^>]*>(.*?)</a>`)
|
||||
if tm := titleRe.FindStringSubmatch(block); len(tm) > 1 {
|
||||
r.Title = stripTags(tm[1])
|
||||
href = bingRealURL(html.UnescapeString(href))
|
||||
|
||||
// 摘要:新版在 p.b_lineclamp*,旧版在 div.b_caption > p
|
||||
var snippet string
|
||||
if m := bingSnipRe.FindStringSubmatch(block); m != nil {
|
||||
snippet = html.UnescapeString(stripTags(m[1]))
|
||||
} else if m := bingCaptionRe.FindStringSubmatch(block); m != nil {
|
||||
snippet = html.UnescapeString(stripTags(m[1]))
|
||||
}
|
||||
snipRe := regexp.MustCompile(`<div class="b_caption">.*?<p>(.*?)</p>`)
|
||||
if sm := snipRe.FindStringSubmatch(block); len(sm) > 1 {
|
||||
r.Snippet = stripTags(sm[1])
|
||||
}
|
||||
if r.URL != "" && r.Title != "" {
|
||||
results = append(results, r)
|
||||
|
||||
title, snippet = strings.TrimSpace(title), strings.TrimSpace(snippet)
|
||||
if href == "" || title == "" || !strings.HasPrefix(href, "http") {
|
||||
continue
|
||||
}
|
||||
results = append(results, searchResult{Title: title, URL: href, Snippet: snippet})
|
||||
}
|
||||
return results
|
||||
}
|
||||
|
||||
// bingRealURL 解开 Bing 的跳转包装:/ck/a?...&u=a1<base64url>&... → 真实 URL。
|
||||
// 不解的话模型拿到的是 `https://cn.bing.com/ck/a?...` 这种不可读地址。
|
||||
func bingRealURL(href string) string {
|
||||
href = strings.TrimSpace(href)
|
||||
if href == "" {
|
||||
return ""
|
||||
}
|
||||
if !strings.Contains(href, "/ck/a") && !strings.Contains(href, "u=a1") {
|
||||
return href
|
||||
}
|
||||
u, err := url.Parse(href)
|
||||
if err != nil {
|
||||
return href
|
||||
}
|
||||
raw := u.Query().Get("u")
|
||||
if !strings.HasPrefix(raw, "a1") {
|
||||
return href
|
||||
}
|
||||
b64 := raw[2:]
|
||||
for _, enc := range []*base64.Encoding{base64.RawURLEncoding, base64.URLEncoding, base64.RawStdEncoding} {
|
||||
if dec, err := enc.DecodeString(b64); err == nil {
|
||||
s := string(dec)
|
||||
if strings.HasPrefix(s, "http://") || strings.HasPrefix(s, "https://") {
|
||||
return s
|
||||
}
|
||||
}
|
||||
}
|
||||
return href
|
||||
}
|
||||
|
||||
func (p *Plugin) handleSearch(args map[string]interface{}) (interface{}, error) {
|
||||
query := readArg(args, "query", "")
|
||||
if query == "" {
|
||||
@ -881,10 +974,9 @@ func (p *Plugin) localSpawnFailback() (context.Context, context.CancelFunc, cont
|
||||
}
|
||||
|
||||
func (p *Plugin) handleBrowserStart(args map[string]interface{}) (interface{}, error) {
|
||||
timeoutStr := readArg(args, "timeout", "10m")
|
||||
timeout, err := time.ParseDuration(timeoutStr)
|
||||
timeout, err := parseBrowserSessionTimeout(args)
|
||||
if err != nil {
|
||||
timeout = 10 * time.Minute
|
||||
return errResult(err.Error()), nil
|
||||
}
|
||||
|
||||
source := readArg(args, "source", "")
|
||||
@ -899,13 +991,19 @@ func (p *Plugin) handleBrowserStart(args map[string]interface{}) (interface{}, e
|
||||
s.mu.Lock()
|
||||
id := s.id
|
||||
cur := s.currentURL
|
||||
s.createdAt = time.Now()
|
||||
s.timeout = timeout
|
||||
closesAt := s.createdAt.Add(timeout)
|
||||
s.mu.Unlock()
|
||||
p.mu.Unlock()
|
||||
log.Printf("[%s] reused browser session %s: timeout=%v closes_at=%s source=%s", p.name, id, timeout, closesAt.Format(time.RFC3339), source)
|
||||
return map[string]interface{}{
|
||||
"id": id,
|
||||
"status": "reused",
|
||||
"url": cur,
|
||||
"note": "已复用本来源的现有标签页(登录态全机共享)",
|
||||
"id": id,
|
||||
"status": "reused",
|
||||
"url": cur,
|
||||
"timeout": timeout.String(),
|
||||
"closes_at": closesAt.Format(time.RFC3339),
|
||||
"note": "已复用本来源的现有标签页,并按本次 timeout 重新设定关闭时间",
|
||||
}, nil
|
||||
}
|
||||
}
|
||||
@ -942,7 +1040,7 @@ func (p *Plugin) handleBrowserStart(args map[string]interface{}) (interface{}, e
|
||||
"插件会注册 homeagent-browser.service 并启动。" +
|
||||
"若本机无法联网安装 chromium,可继续用本地临时模式(重试 browser_start 即自动降级)。"
|
||||
return map[string]interface{}{
|
||||
"error": "backend not installed",
|
||||
"error": "backend not installed",
|
||||
"need_install": true,
|
||||
"guide": guide,
|
||||
}, nil
|
||||
@ -972,13 +1070,15 @@ func (p *Plugin) handleBrowserStart(args map[string]interface{}) (interface{}, e
|
||||
session.currentURL = initURL
|
||||
}
|
||||
|
||||
log.Printf("[%s] created browser session %s: url=%s timeout=%v source=%s", p.name, id, initURL, timeout, source)
|
||||
closesAt := session.createdAt.Add(timeout)
|
||||
log.Printf("[%s] created browser session %s: url=%s timeout=%v closes_at=%s source=%s", p.name, id, initURL, timeout, closesAt.Format(time.RFC3339), source)
|
||||
return map[string]interface{}{
|
||||
"id": id,
|
||||
"status": "created",
|
||||
"mode": "shared-backend",
|
||||
"url": initURL,
|
||||
"timeout": timeout.String(),
|
||||
"id": id,
|
||||
"status": "created",
|
||||
"mode": "shared-backend",
|
||||
"url": initURL,
|
||||
"timeout": timeout.String(),
|
||||
"closes_at": closesAt.Format(time.RFC3339),
|
||||
}, nil
|
||||
}
|
||||
|
||||
@ -1044,11 +1144,11 @@ func (p *Plugin) handleScreenshot(args map[string]interface{}) (interface{}, err
|
||||
}
|
||||
b64 := base64.StdEncoding.EncodeToString(buf)
|
||||
return map[string]interface{}{
|
||||
"status": "ok",
|
||||
"format": format,
|
||||
"size": len(buf),
|
||||
"base64": b64,
|
||||
"data_uri": fmt.Sprintf("data:image/png;base64,%s", b64),
|
||||
"status": "ok",
|
||||
"format": format,
|
||||
"size": len(buf),
|
||||
"base64": b64,
|
||||
"data_uri": fmt.Sprintf("data:image/png;base64,%s", b64),
|
||||
}, nil
|
||||
}
|
||||
|
||||
@ -1079,11 +1179,11 @@ func (p *Plugin) handleHTML(args map[string]interface{}) (interface{}, error) {
|
||||
html = html[:maxChars] + "\n\n[HTML truncated]"
|
||||
}
|
||||
return map[string]interface{}{
|
||||
"status": "ok",
|
||||
"title": title,
|
||||
"url": currentURL,
|
||||
"html": html,
|
||||
"length": len(html),
|
||||
"status": "ok",
|
||||
"title": title,
|
||||
"url": currentURL,
|
||||
"html": html,
|
||||
"length": len(html),
|
||||
}, nil
|
||||
}
|
||||
|
||||
@ -1204,13 +1304,20 @@ func (p *Plugin) cleanupLoop() {
|
||||
case <-p.stopCh:
|
||||
return
|
||||
case <-ticker.C:
|
||||
now := time.Now()
|
||||
p.mu.Lock()
|
||||
for id, s := range p.sessions {
|
||||
if time.Since(s.createdAt) >= s.timeout {
|
||||
log.Printf("[%s] cleanup: browser session %s expired", p.name, id)
|
||||
delete(p.sessions, id)
|
||||
s.Close()
|
||||
p.sdk.InjectInterruptText(p.name, p.name, fmt.Sprintf("[浏览器会话 %s 已超时关闭]", id))
|
||||
s.mu.Lock()
|
||||
closesAt := s.createdAt.Add(s.timeout)
|
||||
expired := !now.Before(closesAt)
|
||||
s.mu.Unlock()
|
||||
if expired {
|
||||
log.Printf("[%s] cleanup: browser session %s reached agent-specified close time %s", p.name, id, closesAt.Format(time.RFC3339))
|
||||
delete(p.sessions, id)
|
||||
s.Close()
|
||||
// NoMemory:会话生命周期通知,不是记忆内容。
|
||||
p.sdk.InjectInterruptTextOpts(p.name, p.name,
|
||||
fmt.Sprintf("[浏览器会话 %s 已按指定时间关闭]", id), sdk.InjectOptions{NoMemory: true})
|
||||
}
|
||||
}
|
||||
p.mu.Unlock()
|
||||
@ -1310,7 +1417,7 @@ WantedBy=multi-user.target
|
||||
return map[string]interface{}{
|
||||
"status": "installed",
|
||||
"endpoint": cdpEndpoint,
|
||||
"chrome": chromePath,
|
||||
"chrome": chromePath,
|
||||
"profile": profileDir,
|
||||
"guide": guide,
|
||||
}, nil
|
||||
|
||||
213
example/browser/plugin_test.go
Normal file
213
example/browser/plugin_test.go
Normal file
@ -0,0 +1,213 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"net/url"
|
||||
"os"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
func TestParseBrowserSessionTimeoutRequiresExplicitValue(t *testing.T) {
|
||||
_, err := parseBrowserSessionTimeout(map[string]interface{}{})
|
||||
if err == nil || !strings.Contains(err.Error(), "timeout is required") {
|
||||
t.Fatalf("expected required timeout error, got %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseBrowserSessionTimeoutAcceptsPositiveDuration(t *testing.T) {
|
||||
got, err := parseBrowserSessionTimeout(map[string]interface{}{"timeout": "2h30m"})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if got != 2*time.Hour+30*time.Minute {
|
||||
t.Fatalf("timeout=%v", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseBrowserSessionTimeoutRejectsInvalidOrNonPositive(t *testing.T) {
|
||||
for _, value := range []string{"invalid", "0s", "-1m"} {
|
||||
if _, err := parseBrowserSessionTimeout(map[string]interface{}{"timeout": value}); err == nil {
|
||||
t.Errorf("timeout %q should be rejected", value)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestBrowserStartReuseResetsExplicitCloseTime(t *testing.T) {
|
||||
p := &Plugin{
|
||||
name: "browser",
|
||||
sessions: map[string]*BrowserSession{
|
||||
"browser_1": {
|
||||
id: "browser_1",
|
||||
shared: true,
|
||||
sessionKey: "qq",
|
||||
createdAt: time.Now().Add(-time.Hour),
|
||||
timeout: time.Minute,
|
||||
currentURL: "https://example.com",
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
before := time.Now()
|
||||
result, err := p.handleBrowserStart(map[string]interface{}{"source": "qq", "timeout": "3h"})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
out := result.(map[string]interface{})
|
||||
if out["status"] != "reused" || out["timeout"] != "3h0m0s" {
|
||||
t.Fatalf("unexpected result: %#v", out)
|
||||
}
|
||||
s := p.sessions["browser_1"]
|
||||
if s.timeout != 3*time.Hour || s.createdAt.Before(before) {
|
||||
t.Fatalf("deadline not reset: createdAt=%v timeout=%v", s.createdAt, s.timeout)
|
||||
}
|
||||
}
|
||||
|
||||
// ── Bing 解析器(2026-09 版式)─────────────────────────────
|
||||
//
|
||||
// 背景:旧实现把块内**第一个 <a>** 当标题 —— 拿到的是 Bing 的「来源行」
|
||||
// `deepin.orghttps://www.deepin.org`;摘要正则 `<div class="b_caption">.*?<p>`
|
||||
// 对现代 Bing 命中 0/N(摘要已迁到 p.b_lineclamp*),于是结果「有标题没摘要」,
|
||||
// 模型只好反复换词重搜。夹具 testdata/bing_cn.html 是真实 cn.bing.com 响应裁剪。
|
||||
|
||||
func TestParseBingResultsRealBingHTML(t *testing.T) {
|
||||
page, err := os.ReadFile("testdata/bing_cn.html")
|
||||
if err != nil {
|
||||
t.Fatalf("读取夹具失败: %v", err)
|
||||
}
|
||||
results := parseBingResults(string(page), 3)
|
||||
if len(results) != 3 {
|
||||
t.Fatalf("应解析出 3 条,实际 %d 条: %+v", len(results), results)
|
||||
}
|
||||
for i, r := range results {
|
||||
if !strings.HasPrefix(r.URL, "http") {
|
||||
t.Errorf("第 %d 条 URL 不是真实地址: %q", i+1, r.URL)
|
||||
}
|
||||
if strings.Contains(r.Title, "http") || strings.Contains(r.Title, "://") {
|
||||
t.Errorf("第 %d 条标题混入了 URL(旧 bug 的典型症状): %q", i+1, r.Title)
|
||||
}
|
||||
if r.Snippet == "" {
|
||||
t.Errorf("第 %d 条没有摘要(旧 bug 的典型症状): %+v", i+1, r)
|
||||
}
|
||||
}
|
||||
// 第一条必须与样本里的真实结果一致
|
||||
if results[0].URL != "https://www.deepin.org/" {
|
||||
t.Errorf("第一条 URL 应为 https://www.deepin.org/,实际 %q", results[0].URL)
|
||||
}
|
||||
if !strings.Contains(results[0].Title, "deepin") {
|
||||
t.Errorf("第一条标题不对: %q", results[0].Title)
|
||||
}
|
||||
if len(results[0].Snippet) < 10 || strings.Contains(results[0].Snippet, "://") {
|
||||
t.Errorf("第一条摘要不对(应是有内容的文本): %q", results[0].Snippet)
|
||||
}
|
||||
}
|
||||
|
||||
// 块内嵌套 <li>(deep links)时不能截断 —— 旧的 `<li class="b_algo"(?s)(.*?)</li>` 会在此翻车
|
||||
func TestParseBingResultsNestedLiKeepsResult(t *testing.T) {
|
||||
page := `<ol id="b_results"><li class="b_algo" data-id iid=SERP.1>` +
|
||||
`<h2><a href="https://a.example/x" h="ID=SERP,1">真标题</a></h2>` +
|
||||
`<div class="b_caption"><p class="b_lineclamp2">真摘要</p></div>` +
|
||||
`<div><ul><li><a href="https://sub.example/deeplink">子链接</a></li></ul></div>` +
|
||||
`</li><li class="b_algo"><h2><a href="https://b.example/y">第二条</a></h2>` +
|
||||
`<p class="b_lineclamp3">摘要二</p></li></ol>`
|
||||
rs := parseBingResults(page, 5)
|
||||
if len(rs) != 2 {
|
||||
t.Fatalf("应解析 2 条,实际 %d 条: %+v", len(rs), rs)
|
||||
}
|
||||
if rs[0].URL != "https://a.example/x" || rs[0].Title != "真标题" || rs[0].Snippet != "真摘要" {
|
||||
t.Errorf("第一条解析错误: %+v", rs[0])
|
||||
}
|
||||
if rs[1].Title != "第二条" || rs[1].Snippet != "摘要二" {
|
||||
t.Errorf("第二条(无 b_caption,摘要走 b_lineclamp3)解析错误: %+v", rs[1])
|
||||
}
|
||||
}
|
||||
|
||||
func TestBingRealURLDecodesRedirectWrapper(t *testing.T) {
|
||||
// Bing 跳转包装:/ck/a?...&u=a1<base64url>
|
||||
wrapped := "/ck/a?!&&p=abc&u=a1aHR0cHM6Ly93d3cuZGVlcGluLm9yZy96aC9EZWVwaW4v&ntb=1"
|
||||
if got := bingRealURL(wrapped); got != "https://www.deepin.org/zh/Deepin/" {
|
||||
t.Errorf("未解开跳转包装: %q", got)
|
||||
}
|
||||
if got := bingRealURL("https://direct.example/p"); got != "https://direct.example/p" {
|
||||
t.Errorf("直链不应被改动: %q", got)
|
||||
}
|
||||
// 解不开时保守返回原值,不能返回空
|
||||
bad := "/ck/a?u=a1!!!!"
|
||||
if got := bingRealURL(bad); got == "" {
|
||||
t.Errorf("解不开时应保留原值,实际返回空")
|
||||
}
|
||||
}
|
||||
|
||||
// roundTripFunc 把任意请求转给本地测试服务器,从而离线测 bingSearch 的完整路径
|
||||
type roundTripFunc func(*http.Request) (*http.Response, error)
|
||||
|
||||
func (f roundTripFunc) RoundTrip(r *http.Request) (*http.Response, error) { return f(r) }
|
||||
|
||||
func TestBingSearchReportsParseFailureInsteadOfEmptyResult(t *testing.T) {
|
||||
var seenURL string
|
||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = w.Write([]byte("<html><body>no result blocks here</body></html>"))
|
||||
}))
|
||||
defer srv.Close()
|
||||
|
||||
p := &Plugin{name: "browser", client: &http.Client{Transport: roundTripFunc(func(r *http.Request) (*http.Response, error) {
|
||||
seenURL = r.URL.String()
|
||||
return srv.Client().Transport.RoundTrip(&http.Request{
|
||||
Method: r.Method, URL: mustParseURL(t, srv.URL), Header: r.Header, Body: r.Body,
|
||||
})
|
||||
})}}
|
||||
|
||||
if _, err := p.bingSearch("任意查询", 5); err == nil {
|
||||
t.Fatal("解析不出结果时必须报错,而不是伪装成「没有结果」")
|
||||
} else if !strings.Contains(err.Error(), "未解析出结果") {
|
||||
t.Errorf("错误信息应说明是解析失败: %v", err)
|
||||
}
|
||||
// 数据源必须是 cn.bing.com(www.bing.com 对程序化请求回 302,拿不到结果块)
|
||||
if !strings.Contains(seenURL, "cn.bing.com") {
|
||||
t.Errorf("应请求 cn.bing.com,实际 %q", seenURL)
|
||||
}
|
||||
if strings.Contains(seenURL, "www.bing.com") {
|
||||
t.Errorf("不应再请求 www.bing.com: %q", seenURL)
|
||||
}
|
||||
}
|
||||
|
||||
// 正常路径:能解析出结果时返回结果且不报错
|
||||
func TestBingSearchParsesFixtureThroughClient(t *testing.T) {
|
||||
page, err := os.ReadFile("testdata/bing_cn.html")
|
||||
if err != nil {
|
||||
t.Fatalf("读取夹具失败: %v", err)
|
||||
}
|
||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
w.Header().Set("Content-Type", "text/html; charset=utf-8")
|
||||
_, _ = w.Write(page)
|
||||
}))
|
||||
defer srv.Close()
|
||||
|
||||
p := &Plugin{name: "browser", client: &http.Client{Transport: roundTripFunc(func(r *http.Request) (*http.Response, error) {
|
||||
return srv.Client().Transport.RoundTrip(&http.Request{
|
||||
Method: r.Method, URL: mustParseURL(t, srv.URL), Header: r.Header, Body: r.Body,
|
||||
})
|
||||
})}}
|
||||
|
||||
results, err := p.bingSearch("deepin", 2)
|
||||
if err != nil {
|
||||
t.Fatalf("应成功,实际 %v", err)
|
||||
}
|
||||
if len(results) != 2 {
|
||||
t.Fatalf("应返回 2 条(count 生效),实际 %d", len(results))
|
||||
}
|
||||
if results[0].Snippet == "" {
|
||||
t.Errorf("摘要不应为空: %+v", results[0])
|
||||
}
|
||||
}
|
||||
|
||||
func mustParseURL(t *testing.T, raw string) *url.URL {
|
||||
t.Helper()
|
||||
u, err := url.Parse(raw)
|
||||
if err != nil {
|
||||
t.Fatalf("解析测试 URL 失败: %v", err)
|
||||
}
|
||||
return u
|
||||
}
|
||||
1
example/browser/testdata/bing_cn.html
vendored
Normal file
1
example/browser/testdata/bing_cn.html
vendored
Normal file
File diff suppressed because one or more lines are too long
@ -15,31 +15,31 @@ import (
|
||||
)
|
||||
|
||||
const (
|
||||
RepeatNone = "none"
|
||||
RepeatDaily = "daily"
|
||||
RepeatWeekday = "weekday"
|
||||
RepeatWeekly = "weekly"
|
||||
RepeatBiweekly = "biweekly"
|
||||
RepeatMonthly = "monthly"
|
||||
RepeatYearly = "yearly"
|
||||
RepeatNone = "none"
|
||||
RepeatDaily = "daily"
|
||||
RepeatWeekday = "weekday"
|
||||
RepeatWeekly = "weekly"
|
||||
RepeatBiweekly = "biweekly"
|
||||
RepeatMonthly = "monthly"
|
||||
RepeatYearly = "yearly"
|
||||
RepeatLunarYearly = "lunar_yearly"
|
||||
)
|
||||
|
||||
type CalendarEvent struct {
|
||||
ID string `json:"id"`
|
||||
Title string `json:"title"`
|
||||
StartTime string `json:"start_time"`
|
||||
EndTime string `json:"end_time,omitempty"`
|
||||
AllDay bool `json:"all_day,omitempty"`
|
||||
Location string `json:"location,omitempty"`
|
||||
Note string `json:"note,omitempty"`
|
||||
Reminds []int `json:"reminds,omitempty"`
|
||||
RemindAt []int64 `json:"remind_at,omitempty"`
|
||||
Repeat string `json:"repeat,omitempty"`
|
||||
ParentID string `json:"parent_id,omitempty"`
|
||||
Lunar bool `json:"lunar,omitempty"`
|
||||
LunarMonth int `json:"lunar_month,omitempty"`
|
||||
LunarDay int `json:"lunar_day,omitempty"`
|
||||
ID string `json:"id"`
|
||||
Title string `json:"title"`
|
||||
StartTime string `json:"start_time"`
|
||||
EndTime string `json:"end_time,omitempty"`
|
||||
AllDay bool `json:"all_day,omitempty"`
|
||||
Location string `json:"location,omitempty"`
|
||||
Note string `json:"note,omitempty"`
|
||||
Reminds []int `json:"reminds,omitempty"`
|
||||
RemindAt []int64 `json:"remind_at,omitempty"`
|
||||
Repeat string `json:"repeat,omitempty"`
|
||||
ParentID string `json:"parent_id,omitempty"`
|
||||
Lunar bool `json:"lunar,omitempty"`
|
||||
LunarMonth int `json:"lunar_month,omitempty"`
|
||||
LunarDay int `json:"lunar_day,omitempty"`
|
||||
}
|
||||
|
||||
type Plugin struct {
|
||||
@ -276,6 +276,9 @@ func nextLunarYearly(targetMonth, targetDay int, after time.Time) (time.Time, bo
|
||||
func (p *Plugin) Start(s *sdk.PluginSDK) error {
|
||||
p.sdk = s
|
||||
|
||||
// 入站通道:本插件用 "calendar" 通道注入输入(见 Inject* 调用),
|
||||
// 输入侧必须显式登记 —— 否则"把该 inputch 划给驻留子"会报 `inputch 未注册`。
|
||||
_ = s.RegisterInputChannel("calendar", sdk.ChannelDef{NoMemory: true})
|
||||
dataDirVal, err := s.Settings().GetCore("core.daemon.data_dir")
|
||||
if err != nil || dataDirVal == "" {
|
||||
dataDirVal = "."
|
||||
@ -359,7 +362,7 @@ func (p *Plugin) Start(s *sdk.PluginSDK) error {
|
||||
s.RegisterTool(tp+"today", sdk.ToolDef{
|
||||
Name: tp + "today", Description: "Show today's events with countdown.",
|
||||
Parameters: map[string]interface{}{
|
||||
"type": "object",
|
||||
"type": "object",
|
||||
"properties": map[string]interface{}{},
|
||||
},
|
||||
}, p.handleToday)
|
||||
@ -367,7 +370,7 @@ func (p *Plugin) Start(s *sdk.PluginSDK) error {
|
||||
s.RegisterTool(tp+"week", sdk.ToolDef{
|
||||
Name: tp + "week", Description: "Show this week's events grouped by day.",
|
||||
Parameters: map[string]interface{}{
|
||||
"type": "object",
|
||||
"type": "object",
|
||||
"properties": map[string]interface{}{},
|
||||
},
|
||||
}, p.handleWeek)
|
||||
|
||||
100
example/deepsearch/README.md
Normal file
100
example/deepsearch/README.md
Normal file
@ -0,0 +1,100 @@
|
||||
# 联网检索插件(HomeAgent)
|
||||
|
||||
给 agent 补上**真正的信息检索**能力:检索交给本地 SearXNG(多引擎聚合、结构化 JSON),
|
||||
并补上「读完前 K 篇再回答」的深检索。
|
||||
|
||||
## 为什么需要它(背景)
|
||||
|
||||
agent 原本只有 `browser_*` 那套浏览器工具,联网检索实际只有 `browser_search` 一个入口,而它是
|
||||
**「抓 Bing HTML + 正则解析」**:
|
||||
|
||||
| 缺陷 | 实测结果 |
|
||||
|---|---|
|
||||
| 标题取的是结果块里**第一个 `<a>`** | 拿到的是 Bing 的「来源行」而非标题 → `deepin.orghttps://www.deepin.org` |
|
||||
| 摘要正则 `<div class="b_caption">.*?<p>` | 对现代 Bing **命中 0/10**(摘要已迁到 `p.b_lineclamp*`)→ 结果**完全没有摘要** |
|
||||
| 用 `www.bing.com` | 程序化请求直接 302;`cn.bing.com` 才返回 10 个结果块 |
|
||||
| 单引擎、无兜底、无去重、无站点读取 | 模型只能反复换词重搜(日志里 8 秒 6 连击) |
|
||||
|
||||
结果就是日志里那句用户反馈:**「你的搜索能力好像不太行啊」**。
|
||||
|
||||
## 依赖:本地 SearXNG(由本插件托管)
|
||||
|
||||
插件会**自己管后端**:
|
||||
|
||||
- **启动时**:探 `healthz`;已在跑就**直接接管**(不重启),没跑就 `docker compose up -d` 并等就绪(上限 6s)
|
||||
- **停止时**:跑 `docker compose stop -t 2` 关闭它
|
||||
|
||||
配置项 `manage_searxng`(默认 true)与 `searxng_dir`(默认 `/root/searxng-agent`)控制这套行为;
|
||||
`stop_searxng_on_exit`(默认 true)设 false 可让后端在插件停止后继续跑(**插件重载频繁时建议设 false**,
|
||||
否则每次重载都会把后端重启一遍)。
|
||||
|
||||
### 生命周期契约(依据内核源码,非猜测)
|
||||
|
||||
| 环节 | 内核行为 |
|
||||
|---|---|
|
||||
| 停止插件 | 发 `plugin.stop` → 插件先跑 **RunStopHandlers(LIFO、幂等)** → 再 `Stop()` → `exit(0)` |
|
||||
| 宽限期 | **5 秒**;未退出则直接 SIGKILL —— 所以关闭动作限时 4s(`searxShutdownBudget`) |
|
||||
| stdin 关闭 | 同样会跑 handlers + `Stop()` |
|
||||
| 崩溃/被 kill | 关闭动作不会执行,后端会留在运行态;下次启动探测到就直接接管(**更安全的失败方向**) |
|
||||
| 自动重启 | `SetAutoRestart(true)` 由注入的 runtime 在 `plugin.start` 后经 `lifecycle.autoRestart` **显式上报**内核 |
|
||||
|
||||
### SearXNG 侧配置
|
||||
|
||||
部署在 **.60**,`127.0.0.1:8888`:
|
||||
|
||||
```
|
||||
/root/searxng-agent/docker-compose.yml # host 网络(要访问宿主 clash)
|
||||
/root/searxng-agent/settings.yml # json 输出 + limiter 关闭 + 出站走 clash
|
||||
```
|
||||
|
||||
两个必须知道的坑:
|
||||
|
||||
1. **`search.formats` 必须含 `json`**,否则 `/search?format=json` 返回 **403**(看起来像网络问题,其实是配置)。
|
||||
2. 该镜像默认 `GRANIAN_PORT=8080`,而 granian 的 `GRANIAN_*` **优先级高于 settings.yml**:
|
||||
.60 上 8080 被 homeagent 占用 → 不改 `SEARXNG_PORT` 就是无休止的 `Address already in use` 崩溃循环。
|
||||
|
||||
实测可用的引擎(2026-09-12):`duckduckgo`、`brave`、`google cse`;`quark` 时好时坏;
|
||||
`baidu`/`google` 经代理出口触发 CAPTCHA,`sogou` 崩溃,`wikidata` 报 HTTP error(已关)。
|
||||
|
||||
## 工具
|
||||
|
||||
| 工具 | 说明 |
|
||||
|---|---|
|
||||
| `deepsearch_search` | 联网检索(首选):标题 + URL + 摘要 + 发布时间,支持 `engines`/`category`/`time_range`/`language`,自动按 URL 去重并按分数排序;会回报**引擎覆盖度与无响应引擎** |
|
||||
| `deepsearch_news` | 新闻检索:`news` 类别 + 默认最近一周;新闻为空时自动回退 general + 时间范围 |
|
||||
| `deepsearch_fetch` | 抓单个网页并抽正文(去脚本/样式/导航),返回标题 + 纯文本,可设截断长度 |
|
||||
| `deepsearch_deep` | **深检索**:检索 → 并行抓前 K 篇正文 → 一次返回「候选清单 + 证据正文」;单篇失败不影响整体 |
|
||||
| `deepsearch_status` | 自检:healthz、json 是否可用、延迟、**哪些引擎真的在返回结果**(检索出问题先跑这个) |
|
||||
|
||||
## 配置项
|
||||
|
||||
| 键 | 默认 | 说明 |
|
||||
|---|---|---|
|
||||
| `searxng_url` | `http://127.0.0.1:8888` | 本地 SearXNG 地址 |
|
||||
| `max_results` | `8` | 默认条数(控制上下文体积) |
|
||||
| `language` | `zh-CN` | 检索语言 |
|
||||
| `safesearch` | `0` | 0 关 / 1 中 / 2 严 |
|
||||
| `request_timeout` | `20` | 单次请求超时(秒) |
|
||||
| `fetch_max_chars` | `4000` | `deepsearch_fetch` 正文上限 |
|
||||
| `proxy` | 空 | 仅作用于本插件直连抓取(搜索出网由 SearXNG 侧负责) |
|
||||
| `user_agent` | Chrome UA | 抓取用 |
|
||||
|
||||
每次调用前重读配置,改完即时生效。
|
||||
|
||||
## 开发与验证
|
||||
|
||||
```bash
|
||||
go test -count=1 -race ./... # 11 项测试(httptest 打桩 SearXNG)
|
||||
|
||||
# 真实后端联调(默认跳过):跑的就是当初失败的那条查询
|
||||
DEEPSEARCH_LIVE_SEARXNG=http://127.0.0.1:8888 go test -run TestLiveSearxng -v ./...
|
||||
|
||||
hmapdev build # 产出 dist/deep_search_bundle.hmap
|
||||
```
|
||||
|
||||
## 已知边界
|
||||
|
||||
- **知乎等站点对直连抓取返回 403**(反爬),`deepsearch_deep` 会如实标注该篇抓取失败并继续;
|
||||
这类页面请改用浏览器工具(`browser_navigate` + `browser_render`)。
|
||||
- 引擎可用性随出口 IP 与目标站点风控变化;`deepsearch_status` 与每次结果里的「覆盖度」行就是给这个用的。
|
||||
- 未做正文去重/相似度合并:同一事件的多篇转载会各占一条(摘要已能区分)。
|
||||
21
example/deepsearch/go.mod
Normal file
21
example/deepsearch/go.mod
Normal file
@ -0,0 +1,21 @@
|
||||
module deepsearch-plugin
|
||||
|
||||
go 1.25.0
|
||||
|
||||
require gitcode.com/JianFeeeee/homeagent-sdk v1.2.0
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
replace gitcode.com/JianFeeeee/homeagent-sdk => /root/.homeagent/hmapdev/sdk/v1.2.0
|
||||
81
example/deepsearch/live_test.go
Normal file
81
example/deepsearch/live_test.go
Normal file
@ -0,0 +1,81 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"os"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
// 真实后端联调(默认跳过,需显式指定地址):
|
||||
//
|
||||
// DEEPSEARCH_LIVE_SEARXNG=http://127.0.0.1:8888 go test -run TestLiveSearxng -v ./...
|
||||
//
|
||||
// 它跑的就是当初失败的场景(日志里那条「你的搜索能力好像不太行啊」对应的查询),
|
||||
// 用来回答一个具体问题:换了后端之后,模型拿到的是不是「带摘要的相关结果」。
|
||||
func TestLiveSearxng(t *testing.T) {
|
||||
base := os.Getenv("DEEPSEARCH_LIVE_SEARXNG")
|
||||
if base == "" {
|
||||
t.Skip("未设置 DEEPSEARCH_LIVE_SEARXNG,跳过真实后端联调")
|
||||
}
|
||||
p := &Plugin{
|
||||
name: "deepsearch",
|
||||
searxURL: strings.TrimRight(base, "/"),
|
||||
maxItems: 6,
|
||||
language: "zh-CN",
|
||||
fetchMax: 1200,
|
||||
userAgent: defaultUA,
|
||||
}
|
||||
p.ensure()
|
||||
|
||||
// 1) 自检
|
||||
st, err := p.handleStatus(map[string]interface{}{})
|
||||
if err != nil {
|
||||
t.Fatalf("status: %v", err)
|
||||
}
|
||||
t.Logf("status: %v", st)
|
||||
|
||||
// 2) 当初失败的那条查询
|
||||
res, err := p.handleSearch(map[string]interface{}{"query": "深度科技 deepin 开发者 被开除"})
|
||||
if err != nil {
|
||||
t.Fatalf("search: %v", err)
|
||||
}
|
||||
txt := res.(map[string]interface{})["content"].(string)
|
||||
t.Logf("检索结果:\n%s", txt)
|
||||
if !strings.Contains(txt, "摘要:") {
|
||||
t.Errorf("结果里应当有摘要(这正是原实现缺失的东西)")
|
||||
}
|
||||
if !strings.Contains(txt, "覆盖:") {
|
||||
t.Errorf("应报告引擎覆盖度")
|
||||
}
|
||||
|
||||
// 3) 正文抓取(取第一条结果的 URL)
|
||||
var firstURL string
|
||||
for _, line := range strings.Split(txt, "\n") {
|
||||
l := strings.TrimSpace(line)
|
||||
if strings.HasPrefix(l, "http") {
|
||||
firstURL = l
|
||||
break
|
||||
}
|
||||
}
|
||||
if firstURL == "" {
|
||||
t.Fatal("未从结果中解析出 URL")
|
||||
}
|
||||
page, err := p.handleFetch(map[string]interface{}{"url": firstURL, "max_chars": float64(600)})
|
||||
if err != nil {
|
||||
t.Logf("抓取 %s 失败(真实站点有反爬/需 JS 属正常):%v", firstURL, err)
|
||||
} else {
|
||||
body := page.(map[string]interface{})["content"].(string)
|
||||
t.Logf("抓取 %s 正文前 400 字:%s", firstURL, oneLine(body, 400))
|
||||
}
|
||||
|
||||
// 4) 深检索
|
||||
deep, err := p.handleDeep(map[string]interface{}{"query": "统信 UOS 内核工程师 西装 事件", "top_k": float64(2)})
|
||||
if err != nil {
|
||||
t.Fatalf("deep: %v", err)
|
||||
}
|
||||
dTxt := deep.(map[string]interface{})["content"].(string)
|
||||
if !strings.Contains(dTxt, "候选清单") || !strings.Contains(dTxt, "正文证据") {
|
||||
t.Errorf("深检索输出结构不对")
|
||||
}
|
||||
t.Logf("深检索输出前 800 字:\n%s", oneLine(dTxt, 800))
|
||||
}
|
||||
12
example/deepsearch/plg.json
Normal file
12
example/deepsearch/plg.json
Normal file
@ -0,0 +1,12 @@
|
||||
{
|
||||
"name": "deepsearch",
|
||||
"name_zh": "联网检索",
|
||||
"name_en": "Deep Search",
|
||||
"version": "1.1.2",
|
||||
"description": "为 agent 提供真正的联网信息检索:本地 SearXNG 聚合多引擎(返回标题/URL/摘要/时间),支持新闻、时间范围、指定引擎;并提供网页正文抽取与「搜索+读前K篇」的深检索",
|
||||
"author": "HomeAgent",
|
||||
"entry": "plugin.bin",
|
||||
"sdk": "1.2.0",
|
||||
"tags": ["search", "web", "searxng", "retrieval", "news"],
|
||||
"targets": "linux/amd64"
|
||||
}
|
||||
1038
example/deepsearch/plugin.go
Normal file
1038
example/deepsearch/plugin.go
Normal file
File diff suppressed because it is too large
Load Diff
343
example/deepsearch/plugin_test.go
Normal file
343
example/deepsearch/plugin_test.go
Normal file
@ -0,0 +1,343 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"net/url"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func newTestPlugin(t *testing.T, h http.HandlerFunc) (*Plugin, *httptest.Server) {
|
||||
t.Helper()
|
||||
srv := httptest.NewServer(h)
|
||||
t.Cleanup(srv.Close)
|
||||
p := &Plugin{
|
||||
name: "deepsearch",
|
||||
searxURL: srv.URL,
|
||||
maxItems: 5,
|
||||
language: "zh-CN",
|
||||
fetchMax: 1000,
|
||||
userAgent: "test-agent",
|
||||
http: srv.Client(),
|
||||
}
|
||||
return p, srv
|
||||
}
|
||||
|
||||
// 一份贴近真实 SearXNG 的响应:含重复 URL、缺摘要、多引擎、无响应引擎
|
||||
const sampleResponse = `{
|
||||
"query": "deepin 被开除",
|
||||
"results": [
|
||||
{"url":"https://www.zhihu.com/question/1?utm_source=x","title":"网传统信内核开发工程师因没穿西服被开除","content":"截止1月9日最新情况…","engines":["duckduckgo","brave"],"score":9.5,"publishedDate":"2026-09-10T00:00:00"},
|
||||
{"url":"https://www.zhihu.com/question/1","title":"网传统信内核开发工程师因没穿西服被开除(重复项)","content":"重复条目","engines":["brave"],"score":1.0},
|
||||
{"url":"https://www.163.com/dy/article/KIQURODQ.html","title":"离谱!传某信创操作系统大厂因西装开除核心开发者","content":"一位负责Linux内核开发的核心工程师…","engines":["brave","quark"],"score":7.2},
|
||||
{"url":"https://bbs.deepin.org.cn/zh","title":"deepin官方论坛","content":"","engines":["duckduckgo"],"score":2.0}
|
||||
],
|
||||
"answers": [],
|
||||
"suggestions": ["deepin 王勇 离职"],
|
||||
"unresponsive_engines": [["baidu","CAPTCHA"],["sogou","unexpected crash"]],
|
||||
"timings": {"search": 1.2}
|
||||
}`
|
||||
|
||||
// 1) 检索:去重 + 按分数排序 + 摘要/覆盖度输出
|
||||
func TestSearchDedupAndFormat(t *testing.T) {
|
||||
var gotQuery url.Values
|
||||
p, _ := newTestPlugin(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.URL.Path == "/search" {
|
||||
gotQuery = r.URL.Query()
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
_, _ = w.Write([]byte(sampleResponse))
|
||||
return
|
||||
}
|
||||
http.NotFound(w, r)
|
||||
})
|
||||
res, err := p.handleSearch(map[string]interface{}{"query": "deepin 被开除", "count": float64(5)})
|
||||
if err != nil {
|
||||
t.Fatalf("err: %v", err)
|
||||
}
|
||||
if gotQuery.Get("format") != "json" {
|
||||
t.Errorf("必须要求 json 输出,实际 %q", gotQuery.Get("format"))
|
||||
}
|
||||
// SearXNG 的 /search **不认** count/limit(实测两者都返回同样的条数),
|
||||
// 所以「要几条」必须由插件侧截断 —— 也不要再发这种无意义参数(曾以为它生效过)。
|
||||
if gotQuery.Get("limit") != "" || gotQuery.Get("count") != "" {
|
||||
t.Errorf("不应依赖 SearXNG 的条数参数(它不认): %q", gotQuery.Encode())
|
||||
}
|
||||
txt := res.(map[string]interface{})["content"].(string)
|
||||
// utm_source 应被规范化掉,重复项只剩一条
|
||||
if n := strings.Count(txt, "zhihu.com/question/1"); n != 1 {
|
||||
t.Errorf("URL 未正确去重(出现 %d 次):\n%s", n, txt)
|
||||
}
|
||||
if !strings.Contains(txt, "网传统信内核开发工程师") {
|
||||
t.Errorf("缺少标题: %s", txt)
|
||||
}
|
||||
if !strings.Contains(txt, "摘要:") {
|
||||
t.Errorf("应输出摘要: %s", txt)
|
||||
}
|
||||
if !strings.Contains(txt, "baidu(CAPTCHA)") {
|
||||
t.Errorf("应回报无响应引擎(让模型知道覆盖度): %s", txt)
|
||||
}
|
||||
if !strings.Contains(txt, "duckduckgo") || !strings.Contains(txt, "quark") {
|
||||
t.Errorf("应回报引擎覆盖: %s", txt)
|
||||
}
|
||||
// 高分条目应排在前面
|
||||
if strings.Index(txt, "统信内核开发工程师") > strings.Index(txt, "离谱!") {
|
||||
t.Errorf("未按分数排序:\n%s", txt)
|
||||
}
|
||||
}
|
||||
|
||||
// 2) 403(未开 json)必须给出可操作提示,而不是裸错误
|
||||
func TestSearchForbiddenHint(t *testing.T) {
|
||||
p, _ := newTestPlugin(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
w.WriteHeader(http.StatusForbidden)
|
||||
_, _ = w.Write([]byte("Forbidden"))
|
||||
})
|
||||
_, err := p.handleSearch(map[string]interface{}{"query": "x"})
|
||||
if err == nil {
|
||||
t.Fatal("应返回错误")
|
||||
}
|
||||
msg := err.Error()
|
||||
if !strings.Contains(msg, "403") || !strings.Contains(msg, "formats") {
|
||||
t.Errorf("403 提示应指向 json/limiter 配置,实际: %s", msg)
|
||||
}
|
||||
}
|
||||
|
||||
// 3) 空结果:要给出原因与下一步建议
|
||||
func TestSearchEmptyHint(t *testing.T) {
|
||||
p, _ := newTestPlugin(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = w.Write([]byte(`{"query":"x","results":[],"suggestions":["换个词"],"unresponsive_engines":[["google","CAPTCHA"]]}`))
|
||||
})
|
||||
res, err := p.handleSearch(map[string]interface{}{"query": "x"})
|
||||
if err != nil {
|
||||
t.Fatalf("err: %v", err)
|
||||
}
|
||||
txt := res.(map[string]interface{})["content"].(string)
|
||||
for _, want := range []string{"未返回结果", "google(CAPTCHA)", "换个词", "deepsearch_news"} {
|
||||
if !strings.Contains(txt, want) {
|
||||
t.Errorf("空结果提示缺少 %q: %s", want, txt)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// 4) 新闻:应带 categories=news 与 time_range=week;新闻为空时回退 general
|
||||
func TestNewsParamsAndFallback(t *testing.T) {
|
||||
var calls []url.Values
|
||||
p, _ := newTestPlugin(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
calls = append(calls, r.URL.Query())
|
||||
if r.URL.Query().Get("categories") == "news" {
|
||||
_, _ = w.Write([]byte(`{"query":"n","results":[]}`))
|
||||
return
|
||||
}
|
||||
_, _ = w.Write([]byte(`{"query":"n","results":[{"url":"https://a.com/1","title":"回退结果","content":"内容","engines":["brave"],"score":1}]}`))
|
||||
})
|
||||
res, err := p.handleNews(map[string]interface{}{"query": "某事"})
|
||||
if err != nil {
|
||||
t.Fatalf("err: %v", err)
|
||||
}
|
||||
if len(calls) != 2 {
|
||||
t.Fatalf("新闻为空时应回退 general,实际调用 %d 次", len(calls))
|
||||
}
|
||||
if calls[0].Get("categories") != "news" || calls[0].Get("time_range") != "week" {
|
||||
t.Errorf("首次应为 news + week,实际 categories=%q time_range=%q", calls[0].Get("categories"), calls[0].Get("time_range"))
|
||||
}
|
||||
if tmp := res.(map[string]interface{})["content"].(string); !strings.Contains(tmp, "回退结果") {
|
||||
t.Errorf("回退结果未被采用: %s", tmp)
|
||||
}
|
||||
}
|
||||
|
||||
// 5) 正文抽取:去脚本/样式/导航,保留 article
|
||||
func TestFetchExtractsArticle(t *testing.T) {
|
||||
page := `<!doctype html><html><head><title>测试标题 - 站点</title>
|
||||
<style>.x{color:red}</style><script>var secret="SHOULD_NOT_APPEAR";</script></head>
|
||||
<body><nav>导航链接</nav><article>
|
||||
<p>第一段正文,包含关键事实。</p><p>第二段正文。</p>
|
||||
</article><footer>页脚</footer></body></html>`
|
||||
var srvURL string
|
||||
p, srv := newTestPlugin(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
w.Header().Set("Content-Type", "text/html; charset=utf-8")
|
||||
_, _ = w.Write([]byte(page))
|
||||
})
|
||||
srvURL = srv.URL
|
||||
// 注意:不要用 example.com 之类真实域名——本机 DNS/proxy 会把它们转走,测试会飘
|
||||
res, err := p.handleFetch(map[string]interface{}{"url": srvURL + "/a"})
|
||||
if err != nil {
|
||||
t.Fatalf("err: %v", err)
|
||||
}
|
||||
txt := res.(map[string]interface{})["content"].(string)
|
||||
if !strings.Contains(txt, "第一段正文") {
|
||||
t.Errorf("正文丢失: %s", txt)
|
||||
}
|
||||
if strings.Contains(txt, "SHOULD_NOT_APPEAR") {
|
||||
t.Errorf("脚本内容不应出现: %s", txt)
|
||||
}
|
||||
if strings.Contains(txt, "导航链接") || strings.Contains(txt, "页脚") {
|
||||
t.Errorf("导航/页脚应被剥离: %s", txt)
|
||||
}
|
||||
if !strings.Contains(txt, "测试标题") {
|
||||
t.Errorf("标题应被提取: %s", txt)
|
||||
}
|
||||
}
|
||||
|
||||
// 6) 深检索:候选 + 正文证据;单篇失败不应导致整体失败
|
||||
func TestDeepSearch(t *testing.T) {
|
||||
var srvURL string // 处理函数先于 server 存在,故用闭包变量回填
|
||||
p, srv := newTestPlugin(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
switch r.URL.Path {
|
||||
case "/search":
|
||||
_, _ = w.Write([]byte(`{"query":"d","results":[
|
||||
{"url":"` + srvURL + `/ok1","title":"好文一","content":"摘要一","engines":["brave"],"score":3},
|
||||
{"url":"` + srvURL + `/bad","title":"打不开的","content":"摘要二","engines":["brave"],"score":2},
|
||||
{"url":"` + srvURL + `/ok2","title":"好文二","content":"摘要三","engines":["brave"],"score":1}]}`))
|
||||
case "/ok1", "/ok2":
|
||||
w.Header().Set("Content-Type", "text/html")
|
||||
_, _ = w.Write([]byte("<html><body><article><p>正文内容 " + r.URL.Path + "</p></article></body></html>"))
|
||||
case "/bad":
|
||||
w.WriteHeader(http.StatusForbidden)
|
||||
default:
|
||||
http.NotFound(w, r)
|
||||
}
|
||||
})
|
||||
srvURL = srv.URL
|
||||
res, err := p.handleDeep(map[string]interface{}{"query": "d", "top_k": float64(3), "max_chars": float64(500)})
|
||||
if err != nil {
|
||||
t.Fatalf("err: %v", err)
|
||||
}
|
||||
txt := res.(map[string]interface{})["content"].(string)
|
||||
for _, want := range []string{"候选清单", "正文证据", "正文内容 /ok1", "正文内容 /ok2", "抓取失败"} {
|
||||
if !strings.Contains(txt, want) {
|
||||
t.Errorf("深检索输出缺少 %q:\n%s", want, txt)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// 7) 自检:健康检查 + 探测检索 + 引擎覆盖统计
|
||||
func TestStatusReportsEngines(t *testing.T) {
|
||||
p, _ := newTestPlugin(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.URL.Path == "/healthz" {
|
||||
_, _ = w.Write([]byte("OK"))
|
||||
return
|
||||
}
|
||||
_, _ = w.Write([]byte(sampleResponse))
|
||||
})
|
||||
res, err := p.handleStatus(map[string]interface{}{})
|
||||
if err != nil {
|
||||
t.Fatalf("err: %v", err)
|
||||
}
|
||||
m := res.(map[string]interface{})
|
||||
if m["healthz"] != 200 {
|
||||
t.Errorf("healthz 应为 200,实际 %v", m["healthz"])
|
||||
}
|
||||
if m["search_ok"] != true {
|
||||
t.Errorf("search_ok 应为 true:%v", m["search_ok"])
|
||||
}
|
||||
engs, ok := m["engines_returning_results"].(map[string]int)
|
||||
if !ok || engs["brave"] == 0 || engs["quark"] == 0 {
|
||||
t.Errorf("引擎统计不正确: %#v", m["engines_returning_results"])
|
||||
}
|
||||
}
|
||||
|
||||
// 8) 摘要压成一行并按字符截断(避免巨长摘要吃掉上下文)
|
||||
func TestOneLineTruncate(t *testing.T) {
|
||||
got := oneLine("第一行\n第二行\t第三行", 5)
|
||||
if strings.Contains(got, "\n") {
|
||||
t.Errorf("应为单行: %q", got)
|
||||
}
|
||||
if r := []rune(got); len(r) != 6 { // 5 字符 + 省略号
|
||||
t.Errorf("截断长度不符: %q (%d runes)", got, len(r))
|
||||
}
|
||||
}
|
||||
|
||||
// 9) 正文抽取长度上限生效
|
||||
func TestHtmlToTextTruncation(t *testing.T) {
|
||||
long := strings.Repeat("字", 5000)
|
||||
_, text := htmlToText("<html><body><article><p>"+long+"</p></article></body></html>", 100)
|
||||
if !strings.Contains(text, "已截断") {
|
||||
t.Errorf("超长正文应被截断: %d", len([]rune(text)))
|
||||
}
|
||||
}
|
||||
|
||||
// 10) 非 http(s) 协议应被拒绝
|
||||
func TestFetchRejectsBadScheme(t *testing.T) {
|
||||
p, _ := newTestPlugin(t, func(w http.ResponseWriter, r *http.Request) {})
|
||||
if _, err := p.handleFetch(map[string]interface{}{"url": "file:///etc/passwd"}); err == nil {
|
||||
t.Fatal("file:// 应被拒绝")
|
||||
}
|
||||
if _, err := p.handleFetch(map[string]interface{}{"url": "javascript:alert(1)"}); err == nil {
|
||||
t.Fatal("javascript: 应被拒绝")
|
||||
}
|
||||
}
|
||||
|
||||
// 11) raw 模式返回结构化 JSON(排查用)
|
||||
func TestSearchRawMode(t *testing.T) {
|
||||
p, _ := newTestPlugin(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = w.Write([]byte(sampleResponse))
|
||||
})
|
||||
res, err := p.handleSearch(map[string]interface{}{"query": "q", "raw": true})
|
||||
if err != nil {
|
||||
t.Fatalf("err: %v", err)
|
||||
}
|
||||
m, ok := res.(*searxResponse)
|
||||
if !ok {
|
||||
t.Fatalf("raw 应返回结构化响应,实际 %T", res)
|
||||
}
|
||||
if len(m.Results) != 4 {
|
||||
t.Errorf("结果数应为 4(raw 不去重),实际 %d", len(m.Results))
|
||||
}
|
||||
if _, err := json.Marshal(m); err != nil {
|
||||
t.Errorf("结构化结果应可序列化: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// 13) 条数截断:SearXNG 不认条数参数,插件必须自己截,并且**如实说明**给了几条
|
||||
func TestSearchTruncatesToCountAndSaysSo(t *testing.T) {
|
||||
p, _ := newTestPlugin(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
_, _ = w.Write([]byte(sampleResponse)) // 4 条,去重后 3 条
|
||||
})
|
||||
res, err := p.handleSearch(map[string]interface{}{"query": "deepin", "count": float64(2)})
|
||||
if err != nil {
|
||||
t.Fatalf("err: %v", err)
|
||||
}
|
||||
txt := res.(map[string]interface{})["content"].(string)
|
||||
|
||||
// 必须明确区分「命中几条」与「返回几条」:写成「命中 N 条」而实际给了 M<N 条,
|
||||
// 模型会把 N 当成拿到手的条数(实测被 agent 当成事实报给用户)。
|
||||
if !strings.Contains(txt, "命中 3 条,返回前 2 条") {
|
||||
t.Errorf("应如实说明命中数与返回数:\n%s", txt)
|
||||
}
|
||||
// 按 score 排序后的前两条:zhihu(9.5)、163(7.2);第三条 bbs.deepin(2.0) 必须被截掉
|
||||
if !strings.Contains(txt, "统信内核开发工程师") || !strings.Contains(txt, "离谱!") {
|
||||
t.Errorf("前两条(按分数)应在:\n%s", txt)
|
||||
}
|
||||
if strings.Contains(txt, "deepin官方论坛") {
|
||||
t.Errorf("第 3 条(score 最低)超出了 count=2,不该出现:\n%s", txt)
|
||||
}
|
||||
// 条目行数也要正好 2 条(防「头部说 2 条、正文还是全量」)
|
||||
if n := strings.Count(txt, "\n http"); n != 2 {
|
||||
t.Errorf("正文应恰好 2 条,实际 %d 条:\n%s", n, txt)
|
||||
}
|
||||
}
|
||||
|
||||
// 14) 条数上限:不因为模型要 200 条就真给 200 条
|
||||
func TestLimitResultsCapsAndDefaults(t *testing.T) {
|
||||
p := &Plugin{name: "deepsearch", maxItems: 8}
|
||||
many := make([]searxResult, 30)
|
||||
for i := range many {
|
||||
many[i] = searxResult{URL: "https://e.test/", Title: "t"}
|
||||
}
|
||||
if got := len(p.limitResults(map[string]interface{}{}, many)); got != 8 {
|
||||
t.Errorf("未指定 count 时应取配置的 max_items=8,实际 %d", got)
|
||||
}
|
||||
if got := len(p.limitResults(map[string]interface{}{"count": float64(3)}, many)); got != 3 {
|
||||
t.Errorf("count=3 应返回 3 条,实际 %d", got)
|
||||
}
|
||||
if got := len(p.limitResults(map[string]interface{}{"count": float64(200)}, many)); got != maxSearchResults {
|
||||
t.Errorf("超过上限应收敛到 %d 条,实际 %d", maxSearchResults, got)
|
||||
}
|
||||
// 结果比 count 少时不能造数据
|
||||
few := many[:2]
|
||||
if got := len(p.limitResults(map[string]interface{}{"count": float64(5)}, few)); got != 2 {
|
||||
t.Errorf("结果不足时应原样返回,实际 %d", got)
|
||||
}
|
||||
}
|
||||
164
example/deepsearch/searxng.go
Normal file
164
example/deepsearch/searxng.go
Normal file
@ -0,0 +1,164 @@
|
||||
package main
|
||||
|
||||
// SearXNG 生命周期托管:插件启动时拉起搜索后端,插件停止时关闭它。
|
||||
//
|
||||
// 契约依据(内核侧 internal/plugin/proc/*,已逐行核对):
|
||||
// - 内核停止插件:发 `plugin.stop` → 插件先跑 RunStopHandlers(LIFO、幂等)→ 再 Stop() → exit(0)
|
||||
// - 若插件未在 stopGracePeriod(**5 秒**)内退出,内核直接 SIGKILL
|
||||
// - stdin 关闭(内核消失)同样会跑 handlers + Stop()
|
||||
//
|
||||
// 因此这里的关闭动作必须**有界**:searxShutdownBudget 取 4s,留 1s 余量。
|
||||
//
|
||||
// 归属规则(谁拉起谁关):**只有本插件真正执行了 `docker compose up -d` 的实例才算「我们起的」**。
|
||||
// 探活发现已在运行的实例只「接管」——不认领关闭责任。否则同一台机器上的第二个实例
|
||||
// (E2E 测试拉起的插件、另一个 daemon)退出时会把生产后端一起带走:实测就是这条把
|
||||
// 线上搜索服务反复关停的(测试实例用默认配置,测试结束就 `docker compose stop`)。
|
||||
// 若插件是被 kill -9 / OOM 带走的,关闭动作不会执行 —— SearXNG 会留在运行态;
|
||||
// 下次 Start 探测到它在跑就直接接管,这是更安全的失败方向。
|
||||
|
||||
import (
|
||||
"context"
|
||||
"log"
|
||||
"net/http"
|
||||
"os/exec"
|
||||
"time"
|
||||
)
|
||||
|
||||
const (
|
||||
cfgManageSearx = "manage_searxng"
|
||||
cfgSearxDir = "searxng_dir"
|
||||
cfgStopOnExit = "stop_searxng_on_exit"
|
||||
|
||||
defaultSearxDir = "/root/searxng-agent"
|
||||
|
||||
searxProbeTimeout = 1500 * time.Millisecond // 单次 healthz 探测
|
||||
searxUpBudget = 20 * time.Second // docker compose up -d 的上限(正常 1s 内返回)
|
||||
searxReadyBudget = 6 * time.Second // up 之后等 healthz 就绪的上限
|
||||
searxShutdownBudget = 4 * time.Second // 必须 < 内核 5s 宽限期
|
||||
)
|
||||
|
||||
// searxBudget 把四个时间预算收拢,便于单测注入短值(否则测试要真等就绪窗口)。
|
||||
type searxBudget struct {
|
||||
probe time.Duration
|
||||
up time.Duration
|
||||
ready time.Duration
|
||||
shutdown time.Duration
|
||||
}
|
||||
|
||||
func (p *Plugin) budget() searxBudget {
|
||||
b := p.bud
|
||||
if b.probe == 0 {
|
||||
b.probe = searxProbeTimeout
|
||||
}
|
||||
if b.up == 0 {
|
||||
b.up = searxUpBudget
|
||||
}
|
||||
if b.ready == 0 {
|
||||
b.ready = searxReadyBudget
|
||||
}
|
||||
if b.shutdown == 0 {
|
||||
b.shutdown = searxShutdownBudget
|
||||
}
|
||||
return b
|
||||
}
|
||||
|
||||
// cmdRunner 抽出来是为了让生命周期逻辑可单测:注入假执行器,不起真容器。
|
||||
type cmdRunner func(ctx context.Context, dir, name string, args ...string) (string, error)
|
||||
|
||||
func defaultRunner(ctx context.Context, dir, name string, args ...string) (string, error) {
|
||||
cmd := exec.CommandContext(ctx, name, args...)
|
||||
cmd.Dir = dir
|
||||
out, err := cmd.CombinedOutput()
|
||||
return string(out), err
|
||||
}
|
||||
|
||||
// searxReachable 探测搜索后端是否可用(只看 healthz,不发检索请求)。
|
||||
func (p *Plugin) searxReachable(timeout time.Duration) bool {
|
||||
if p.searxURL == "" {
|
||||
return false
|
||||
}
|
||||
base := p.http
|
||||
if base == nil {
|
||||
base = &http.Client{}
|
||||
}
|
||||
cl := *base // 复制一份,避免改到共享 client 的超时
|
||||
cl.Timeout = timeout
|
||||
req, err := http.NewRequest(http.MethodGet, p.searxURL+"/healthz", nil)
|
||||
if err != nil {
|
||||
return false
|
||||
}
|
||||
req.Header.Set("User-Agent", p.userAgent)
|
||||
resp, err := cl.Do(req)
|
||||
if err != nil {
|
||||
return false
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
return resp.StatusCode < 400
|
||||
}
|
||||
|
||||
// ensureSearxng 在插件启动时确保搜索后端在跑;已在跑则直接接管,不重启。
|
||||
func (p *Plugin) ensureSearxng() {
|
||||
b := p.budget()
|
||||
if !p.manageSearx {
|
||||
log.Printf("[%s] 未启用 SearXNG 托管(manage_searxng=false),假定 %s 由外部维护", p.name, p.searxURL)
|
||||
return
|
||||
}
|
||||
if p.searxReachable(b.probe) {
|
||||
// 只接管,不认领:不是我们拉起来的,就不能由我们关掉
|
||||
log.Printf("[%s] SearXNG 已在运行(%s),直接接管(不认领关闭责任)", p.name, p.searxURL)
|
||||
return
|
||||
}
|
||||
ctx, cancel := context.WithTimeout(context.Background(), b.up)
|
||||
out, err := p.run(ctx, p.searxDir, "docker", "compose", "up", "-d")
|
||||
cancel()
|
||||
if err != nil {
|
||||
log.Printf("[%s] 拉起 SearXNG 失败(dir=%s,请检查 manage_searxng/searxng_dir 配置): %v;输出: %s",
|
||||
p.name, p.searxDir, err, oneLine(out, 300))
|
||||
return
|
||||
}
|
||||
log.Printf("[%s] 已执行 docker compose up -d(%s):%s", p.name, p.searxDir, oneLine(out, 200))
|
||||
|
||||
deadline := time.Now().Add(b.ready)
|
||||
for time.Now().Before(deadline) {
|
||||
if p.searxReachable(800 * time.Millisecond) {
|
||||
log.Printf("[%s] SearXNG 就绪", p.name)
|
||||
p.markSearxOwned()
|
||||
return
|
||||
}
|
||||
time.Sleep(600 * time.Millisecond)
|
||||
}
|
||||
log.Printf("[%s] SearXNG 已启动但 %s 内未就绪;首次检索会自动等待", p.name, b.ready)
|
||||
p.markSearxOwned()
|
||||
}
|
||||
|
||||
func (p *Plugin) markSearxOwned() {
|
||||
p.searxMu.Lock()
|
||||
p.searxOwned = true
|
||||
p.searxMu.Unlock()
|
||||
}
|
||||
|
||||
// shutdownSearxng 关闭搜索后端。幂等,且有界(内核宽限期 5s,这里最多 4s)。
|
||||
func (p *Plugin) shutdownSearxng() {
|
||||
b := p.budget()
|
||||
p.searxMu.Lock()
|
||||
owned := p.searxOwned
|
||||
p.searxOwned = false
|
||||
p.searxMu.Unlock()
|
||||
|
||||
if !owned {
|
||||
return // 不是我们拉起来的 / 已经关过
|
||||
}
|
||||
if !p.manageSearx || !p.stopOnExit {
|
||||
log.Printf("[%s] 保留 SearXNG 运行(stop_searxng_on_exit=false)", p.name)
|
||||
return
|
||||
}
|
||||
ctx, cancel := context.WithTimeout(context.Background(), b.shutdown)
|
||||
defer cancel()
|
||||
out, err := p.run(ctx, p.searxDir, "docker", "compose", "stop", "-t", "2")
|
||||
if err != nil {
|
||||
// 故意只记日志:这里再重试就会拖过内核宽限期,被 SIGKILL 更糟
|
||||
log.Printf("[%s] 关闭 SearXNG 失败(忽略): %v;输出: %s", p.name, err, oneLine(out, 200))
|
||||
return
|
||||
}
|
||||
log.Printf("[%s] 已关闭 SearXNG", p.name)
|
||||
}
|
||||
223
example/deepsearch/searxng_test.go
Normal file
223
example/deepsearch/searxng_test.go
Normal file
@ -0,0 +1,223 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"sync"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
type fakeCall struct {
|
||||
dir string
|
||||
name string
|
||||
args []string
|
||||
}
|
||||
|
||||
func (c fakeCall) String() string { return c.name + " " + strings.Join(c.args, " ") }
|
||||
|
||||
// newFakeRunner 记录调用并返回预设结果
|
||||
func newFakeRunner(calls *[]fakeCall, out string, err error) cmdRunner {
|
||||
var mu sync.Mutex
|
||||
return func(ctx context.Context, dir, name string, args ...string) (string, error) {
|
||||
mu.Lock()
|
||||
*calls = append(*calls, fakeCall{dir: dir, name: name, args: args})
|
||||
mu.Unlock()
|
||||
return out, err
|
||||
}
|
||||
}
|
||||
|
||||
// fastBudget 把就绪窗口压到毫秒级,避免单测真等
|
||||
func fastBudget() searxBudget {
|
||||
return searxBudget{
|
||||
probe: 50 * time.Millisecond,
|
||||
up: time.Second,
|
||||
ready: 200 * time.Millisecond,
|
||||
shutdown: time.Second,
|
||||
}
|
||||
}
|
||||
|
||||
// 1) 后端没跑 → 应执行 docker compose up -d,并认领关闭责任
|
||||
func TestEnsureSearxngStartsWhenUnreachable(t *testing.T) {
|
||||
var calls []fakeCall
|
||||
p := &Plugin{
|
||||
name: "deepsearch", searxURL: "http://127.0.0.1:1", searxDir: "/tmp/fake-searx",
|
||||
manageSearx: true, stopOnExit: true, userAgent: "test",
|
||||
bud: fastBudget(), run: newFakeRunner(&calls, "Container searxng-agent Started", nil),
|
||||
}
|
||||
p.ensureSearxng()
|
||||
|
||||
if len(calls) != 1 {
|
||||
t.Fatalf("应恰好拉起一次,实际 %d 次:%v", len(calls), calls)
|
||||
}
|
||||
got := calls[0]
|
||||
if got.name != "docker" || strings.Join(got.args, " ") != "compose up -d" {
|
||||
t.Errorf("命令不对:%s", got)
|
||||
}
|
||||
if got.dir != "/tmp/fake-searx" {
|
||||
t.Errorf("工作目录应为配置的 compose 目录,实际 %q", got.dir)
|
||||
}
|
||||
if !p.searxOwned {
|
||||
t.Error("既然是我们拉起的,就应认领关闭责任")
|
||||
}
|
||||
}
|
||||
|
||||
// 2) 后端已在跑 → 不重启,**且不认领关闭责任**
|
||||
//
|
||||
// 这条是关键:同一台机器上会有第二个实例(E2E 测试拉起的插件、另一个 daemon)。
|
||||
// 如果「接管」也算「我拥有」,任一实例退出就会把生产后端关掉 —— 线上实测就是
|
||||
// 测试实例在 teardown 时 `docker compose stop`,把搜索服务反复关停。
|
||||
func TestEnsureSearxngAdoptsRunningBackendWithoutOwning(t *testing.T) {
|
||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.URL.Path == "/healthz" {
|
||||
_, _ = w.Write([]byte("OK"))
|
||||
return
|
||||
}
|
||||
http.NotFound(w, r)
|
||||
}))
|
||||
defer srv.Close()
|
||||
|
||||
var calls []fakeCall
|
||||
p := &Plugin{
|
||||
name: "deepsearch", searxURL: srv.URL, searxDir: "/tmp/fake-searx",
|
||||
manageSearx: true, stopOnExit: true, userAgent: "test",
|
||||
bud: fastBudget(), run: newFakeRunner(&calls, "", nil),
|
||||
}
|
||||
p.ensureSearxng()
|
||||
|
||||
if len(calls) != 0 {
|
||||
t.Errorf("已在跑就不该重启它,实际执行了:%v", calls)
|
||||
}
|
||||
if p.searxOwned {
|
||||
t.Error("不是我们拉起的,就不能认领关闭责任(否则退出时会带走别人的后端)")
|
||||
}
|
||||
}
|
||||
|
||||
// 2b) 接管的实例退出时,一个 docker 命令都不能发
|
||||
func TestAdoptedBackendSurvivesShutdown(t *testing.T) {
|
||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = w.Write([]byte("OK"))
|
||||
}))
|
||||
defer srv.Close()
|
||||
|
||||
var calls []fakeCall
|
||||
p := &Plugin{
|
||||
name: "deepsearch", searxURL: srv.URL, searxDir: "/tmp/fake-searx",
|
||||
manageSearx: true, stopOnExit: true, userAgent: "test",
|
||||
bud: fastBudget(), run: newFakeRunner(&calls, "", nil),
|
||||
}
|
||||
p.ensureSearxng()
|
||||
if err := p.Stop(); err != nil {
|
||||
t.Fatalf("Stop: %v", err)
|
||||
}
|
||||
if len(calls) != 0 {
|
||||
t.Errorf("接管来的后端在退出时必须留着,实际执行了:%v", calls)
|
||||
}
|
||||
}
|
||||
|
||||
// 3) 关掉托管 → 完全不碰 docker
|
||||
func TestEnsureSearxngDisabled(t *testing.T) {
|
||||
var calls []fakeCall
|
||||
p := &Plugin{
|
||||
name: "deepsearch", searxURL: "http://127.0.0.1:1", searxDir: "/tmp/fake-searx",
|
||||
manageSearx: false, stopOnExit: true, userAgent: "test",
|
||||
bud: fastBudget(), run: newFakeRunner(&calls, "", nil),
|
||||
}
|
||||
p.ensureSearxng()
|
||||
if len(calls) != 0 || p.searxOwned {
|
||||
t.Errorf("manage_searxng=false 时不该有任何动作:calls=%v owned=%v", calls, p.searxOwned)
|
||||
}
|
||||
}
|
||||
|
||||
// 4) 拉起失败不能让插件起不来(记日志即可)
|
||||
func TestEnsureSearxngFailureNonFatal(t *testing.T) {
|
||||
var calls []fakeCall
|
||||
p := &Plugin{
|
||||
name: "deepsearch", searxURL: "http://127.0.0.1:1", searxDir: "/tmp/fake-searx",
|
||||
manageSearx: true, stopOnExit: true, userAgent: "test",
|
||||
bud: fastBudget(), run: newFakeRunner(&calls, "Cannot connect to the Docker daemon", errors.New("exit status 1")),
|
||||
}
|
||||
p.ensureSearxng() // 不应 panic
|
||||
if p.searxOwned {
|
||||
t.Error("没拉起来就不该认领关闭责任(否则停止时会去关一个不是我们起的服务)")
|
||||
}
|
||||
}
|
||||
|
||||
// 5) 停止:关掉我们拉起的后端,且幂等
|
||||
func TestShutdownStopsOwnedBackend(t *testing.T) {
|
||||
var calls []fakeCall
|
||||
runner := newFakeRunner(&calls, "ok", nil)
|
||||
p := &Plugin{
|
||||
name: "deepsearch", searxURL: "http://127.0.0.1:1", searxDir: "/tmp/fake-searx",
|
||||
manageSearx: true, stopOnExit: true, userAgent: "test",
|
||||
bud: fastBudget(), run: runner,
|
||||
}
|
||||
p.ensureSearxng()
|
||||
calls = nil
|
||||
|
||||
p.shutdownSearxng()
|
||||
if len(calls) != 1 {
|
||||
t.Fatalf("应执行一次 compose stop,实际 %v", calls)
|
||||
}
|
||||
if got := strings.Join(calls[0].args, " "); !strings.HasPrefix(got, "compose stop") {
|
||||
t.Errorf("停止命令不对:%s", got)
|
||||
}
|
||||
if p.searxOwned {
|
||||
t.Error("停止后应清掉认领标记")
|
||||
}
|
||||
|
||||
p.shutdownSearxng() // 幂等:不应再调一次
|
||||
if len(calls) != 1 {
|
||||
t.Errorf("重复停止应无副作用,实际 %v", calls)
|
||||
}
|
||||
}
|
||||
|
||||
// 6) 不是我们拉起的 → 停止时不许动它
|
||||
func TestShutdownSkippedWhenNotOwned(t *testing.T) {
|
||||
var calls []fakeCall
|
||||
p := &Plugin{
|
||||
name: "deepsearch", searxDir: "/tmp/fake-searx", manageSearx: true, stopOnExit: true,
|
||||
bud: fastBudget(), run: newFakeRunner(&calls, "", nil),
|
||||
}
|
||||
p.shutdownSearxng()
|
||||
if len(calls) != 0 {
|
||||
t.Errorf("不该去停一个我们没起的服务:%v", calls)
|
||||
}
|
||||
}
|
||||
|
||||
// 7) 配了「停止时保留」→ 认领过也不关
|
||||
func TestShutdownKeepsBackendWhenConfigured(t *testing.T) {
|
||||
var calls []fakeCall
|
||||
p := &Plugin{
|
||||
name: "deepsearch", searxURL: "http://127.0.0.1:1", searxDir: "/tmp/fake-searx",
|
||||
manageSearx: true, stopOnExit: false, userAgent: "test",
|
||||
bud: fastBudget(), run: newFakeRunner(&calls, "", nil),
|
||||
}
|
||||
p.ensureSearxng()
|
||||
calls = nil
|
||||
p.shutdownSearxng()
|
||||
if len(calls) != 0 {
|
||||
t.Errorf("stop_searxng_on_exit=false 时不应关闭:%v", calls)
|
||||
}
|
||||
}
|
||||
|
||||
// 8) Stop() 自身也要收尾(内核 stdin 关闭路径不会走 stop handler 的注册顺序之外)
|
||||
func TestStopTriggersShutdown(t *testing.T) {
|
||||
var calls []fakeCall
|
||||
p := &Plugin{
|
||||
name: "deepsearch", searxURL: "http://127.0.0.1:1", searxDir: "/tmp/fake-searx",
|
||||
manageSearx: true, stopOnExit: true, userAgent: "test",
|
||||
bud: fastBudget(), run: newFakeRunner(&calls, "", nil),
|
||||
}
|
||||
p.ensureSearxng()
|
||||
calls = nil
|
||||
if err := p.Stop(); err != nil {
|
||||
t.Fatalf("Stop 返回错误: %v", err)
|
||||
}
|
||||
if len(calls) != 1 {
|
||||
t.Errorf("Stop 应触发一次关闭,实际 %v", calls)
|
||||
}
|
||||
}
|
||||
@ -48,6 +48,9 @@ func (p *Plugin) Start(s *sdk.PluginSDK) error {
|
||||
s.SetAutoRestart(true)
|
||||
p.sdk = s
|
||||
p.tp = p.name + "_"
|
||||
// 入站通道:本插件用 p.name 通道注入输入(见 Inject* 调用),
|
||||
// 输入侧必须显式登记 —— 否则"把该 inputch 划给驻留子"会报 `inputch 未注册`。
|
||||
_ = s.RegisterInputChannel(p.name, sdk.ChannelDef{NoMemory: true})
|
||||
|
||||
dataDirVal, err := s.Settings().GetCore("core.daemon.data_dir")
|
||||
if err != nil || dataDirVal == "" {
|
||||
|
||||
@ -1435,7 +1435,12 @@ func (p *Plugin) handleWebhook(w http.ResponseWriter, r *http.Request) {
|
||||
|
||||
if p.sdk != nil {
|
||||
// NoMemory:HTTP 侧来的中断提示,不是对话内容。
|
||||
p.sdk.InjectInterruptTextOpts(p.name, p.name, interrupt, sdk.InjectOptions{NoMemory: true})
|
||||
// Priority:QQ 消息是**低级别中断**——既不是时钟那样的实时工作,
|
||||
// 也不是紧急工作,所以声明 L1(完全可等)。
|
||||
p.sdk.InjectInterruptTextOpts(p.name, p.name, interrupt, sdk.InjectOptions{
|
||||
NoMemory: true,
|
||||
Priority: sdk.PriorityL1,
|
||||
})
|
||||
}
|
||||
w.WriteHeader(http.StatusOK)
|
||||
}
|
||||
@ -2531,9 +2536,10 @@ func (p *Plugin) handleDownloadFile(args map[string]interface{}) (interface{}, e
|
||||
log.Printf("[qq] 文件下载完成: %s", savePath)
|
||||
if p.sdk != nil {
|
||||
// NoMemory:下载完成的状态通知,不是记忆内容。
|
||||
// Priority:同上,QQ 侧一律低级别中断(L1)。
|
||||
p.sdk.InjectInterruptTextOpts(p.name, p.name,
|
||||
fmt.Sprintf("文件下载完成: %s,保存在 %s", filepath.Base(savePath), savePath),
|
||||
sdk.InjectOptions{NoMemory: true})
|
||||
sdk.InjectOptions{NoMemory: true, Priority: sdk.PriorityL1})
|
||||
}
|
||||
} else {
|
||||
errMsg = "下载失败,文件可能已过期"
|
||||
|
||||
@ -104,6 +104,9 @@ func (p *Plugin) Start(s *sdk.PluginSDK) error {
|
||||
s.SetAutoRestart(true)
|
||||
p.sdk = s
|
||||
p.client = &http.Client{Timeout: 30 * time.Second}
|
||||
// 入站通道:本插件用 "rss" 通道注入输入(见 Inject* 调用),
|
||||
// 输入侧必须显式登记 —— 否则"把该 inputch 划给驻留子"会报 `inputch 未注册`。
|
||||
_ = s.RegisterInputChannel("rss", sdk.ChannelDef{NoMemory: true})
|
||||
p.fp = gofeed.NewParser()
|
||||
p.stopCh = make(chan struct{})
|
||||
p.seenGUIDs = make(map[string]bool)
|
||||
@ -158,7 +161,7 @@ func (p *Plugin) Start(s *sdk.PluginSDK) error {
|
||||
s.RegisterTool(tp+"list", sdk.ToolDef{
|
||||
Name: tp + "list", Description: "List all subscribed feeds",
|
||||
Parameters: map[string]interface{}{
|
||||
"type": "object",
|
||||
"type": "object",
|
||||
"properties": map[string]interface{}{},
|
||||
},
|
||||
}, p.handleList)
|
||||
@ -167,7 +170,7 @@ func (p *Plugin) Start(s *sdk.PluginSDK) error {
|
||||
Name: tp + "check_now", Description: "Manually check all feeds for new articles now",
|
||||
NoMemory: true,
|
||||
Parameters: map[string]interface{}{
|
||||
"type": "object",
|
||||
"type": "object",
|
||||
"properties": map[string]interface{}{},
|
||||
},
|
||||
}, p.handleCheckNow)
|
||||
@ -445,7 +448,7 @@ func (p *Plugin) loadData() {
|
||||
return
|
||||
}
|
||||
var data struct {
|
||||
Feeds []FeedSub `json:"feeds"`
|
||||
Feeds []FeedSub `json:"feeds"`
|
||||
SeenGUIDs map[string]bool `json:"seen"`
|
||||
}
|
||||
if json.Unmarshal(b, &data) != nil {
|
||||
@ -463,7 +466,7 @@ func (p *Plugin) saveData() {
|
||||
p.mu.RLock()
|
||||
defer p.mu.RUnlock()
|
||||
data := struct {
|
||||
Feeds []FeedSub `json:"feeds"`
|
||||
Feeds []FeedSub `json:"feeds"`
|
||||
SeenGUIDs map[string]bool `json:"seen"`
|
||||
}{
|
||||
Feeds: p.feeds,
|
||||
@ -488,8 +491,6 @@ func (p *Plugin) cleanupData() {
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
// atomicWriteJSON 原子写 JSON:先写临时文件再 rename,避免进程崩溃截断数据文件。
|
||||
func atomicWriteJSON(path string, data []byte) error {
|
||||
tmp := path + ".tmp"
|
||||
|
||||
81
example/vikunja/README.md
Normal file
81
example/vikunja/README.md
Normal file
@ -0,0 +1,81 @@
|
||||
# Vikunja 插件(HomeAgent)
|
||||
|
||||
把 [Vikunja](https://vikunja.io) 待办/任务管理接入 HomeAgent:用自然语言查任务、建任务、改期、完成、看板拖动、指派、评论、时间跟踪、导入数据等。
|
||||
|
||||
## 配置项(全部可在插件配置界面修改)
|
||||
|
||||
| 键 | 类型 | 默认 | 说明 |
|
||||
|---|---|---|---|
|
||||
| `url` | string | `https://vikunja.jianfgit.xyz` | 站点根地址,**不带** `/api` |
|
||||
| `token` | password(secret) | 空 | **必填**。Vikunja → 设置 → API Tokens 生成(`tk_` 开头)。令牌的权限范围决定本插件能力上限:勾全范围即为完整能力 |
|
||||
| `api_version` | select | `v2` | `v2`(推荐,标准 REST,含时间跟踪等新能力)或 `v1`(用于 v2 暂未提供的端点) |
|
||||
| `default_project_id` | string | 空 | 新建任务未指定项目时落到这里;留空则必须显式指定 |
|
||||
| `max_items` | int | `25` | 列表类工具的默认条数,控制上下文体积 |
|
||||
| `compact_output` | bool | `true` | 任务/项目/标签列表只返回关键字段;关闭则返回 Vikunja 完整对象 |
|
||||
| `timeout_seconds` | int | `20` | 单次 HTTP 超时 |
|
||||
| `verify_tls` | bool | `true` | 自签证书站点可关闭(不建议) |
|
||||
|
||||
配置在**每次工具调用前重新读取**,因此换了 token 不必重启插件。
|
||||
|
||||
## 工具
|
||||
|
||||
| 工具 | 能力 |
|
||||
|---|---|
|
||||
| `vikunja_status` | 连接/配置自检:地址、token 对应的用户、API 版本、服务器能力、CalDAV 地址 |
|
||||
| `vikunja_tasks` | 列任务:按项目、完成状态、截止(today/this_week/overdue/no_due)、关键词、原生 filter 表达式 |
|
||||
| `vikunja_task_get` / `task_create` / `task_update` / `task_done` / `task_delete` | 任务增删改查(`task_update` 只传要改的字段) |
|
||||
| `vikunja_task_bulk` | 批量改完成状态/项目/优先级/截止/标签 |
|
||||
| `vikunja_task_assignees` / `task_labels` / `task_comments` / `task_relations` / `task_attachments` | 指派、标签、评论、关联(子任务/依赖/相关)、附件(支持上传本地文件) |
|
||||
| `vikunja_projects` / `project_views` | 项目增删改查、归档;视图与看板桶(把任务移入桶=看板拖动) |
|
||||
| `vikunja_labels` / `filters` | 标签、保存的筛选器(Saved Filter) |
|
||||
| `vikunja_teams` / `sharing` | 团队与成员;项目分享(用户/团队授权、链接分享含密码) |
|
||||
| `vikunja_notifications` / `subscriptions` / `webhooks` | 通知、订阅、Webhook 管理 |
|
||||
| `vikunja_time_entries` | 时间跟踪(**仅 v2**):补录/修改/删除、开始与停止计时器 |
|
||||
| `vikunja_migrate` | 从 TickTick/WeKan/CSV/Planka/Vikunja 文件(v2)与 Todoist/Trello/微软待办(v1)导入 |
|
||||
| `vikunja_user` / `vikunja_admin` | 当前账号(设置、登录会话、API Token)与实例管理(用户增删/提权/停用/改密、项目归属转移,需实例管理员) |
|
||||
| `vikunja_reactions` | 任务/评论的表情回应 |
|
||||
| `vikunja_api` | **通用直通**:调任意端点,未封装的能力走这里(可强制指定 v1/v2),保证能力无死角 |
|
||||
|
||||
## v1 / v2 差异(已按实例自带规范逐条核对)
|
||||
|
||||
插件默认 v2,并自动处理下列差异:
|
||||
|
||||
| 操作 | v1 | v2 |
|
||||
|---|---|---|
|
||||
| 建任务 | `PUT /projects/{id}/tasks` | `POST /projects/{id}/tasks` |
|
||||
| 改任务 | `POST /tasks/{id}`(必须整对象 → 插件自动取回-合并-提交) | `PATCH /tasks/{id}`(merge-patch,只发变更字段;被拒则回落取回-合并-PUT) |
|
||||
| 搜索参数 | `?s=` | `?q=` |
|
||||
| 加标签 | `PUT`(Label 对象) | `POST`(`{"label_id":N}`) |
|
||||
| 批量改 | `POST /tasks/bulk` | `PUT /tasks/bulk` |
|
||||
| 时间跟踪 | 不支持 | `/time-entries`(`end_time` 为 null 即计时中;停止用 `/time-entries/timer/stop`) |
|
||||
| 导入 | Todoist / Trello / 微软待办 | TickTick / WeKan / CSV / Planka / Vikunja 文件 |
|
||||
|
||||
> 官方路线:v1 仍支持但新端点只进 v2,3.0 弃用、4.0 移除。除“导入”外建议一律用 v2。
|
||||
|
||||
## 开发与构建
|
||||
|
||||
```bash
|
||||
cd third_party/homeagent-sdk/example/vikunja
|
||||
|
||||
go test -count=1 -race ./... # 16 项测试(httptest 打桩,不需要真 token)
|
||||
hmapdev build # 产出 dist/vikunja_bundle.hmap
|
||||
```
|
||||
|
||||
`go.mod` 里的 `replace` 把 SDK 指向仓库内的 `third_party/homeagent-sdk`,因此无需联网拉私有模块。
|
||||
|
||||
### 部署到运行实例
|
||||
|
||||
`.hmap` 包内是 `plugin.json` + `plugin.bin.<os>.<arch>`,安装时按运行平台重命名入口文件:
|
||||
|
||||
```bash
|
||||
unzip -o dist/vikunja_bundle.hmap -d /home/newqqagent/plugins/vikunja
|
||||
cd /home/newqqagent/plugins/vikunja && mv plugin.bin.linux.amd64 plugin.bin
|
||||
# 然后重载插件(或重启 homeagent.service)
|
||||
```
|
||||
|
||||
## 已知边界
|
||||
|
||||
- **附件下载**未单独封装:`task_attachments` 支持列出/上传/删除,下载请用 `vikunja_api` 访问附件 URL。
|
||||
- **链接分享的字段**(`right`/`password`)按 Vikunja 版本语义透传;如遇 4xx,可直接用 `raw` 参数传完整 JSON。
|
||||
- **批量改标签**的 `fields` 结构以 `BulkTask` 为准,未在真实实例上验证过(缺少可用 token),如有偏差请用 `vikunja_api` 直通。
|
||||
- CalDAV 是客户端协议,插件只提供地址(`vikunja_status` 里的 `caldav_url`),不做 CalDAV 同步。
|
||||
15
example/vikunja/go.mod
Normal file
15
example/vikunja/go.mod
Normal file
@ -0,0 +1,15 @@
|
||||
module vikunja-plugin
|
||||
|
||||
go 1.25.0
|
||||
|
||||
require gitcode.com/JianFeeeee/homeagent-sdk v1.2.0
|
||||
|
||||
// 与同目录其它示例一致:SDK 指向仓库内的 vendored 副本
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
replace gitcode.com/JianFeeeee/homeagent-sdk => /root/.homeagent/hmapdev/sdk/v1.2.0
|
||||
12
example/vikunja/plg.json
Normal file
12
example/vikunja/plg.json
Normal file
@ -0,0 +1,12 @@
|
||||
{
|
||||
"name": "vikunja",
|
||||
"name_zh": "Vikunja 待办",
|
||||
"name_en": "Vikunja",
|
||||
"version": "1.0.1",
|
||||
"description": "Vikunja 待办/任务管理:任务增删改查、项目与看板桶、标签、指派、评论、关联、附件、保存筛选器、团队与分享、通知、订阅、Webhook、时间跟踪、数据导入、实例管理;并附通用 API 直通工具兜底",
|
||||
"author": "HomeAgent",
|
||||
"entry": "plugin.bin",
|
||||
"sdk": "1.2.0",
|
||||
"tags": ["vikunja", "todo", "task", "gtd", "productivity"],
|
||||
"targets": "linux/amd64"
|
||||
}
|
||||
2617
example/vikunja/plugin.go
Normal file
2617
example/vikunja/plugin.go
Normal file
File diff suppressed because it is too large
Load Diff
523
example/vikunja/plugin_test.go
Normal file
523
example/vikunja/plugin_test.go
Normal file
@ -0,0 +1,523 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"io"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
)
|
||||
|
||||
// newTestPlugin 构造一个不依赖 sdk 的插件实例,指向 httptest 服务。
|
||||
// ensure() 在 sdk==nil 时会保留已设置的字段,因此可以这样直接测处理器。
|
||||
func newTestPlugin(t *testing.T, h http.HandlerFunc) (*Plugin, *httptest.Server) {
|
||||
t.Helper()
|
||||
srv := httptest.NewServer(h)
|
||||
t.Cleanup(srv.Close)
|
||||
p := &Plugin{
|
||||
name: "vikunja",
|
||||
baseURL: srv.URL,
|
||||
token: "tk_test",
|
||||
apiVer: "v2",
|
||||
maxItems: 5,
|
||||
compact: true,
|
||||
http: srv.Client(),
|
||||
}
|
||||
return p, srv
|
||||
}
|
||||
|
||||
func mustJSON(t *testing.T, v interface{}) []byte {
|
||||
t.Helper()
|
||||
b, err := json.Marshal(v)
|
||||
if err != nil {
|
||||
t.Fatalf("marshal: %v", err)
|
||||
}
|
||||
return b
|
||||
}
|
||||
|
||||
// 1) 列表:v2 用 q= 搜索,且 filter 会带上默认 done 条件
|
||||
func TestTasksListV2(t *testing.T) {
|
||||
var gotQuery string
|
||||
p, _ := newTestPlugin(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
gotQuery = r.URL.RawQuery
|
||||
if r.Header.Get("Authorization") != "Bearer tk_test" {
|
||||
t.Errorf("缺少 Bearer 头: %q", r.Header.Get("Authorization"))
|
||||
}
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
_, _ = w.Write([]byte(`[{"id":1,"title":"写周报","done":false,"project_id":3,"due_date":"2026-09-13T10:00:00Z","labels":[{"title":"工作"}],"assignees":[{"username":"jianf"}]}]`))
|
||||
})
|
||||
res, err := p.handleTasksList(map[string]interface{}{"search": "周报", "limit": float64(5)})
|
||||
if err != nil {
|
||||
t.Fatalf("err: %v", err)
|
||||
}
|
||||
if !strings.Contains(gotQuery, "q=%E5%91%A8%E6%8A%A5") {
|
||||
t.Errorf("v2 应使用 q= 搜索,实际 query=%s", gotQuery)
|
||||
}
|
||||
if strings.Contains(gotQuery, "s=") {
|
||||
t.Errorf("v2 不应使用 s=,实际 query=%s", gotQuery)
|
||||
}
|
||||
if !strings.Contains(gotQuery, "per_page=5") {
|
||||
t.Errorf("per_page 未生效: %s", gotQuery)
|
||||
}
|
||||
if !strings.Contains(gotQuery, "filter=done+%3D+false") && !strings.Contains(gotQuery, "filter=done%20%3D%20false") {
|
||||
t.Errorf("默认应过滤未完成,实际 filter 片段: %s", gotQuery)
|
||||
}
|
||||
m, ok := res.(map[string]interface{})
|
||||
if !ok {
|
||||
t.Fatalf("结果应为 map,实际 %T", res)
|
||||
}
|
||||
if m["count"].(int) != 1 {
|
||||
t.Errorf("count 应为 1,实际 %v", m["count"])
|
||||
}
|
||||
tasks := m["tasks"].([]interface{})
|
||||
tk := tasks[0].(map[string]interface{})
|
||||
if _, ok := tk["labels"].([]string); !ok {
|
||||
t.Errorf("标签应被投影成名称数组,实际 %T", tk["labels"])
|
||||
}
|
||||
if _, ok := tk["description"]; ok {
|
||||
t.Errorf("精简输出不应出现 description")
|
||||
}
|
||||
}
|
||||
|
||||
// 2) 列表:v1 用 s= 搜索
|
||||
func TestTasksListV1SearchParam(t *testing.T) {
|
||||
var gotQuery string
|
||||
p, _ := newTestPlugin(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
gotQuery = r.URL.RawQuery
|
||||
_, _ = w.Write([]byte(`[]`))
|
||||
})
|
||||
p.apiVer = "v1"
|
||||
if _, err := p.handleTasksList(map[string]interface{}{"search": "abc"}); err != nil {
|
||||
t.Fatalf("err: %v", err)
|
||||
}
|
||||
if !strings.Contains(gotQuery, "s=abc") {
|
||||
t.Errorf("v1 应使用 s= 搜索,实际 %s", gotQuery)
|
||||
}
|
||||
if strings.Contains(gotQuery, "q=") {
|
||||
t.Errorf("v1 不应出现 q=,实际 %s", gotQuery)
|
||||
}
|
||||
}
|
||||
|
||||
// 3) 建任务:v1=PUT、v2=POST(同路径,方法不同)
|
||||
func TestTaskCreateMethodByVersion(t *testing.T) {
|
||||
for _, tc := range []struct {
|
||||
ver string
|
||||
method string
|
||||
}{
|
||||
{"v1", http.MethodPut},
|
||||
{"v2", http.MethodPost},
|
||||
} {
|
||||
var gotMethod, gotPath string
|
||||
p, _ := newTestPlugin(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
gotMethod, gotPath = r.Method, r.URL.Path
|
||||
_, _ = w.Write([]byte(`{"id":42,"title":"买菜"}`))
|
||||
})
|
||||
p.apiVer = tc.ver
|
||||
if _, err := p.handleTaskCreate(map[string]interface{}{"project_id": "3", "title": "买菜"}); err != nil {
|
||||
t.Fatalf("[%s] err: %v", tc.ver, err)
|
||||
}
|
||||
if gotMethod != tc.method {
|
||||
t.Errorf("[%s] 期望 %s,实际 %s", tc.ver, tc.method, gotMethod)
|
||||
}
|
||||
if gotPath != "/api/"+tc.ver+"/projects/3/tasks" {
|
||||
t.Errorf("[%s] 路径错误: %s", tc.ver, gotPath)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// 4) 改任务(v2):走 merge-patch,只发变更字段
|
||||
func TestTaskUpdateV2MergePatch(t *testing.T) {
|
||||
var method, ctype string
|
||||
var body map[string]interface{}
|
||||
p, _ := newTestPlugin(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
method = r.Method
|
||||
ctype = r.Header.Get("Content-Type")
|
||||
raw, _ := io.ReadAll(r.Body)
|
||||
_ = json.Unmarshal(raw, &body)
|
||||
_, _ = w.Write([]byte(`{"id":7,"done":true}`))
|
||||
})
|
||||
if _, err := p.handleTaskUpdate(map[string]interface{}{"id": "7", "done": true}); err != nil {
|
||||
t.Fatalf("err: %v", err)
|
||||
}
|
||||
if method != http.MethodPatch {
|
||||
t.Errorf("v2 应用 PATCH,实际 %s", method)
|
||||
}
|
||||
if !strings.Contains(ctype, "merge-patch") {
|
||||
t.Errorf("应使用 merge-patch 内容类型,实际 %s", ctype)
|
||||
}
|
||||
if len(body) != 1 || body["done"] != true {
|
||||
t.Errorf("只应发送变更字段,实际 %v", body)
|
||||
}
|
||||
}
|
||||
|
||||
// 5) 改任务(v2)回退:merge-patch 被拒 → 取回-合并-PUT
|
||||
func TestTaskUpdateV2FallbackToMergePut(t *testing.T) {
|
||||
var calls []string
|
||||
var putBody map[string]interface{}
|
||||
p, _ := newTestPlugin(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
calls = append(calls, r.Method+" "+r.URL.Path)
|
||||
switch {
|
||||
case r.Method == http.MethodPatch:
|
||||
w.WriteHeader(http.StatusUnsupportedMediaType)
|
||||
_, _ = w.Write([]byte(`{"code":9,"message":"unsupported media type"}`))
|
||||
case r.Method == http.MethodGet:
|
||||
_, _ = w.Write([]byte(`{"id":7,"title":"旧标题","done":false,"priority":1}`))
|
||||
case r.Method == http.MethodPut:
|
||||
raw, _ := io.ReadAll(r.Body)
|
||||
_ = json.Unmarshal(raw, &putBody)
|
||||
_, _ = w.Write([]byte(`{"id":7,"title":"新标题","done":false,"priority":1}`))
|
||||
default:
|
||||
t.Errorf("意外请求: %s %s", r.Method, r.URL.Path)
|
||||
}
|
||||
})
|
||||
if _, err := p.handleTaskUpdate(map[string]interface{}{"id": "7", "title": "新标题"}); err != nil {
|
||||
t.Fatalf("err: %v", err)
|
||||
}
|
||||
want := []string{"PATCH /api/v2/tasks/7", "GET /api/v2/tasks/7", "PUT /api/v2/tasks/7"}
|
||||
if len(calls) != len(want) {
|
||||
t.Fatalf("调用序列不符: %v", calls)
|
||||
}
|
||||
for i := range want {
|
||||
if calls[i] != want[i] {
|
||||
t.Errorf("第 %d 步期望 %s,实际 %s", i+1, want[i], calls[i])
|
||||
}
|
||||
}
|
||||
if putBody["title"] != "新标题" {
|
||||
t.Errorf("合并后的 body 应含新标题,实际 %v", putBody)
|
||||
}
|
||||
if putBody["priority"] != float64(1) {
|
||||
t.Errorf("合并必须保留原有字段(priority),实际 %v", putBody)
|
||||
}
|
||||
}
|
||||
|
||||
// 6) 改任务(v1):没有 merge-patch,必须取回-合并-POST
|
||||
func TestTaskUpdateV1FetchMergePost(t *testing.T) {
|
||||
var calls []string
|
||||
p, _ := newTestPlugin(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
calls = append(calls, r.Method+" "+r.URL.Path)
|
||||
if r.Method == http.MethodGet {
|
||||
_, _ = w.Write([]byte(`{"id":9,"title":"旧","priority":2}`))
|
||||
return
|
||||
}
|
||||
_, _ = w.Write([]byte(`{"id":9,"title":"新","priority":2}`))
|
||||
})
|
||||
p.apiVer = "v1"
|
||||
if _, err := p.handleTaskUpdate(map[string]interface{}{"id": "9", "title": "新"}); err != nil {
|
||||
t.Fatalf("err: %v", err)
|
||||
}
|
||||
want := []string{"GET /api/v1/tasks/9", "POST /api/v1/tasks/9"}
|
||||
if len(calls) != 2 || calls[0] != want[0] || calls[1] != want[1] {
|
||||
t.Fatalf("v1 应为 GET→POST,实际 %v", calls)
|
||||
}
|
||||
}
|
||||
|
||||
// 7) 错误映射:401 提示检查 token
|
||||
func TestErrorHint401(t *testing.T) {
|
||||
p, _ := newTestPlugin(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
w.WriteHeader(http.StatusUnauthorized)
|
||||
_, _ = w.Write([]byte(`{"code":11,"message":"invalid token"}`))
|
||||
})
|
||||
_, err := p.handleTasksList(map[string]interface{}{})
|
||||
if err == nil {
|
||||
t.Fatal("应返回错误")
|
||||
}
|
||||
msg := err.Error()
|
||||
if !strings.Contains(msg, "401") || !strings.Contains(msg, "code=11") {
|
||||
t.Errorf("错误信息应含状态码与 Vikunja code,实际 %s", msg)
|
||||
}
|
||||
if !strings.Contains(msg, "token") {
|
||||
t.Errorf("401 应给出 token 提示,实际 %s", msg)
|
||||
}
|
||||
}
|
||||
|
||||
// 8) 未配置 token 时应给出可操作提示,而不是发出无凭据请求
|
||||
func TestMissingToken(t *testing.T) {
|
||||
p, _ := newTestPlugin(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
t.Error("未配置 token 时不应发请求")
|
||||
})
|
||||
p.token = ""
|
||||
_, err := p.handleTasksList(map[string]interface{}{})
|
||||
if err == nil || !strings.Contains(err.Error(), "vikunja.token") {
|
||||
t.Fatalf("应提示配置项名,实际 %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// 9) 导入:Todoist 必须走 v1(即使插件默认是 v2)
|
||||
func TestMigrateUsesV1ForTodoist(t *testing.T) {
|
||||
var path string
|
||||
p, _ := newTestPlugin(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
path = r.URL.Path
|
||||
_, _ = w.Write([]byte(`{"ok":true}`))
|
||||
})
|
||||
if _, err := p.handleMigrate(map[string]interface{}{"action": "start", "source": "todoist", "code": "abc"}); err != nil {
|
||||
t.Fatalf("err: %v", err)
|
||||
}
|
||||
if path != "/api/v1/migration/todoist/migrate" {
|
||||
t.Errorf("Todoist 导入必须走 v1,实际 %s", path)
|
||||
}
|
||||
}
|
||||
|
||||
// 10) 导入:WeKan 走 v2
|
||||
func TestMigrateUsesV2ForWekan(t *testing.T) {
|
||||
var path, method string
|
||||
p, _ := newTestPlugin(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
path, method = r.URL.Path, r.Method
|
||||
_, _ = w.Write([]byte(`{"ok":true}`))
|
||||
})
|
||||
if _, err := p.handleMigrate(map[string]interface{}{"action": "start", "source": "wekan"}); err != nil {
|
||||
t.Fatalf("err: %v", err)
|
||||
}
|
||||
if path != "/api/v2/migration/wekan/migrate" || method != http.MethodPost {
|
||||
t.Errorf("WeKan 应走 v2 POST,实际 %s %s", method, path)
|
||||
}
|
||||
}
|
||||
|
||||
// 11) 时间跟踪:秒数换算成 end_time;计时开始则不带 end_time
|
||||
func TestTimeEntrySecondsBecomesEndTime(t *testing.T) {
|
||||
var body map[string]interface{}
|
||||
p, _ := newTestPlugin(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
raw, _ := io.ReadAll(r.Body)
|
||||
_ = json.Unmarshal(raw, &body)
|
||||
_, _ = w.Write([]byte(`{"id":1}`))
|
||||
})
|
||||
start := "2026-09-12T10:00:00+08:00"
|
||||
if _, err := p.handleTimeEntries(map[string]interface{}{
|
||||
"action": "create", "task_id": "5", "seconds": float64(600),
|
||||
"start_time": start,
|
||||
}); err != nil {
|
||||
t.Fatalf("err: %v", err)
|
||||
}
|
||||
// 判据不写死字符串:按时区无关的方式比较两个时间点
|
||||
sStart, err := time.Parse(time.RFC3339, start)
|
||||
if err != nil {
|
||||
t.Fatalf("case 自身时间写错: %v", err)
|
||||
}
|
||||
gotEnd, ok := body["end_time"].(string)
|
||||
if !ok {
|
||||
t.Fatalf("应有 end_time,实际 %v", body["end_time"])
|
||||
}
|
||||
tEnd, err := time.Parse(time.RFC3339, gotEnd)
|
||||
if err != nil {
|
||||
t.Fatalf("end_time 不是 RFC3339: %q", gotEnd)
|
||||
}
|
||||
if diff := tEnd.Sub(sStart); diff != 10*time.Minute {
|
||||
t.Errorf("end_time 应由 start_time+600s 推出,实际差值 %v", diff)
|
||||
}
|
||||
if _, ok := body["seconds"]; ok {
|
||||
t.Errorf("TimeEntry 没有 seconds 字段,不应发送:%v", body)
|
||||
}
|
||||
|
||||
body = nil
|
||||
if _, err := p.handleTimeEntries(map[string]interface{}{"action": "timer_start", "task_id": "5"}); err != nil {
|
||||
t.Fatalf("err: %v", err)
|
||||
}
|
||||
v, present := body["end_time"]
|
||||
if !present || v != nil {
|
||||
t.Errorf("计时开始应显式 end_time=null(live timer),实际 %v", body)
|
||||
}
|
||||
}
|
||||
|
||||
// 12) 时间跟踪在 v1 下应给出明确不可用提示
|
||||
func TestTimeEntryUnavailableOnV1(t *testing.T) {
|
||||
p, _ := newTestPlugin(t, func(w http.ResponseWriter, r *http.Request) {})
|
||||
p.apiVer = "v1"
|
||||
_, err := p.handleTimeEntries(map[string]interface{}{"action": "list"})
|
||||
if err == nil || !strings.Contains(err.Error(), "v2") {
|
||||
t.Fatalf("v1 下应提示改用 v2,实际 %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// 13) 标签:v1 收 Label 对象、v2 收 label_id
|
||||
func TestLabelBodyByVersion(t *testing.T) {
|
||||
var body map[string]interface{}
|
||||
p, _ := newTestPlugin(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
raw, _ := io.ReadAll(r.Body)
|
||||
_ = json.Unmarshal(raw, &body)
|
||||
_, _ = w.Write([]byte(`{}`))
|
||||
})
|
||||
if _, err := p.handleTaskLabels(map[string]interface{}{"action": "add", "id": "1", "label_id": "5"}); err != nil {
|
||||
t.Fatalf("err: %v", err)
|
||||
}
|
||||
if body["label_id"] != float64(5) {
|
||||
t.Errorf("v2 应发送 label_id,实际 %v", body)
|
||||
}
|
||||
|
||||
body = nil
|
||||
p.apiVer = "v1"
|
||||
if _, err := p.handleTaskLabels(map[string]interface{}{"action": "add", "id": "1", "label_id": "5"}); err != nil {
|
||||
t.Fatalf("err: %v", err)
|
||||
}
|
||||
if body["id"] != float64(5) {
|
||||
t.Errorf("v1 应发送 Label 对象(id),实际 %v", body)
|
||||
}
|
||||
}
|
||||
|
||||
// 14) 时间字符串容忍:today / +3d / ISO
|
||||
func TestNormalizeTime(t *testing.T) {
|
||||
for _, in := range []string{"today", "tomorrow", "+3d", "2026-09-12 18:00", "2026-09-12T18:00:00+08:00"} {
|
||||
got := normalizeTime(in)
|
||||
s, ok := got.(string)
|
||||
if !ok {
|
||||
t.Fatalf("%s: 期望字符串,实际 %T", in, got)
|
||||
}
|
||||
if _, err := time.Parse(time.RFC3339, s); err != nil {
|
||||
t.Errorf("%s → %s 不是 RFC3339: %v", in, s, err)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// 15) 通用直通:可指定 api_version,method 大小写不敏感
|
||||
func TestRawAPI(t *testing.T) {
|
||||
var method, path string
|
||||
p, _ := newTestPlugin(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
method, path = r.Method, r.URL.Path
|
||||
_, _ = w.Write([]byte(`[]`))
|
||||
})
|
||||
if _, err := p.handleRawAPI(map[string]interface{}{"method": "get", "path": "projects", "api_version": "v1"}); err != nil {
|
||||
t.Fatalf("err: %v", err)
|
||||
}
|
||||
if method != http.MethodGet || path != "/api/v1/projects" {
|
||||
t.Errorf("直通参数未生效: %s %s", method, path)
|
||||
}
|
||||
}
|
||||
|
||||
// 16) 精简输出可关闭(关闭时返回原样)
|
||||
func TestCompactToggle(t *testing.T) {
|
||||
p, _ := newTestPlugin(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = w.Write([]byte(`[{"id":1,"title":"t","description":"很长的描述","done":false}]`))
|
||||
})
|
||||
p.compact = false
|
||||
res, err := p.handleTasksList(map[string]interface{}{})
|
||||
if err != nil {
|
||||
t.Fatalf("err: %v", err)
|
||||
}
|
||||
arr, ok := res.([]interface{})
|
||||
if !ok {
|
||||
t.Fatalf("关闭精简后应原样返回数组,实际 %T", res)
|
||||
}
|
||||
if _, ok := arr[0].(map[string]interface{})["description"]; !ok {
|
||||
t.Errorf("关闭精简后应保留 description")
|
||||
}
|
||||
}
|
||||
|
||||
// ── 回归:JSON body 里的 ID 必须是数字(线上实测的 422 缺口)────────────
|
||||
//
|
||||
// vikunja v2.6.0 实测(2026-09-12):
|
||||
// {"project_id":"1"} → 422 expected integer at body.project_id
|
||||
// {"user_id":"1"} → 422 expected integer at body.user_id
|
||||
// {"username":"jianf"} → 422 unexpected property at body.username
|
||||
// 旧实现把 argID() 的字符串直接塞进 body,assignee 还额外带 username,
|
||||
// 于是「建任务」「指派」在 v2 下必定失败 —— 只有真调用才暴露,单测没盖到。
|
||||
|
||||
func TestTaskCreateSendsNumericProjectID(t *testing.T) {
|
||||
var body map[string]interface{}
|
||||
var raw []byte
|
||||
p, _ := newTestPlugin(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
raw, _ = io.ReadAll(r.Body)
|
||||
_ = json.Unmarshal(raw, &body)
|
||||
_, _ = w.Write([]byte(`{"id":42,"title":"买菜"}`))
|
||||
})
|
||||
// project_id 传 float64 —— 这正是 SDK 从 JSON 解出来的真实类型
|
||||
if _, err := p.handleTaskCreate(map[string]interface{}{"project_id": float64(3), "title": "买菜"}); err != nil {
|
||||
t.Fatalf("err: %v", err)
|
||||
}
|
||||
if _, ok := body["project_id"].(float64); !ok {
|
||||
t.Errorf("project_id 必须是 JSON 数字,实际 %T=%v", body["project_id"], body["project_id"])
|
||||
}
|
||||
if strings.Contains(string(raw), `"project_id":"`) {
|
||||
t.Errorf("出现字符串型 project_id(v2 会 422 expected integer): %s", raw)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAssigneeAddResolvesUsernameToNumericUserID(t *testing.T) {
|
||||
var body map[string]interface{}
|
||||
var raw []byte
|
||||
var calls []string
|
||||
p, _ := newTestPlugin(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
calls = append(calls, r.Method+" "+r.URL.Path)
|
||||
switch r.URL.Path {
|
||||
case "/api/v2/users":
|
||||
if r.URL.Query().Get("q") != "alice" {
|
||||
t.Errorf("v2 用户搜索应用 q=,实际 query=%q", r.URL.RawQuery)
|
||||
}
|
||||
_, _ = w.Write([]byte(`[{"id":7,"username":"alice"},{"id":9,"username":"alice2"}]`))
|
||||
case "/api/v2/tasks/1/assignees":
|
||||
raw, _ = io.ReadAll(r.Body)
|
||||
_ = json.Unmarshal(raw, &body)
|
||||
w.WriteHeader(http.StatusCreated)
|
||||
_, _ = w.Write([]byte(`{"user_id":7}`))
|
||||
default:
|
||||
t.Errorf("意外请求: %s %s", r.Method, r.URL.Path)
|
||||
}
|
||||
})
|
||||
if _, err := p.handleTaskAssignees(map[string]interface{}{"id": "1", "action": "add", "user": "alice"}); err != nil {
|
||||
t.Fatalf("err: %v", err)
|
||||
}
|
||||
if len(calls) != 2 {
|
||||
t.Fatalf("应先查用户再指派,实际调用: %v", calls)
|
||||
}
|
||||
if n, ok := body["user_id"].(float64); !ok || int(n) != 7 {
|
||||
t.Errorf("user_id 必须是数字 7,实际 %T=%v", body["user_id"], body["user_id"])
|
||||
}
|
||||
if _, ok := body["username"]; ok {
|
||||
t.Errorf("v2 不接受 username 字段(422 unexpected property): %s", raw)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAssigneeAddNumericUserSkipsLookup(t *testing.T) {
|
||||
var calls []string
|
||||
var body map[string]interface{}
|
||||
p, _ := newTestPlugin(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
calls = append(calls, r.Method+" "+r.URL.Path)
|
||||
if r.URL.Path == "/api/v2/users" {
|
||||
t.Errorf("传数字 ID 时不该再查用户表")
|
||||
}
|
||||
raw, _ := io.ReadAll(r.Body)
|
||||
_ = json.Unmarshal(raw, &body)
|
||||
w.WriteHeader(http.StatusCreated)
|
||||
_, _ = w.Write([]byte(`{"user_id":7}`))
|
||||
})
|
||||
if _, err := p.handleTaskAssignees(map[string]interface{}{"id": "1", "action": "add", "user": "7"}); err != nil {
|
||||
t.Fatalf("err: %v", err)
|
||||
}
|
||||
if len(calls) != 1 {
|
||||
t.Errorf("应只有一次请求,实际: %v", calls)
|
||||
}
|
||||
if n, ok := body["user_id"].(float64); !ok || int(n) != 7 {
|
||||
t.Errorf("user_id 应为数字 7,实际 %T=%v", body["user_id"], body["user_id"])
|
||||
}
|
||||
}
|
||||
|
||||
func TestAssigneeRemoveUsesResolvedNumericPath(t *testing.T) {
|
||||
var gotPath string
|
||||
p, _ := newTestPlugin(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
switch r.URL.Path {
|
||||
case "/api/v2/users":
|
||||
_, _ = w.Write([]byte(`[{"id":7,"username":"alice"}]`))
|
||||
default:
|
||||
gotPath = r.Method + " " + r.URL.Path
|
||||
w.WriteHeader(http.StatusNoContent)
|
||||
}
|
||||
})
|
||||
if _, err := p.handleTaskAssignees(map[string]interface{}{"id": "1", "action": "remove", "user": "alice"}); err != nil {
|
||||
t.Fatalf("err: %v", err)
|
||||
}
|
||||
if gotPath != "DELETE /api/v2/tasks/1/assignees/7" {
|
||||
t.Errorf("移除应用解析出的数字 ID,实际 %q", gotPath)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAssigneeAddUnknownUserGivesReadableError(t *testing.T) {
|
||||
p, _ := newTestPlugin(t, func(w http.ResponseWriter, r *http.Request) {
|
||||
_, _ = w.Write([]byte(`[{"id":7,"username":"bob"}]`))
|
||||
})
|
||||
_, err := p.handleTaskAssignees(map[string]interface{}{"id": "1", "action": "add", "user": "alice"})
|
||||
if err == nil {
|
||||
t.Fatal("找不到用户时必须报错,而不是发出一个注定 422 的请求")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "找不到用户") || !strings.Contains(err.Error(), "bob") {
|
||||
t.Errorf("错误信息应说明找不到并给出相近候选: %v", err)
|
||||
}
|
||||
}
|
||||
@ -50,7 +50,7 @@ var (
|
||||
// 1.2.0 就归发布线所有,main 立刻推进到 1.3.0;而 SDK 因为要等正式 tag,
|
||||
// 它的 main 在 v1.2.0 打出来之前不得越过 1.2.0。
|
||||
// (曾误按 §七.4 把这里推到 1.3.0,等于宣称 1.2.0 已发布。)
|
||||
Version = "1.2.0"
|
||||
Version = "1.3.0"
|
||||
|
||||
// Commit 是构建时的 Git commit hash。
|
||||
Commit = "unknown"
|
||||
|
||||
@ -78,8 +78,30 @@ type InjectOptions struct {
|
||||
NoMemory bool
|
||||
ContextPolicy string
|
||||
CleanerName string
|
||||
|
||||
// Priority 声明**中断注入**的优先级(仅 InjectInterrupt* 有意义)。
|
||||
//
|
||||
// 取值 PriorityL1..PriorityL4;空等同 L1(默认级)。
|
||||
// L4 只有**内核级插件**能用(见 PriorityL4 注释);外部插件的 L4 会被夹到 L3。
|
||||
//
|
||||
// 排队注入(InjectText*/InjectInputSync)没有级别:它们本就是“不需及时处理”
|
||||
// 的那一类,可被任何中断打断。
|
||||
Priority string
|
||||
}
|
||||
|
||||
// 中断优先级取值。
|
||||
//
|
||||
// L1..L3 任何插件都可声明;**L4 只有内核级插件**(编译期内置插件,
|
||||
// 如 cli/webui/timer)才能声明——它用于实现真正的“立即打断”能力,
|
||||
// 例如 WebUI 的终止按钮。外部插件(走 proc 桥)声明 L4 会被内核夹到 L3。
|
||||
const (
|
||||
PriorityL1 = "L1"
|
||||
PriorityL2 = "L2"
|
||||
PriorityL3 = "L3"
|
||||
// PriorityL4 仅内核级(内置)插件可用;外部插件声明会被夹到 L3。
|
||||
PriorityL4 = "L4"
|
||||
)
|
||||
|
||||
// ChannelDef 描述通道在记忆计算层的行为,与 ToolDef.NoMemory/Cleaner 语义一致。
|
||||
// NoMemory: 此通道输入/输出不参与记忆计算(向量化/关键词提取/蒸馏),但原文保留在上下文中
|
||||
// Cleaner: 计算层过滤函数,不改原文;仅在向量化/jieba/蒸馏/存档提取关键词时调用
|
||||
@ -262,6 +284,13 @@ type InputChannelRegistrar func(name string, def ChannelDef) error
|
||||
// OutputChannelRegistrar registers an output channel that the output_send tool can use.
|
||||
type OutputChannelRegistrar func(name string, caps int, desc string, def ChannelDef, handler ToolHandler) error
|
||||
|
||||
// OutputChannelUnregistrar 注销一个输出通道。
|
||||
//
|
||||
// 为什么需要它:输出通道不止有"启动时注册一次"的静态通道,还有**随外部资源生灭**的
|
||||
// 动态通道 —— 典型是远程设备:`device/<id>` 只在设备在线期间存在,设备掉线后
|
||||
// 必须注销,否则 output_list_channels 会一直列着它、模型会往一个死通道发消息。
|
||||
type OutputChannelUnregistrar func(name string) error
|
||||
|
||||
// Output capability flags
|
||||
const (
|
||||
CapText = 1
|
||||
@ -274,22 +303,23 @@ const (
|
||||
// PluginSDK is the main API surface provided to plugins at runtime.
|
||||
// It wraps tool registration, settings, memory, knowledge, LLM, and IO injection.
|
||||
type PluginSDK struct {
|
||||
name string
|
||||
regTool ToolRegistrar
|
||||
regStage StageRegistrar
|
||||
regAPI APIRegistrar
|
||||
regOutput OutputChannelRegistrar
|
||||
regInput InputChannelRegistrar
|
||||
io IOInjector
|
||||
mem MemoryAPI
|
||||
textMem TextMemoryAPI
|
||||
docMem DocMemoryAPI
|
||||
know KnowledgeAPI
|
||||
llm LLMAPI
|
||||
sett SettingsAPI
|
||||
social SocialAPI
|
||||
events EventSubscriber
|
||||
plgMgr PluginMgrAPI
|
||||
name string
|
||||
regTool ToolRegistrar
|
||||
regStage StageRegistrar
|
||||
regAPI APIRegistrar
|
||||
regOutput OutputChannelRegistrar
|
||||
regOutputUnreg OutputChannelUnregistrar
|
||||
regInput InputChannelRegistrar
|
||||
io IOInjector
|
||||
mem MemoryAPI
|
||||
textMem TextMemoryAPI
|
||||
docMem DocMemoryAPI
|
||||
know KnowledgeAPI
|
||||
llm LLMAPI
|
||||
sett SettingsAPI
|
||||
social SocialAPI
|
||||
events EventSubscriber
|
||||
plgMgr PluginMgrAPI
|
||||
|
||||
// apiMu 保护上面这些由内核注入的 API 字段,以及 autoRestart。
|
||||
//
|
||||
@ -445,6 +475,11 @@ func (s *PluginSDK) RegisterPluginAPI(name string) error {
|
||||
}
|
||||
|
||||
// RegisterOutputChannel registers an output channel that the output_send tool can route to.
|
||||
//
|
||||
// 与 RegisterInputChannel 的分工:本函数声明**出站**(output_send__<name> 的回复发给谁);
|
||||
// 入站(谁会往 <name> 注入输入)是另一件事,用 RegisterInputChannel 声明。
|
||||
// 若该通道同时也是你的注入入口,两个都要登记。
|
||||
//
|
||||
// name: channel name (e.g. "qq", "webui")
|
||||
// caps: bitmask of supported output capabilities (CapText, CapFile, etc.)
|
||||
// desc: description of the channel, expected meta format, and type enum
|
||||
@ -460,7 +495,27 @@ func (s *PluginSDK) RegisterOutputChannel(name string, caps int, desc string, de
|
||||
return nil
|
||||
}
|
||||
|
||||
// UnregisterOutputChannel 注销一个输出通道(动态通道随资源生灭时必须调用)。
|
||||
func (s *PluginSDK) UnregisterOutputChannel(name string) error {
|
||||
s.apiMu.RLock()
|
||||
reg := s.regOutputUnreg
|
||||
s.apiMu.RUnlock()
|
||||
if reg != nil {
|
||||
return reg(name)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// RegisterInputChannel registers an input channel with its memory behavior.
|
||||
//
|
||||
// 契约:**凡是用 InjectText*/InjectInput*/InjectInterrupt*(source, "<name>", ...)
|
||||
// 注入的通道名,都应当在这里登记**。inputch 是内核里最基本的**输入路由单位**:
|
||||
// 只有登记过的通道才能在 inputch 登记表里出现,父 agent 才能"把某个 inputch 划给驻留子";
|
||||
// 没登记就划分会直接失败(`inputch 未注册`)。
|
||||
//
|
||||
// 只登记输出通道(RegisterOutputChannel)而没登记输入通道时,内核会兜底登记同名
|
||||
// inputch 并打告警日志 —— 兜底只为兼容老插件,新插件请显式登记。
|
||||
//
|
||||
// def.NoMemory: 此通道输入不参与记忆计算
|
||||
// def.Cleaner: 计算层对输入文本清洗后(不改原文)再向量化/提关键词
|
||||
func (s *PluginSDK) RegisterInputChannel(name string, def ChannelDef) error {
|
||||
@ -482,6 +537,13 @@ func (s *PluginSDK) SetOutputChannelRegistrar(r OutputChannelRegistrar) {
|
||||
s.apiMu.Unlock()
|
||||
}
|
||||
|
||||
// SetOutputChannelUnregistrar sets the output channel unregistrar (called by the core at startup).
|
||||
func (s *PluginSDK) SetOutputChannelUnregistrar(r OutputChannelUnregistrar) {
|
||||
s.apiMu.Lock()
|
||||
s.regOutputUnreg = r
|
||||
s.apiMu.Unlock()
|
||||
}
|
||||
|
||||
// SetInputChannelRegistrar sets the input channel registrar (called by the core at startup).
|
||||
func (s *PluginSDK) SetInputChannelRegistrar(r InputChannelRegistrar) {
|
||||
s.apiMu.Lock()
|
||||
|
||||
@ -79,6 +79,34 @@ func cmdBuild(args []string) {
|
||||
return
|
||||
}
|
||||
|
||||
// 项目可在 plg.json 里声明 sdk(中版本或完整版本,如 "1.2" / "1.2.1");
|
||||
// 显式 --sdk-path / plg.json 的 sdk_path 优先 —— 那是直指源码目录,
|
||||
// 常用于本机改 SDK 的联调场景。
|
||||
if sdkPath == "" && strings.TrimSpace(plg.SDK) != "" {
|
||||
dir, ver, err := ResolveSDKForProject(plg.SDK)
|
||||
if err != nil {
|
||||
fmt.Printf("error: %v\n", err)
|
||||
os.Exit(1)
|
||||
}
|
||||
sdkPath, plg.ResolvedSDK = dir, ver
|
||||
fmt.Printf("[hmapdev] SDK %s(项目声明 sdk=%s)\n", ver, plg.SDK)
|
||||
} else if sdkPath != "" && plg.ResolvedSDK == "" {
|
||||
// 走的是显式路径:尽力记录它是哪版(读不到就不记,不因此失败)
|
||||
plg.ResolvedSDK = normalizeSDKVersion(readMetaVersion(sdkPath))
|
||||
}
|
||||
|
||||
// SDK 能力前置校验:proc 桥的模板(z_proc_gen.go)会透传 InjectOptions.Priority,
|
||||
// 而旧版 SDK 没有这个字段。不校验的话,用户看到的是 z_proc_gen.go 里两条
|
||||
// "opts.Priority undefined" 编译错误——错误信息指向生成物,完全看不出是 SDK 版本问题。
|
||||
if sdkPath != "" && !sdkHasInjectPriority(sdkPath) {
|
||||
fmt.Printf("error: 当前 SDK(%s)缺少 sdk.InjectOptions.Priority\n", plg.ResolvedSDK)
|
||||
fmt.Printf(" 子进程模式(proc 桥)的模板需要它来透传注入优先级 L1-L4。\n")
|
||||
fmt.Printf(" 解决办法(二选一):\n")
|
||||
fmt.Printf(" 1) 升级 SDK:hmapdev sdk install <含该能力的版本> && hmapdev sdk use <版本>\n")
|
||||
fmt.Printf(" 2) 用本地 SDK 源码:hmapdev sdk install --from /path/to/homeagent-sdk\n")
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
// Ensure go.mod exists with correct SDK path
|
||||
sdkModule := ensureGoMod(plg, sdkPath)
|
||||
|
||||
@ -269,6 +297,10 @@ func writePluginJSON(plg *PlgConfig, platforms []string, entry string) {
|
||||
if len(plg.Tags) > 0 {
|
||||
m["tags"] = plg.Tags
|
||||
}
|
||||
// 记录「用哪版 SDK 编的」:插件产物与内核协议绑定,出问题时这是第一个要看的字段。
|
||||
if plg.ResolvedSDK != "" {
|
||||
m["sdk"] = plg.ResolvedSDK
|
||||
}
|
||||
data, _ := json.MarshalIndent(m, "", " ")
|
||||
os.WriteFile("plugin.json", data, 0644)
|
||||
}
|
||||
@ -370,7 +402,28 @@ func ensureGoMod(plg *PlgConfig, sdkPath string) string {
|
||||
}
|
||||
keep = append(keep, line)
|
||||
}
|
||||
if alreadyExists {
|
||||
// 同步 require 版本:replace 指向 1.2.1 而 require 还写 1.2.0 是自相矛盾的
|
||||
// —— 有人删掉 replace 就会静默退回旧版本去编(`go list -m` 报的也是假版本)。
|
||||
// 以本次真正选中的版本为准改写 require 行。
|
||||
requireChanged := false
|
||||
if v := normalizeSDKVersion(plg.ResolvedSDK); v != "" {
|
||||
want := "require " + sdkModule + " v" + v
|
||||
for i, line := range keep {
|
||||
t := strings.TrimSpace(line)
|
||||
if !strings.HasPrefix(t, "require ") {
|
||||
continue
|
||||
}
|
||||
parts := strings.Fields(t)
|
||||
if len(parts) >= 3 && parts[1] == sdkModule {
|
||||
indent := line[:len(line)-len(strings.TrimLeft(line, " \t"))]
|
||||
if t != want {
|
||||
keep[i] = indent + want
|
||||
requireChanged = true
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
if alreadyExists && !requireChanged {
|
||||
return sdkModule
|
||||
}
|
||||
keep = append(keep, replaceLine, "")
|
||||
@ -828,3 +881,22 @@ func linkThirdpart(plg *PlgConfig, target string) func() {
|
||||
os.Remove(importFile)
|
||||
}
|
||||
}
|
||||
|
||||
// sdkHasInjectPriority 报告该 SDK 源码是否已具备 InjectOptions.Priority
|
||||
// (proc 桥透传注入优先级所必需的能力;SDK 开发期与已发布版本可能不一致)。
|
||||
func sdkHasInjectPriority(sdkPath string) bool {
|
||||
data, err := os.ReadFile(filepath.Join(sdkPath, "sdk", "plugin.go"))
|
||||
if err != nil {
|
||||
return true // 读不到就不拦(不在校验范围内)
|
||||
}
|
||||
src := string(data)
|
||||
i := strings.Index(src, "type InjectOptions struct")
|
||||
if i < 0 {
|
||||
return true
|
||||
}
|
||||
seg := src[i:]
|
||||
if j := strings.Index(seg, "\n}"); j > 0 {
|
||||
seg = seg[:j]
|
||||
}
|
||||
return strings.Contains(seg, "Priority")
|
||||
}
|
||||
|
||||
@ -34,6 +34,18 @@ type PlgConfig struct {
|
||||
GoVersion string `json:"go_version,omitempty"`
|
||||
Replaces map[string]string `json:"replaces,omitempty"`
|
||||
SourceDirs []string `json:"source_dirs,omitempty"`
|
||||
|
||||
// SDK 声明本插件针对的 SDK **接口版本**(中版本或完整版本,如 "1.2" / "1.2.1")。
|
||||
//
|
||||
// 为何需要:工具链存储里可能装有多个 SDK 版本,而插件产物与内核是协议绑定的——
|
||||
// 不给声明就只能猜(旧行为是直接用 current:谁改过 current 就拿谁的版本编,
|
||||
// 出错时表现为莫名其妙的编译错误)。写中版本表示「只要 1.2 这条接口线,
|
||||
// 补丁由工具链挑最新」(patch 只含工具链/打包修复,接口不变,见 README 版本语义)。
|
||||
SDK string `json:"sdk,omitempty"`
|
||||
|
||||
// ResolvedSDK 是本次构建实际选中的 SDK 版本(build 按 SDK 声明解析后回填),
|
||||
// 只写进产物里的 plugin.json,便于事后追溯「这个 .hmap 是哪版 SDK 编的」。
|
||||
ResolvedSDK string `json:"-"`
|
||||
}
|
||||
|
||||
// TargetList parses the Targets string into a slice.
|
||||
@ -159,6 +171,9 @@ func cmdInit(args []string) {
|
||||
data.SDKModule = sdkMod
|
||||
data.SDKVersion = "v" + sdkVer
|
||||
data.SDKLocalPath = strings.ReplaceAll(sdkRoot, "\\", "/")
|
||||
// 声明**完整版本号**:SDK 版本跟随内核中版本、patch 位恒为 .0,
|
||||
// 一条内核线只对应一个 SDK 版本(build 时按此解析,见 ResolveSDKForProject)。
|
||||
data.Plg.SDK = normalizeSDKVersion(sdkVer)
|
||||
}
|
||||
|
||||
if err := os.MkdirAll(dir, 0755); err != nil {
|
||||
|
||||
@ -58,6 +58,27 @@ func cmdSDK(args []string) {
|
||||
sdkHelp()
|
||||
return
|
||||
}
|
||||
// install --from <本地目录> [version]:用本地 SDK 源码装一个版本并激活。
|
||||
if args[0] == "install" {
|
||||
from := ""
|
||||
rest := []string{}
|
||||
for i := 1; i < len(args); i++ {
|
||||
if args[i] == "--from" && i+1 < len(args) {
|
||||
from = args[i+1]
|
||||
i++
|
||||
continue
|
||||
}
|
||||
rest = append(rest, args[i])
|
||||
}
|
||||
if from != "" {
|
||||
version := ""
|
||||
if len(rest) > 0 && rest[0] != "latest" {
|
||||
version = rest[0]
|
||||
}
|
||||
cmdSDKInstallFromDir(from, version)
|
||||
return
|
||||
}
|
||||
}
|
||||
switch args[0] {
|
||||
case "list":
|
||||
cmdSDKList()
|
||||
@ -100,7 +121,8 @@ Commands:
|
||||
Examples:
|
||||
hmapdev sdk install v0.7.1
|
||||
hmapdev sdk install latest
|
||||
hmapdev sdk use v0.7.1
|
||||
hmapdev sdk install v0.7.1
|
||||
hmapdev sdk install --from /path/to/homeagent-sdk # 用本地源码(SDK 开发时用)sdk use v0.7.1
|
||||
`)
|
||||
}
|
||||
|
||||
@ -144,6 +166,51 @@ func cmdSDKList() {
|
||||
}
|
||||
}
|
||||
|
||||
// cmdSDKInstallFromDir 从**本地 SDK 源码目录**安装一个版本。
|
||||
//
|
||||
// 为什么需要它:`install` 只能从 Release 归档下载,而 SDK 开发时的新能力
|
||||
// (例如 `InjectOptions.Priority` 这类 proc 桥要透传的字段)往往还没发版 ——
|
||||
// 此时生成出来的插件工程会因为"引用的 SDK 还没有该字段"直接编译失败。
|
||||
// 有 --from 才能"用本地源码当这个版本的 SDK",边改 SDK 边验证模板工程。
|
||||
func cmdSDKInstallFromDir(src, version string) {
|
||||
store := sdkStore()
|
||||
if err := os.MkdirAll(store, 0755); err != nil {
|
||||
fmt.Printf("error: create SDK store %s: %v\n", store, err)
|
||||
os.Exit(1)
|
||||
}
|
||||
if version == "" {
|
||||
version = readMetaVersion(src)
|
||||
}
|
||||
if version == "" {
|
||||
fmt.Printf("error: cannot determine version from %s/meta/meta.go\n", src)
|
||||
os.Exit(1)
|
||||
}
|
||||
if !strings.HasPrefix(version, "v") {
|
||||
version = "v" + version
|
||||
}
|
||||
if _, err := os.Stat(filepath.Join(src, "go.mod")); err != nil {
|
||||
fmt.Printf("error: %s 看起来不是 SDK 源码目录(缺 go.mod)\n", src)
|
||||
os.Exit(1)
|
||||
}
|
||||
dest := sdkVersionDir(version)
|
||||
_ = os.RemoveAll(dest)
|
||||
if err := copyDir(src, dest); err != nil {
|
||||
fmt.Printf("error: copy %s -> %s: %v\n", src, dest, err)
|
||||
os.Exit(1)
|
||||
}
|
||||
// 源码目录里的开发产物不该带进 store。
|
||||
for _, junk := range []string{".git", "dist", "build"} {
|
||||
_ = os.RemoveAll(filepath.Join(dest, junk))
|
||||
}
|
||||
fmt.Printf("Installed SDK %s from %s\n", version, src)
|
||||
fmt.Printf(" %s\n", dest)
|
||||
if err := os.WriteFile(filepath.Join(store, "current"), []byte(version), 0644); err != nil {
|
||||
fmt.Printf("error: activate %s: %v\n", version, err)
|
||||
os.Exit(1)
|
||||
}
|
||||
fmt.Printf("Activated SDK %s\n", version)
|
||||
}
|
||||
|
||||
// cmdSDKInstall downloads and installs an SDK version from Release archive.
|
||||
func cmdSDKInstall(version string) {
|
||||
store := sdkStore()
|
||||
@ -520,5 +587,3 @@ func readMetaVersion(sdkRoot string) string {
|
||||
}
|
||||
return "0.0.0"
|
||||
}
|
||||
|
||||
|
||||
|
||||
@ -2,7 +2,11 @@ package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"runtime"
|
||||
|
||||
"gitcode.com/JianFeeeee/homeagent-sdk/meta"
|
||||
)
|
||||
|
||||
func main() {
|
||||
@ -21,15 +25,42 @@ func main() {
|
||||
cmdDebug(os.Args[2:])
|
||||
case "sdk":
|
||||
cmdSDK(os.Args[2:])
|
||||
case "version", "-v", "--version":
|
||||
printVersion()
|
||||
default:
|
||||
help()
|
||||
}
|
||||
}
|
||||
|
||||
// printVersion 输出工具链自身的版本身份。
|
||||
//
|
||||
// 为何必须有:此前工具链不报版本,而插件产物与内核是**协议绑定**的——
|
||||
// 手里是哪一版工具链、能不能配当前内核,只能靠翻文件名或猜。
|
||||
// 版本号来自 meta.Version(与 SDK 发布同源,由 -ldflags -X 注入);
|
||||
// lnflags 未注入时它是源码里的默认值,此时提示它可能是开发构建。
|
||||
func printVersion() {
|
||||
printVersionTo(os.Stdout)
|
||||
}
|
||||
|
||||
// printVersionTo 把版本身份写到 w(抽出来是为了能被测试钉住)。
|
||||
func printVersionTo(w io.Writer) {
|
||||
fmt.Fprintf(w, "hmapdev %s\n", meta.Version)
|
||||
fmt.Fprintf(w, " SDK 模块: %s\n", "gitcode.com/JianFeeeee/homeagent-sdk")
|
||||
if meta.Commit != "" && meta.Commit != "unknown" {
|
||||
fmt.Fprintf(w, " 构建提交: %s\n", meta.Commit)
|
||||
}
|
||||
if meta.BuildTime != "" && meta.BuildTime != "unknown" {
|
||||
fmt.Fprintf(w, " 构建时间: %s\n", meta.BuildTime)
|
||||
}
|
||||
fmt.Fprintf(w, " 构建用 Go: %s\n", runtime.Version())
|
||||
fmt.Fprintf(w, " 可执行文件: %s\n", os.Args[0])
|
||||
}
|
||||
|
||||
func help() {
|
||||
fmt.Print(`HomeAgent Plugin Dev Tool
|
||||
|
||||
Usage:
|
||||
hmapdev version Print toolchain version
|
||||
hmapdev init <name> Scaffold a new plugin project
|
||||
hmapdev init <name> --lua Create Lua plugin
|
||||
hmapdev init <name> --type remotedevice
|
||||
|
||||
57
tools/hmapdev/main_version_test.go
Normal file
57
tools/hmapdev/main_version_test.go
Normal file
@ -0,0 +1,57 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"gitcode.com/JianFeeeee/homeagent-sdk/meta"
|
||||
)
|
||||
|
||||
// 工具链必须能报出自己的版本。
|
||||
//
|
||||
// 为什么值得钉住:插件产物与内核是协议绑定的,「手里是哪一版工具链」直接决定
|
||||
// 产物能不能建链;此前既没有 version 子命令,`-ldflags -X meta.Version` 也因为
|
||||
// meta 包没被链接而**静默无效**(表现为报不出任何版本)。
|
||||
func TestPrintVersionReportsInjectedVersion(t *testing.T) {
|
||||
origVersion, origCommit := meta.Version, meta.Commit
|
||||
defer func() { meta.Version, meta.Commit = origVersion, origCommit }()
|
||||
|
||||
// 模拟 -ldflags 注入后的取值
|
||||
meta.Version = "9.9.9"
|
||||
meta.Commit = "deadbee"
|
||||
|
||||
var buf bytes.Buffer
|
||||
printVersionTo(&buf)
|
||||
out := buf.String()
|
||||
|
||||
if !strings.Contains(out, "9.9.9") {
|
||||
t.Fatalf("版本号未出现在输出里(-X 注入会失效):\n%s", out)
|
||||
}
|
||||
if !strings.Contains(out, "hmapdev") {
|
||||
t.Fatalf("输出里没有工具名:\n%s", out)
|
||||
}
|
||||
if !strings.Contains(out, "deadbee") {
|
||||
t.Fatalf("提交号未出现在输出里:\n%s", out)
|
||||
}
|
||||
if !strings.Contains(out, "HomeAgent") && !strings.Contains(out, "homeagent-sdk") {
|
||||
t.Fatalf("输出里没有 SDK 模块标识:\n%s", out)
|
||||
}
|
||||
}
|
||||
|
||||
// 未注入时(源码默认值)也必须能报——否则开发构建和发版构建长得一样。
|
||||
func TestPrintVersionWorksWithoutInjection(t *testing.T) {
|
||||
origCommit, origBuildTime := meta.Commit, meta.BuildTime
|
||||
defer func() { meta.Commit, meta.BuildTime = origCommit, origBuildTime }()
|
||||
meta.Commit, meta.BuildTime = "unknown", "unknown"
|
||||
|
||||
var buf bytes.Buffer
|
||||
printVersionTo(&buf)
|
||||
out := buf.String()
|
||||
if !strings.Contains(out, meta.Version) {
|
||||
t.Fatalf("未注入时应报出源码默认版本 %q:\n%s", meta.Version, out)
|
||||
}
|
||||
if strings.Contains(out, "unknown") {
|
||||
t.Fatalf("unknown 字段不应出现在输出里(噪声):\n%s", out)
|
||||
}
|
||||
}
|
||||
135
tools/hmapdev/sdk_resolve.go
Normal file
135
tools/hmapdev/sdk_resolve.go
Normal file
@ -0,0 +1,135 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"sort"
|
||||
"strconv"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// sdkVersionEntry 是本地 SDK 存储里的一个版本。
|
||||
//
|
||||
// Dir 是存储目录名(历史上有 "v0.8.0" 与 "1.2.0" 两种写法都出现过,所以
|
||||
// 目录名与规范化版本号要分开存),Version 是去掉 v 前缀的 x.y.z。
|
||||
type sdkVersionEntry struct {
|
||||
Dir string
|
||||
Version string
|
||||
}
|
||||
|
||||
// normalizeSDKVersion 去掉常见的前缀写法,得到 x.y.z。
|
||||
func normalizeSDKVersion(v string) string {
|
||||
return strings.TrimPrefix(strings.TrimSpace(v), "v")
|
||||
}
|
||||
|
||||
// parseSDKVersion 解析 x.y.z / x.y(后者补 0)。
|
||||
func parseSDKVersion(v string) (maj, min, patch int, ok bool) {
|
||||
v = normalizeSDKVersion(v)
|
||||
parts := strings.Split(v, ".")
|
||||
if len(parts) < 2 || len(parts) > 3 {
|
||||
return 0, 0, 0, false
|
||||
}
|
||||
nums := make([]int, 0, 3)
|
||||
for _, p := range parts {
|
||||
n, err := strconv.Atoi(p)
|
||||
if err != nil || n < 0 {
|
||||
return 0, 0, 0, false
|
||||
}
|
||||
nums = append(nums, n)
|
||||
}
|
||||
for len(nums) < 3 {
|
||||
nums = append(nums, 0)
|
||||
}
|
||||
return nums[0], nums[1], nums[2], true
|
||||
}
|
||||
|
||||
// compareSDKVersion 比较两个 x.y.z(a<b 返回 -1,相等 0,a>b 返回 1)。
|
||||
func compareSDKVersion(a, b string) int {
|
||||
amaj, amin, apat, aok := parseSDKVersion(a)
|
||||
bmaj, bmin, bpat, bok := parseSDKVersion(b)
|
||||
if !aok || !bok {
|
||||
return strings.Compare(normalizeSDKVersion(a), normalizeSDKVersion(b))
|
||||
}
|
||||
for _, d := range [][2]int{{amaj, bmaj}, {amin, bmin}, {apat, bpat}} {
|
||||
switch {
|
||||
case d[0] < d[1]:
|
||||
return -1
|
||||
case d[0] > d[1]:
|
||||
return 1
|
||||
}
|
||||
}
|
||||
return 0
|
||||
}
|
||||
|
||||
// listInstalledSDKs 列出存储里已安装的 SDK,按版本升序。
|
||||
func listInstalledSDKs() []sdkVersionEntry {
|
||||
store := sdkStore()
|
||||
entries, err := os.ReadDir(store)
|
||||
if err != nil {
|
||||
return nil
|
||||
}
|
||||
var out []sdkVersionEntry
|
||||
for _, e := range entries {
|
||||
if !e.IsDir() {
|
||||
continue
|
||||
}
|
||||
name := e.Name()
|
||||
if name == "current" || strings.HasPrefix(name, ".") {
|
||||
continue
|
||||
}
|
||||
v := normalizeSDKVersion(name)
|
||||
if _, _, _, ok := parseSDKVersion(v); !ok {
|
||||
continue // 非版本目录(用户放别的东西进去时不误判)
|
||||
}
|
||||
out = append(out, sdkVersionEntry{Dir: name, Version: v})
|
||||
}
|
||||
sort.Slice(out, func(i, j int) bool { return compareSDKVersion(out[i].Version, out[j].Version) < 0 })
|
||||
return out
|
||||
}
|
||||
|
||||
// ResolveSDKForProject 按项目声明的 SDK 版本(plg.json 的 "sdk" 字段)在本地存储里定位 SDK。
|
||||
//
|
||||
// 声明必须是**完整版本号**(x.y.z,如 "1.2.0"):SDK 的版本纪律是「跟随内核中版本,
|
||||
// patch 位恒为 .0」(内核的 patch 不碰公开接口 → SDK 不跟版),所以一条内核线
|
||||
// 只对应一个 SDK 版本号,写 "1.2" 这种区间写法既不必要、又容易让人以为
|
||||
// 「同一条线里还能挑不同 SDK」。工具链直接拒它,顺便把这条规矩说清楚。
|
||||
//
|
||||
// 找不到时必须报**可执行**的错误:列出已装版本 + 可直接粘贴的安装命令 ——
|
||||
// 只说 "not found" 会让人以为是工具链坏了。
|
||||
func ResolveSDKForProject(declared string) (dir, version string, err error) {
|
||||
declared = normalizeSDKVersion(declared)
|
||||
if strings.Count(declared, ".") != 2 {
|
||||
return "", "", fmt.Errorf(
|
||||
"plg.json 的 sdk 字段 %q 必须是完整版本号(如 \"1.2.0\")——\n"+
|
||||
" SDK 版本跟随内核中版本、patch 位恒为 .0,一条内核线只有一个 SDK 版本", declared)
|
||||
}
|
||||
maj, min, pat, ok := parseSDKVersion(declared)
|
||||
if !ok {
|
||||
return "", "", fmt.Errorf("plg.json 的 sdk 字段 %q 不是合法版本号(写法:\"1.2.0\")", declared)
|
||||
}
|
||||
|
||||
installed := listInstalledSDKs()
|
||||
for i := range installed {
|
||||
e := installed[i]
|
||||
emaj, emin, epat, _ := parseSDKVersion(e.Version)
|
||||
if emaj == maj && emin == min && epat == pat {
|
||||
return filepath.Join(sdkStore(), e.Dir), e.Version, nil
|
||||
}
|
||||
}
|
||||
|
||||
// 未命中:给出可执行的下一步
|
||||
var have []string
|
||||
for _, e := range installed {
|
||||
have = append(have, e.Version)
|
||||
}
|
||||
avail := "(存储里还没有任何 SDK)"
|
||||
if len(have) > 0 {
|
||||
avail = "已安装:" + strings.Join(have, ", ")
|
||||
}
|
||||
return "", "", fmt.Errorf(
|
||||
"项目声明 sdk=%s,但本地 SDK 存储里没有这个版本;%s\n"+
|
||||
" 安装:hmapdev sdk install v%s\n"+
|
||||
" 查看:hmapdev sdk list",
|
||||
declared, avail, declared)
|
||||
}
|
||||
103
tools/hmapdev/sdk_resolve_test.go
Normal file
103
tools/hmapdev/sdk_resolve_test.go
Normal file
@ -0,0 +1,103 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
// withSDKStore 把 SDK 存储指到临时目录(sdkStore 读 HOME),并造出给定版本目录。
|
||||
func withSDKStore(t *testing.T, versions ...string) {
|
||||
t.Helper()
|
||||
home := t.TempDir()
|
||||
t.Setenv("HOME", home)
|
||||
store := filepath.Join(home, ".homeagent", sdkDirName)
|
||||
if err := os.MkdirAll(store, 0755); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
for _, v := range versions {
|
||||
if err := os.MkdirAll(filepath.Join(store, v), 0755); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// 项目声明中版本 → 挑该接口线里最新的补丁;声明完整版本 → 精确命中。
|
||||
//
|
||||
// 为什么允许中版本是关键判据:patch 位只含工具链/打包修复(接口不变),
|
||||
// 让项目声明 "1.2" 而不是死钉 "1.2.0",才能既跟得上工具链修复又不跨接口线。
|
||||
func TestResolveSDKForProject(t *testing.T) {
|
||||
t.Run("区间写法(1.2)被拒并说明版本纪律", func(t *testing.T) {
|
||||
// 判据:SDK 的 patch 位恒为 .0 → 一条内核线只有一个 SDK 版本,
|
||||
// 区间写法会让人误以为「同一条线里还能挑版本」,所以直接拒。
|
||||
withSDKStore(t, "1.2.0")
|
||||
_, _, err := ResolveSDKForProject("1.2")
|
||||
if err == nil {
|
||||
t.Fatal("1.2 这种区间写法应被拒绝")
|
||||
}
|
||||
for _, want := range []string{"完整版本号", "patch 位恒为 .0"} {
|
||||
if !strings.Contains(err.Error(), want) {
|
||||
t.Fatalf("拒绝理由里应说清规矩(缺少 %q): %v", want, err)
|
||||
}
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("完整版本精确命中", func(t *testing.T) {
|
||||
withSDKStore(t, "1.2.0", "1.3.0")
|
||||
_, ver, err := ResolveSDKForProject("1.2.0")
|
||||
if err != nil || ver != "1.2.0" {
|
||||
t.Fatalf("精确命中失败: ver=%s err=%v", ver, err)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("存储目录带 v 前缀也能命中", func(t *testing.T) {
|
||||
withSDKStore(t, "v1.2.0")
|
||||
dir, ver, err := ResolveSDKForProject("1.2.0")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if ver != "1.2.0" || !strings.HasSuffix(dir, "v1.2.0") {
|
||||
t.Fatalf("带 v 前缀的目录名未被识别: dir=%s ver=%s", dir, ver)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("未命中要给出可执行命令与已装清单", func(t *testing.T) {
|
||||
withSDKStore(t, "1.2.0")
|
||||
_, _, err := ResolveSDKForProject("2.0.0")
|
||||
if err == nil {
|
||||
t.Fatal("应报错")
|
||||
}
|
||||
msg := err.Error()
|
||||
for _, want := range []string{"sdk=2.0.0", "hmapdev sdk install", "hmapdev sdk list", "1.2.0"} {
|
||||
if !strings.Contains(msg, want) {
|
||||
t.Fatalf("错误信息缺少 %q(要可执行,不能只说 not found):\n%s", want, msg)
|
||||
}
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("空存储也能给出安装指引", func(t *testing.T) {
|
||||
withSDKStore(t)
|
||||
_, _, err := ResolveSDKForProject("1.2.0")
|
||||
if err == nil || !strings.Contains(err.Error(), "hmapdev sdk install v1.2.0") {
|
||||
t.Fatalf("空存储时应提示装哪个版本: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("非法声明直接拒绝", func(t *testing.T) {
|
||||
withSDKStore(t, "1.2.0")
|
||||
for _, bad := range []string{"abc", "1", "1.2", "1.2.3.4", "-1.2.0"} {
|
||||
if _, _, err := ResolveSDKForProject(bad); err == nil {
|
||||
t.Fatalf("非法版本 %q 应被拒绝(宁可报错也不许当通配符)", bad)
|
||||
}
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("非版本目录不参与匹配", func(t *testing.T) {
|
||||
withSDKStore(t, "1.2.0", "backup-old", ".hidden", "current")
|
||||
_, ver, err := ResolveSDKForProject("1.2.0")
|
||||
if err != nil || ver != "1.2.0" {
|
||||
t.Fatalf("杂项目录不应干扰: ver=%s err=%v", ver, err)
|
||||
}
|
||||
})
|
||||
}
|
||||
@ -9,6 +9,7 @@ const tmplPlgJSON = `{
|
||||
"description": "{{.Plg.Description}}",
|
||||
"author": "{{.Plg.Author}}",
|
||||
"entry": "{{.Plg.Entry}}",
|
||||
"sdk": "{{.Plg.SDK}}",
|
||||
"tags": [{{range $i, $t := .Plg.Tags}}{{if $i}}, {{end}}"{{$t}}"{{end}}],
|
||||
"targets": "{{.Plg.Targets}}"
|
||||
}
|
||||
@ -48,6 +49,22 @@ func (p *Plugin) Start(s *sdk.PluginSDK) error {
|
||||
DisplayName: "示例配置", Description: "An example configuration key",
|
||||
Category: "{{.Plg.Name}}",
|
||||
})
|
||||
// ---- 通道(channel):两个方向是分开的两件事 ----
|
||||
//
|
||||
// 入站 inputch ——「谁会往这个通道注入输入」。
|
||||
// 凡是用 s.InjectText*/InjectInput*/InjectInterrupt*(source, "<name>", ...) 注入的通道名,
|
||||
// 都要在这里登记:inputch 是内核最基本的**输入路由单位**,只有登记过的通道
|
||||
// 才能被「划给驻留子(resident sub-agent)」;没登记就划分会失败(inputch 未注册)。
|
||||
// 只登记出站通道时内核会兜底登记同名 inputch **并打告警**(兼容老插件)。
|
||||
chName := p.name
|
||||
_ = s.RegisterInputChannel(chName, sdk.ChannelDef{NoMemory: true})
|
||||
// 出站 output ——「output_send__<name> 的回复发给谁」。
|
||||
// handler 收到 map:payload(string) / type(string) / meta(string|optional)。
|
||||
_ = s.RegisterOutputChannel(chName, sdk.CapText, "示例通道(回复由此返回)",
|
||||
sdk.ChannelDef{NoMemory: true}, func(args map[string]interface{}) (interface{}, error) {
|
||||
return map[string]interface{}{"status": "ok"}, nil
|
||||
})
|
||||
|
||||
tp := p.name + "_"
|
||||
s.RegisterTool(tp+"hello", sdk.ToolDef{
|
||||
Name: tp + "hello",
|
||||
@ -147,6 +164,15 @@ const tmplMainLua = `-- {{.Plg.Name}} plugin
|
||||
local plugin = { name = "{{.Plg.Name}}" }
|
||||
function plugin.start(sdk)
|
||||
sdk.log("info", "{{.Plg.Name}} starting...")
|
||||
|
||||
-- 通道:入站与出站分开登记。
|
||||
-- 入站 inputch:凡是用 sdk.inject_text/sdk.inject_interrupt(source, "<name>", ...) 注入的通道名
|
||||
-- 都要登记;只有登记过的通道才能被「划给驻留子」(没登记会报 inputch 未注册)。
|
||||
sdk.register_input_channel("{{.Plg.Name}}", { no_memory = true })
|
||||
-- 出站 output:output_send__<name> 的回复由 handler 处理
|
||||
sdk.register_output_channel("{{.Plg.Name}}", 1, "示例通道(回复由此返回)", { no_memory = true },
|
||||
function(args) return { status = "ok" } end)
|
||||
|
||||
sdk.register_tool("{{.Plg.Name}}_hello", {
|
||||
description = "A hello world tool",
|
||||
parameters = { type = "object", properties = {} }
|
||||
@ -514,6 +540,21 @@ const tmplReadme = `# {{.Plg.Name}}
|
||||
hmapdev build
|
||||
` + "```" + `
|
||||
|
||||
## Channels
|
||||
|
||||
入站与出站是分开登记的两件事:
|
||||
|
||||
| 方向 | API | 用途 |
|
||||
|---|---|---|
|
||||
| 入站 inputch | RegisterInputChannel(name, def) | 声明「谁会往这个通道注入输入」。**凡是用 InjectText*/InjectInput*/InjectInterrupt*(source, "<name>", ...) 注入的通道名都要登记** |
|
||||
| 出站 output | RegisterOutputChannel(name, caps, desc, def, handler) | 声明 output_send__<name> 的回复发给谁;handler 收到 {payload,type,meta} |
|
||||
|
||||
def(ChannelDef)描述该通道在记忆计算层的行为:NoMemory: true = 该通道输入不进记忆;
|
||||
Cleaner = 计算层清洗后再向量化/提关键词(原文不改)。
|
||||
|
||||
> 只登记出站通道、却用同名通道注入输入时,内核会兜底登记同名 inputch 并在日志里告警。
|
||||
> 兜底只为兼容老插件 —— 请显式登记,让「这是入站通道」成为插件的明确意图。
|
||||
|
||||
## Install
|
||||
|
||||
Upload the .hmap file through the Plugin Manager API.
|
||||
|
||||
@ -287,6 +287,10 @@ func applyInjectOpts(args map[string]interface{}, opts sdk.InjectOptions) {
|
||||
if opts.CleanerName != "" {
|
||||
args["cleaner_name"] = opts.CleanerName
|
||||
}
|
||||
// priority 只对中断注入有意义(排队注入没有级别)。
|
||||
if opts.Priority != "" {
|
||||
args["priority"] = opts.Priority
|
||||
}
|
||||
}
|
||||
|
||||
// ---- 全局状态 ----
|
||||
|
||||
3
tools/vscode-hmapdev/.gitignore
vendored
Normal file
3
tools/vscode-hmapdev/.gitignore
vendored
Normal file
@ -0,0 +1,3 @@
|
||||
node_modules/
|
||||
out/
|
||||
*.vsix
|
||||
5
tools/vscode-hmapdev/.vscodeignore
Normal file
5
tools/vscode-hmapdev/.vscodeignore
Normal file
@ -0,0 +1,5 @@
|
||||
src/
|
||||
tsconfig.json
|
||||
node_modules/
|
||||
out/test/
|
||||
.gitignore
|
||||
69
tools/vscode-hmapdev/README.md
Normal file
69
tools/vscode-hmapdev/README.md
Normal file
@ -0,0 +1,69 @@
|
||||
# hmapdev — HomeAgent 插件开发 VSCode 扩展
|
||||
|
||||
调试与构建 HomeAgent 插件工程的 IDE 支持:**plg.json 校验、SDK 版本解析、构建/运行、内核日志跟随**。
|
||||
|
||||
## 为什么需要它
|
||||
|
||||
插件的真实形态是「**独立子进程 + 内核侧握手**」,所以插件的三类问题几乎都在 IDE 之外发生:
|
||||
|
||||
1. **编不出来** —— 最常见的原因不是代码,而是项目没声明要用哪版 SDK,工具链拿了存储里的
|
||||
`current`(可能是陈旧的 `v0.8.0`),于是报一堆看不懂的 `undefined: sdk.XXX`;
|
||||
2. **编出来但起不来** —— 产物与内核**协议绑定**(协议版本 + 共享内存魔数),用错工具链编出来的
|
||||
插件会在握手时被拒;
|
||||
3. **起来了但行为不对** —— 真因往往只在内核日志里(建链失败、崩溃重启、工具报错)。
|
||||
|
||||
本扩展把这三件事拉进 IDE:**先把「用哪版 SDK」摆到明面上**,再让构建/运行/看日志变成一条动作链。
|
||||
|
||||
## 功能
|
||||
|
||||
| 功能 | 说明 |
|
||||
|---|---|
|
||||
| **plg.json 诊断** | 必需字段;`sdk` 必须是**完整版本号**(区间写法 `1.2` 会报错并说明「patch 位恒为 .0」);声明的 SDK 若未安装在本地存储,直接给出 `hmapdev sdk install vX.Y.Z` |
|
||||
| **状态栏** | `插件 · SDK <声明> · hmapdev <版本>`;工具链缺失或工程有错时变红/黄,tooltip 列出已装 SDK |
|
||||
| **构建 / 清理 / 运行** | `hmapdev build`、`build --target all`、`clean`、`debug`(解释执行,快速迭代)——在集成终端里跑,可 Ctrl-C |
|
||||
| **任务(Tasks)** | 同一批动作注册为 `hmapdev` 任务,可绑快捷键、串依赖;带 **Go 问题匹配器**,编译错误进 Problems 面板 |
|
||||
| **跟随内核日志** | 读 `<dataDir>/log` 下最新的 `homed_*.log`,按插件名过滤后持续输出(真正的联调回路) |
|
||||
| **SDK 管理** | 查看工具链版本、列出/安装/切换 SDK 版本(走 QuickPick,不用记命令) |
|
||||
| **JSON 支持** | `plg.json` 的 schema 校验 + 骨架片段 |
|
||||
|
||||
## 安装
|
||||
|
||||
```bash
|
||||
cd tools/vscode-hmapdev
|
||||
npm install
|
||||
npm run compile
|
||||
```
|
||||
|
||||
然后二选一:
|
||||
|
||||
- **开发模式**:在 VSCode 里打开本目录,按 `F5`(Extension Development Host),把插件工程目录作为工作区打开;
|
||||
- **安装到本机**:`npx @vscode/vsce package` 生成 `.vsix`,再 `code --install-extension hmapdev-vscode-0.1.0.vsix`。
|
||||
|
||||
前提:`hmapdev` 在 `PATH` 上(或设置 `hmapdev.path`)。
|
||||
|
||||
## 配置
|
||||
|
||||
| 设置 | 默认 | 说明 |
|
||||
|---|---|---|
|
||||
| `hmapdev.path` | `hmapdev` | 工具链可执行文件路径 |
|
||||
| `hmapdev.kernelDataDir` | 空 | 内核数据目录(`homed -data` 的那个);填了才能跟随内核日志 |
|
||||
| `hmapdev.diagnoseSdk` | `true` | 是否校验声明的 SDK 是否已安装(需要能执行 hmapdev) |
|
||||
|
||||
## 用法(典型开发回路)
|
||||
|
||||
1. 打开插件工程(含 `plg.json`)→ 状态栏出现 `插件 · SDK <版本> · hmapdev <版本>`;
|
||||
2. 若 `sdk` 报错(未声明 / 区间写法 / 未安装)→ 按提示执行 `hmapdev: 安装 SDK 版本…`,再 `hmapdev: 刷新状态`;
|
||||
3. `hmapdev: 构建插件`(或 `构建(全部目标平台)`)→ 编译错误直接进 Problems;
|
||||
4. 快速验证行为:`hmapdev: 运行插件(解释执行)`;
|
||||
5. 与内核联调:设置 `hmapdev.kernelDataDir` → `hmapdev: 跟随内核日志`,只看本插件的行;
|
||||
6. 改代码 → 重复 3/5。装进内核时记得**与内核同批替换**(协议绑定的产物不支持滚动升级)。
|
||||
|
||||
## 诚实的边界
|
||||
|
||||
- **这不是源码级调试器**:没有断点/单步。插件的 Go 代码要么编译成产物在内核里跑、要么用
|
||||
`hmapdev debug`(yaegi 解释执行)跑,两条路都不提供 DAP 调试会话。本扩展做的是
|
||||
「构建 + 运行 + 看内核日志 + 清单校验」,这也是插件问题实际能被定位的方式。
|
||||
- **Windows 目标**:不支持(协议 2 的统一共享内存区未移植到 Windows,内核侧改走 WSL2),
|
||||
扩展只给提示,不假装能构建。
|
||||
- **`sdk` 字段的语义**:它声明的是**本插件针对的 SDK 版本**(= 接口线),不是内核版本。
|
||||
SDK 版本跟随内核中版本、patch 位恒为 `.0`。
|
||||
59
tools/vscode-hmapdev/package-lock.json
generated
Normal file
59
tools/vscode-hmapdev/package-lock.json
generated
Normal file
@ -0,0 +1,59 @@
|
||||
{
|
||||
"name": "hmapdev-vscode",
|
||||
"version": "0.1.0",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "hmapdev-vscode",
|
||||
"version": "0.1.0",
|
||||
"license": "AGPL-3.0-only",
|
||||
"devDependencies": {
|
||||
"@types/node": "^22.0.0",
|
||||
"@types/vscode": "^1.85.0",
|
||||
"typescript": "^5.6.0"
|
||||
},
|
||||
"engines": {
|
||||
"vscode": "^1.85.0"
|
||||
}
|
||||
},
|
||||
"node_modules/@types/node": {
|
||||
"version": "22.20.2",
|
||||
"resolved": "https://registry.npmmirror.com/@types/node/-/node-22.20.2.tgz",
|
||||
"integrity": "sha512-xlvWf4Vs9n1PEVYwP1n4vvG07M6y8WgvJ2t0vbrWTmijsIHp1cS+uJ2kMIRdY3nHZK0nCYKrPeD171+SzF4/zw==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"undici-types": "~6.21.0"
|
||||
}
|
||||
},
|
||||
"node_modules/@types/vscode": {
|
||||
"version": "1.137.0",
|
||||
"resolved": "https://registry.npmmirror.com/@types/vscode/-/vscode-1.137.0.tgz",
|
||||
"integrity": "sha512-0dc/BBWxkyUsJzXIZ7PkKSalThmS4xiBT+8YEDiWdCefRKHGVV5ZNkM5NB5ULYamallYJujIfncNoXWFlyzL8A==",
|
||||
"dev": true,
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/typescript": {
|
||||
"version": "5.9.3",
|
||||
"resolved": "https://registry.npmmirror.com/typescript/-/typescript-5.9.3.tgz",
|
||||
"integrity": "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw==",
|
||||
"dev": true,
|
||||
"license": "Apache-2.0",
|
||||
"bin": {
|
||||
"tsc": "bin/tsc",
|
||||
"tsserver": "bin/tsserver"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=14.17"
|
||||
}
|
||||
},
|
||||
"node_modules/undici-types": {
|
||||
"version": "6.21.0",
|
||||
"resolved": "https://registry.npmmirror.com/undici-types/-/undici-types-6.21.0.tgz",
|
||||
"integrity": "sha512-iwDZqg0QAGrg9Rav5H4n0M64c3mkR59cJ6wQp+7C4nI0gsmExaedaYLNO44eT4AtBBwjbTiGPMlt2Md0T9H9JQ==",
|
||||
"dev": true,
|
||||
"license": "MIT"
|
||||
}
|
||||
}
|
||||
}
|
||||
174
tools/vscode-hmapdev/package.json
Normal file
174
tools/vscode-hmapdev/package.json
Normal file
@ -0,0 +1,174 @@
|
||||
{
|
||||
"name": "hmapdev-vscode",
|
||||
"displayName": "HomeAgent Plugin Dev (hmapdev)",
|
||||
"description": "调试与构建 HomeAgent 插件工程:plg.json 校验、SDK 版本解析、hmapdev 构建/运行、内核日志跟随。",
|
||||
"version": "0.1.0",
|
||||
"publisher": "JianFeeeee",
|
||||
"license": "AGPL-3.0-only",
|
||||
"private": true,
|
||||
"engines": {
|
||||
"vscode": "^1.85.0"
|
||||
},
|
||||
"categories": [
|
||||
"Programming Languages",
|
||||
"Debuggers",
|
||||
"Other"
|
||||
],
|
||||
"main": "./out/extension.js",
|
||||
"activationEvents": [
|
||||
"workspaceContains:plg.json",
|
||||
"workspaceContains:**/plg.json"
|
||||
],
|
||||
"contributes": {
|
||||
"commands": [
|
||||
{
|
||||
"command": "hmapdev.build",
|
||||
"title": "hmapdev: 构建插件"
|
||||
},
|
||||
{
|
||||
"command": "hmapdev.buildAll",
|
||||
"title": "hmapdev: 构建插件(全部目标平台)"
|
||||
},
|
||||
{
|
||||
"command": "hmapdev.clean",
|
||||
"title": "hmapdev: 清理产物"
|
||||
},
|
||||
{
|
||||
"command": "hmapdev.run",
|
||||
"title": "hmapdev: 运行插件(解释执行,快速迭代)"
|
||||
},
|
||||
{
|
||||
"command": "hmapdev.showVersion",
|
||||
"title": "hmapdev: 查看工具链版本"
|
||||
},
|
||||
{
|
||||
"command": "hmapdev.listSdk",
|
||||
"title": "hmapdev: 列出 SDK 版本"
|
||||
},
|
||||
{
|
||||
"command": "hmapdev.installSdk",
|
||||
"title": "hmapdev: 安装 SDK 版本…"
|
||||
},
|
||||
{
|
||||
"command": "hmapdev.useSdk",
|
||||
"title": "hmapdev: 切换当前 SDK 版本…"
|
||||
},
|
||||
{
|
||||
"command": "hmapdev.tailKernelLog",
|
||||
"title": "hmapdev: 跟随内核日志(按插件过滤)"
|
||||
},
|
||||
{
|
||||
"command": "hmapdev.stopTailKernelLog",
|
||||
"title": "hmapdev: 停止跟随内核日志"
|
||||
},
|
||||
{
|
||||
"command": "hmapdev.openPlgJson",
|
||||
"title": "hmapdev: 打开 plg.json"
|
||||
},
|
||||
{
|
||||
"command": "hmapdev.refresh",
|
||||
"title": "hmapdev: 刷新状态(重新探测工具链与 SDK)"
|
||||
}
|
||||
],
|
||||
"configuration": {
|
||||
"title": "HomeAgent Plugin Dev",
|
||||
"properties": {
|
||||
"hmapdev.path": {
|
||||
"type": "string",
|
||||
"default": "hmapdev",
|
||||
"description": "hmapdev 可执行文件路径(默认从 PATH 找)。"
|
||||
},
|
||||
"hmapdev.kernelDataDir": {
|
||||
"type": "string",
|
||||
"default": "",
|
||||
"description": "内核数据目录(homed -data 的那个目录)。填了才能跟随内核日志调试;留空则「跟随内核日志」会先询问。"
|
||||
},
|
||||
"hmapdev.diagnoseSdk": {
|
||||
"type": "boolean",
|
||||
"default": true,
|
||||
"description": "校验 plg.json 里声明的 SDK 版本是否已安装在本地 SDK 存储(需要能执行 hmapdev)。"
|
||||
}
|
||||
}
|
||||
},
|
||||
"taskDefinitions": [
|
||||
{
|
||||
"type": "hmapdev",
|
||||
"required": [
|
||||
"action"
|
||||
],
|
||||
"properties": {
|
||||
"action": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"build",
|
||||
"buildAll",
|
||||
"clean",
|
||||
"run"
|
||||
],
|
||||
"description": "要执行的 hmapdev 动作。"
|
||||
},
|
||||
"cwd": {
|
||||
"type": "string",
|
||||
"description": "插件工程目录(默认取 plg.json 所在目录)。"
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"problemMatchers": [
|
||||
{
|
||||
"name": "hmapdev-go",
|
||||
"owner": "go",
|
||||
"source": "hmapdev",
|
||||
"fileLocation": [
|
||||
"relative",
|
||||
"${workspaceFolder}"
|
||||
],
|
||||
"pattern": [
|
||||
{
|
||||
"regexp": "^(.+\\.go):(\\d+):(\\d+):\\s+(.+)$",
|
||||
"file": 1,
|
||||
"line": 2,
|
||||
"column": 3,
|
||||
"message": 4
|
||||
},
|
||||
{
|
||||
"regexp": "^(.+\\.go):(\\d+):\\s+(.+)$",
|
||||
"file": 1,
|
||||
"line": 2,
|
||||
"message": 3
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"languages": [
|
||||
{
|
||||
"id": "json",
|
||||
"filenames": [
|
||||
"plg.json"
|
||||
]
|
||||
}
|
||||
],
|
||||
"jsonValidation": [
|
||||
{
|
||||
"fileMatch": "plg.json",
|
||||
"url": "./schema/plg.schema.json"
|
||||
}
|
||||
],
|
||||
"snippets": [
|
||||
{
|
||||
"language": "json",
|
||||
"path": "./snippets/plg.json.code-snippets"
|
||||
}
|
||||
]
|
||||
},
|
||||
"scripts": {
|
||||
"compile": "tsc -p ./",
|
||||
"watch": "tsc -watch -p ./",
|
||||
"test": "tsc -p ./ && node --test out/test/*.test.js"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/node": "^22.0.0",
|
||||
"@types/vscode": "^1.85.0",
|
||||
"typescript": "^5.6.0"
|
||||
}
|
||||
}
|
||||
41
tools/vscode-hmapdev/schema/plg.schema.json
Normal file
41
tools/vscode-hmapdev/schema/plg.schema.json
Normal file
@ -0,0 +1,41 @@
|
||||
{
|
||||
"$schema": "http://json-schema.org/draft-07/schema#",
|
||||
"title": "HomeAgent 插件清单(plg.json)",
|
||||
"type": "object",
|
||||
"required": ["name", "version", "entry"],
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "插件名(与目录名一致最省事)"
|
||||
},
|
||||
"name_zh": { "type": "string", "description": "中文显示名" },
|
||||
"name_en": { "type": "string", "description": "英文显示名" },
|
||||
"version": { "type": "string", "description": "插件自身版本号(如 0.1.0),与内核/SDK 版本无关" },
|
||||
"description": { "type": "string" },
|
||||
"author": { "type": "string" },
|
||||
"entry": {
|
||||
"type": "string",
|
||||
"description": "入口产物文件名(子进程模式通常是 plugin.bin;Lua 是 main.lua)"
|
||||
},
|
||||
"sdk": {
|
||||
"type": "string",
|
||||
"pattern": "^v?\\d+\\.\\d+\\.\\d+$",
|
||||
"description": "本插件针对的 SDK 版本,必须是完整版本号(如 1.2.0)。SDK 版本跟随内核中版本、patch 位恒为 .0,一条内核线只有一个 SDK 版本;工具链按此在本地 SDK 存储里选择版本。"
|
||||
},
|
||||
"tags": { "type": "array", "items": { "type": "string" } },
|
||||
"targets": {
|
||||
"type": "string",
|
||||
"description": "目标平台,逗号分隔,如 linux/amd64,darwin/arm64(windows 目标暂不支持插件产物)"
|
||||
},
|
||||
"outdir": { "type": "string", "description": "产物目录(默认 dist)" },
|
||||
"bundle": { "type": "boolean", "description": "是否打包成 .hmap(默认 true)" },
|
||||
"sdk_path": {
|
||||
"type": "string",
|
||||
"description": "直接指定 SDK 源码目录(本机改 SDK 联调时用);设置后优先于 sdk 字段"
|
||||
},
|
||||
"go_version": { "type": "string" },
|
||||
"replaces": { "type": "object", "additionalProperties": { "type": "string" } },
|
||||
"source_dirs": { "type": "array", "items": { "type": "string" } }
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
26
tools/vscode-hmapdev/snippets/plg.json.code-snippets
Normal file
26
tools/vscode-hmapdev/snippets/plg.json.code-snippets
Normal file
@ -0,0 +1,26 @@
|
||||
{
|
||||
"plg.json 骨架": {
|
||||
"prefix": "plg",
|
||||
"body": [
|
||||
"{",
|
||||
" \"name\": \"${1:MyPlugin}\",",
|
||||
" \"name_zh\": \"${2:中文名}\",",
|
||||
" \"name_en\": \"${1:MyPlugin}\",",
|
||||
" \"version\": \"0.1.0\",",
|
||||
" \"description\": \"${3:插件说明}\",",
|
||||
" \"author\": \"${4:HomeAgent}\",",
|
||||
" \"entry\": \"plugin.bin\",",
|
||||
" \"sdk\": \"${5:1.2.0}\",",
|
||||
" \"tags\": [\"${1:MyPlugin}\"],",
|
||||
" \"targets\": \"linux/amd64,darwin/arm64\"",
|
||||
"}",
|
||||
"$0"
|
||||
],
|
||||
"description": "plg.json 必需字段骨架(sdk 必须是完整版本号)"
|
||||
},
|
||||
"sdk 字段": {
|
||||
"prefix": "sdk",
|
||||
"body": ["\"sdk\": \"${1:1.2.0}\","],
|
||||
"description": "声明本插件针对的 SDK 版本(完整版本号;patch 位恒为 .0)"
|
||||
}
|
||||
}
|
||||
174
tools/vscode-hmapdev/src/core.ts
Normal file
174
tools/vscode-hmapdev/src/core.ts
Normal file
@ -0,0 +1,174 @@
|
||||
/**
|
||||
* 纯逻辑层:不 import vscode,便于用 node --test 直接单测。
|
||||
*
|
||||
* 这里的规矩必须与工具链一致(tools/hmapdev/sdk_resolve.go):
|
||||
* - SDK 版本跟随内核中版本、**patch 位恒为 .0** → 一条内核线只有一个 SDK 版本;
|
||||
* - 因此 plg.json 的 `sdk` 必须是**完整版本号**(x.y.z),区间写法("1.2")要报错,
|
||||
* 否则项目会以为「同一条线里还能挑不同 SDK」。
|
||||
*/
|
||||
|
||||
/** plg.json 的字段(未知字段保留,不做拒绝)。 */
|
||||
export interface PlgConfig {
|
||||
name?: string;
|
||||
name_zh?: string;
|
||||
name_en?: string;
|
||||
version?: string;
|
||||
description?: string;
|
||||
author?: string;
|
||||
entry?: string;
|
||||
sdk?: string;
|
||||
tags?: string[];
|
||||
targets?: string;
|
||||
sdk_path?: string;
|
||||
outdir?: string;
|
||||
bundle?: boolean;
|
||||
replaces?: Record<string, string>;
|
||||
source_dirs?: string[];
|
||||
}
|
||||
|
||||
/** 诊断级别(与 vscode.DiagnosticSeverity 数值对齐,避免耦合)。 */
|
||||
export enum Severity {
|
||||
Error = 0,
|
||||
Warning = 1,
|
||||
Information = 2,
|
||||
Hint = 3,
|
||||
}
|
||||
|
||||
export interface PlgDiagnostic {
|
||||
severity: Severity;
|
||||
message: string;
|
||||
/** plg.json 里的字段名(用于在 JSON 文档里定位)。 */
|
||||
field?: string;
|
||||
}
|
||||
|
||||
/** 完整版本号(x.y.z,允许 v 前缀)。 */
|
||||
export function isFullVersion(v: string): boolean {
|
||||
return /^v?\d+\.\d+\.\d+$/.test((v ?? "").trim());
|
||||
}
|
||||
|
||||
/** 中版本(x.y)。 */
|
||||
export function isMinorVersion(v: string): boolean {
|
||||
return /^v?\d+\.\d+$/.test((v ?? "").trim());
|
||||
}
|
||||
|
||||
export function normalizeVersion(v: string): string {
|
||||
return (v ?? "").trim().replace(/^v/, "");
|
||||
}
|
||||
|
||||
/**
|
||||
* 校验 plg.json。
|
||||
*
|
||||
* `installedSdks` 为本地 SDK 存储里已安装的版本(不带 v 前缀);传 undefined 表示
|
||||
* 没探测(例如工具链不可用),此时只校验格式、不报「未安装」。
|
||||
*/
|
||||
export function validatePlg(cfg: PlgConfig, installedSdks?: string[]): PlgDiagnostic[] {
|
||||
const out: PlgDiagnostic[] = [];
|
||||
const req = (field: keyof PlgConfig, hint: string) => {
|
||||
const v = cfg[field];
|
||||
if (v === undefined || v === null || String(v).trim() === "") {
|
||||
out.push({ severity: Severity.Error, message: `${field} 不能为空(${hint})`, field: field as string });
|
||||
}
|
||||
};
|
||||
req("name", "插件名,与目录名一致最省事");
|
||||
req("entry", "入口产物,子进程模式通常是 plugin.bin");
|
||||
req("version", "插件自身版本号,如 0.1.0");
|
||||
|
||||
// SDK 声明:这是「工具链自动选 SDK 版本」的依据,缺了就只能退回 current
|
||||
if (cfg.sdk === undefined || cfg.sdk === null || String(cfg.sdk).trim() === "") {
|
||||
out.push({
|
||||
severity: Severity.Warning,
|
||||
message: "缺少 sdk 字段:工具链无法据此选择 SDK 版本,会退回存储里的 current(换机器/换人后容易编出与预期不符的产物)",
|
||||
field: "sdk",
|
||||
});
|
||||
} else if (isMinorVersion(cfg.sdk)) {
|
||||
out.push({
|
||||
severity: Severity.Error,
|
||||
message:
|
||||
`sdk 必须是完整版本号(如 "1.2.0"):${cfg.sdk} 这种区间写法会让人以为同一条内核线里还能挑不同 SDK。` +
|
||||
`SDK 版本跟随内核中版本、patch 位恒为 .0,一条内核线只有一个 SDK 版本。`,
|
||||
field: "sdk",
|
||||
});
|
||||
} else if (!isFullVersion(cfg.sdk)) {
|
||||
out.push({ severity: Severity.Error, message: `sdk 不是合法版本号(写法:"1.2.0")`, field: "sdk" });
|
||||
} else if (installedSdks && !installedSdks.includes(normalizeVersion(cfg.sdk))) {
|
||||
const have = installedSdks.length ? installedSdks.join(", ") : "(存储里还没有任何 SDK)";
|
||||
out.push({
|
||||
severity: Severity.Error,
|
||||
message: `声明的 SDK ${normalizeVersion(cfg.sdk)} 未安装。已安装:${have}。安装:hmapdev sdk install v${normalizeVersion(cfg.sdk)}`,
|
||||
field: "sdk",
|
||||
});
|
||||
}
|
||||
|
||||
// 目标平台:windows 目前不支持(协议 2 的统一共享内存区未移植)
|
||||
const targets = (cfg.targets ?? "").toLowerCase();
|
||||
if (targets.includes("windows")) {
|
||||
out.push({
|
||||
severity: Severity.Information,
|
||||
message: "windows 目标暂不支持插件产物:协议 2 的统一共享内存区未移植 Windows(内核改走 WSL2)。构建会在该目标上明确报错。",
|
||||
field: "targets",
|
||||
});
|
||||
}
|
||||
if (!cfg.targets) {
|
||||
out.push({ severity: Severity.Information, message: "未声明 targets,构建时按默认目标处理", field: "targets" });
|
||||
}
|
||||
return out;
|
||||
}
|
||||
|
||||
/**
|
||||
* 解析 `hmapdev sdk list` 的输出,返回已安装版本(去 v 前缀、升序)。
|
||||
*
|
||||
* 输出形如:
|
||||
* Installed SDK versions:
|
||||
* * v1.2.0
|
||||
* v0.8.0
|
||||
* 每行可能带 `*` 标记(当前版本)或前导空格。
|
||||
*/
|
||||
export function parseSdkList(text: string): string[] {
|
||||
const out: string[] = [];
|
||||
for (const raw of (text ?? "").split(/\r?\n/)) {
|
||||
const line = raw.trim().replace(/^\*\s*/, "").trim();
|
||||
const m = /^v?(\d+\.\d+\.\d+)$/.exec(line);
|
||||
if (m) {
|
||||
out.push(m[1]);
|
||||
}
|
||||
}
|
||||
return out.sort(compareVersions);
|
||||
}
|
||||
|
||||
/**
|
||||
* 解析 `hmapdev version` 的自述(首行形如 `hmapdev 1.2.0`)。
|
||||
*
|
||||
* 只认**以数字开头**的版本 token:否则 `hmapdev 未找到` / `hmapdev error`
|
||||
* 这类输出会被当成版本号,把「工具链不在」误报成「工具链 1.x」
|
||||
* (状态栏与「是否已装 SDK」的判断都基于它,假版本会让诊断全面失真)。
|
||||
*/
|
||||
export function parseToolchainVersion(text: string): string {
|
||||
for (const raw of (text ?? "").split(/\r?\n/)) {
|
||||
const m = /^hmapdev\s+v?(\d+(?:\.\d+)*(?:[-+.][0-9A-Za-z.-]+)?)\s*$/.exec(raw.trim());
|
||||
if (m) {
|
||||
return m[1];
|
||||
}
|
||||
}
|
||||
return "";
|
||||
}
|
||||
|
||||
/** 数值比较 x.y.z(字典序会把 1.2.9 排在 1.2.10 之后)。 */
|
||||
export function compareVersions(a: string, b: string): number {
|
||||
const pa = normalizeVersion(a).split(".").map((n) => parseInt(n, 10) || 0);
|
||||
const pb = normalizeVersion(b).split(".").map((n) => parseInt(n, 10) || 0);
|
||||
for (let i = 0; i < 3; i++) {
|
||||
const d = (pa[i] ?? 0) - (pb[i] ?? 0);
|
||||
if (d !== 0) {
|
||||
return d;
|
||||
}
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
|
||||
/** 状态栏文本:插件 + 声明 SDK + 工具链版本(缺项用 "?")。 */
|
||||
export function statusBarText(cfg: PlgConfig | undefined, toolchainVersion: string): string {
|
||||
const name = cfg?.name?.trim() || "(未识别插件)";
|
||||
const sdk = cfg?.sdk ? normalizeVersion(cfg.sdk) : "未声明";
|
||||
const tc = toolchainVersion ? `hmapdev ${toolchainVersion}` : "hmapdev 未找到";
|
||||
return `${name} · SDK ${sdk} · ${tc}`;
|
||||
}
|
||||
272
tools/vscode-hmapdev/src/extension.ts
Normal file
272
tools/vscode-hmapdev/src/extension.ts
Normal file
@ -0,0 +1,272 @@
|
||||
import * as cp from "child_process";
|
||||
import * as path from "path";
|
||||
import * as vscode from "vscode";
|
||||
|
||||
import { PlgConfig, Severity, statusBarText, validatePlg } from "./core";
|
||||
import { Toolchain } from "./toolchain";
|
||||
|
||||
let out: vscode.OutputChannel;
|
||||
let tc: Toolchain;
|
||||
let status: vscode.StatusBarItem;
|
||||
let diagnostics: vscode.DiagnosticCollection;
|
||||
let tailChild: cp.ChildProcess | undefined;
|
||||
|
||||
/** 找到工作区里的 plg.json(多个时取第一个并提示)。 */
|
||||
async function findPlg(): Promise<vscode.Uri | undefined> {
|
||||
const found = await vscode.workspace.findFiles("**/plg.json", "**/{node_modules,out,dist,build}/**", 5);
|
||||
if (found.length === 0) {
|
||||
return undefined;
|
||||
}
|
||||
return found[0];
|
||||
}
|
||||
|
||||
async function readPlg(uri: vscode.Uri): Promise<PlgConfig | undefined> {
|
||||
try {
|
||||
const txt = Buffer.from(await vscode.workspace.fs.readFile(uri)).toString("utf8");
|
||||
return JSON.parse(txt) as PlgConfig;
|
||||
} catch (e) {
|
||||
out.appendLine(`error: 解析 ${uri.fsPath} 失败:${e instanceof Error ? e.message : String(e)}`);
|
||||
return undefined;
|
||||
}
|
||||
}
|
||||
|
||||
function severityToVscode(s: Severity): vscode.DiagnosticSeverity {
|
||||
switch (s) {
|
||||
case Severity.Error:
|
||||
return vscode.DiagnosticSeverity.Error;
|
||||
case Severity.Warning:
|
||||
return vscode.DiagnosticSeverity.Warning;
|
||||
case Severity.Information:
|
||||
return vscode.DiagnosticSeverity.Information;
|
||||
default:
|
||||
return vscode.DiagnosticSeverity.Hint;
|
||||
}
|
||||
}
|
||||
|
||||
/** 在 JSON 文档里定位字段(找不到就标整个文件,至少让人看见)。 */
|
||||
function rangeForField(doc: vscode.TextDocument, field?: string): vscode.Range {
|
||||
if (field) {
|
||||
const idx = doc.getText().indexOf(`"${field}"`);
|
||||
if (idx >= 0) {
|
||||
const start = doc.positionAt(idx);
|
||||
const end = doc.positionAt(idx + field.length + 2);
|
||||
return new vscode.Range(start, end);
|
||||
}
|
||||
}
|
||||
return new vscode.Range(new vscode.Position(0, 0), new vscode.Position(0, 0));
|
||||
}
|
||||
|
||||
async function refresh(): Promise<void> {
|
||||
const uri = await findPlg();
|
||||
diagnostics.clear();
|
||||
if (!uri) {
|
||||
status.text = statusBarText(undefined, await tc.version());
|
||||
status.tooltip = "工作区里没有找到 plg.json(本扩展只在插件工程里工作)";
|
||||
return;
|
||||
}
|
||||
const cfg = await readPlg(uri);
|
||||
if (!cfg) {
|
||||
return;
|
||||
}
|
||||
|
||||
const tcVersion = await tc.version();
|
||||
const diagSetting = vscode.workspace.getConfiguration("hmapdev").get<boolean>("diagnoseSdk", true);
|
||||
const installed = diagSetting ? await tc.sdkList() : undefined;
|
||||
|
||||
const doc = await vscode.workspace.openTextDocument(uri);
|
||||
const items = validatePlg(cfg, installed).map((d) => {
|
||||
const vd = new vscode.Diagnostic(rangeForField(doc, d.field), d.message, severityToVscode(d.severity));
|
||||
vd.source = "hmapdev";
|
||||
return vd;
|
||||
});
|
||||
diagnostics.set(uri, items);
|
||||
|
||||
const errors = items.filter((d) => d.severity === vscode.DiagnosticSeverity.Error).length;
|
||||
status.text = `$(tools) ${statusBarText(cfg, tcVersion)}`;
|
||||
status.backgroundColor = tc.isMissing()
|
||||
? new vscode.ThemeColor("statusBarItem.errorBackground")
|
||||
: errors > 0
|
||||
? new vscode.ThemeColor("statusBarItem.warningBackground")
|
||||
: undefined;
|
||||
const installedText = installed ? installed.join(", ") || "(无)" : "(未探测)";
|
||||
status.tooltip = [
|
||||
`插件:${cfg.name ?? "?"}`,
|
||||
`声明 SDK:${cfg.sdk ?? "未声明"}`,
|
||||
`已安装 SDK:${installedText}`,
|
||||
`工具链:${tcVersion ? `hmapdev ${tcVersion}` : "未找到(检查 hmapdev.path / PATH)"}`,
|
||||
`plg.json:${uri.fsPath}`,
|
||||
].join("\n");
|
||||
status.command = "hmapdev.openPlgJson";
|
||||
status.show();
|
||||
}
|
||||
|
||||
async function pluginDir(): Promise<string | undefined> {
|
||||
const uri = await findPlg();
|
||||
return uri ? path.dirname(uri.fsPath) : undefined;
|
||||
}
|
||||
|
||||
async function withDir(fn: (dir: string) => unknown | Promise<unknown>): Promise<void> {
|
||||
const dir = await pluginDir();
|
||||
if (!dir) {
|
||||
void vscode.window.showWarningMessage("当前工作区没有 plg.json,无法定位插件工程。");
|
||||
return;
|
||||
}
|
||||
await fn(dir);
|
||||
}
|
||||
|
||||
export function activate(context: vscode.ExtensionContext): void {
|
||||
out = vscode.window.createOutputChannel("hmapdev");
|
||||
tc = new Toolchain(out);
|
||||
diagnostics = vscode.languages.createDiagnosticCollection("hmapdev");
|
||||
status = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Left, 100);
|
||||
|
||||
context.subscriptions.push(out, diagnostics, status);
|
||||
|
||||
const reg = (id: string, fn: () => unknown) =>
|
||||
context.subscriptions.push(vscode.commands.registerCommand(id, async () => {
|
||||
try {
|
||||
await fn();
|
||||
} catch (e) {
|
||||
const msg = e instanceof Error ? e.message : String(e);
|
||||
out.appendLine(`error: ${msg}`);
|
||||
void vscode.window.showErrorMessage(`hmapdev: ${msg}`);
|
||||
}
|
||||
}));
|
||||
|
||||
reg("hmapdev.build", () => withDir((d) => tc.runInTerminal(["build"], d, "hmapdev build")));
|
||||
reg("hmapdev.buildAll", () => withDir((d) => tc.runInTerminal(["build", "--target", "all"], d, "hmapdev build all")));
|
||||
reg("hmapdev.clean", () => withDir((d) => tc.runInTerminal(["clean"], d, "hmapdev clean")));
|
||||
reg("hmapdev.run", () => withDir((d) => tc.runInTerminal(["debug", d], d, "hmapdev debug")));
|
||||
|
||||
reg("hmapdev.showVersion", async () => {
|
||||
out.show(true);
|
||||
const v = await tc.version(true);
|
||||
if (!v) {
|
||||
void vscode.window.showErrorMessage("找不到 hmapdev:请把它放到 PATH,或设置 hmapdev.path。");
|
||||
return;
|
||||
}
|
||||
await tc.runAndLog(["version"], process.cwd());
|
||||
});
|
||||
|
||||
reg("hmapdev.listSdk", async () => {
|
||||
out.show(true);
|
||||
await tc.runAndLog(["sdk", "list"], process.cwd());
|
||||
await refresh();
|
||||
});
|
||||
|
||||
reg("hmapdev.installSdk", async () => {
|
||||
const v = await vscode.window.showInputBox({
|
||||
title: "安装 SDK 版本",
|
||||
prompt: '输入完整版本号(如 1.2.0)或 latest。注意:SDK 版本跟随内核中版本,patch 位恒为 .0。',
|
||||
placeHolder: "1.2.0",
|
||||
});
|
||||
if (!v) {
|
||||
return;
|
||||
}
|
||||
tc.runInTerminal(["sdk", "install", `v${v.replace(/^v/, "")}`], process.cwd(), "hmapdev sdk install");
|
||||
void vscode.window.showInformationMessage(`安装完成后执行「hmapdev: 刷新状态」以重新校验。`);
|
||||
});
|
||||
|
||||
reg("hmapdev.useSdk", async () => {
|
||||
const list = await tc.sdkList(true);
|
||||
if (!list || list.length === 0) {
|
||||
void vscode.window.showWarningMessage("没有探测到已安装的 SDK 版本(先跑「hmapdev: 列出 SDK 版本」看看)。");
|
||||
return;
|
||||
}
|
||||
const pick = await vscode.window.showQuickPick(list, { title: "切换当前 SDK 版本(存储里的 current)" });
|
||||
if (!pick) {
|
||||
return;
|
||||
}
|
||||
tc.runInTerminal(["sdk", "use", `v${pick}`], process.cwd(), "hmapdev sdk use");
|
||||
setTimeout(() => void refresh(), 1500);
|
||||
});
|
||||
|
||||
reg("hmapdev.tailKernelLog", async () => {
|
||||
const cfgDir = vscode.workspace.getConfiguration("hmapdev");
|
||||
let dataDir = cfgDir.get<string>("kernelDataDir", "");
|
||||
if (!dataDir) {
|
||||
const answer = await vscode.window.showInputBox({
|
||||
title: "内核数据目录",
|
||||
prompt: "homed -data 指向的目录(用于跟随内核日志)。填一次会记住到设置里。",
|
||||
placeHolder: "/home/newqqagent",
|
||||
});
|
||||
if (!answer) {
|
||||
return;
|
||||
}
|
||||
dataDir = answer;
|
||||
await cfgDir.update("kernelDataDir", dataDir, vscode.ConfigurationTarget.Workspace);
|
||||
}
|
||||
const uri = await findPlg();
|
||||
const filter = uri ? (await readPlg(uri))?.name ?? "" : "";
|
||||
tailChild?.kill();
|
||||
tailChild = tc.tailKernelLog(dataDir, filter);
|
||||
out.show(true);
|
||||
});
|
||||
|
||||
reg("hmapdev.stopTailKernelLog", () => {
|
||||
if (tailChild) {
|
||||
tailChild.kill();
|
||||
tailChild = undefined;
|
||||
out.appendLine("已停止跟随内核日志");
|
||||
}
|
||||
});
|
||||
|
||||
reg("hmapdev.openPlgJson", async () => {
|
||||
const uri = await findPlg();
|
||||
if (uri) {
|
||||
await vscode.window.showTextDocument(await vscode.workspace.openTextDocument(uri));
|
||||
} else {
|
||||
void vscode.window.showWarningMessage("工作区里没有 plg.json。");
|
||||
}
|
||||
});
|
||||
|
||||
reg("hmapdev.refresh", async () => {
|
||||
await tc.sdkList(true);
|
||||
await tc.version(true);
|
||||
await refresh();
|
||||
});
|
||||
|
||||
// 任务提供者:把 hmapdev 动作接进 VSCode 的任务体系(可绑定快捷键 / 串联依赖 / 复用问题匹配器)
|
||||
context.subscriptions.push(
|
||||
vscode.tasks.registerTaskProvider("hmapdev", {
|
||||
provideTasks: async () => {
|
||||
const dir = await pluginDir();
|
||||
if (!dir) {
|
||||
return [];
|
||||
}
|
||||
const mk = (action: string, label: string, args: string[]) => {
|
||||
const def: vscode.TaskDefinition = { type: "hmapdev", action };
|
||||
const exec = new vscode.ProcessExecution(
|
||||
vscode.workspace.getConfiguration("hmapdev").get<string>("path", "hmapdev") || "hmapdev",
|
||||
args,
|
||||
{ cwd: dir }
|
||||
);
|
||||
return new vscode.Task(def, vscode.TaskScope.Workspace, label, "hmapdev", exec, ["$hmapdev-go"]);
|
||||
};
|
||||
return [
|
||||
mk("build", "hmapdev: build", ["build"]),
|
||||
mk("buildAll", "hmapdev: build (all targets)", ["build", "--target", "all"]),
|
||||
mk("clean", "hmapdev: clean", ["clean"]),
|
||||
mk("run", "hmapdev: run (interpreted)", ["debug", dir]),
|
||||
];
|
||||
},
|
||||
resolveTask: (task) => task,
|
||||
})
|
||||
);
|
||||
|
||||
// plg.json 变化 → 重算诊断(含保存与外部修改)
|
||||
const watcher = vscode.workspace.createFileSystemWatcher("**/plg.json");
|
||||
context.subscriptions.push(
|
||||
watcher,
|
||||
watcher.onDidChange(() => void refresh()),
|
||||
watcher.onDidCreate(() => void refresh()),
|
||||
watcher.onDidDelete(() => void refresh())
|
||||
);
|
||||
|
||||
void refresh();
|
||||
}
|
||||
|
||||
export function deactivate(): void {
|
||||
tailChild?.kill();
|
||||
tailChild = undefined;
|
||||
}
|
||||
106
tools/vscode-hmapdev/src/test/core.test.ts
Normal file
106
tools/vscode-hmapdev/src/test/core.test.ts
Normal file
@ -0,0 +1,106 @@
|
||||
import * as assert from "node:assert/strict";
|
||||
import { test } from "node:test";
|
||||
|
||||
import {
|
||||
PlgConfig,
|
||||
Severity,
|
||||
compareVersions,
|
||||
isFullVersion,
|
||||
isMinorVersion,
|
||||
normalizeVersion,
|
||||
parseSdkList,
|
||||
parseToolchainVersion,
|
||||
statusBarText,
|
||||
validatePlg,
|
||||
} from "../core";
|
||||
|
||||
const good: PlgConfig = { name: "memo", version: "0.1.0", entry: "plugin.bin", sdk: "1.2.0" };
|
||||
|
||||
test("isFullVersion / isMinorVersion 区分完整版本与区间写法", () => {
|
||||
assert.equal(isFullVersion("1.2.0"), true);
|
||||
assert.equal(isFullVersion("v1.2.0"), true);
|
||||
assert.equal(isFullVersion("1.2"), false);
|
||||
assert.equal(isFullVersion("1.2.3.4"), false);
|
||||
assert.equal(isMinorVersion("1.2"), true);
|
||||
assert.equal(isMinorVersion("1.2.0"), false);
|
||||
assert.equal(normalizeVersion("v1.2.0"), "1.2.0");
|
||||
});
|
||||
|
||||
test("合法的 plg.json 不产生错误", () => {
|
||||
const d = validatePlg(good, ["1.2.0"]);
|
||||
assert.equal(d.filter((x) => x.severity === Severity.Error).length, 0, JSON.stringify(d));
|
||||
});
|
||||
|
||||
test("缺必需字段要报错并指出字段", () => {
|
||||
const d = validatePlg({ sdk: "1.2.0" }, ["1.2.0"]);
|
||||
const fields = d.filter((x) => x.severity === Severity.Error).map((x) => x.field).sort();
|
||||
assert.deepEqual(fields, ["entry", "name", "version"]);
|
||||
});
|
||||
|
||||
test("区间写法 1.2 必须被拒,并说明 patch 位恒为 .0", () => {
|
||||
const d = validatePlg({ ...good, sdk: "1.2" }, ["1.2.0"]);
|
||||
const err = d.find((x) => x.field === "sdk" && x.severity === Severity.Error);
|
||||
assert.ok(err, "区间写法应报错");
|
||||
assert.match(err!.message, /完整版本号/);
|
||||
assert.match(err!.message, /patch 位恒为 \.0/);
|
||||
});
|
||||
|
||||
test("缺 sdk 字段只警告(向后兼容存量项目)", () => {
|
||||
const d = validatePlg({ name: "memo", version: "0.1.0", entry: "plugin.bin" }, ["1.2.0"]);
|
||||
const sdk = d.find((x) => x.field === "sdk");
|
||||
assert.ok(sdk);
|
||||
assert.equal(sdk!.severity, Severity.Warning);
|
||||
});
|
||||
|
||||
test("声明的 SDK 未安装要报错并给出安装命令", () => {
|
||||
const d = validatePlg(good, ["0.8.0"]);
|
||||
const err = d.find((x) => x.field === "sdk" && x.severity === Severity.Error);
|
||||
assert.ok(err, "未安装应报错");
|
||||
assert.match(err!.message, /hmapdev sdk install v1\.2\.0/);
|
||||
assert.match(err!.message, /0\.8\.0/);
|
||||
});
|
||||
|
||||
test("探测不到已装列表时不误报未安装", () => {
|
||||
const d = validatePlg(good, undefined);
|
||||
assert.equal(d.filter((x) => x.severity === Severity.Error).length, 0, JSON.stringify(d));
|
||||
});
|
||||
|
||||
test("windows 目标给提示(协议 2 未移植)", () => {
|
||||
const d = validatePlg({ ...good, targets: "linux/amd64,windows/amd64" }, ["1.2.0"]);
|
||||
const info = d.find((x) => x.field === "targets");
|
||||
assert.ok(info);
|
||||
assert.match(info!.message, /WSL2/);
|
||||
});
|
||||
|
||||
test("parseSdkList 吃掉 * 标记与空格,并按数值排序", () => {
|
||||
const text = ["Installed SDK versions:", " * v1.2.0", " v0.8.0", " v1.2.10"].join("\n");
|
||||
assert.deepEqual(parseSdkList(text), ["0.8.0", "1.2.0", "1.2.10"]);
|
||||
assert.deepEqual(parseSdkList("No SDK versions installed."), []);
|
||||
});
|
||||
|
||||
test("parseToolchainVersion 从 self-report 里取版本", () => {
|
||||
const text = ["hmapdev 1.2.0", " SDK 模块: gitcode.com/JianFeeeee/homeagent-sdk", " 构建用 Go: go1.25.12"].join("\n");
|
||||
assert.equal(parseToolchainVersion(text), "1.2.0");
|
||||
assert.equal(parseToolchainVersion("Usage:\n hmapdev init <name>"), "");
|
||||
});
|
||||
|
||||
// 反向核对抓到的真缺陷:`hmapdev <非版本>` 形状的输出曾被当成版本号,
|
||||
// 于是「工具链不在」会被显示成「工具链 <垃圾词>」,并让 SDK 诊断跟着失真。
|
||||
test("parseToolchainVersion 不会把非版本 token 当成版本", () => {
|
||||
for (const bad of ["hmapdev 未找到", "hmapdev error", "hmapdev not found", "hmapdev -v", "hmapdev"]) {
|
||||
assert.equal(parseToolchainVersion(bad), "", `不应从 ${JSON.stringify(bad)} 解析出版本`);
|
||||
}
|
||||
assert.equal(parseToolchainVersion("hmapdev 1.3.0-dev"), "1.3.0-dev"); // 开发构建的后缀要带出来
|
||||
assert.equal(parseToolchainVersion("hmapdev v1.2.0"), "1.2.0");
|
||||
});
|
||||
|
||||
test("compareVersions 是数值比较(1.2.10 > 1.2.9)", () => {
|
||||
assert.ok(compareVersions("1.2.10", "1.2.9") > 0);
|
||||
assert.ok(compareVersions("1.2.0", "1.2.0") === 0);
|
||||
assert.ok(compareVersions("0.8.0", "1.2.0") < 0);
|
||||
});
|
||||
|
||||
test("状态栏文本包含插件、声明 SDK 与工具链版本", () => {
|
||||
assert.equal(statusBarText(good, "1.2.0"), "memo · SDK 1.2.0 · hmapdev 1.2.0");
|
||||
assert.equal(statusBarText({ ...good, sdk: undefined }, ""), "memo · SDK 未声明 · hmapdev 未找到");
|
||||
});
|
||||
139
tools/vscode-hmapdev/src/toolchain.ts
Normal file
139
tools/vscode-hmapdev/src/toolchain.ts
Normal file
@ -0,0 +1,139 @@
|
||||
import * as cp from "child_process";
|
||||
import * as fs from "fs";
|
||||
import * as path from "path";
|
||||
import * as vscode from "vscode";
|
||||
|
||||
import { parseSdkList, parseToolchainVersion } from "./core";
|
||||
|
||||
/** execFile 的 Promise 版(不引第三方依赖)。 */
|
||||
function execFile(
|
||||
file: string,
|
||||
args: string[],
|
||||
cwd: string,
|
||||
timeoutMs = 120_000
|
||||
): Promise<{ code: number; stdout: string; stderr: string }> {
|
||||
return new Promise((resolve) => {
|
||||
cp.execFile(file, args, { cwd, timeout: timeoutMs, maxBuffer: 8 * 1024 * 1024 }, (err, stdout, stderr) => {
|
||||
const code = err && typeof (err as { code?: number }).code === "number" ? (err as { code: number }).code : err ? 1 : 0;
|
||||
resolve({ code, stdout: stdout ?? "", stderr: stderr ?? "" });
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* 工具链封装:定位 hmapdev、执行命令、缓存 version / sdk list。
|
||||
*
|
||||
* 为什么要缓存并显式 refresh:SDK 存储会在外部变化(`hmapdev sdk install` 之后),
|
||||
* 而诊断信息依赖它——不刷新就会一直报「未安装」。
|
||||
*/
|
||||
export class Toolchain {
|
||||
private versionCache?: string;
|
||||
private sdkCache?: string[];
|
||||
private missing = false;
|
||||
|
||||
constructor(private readonly out: vscode.OutputChannel) {}
|
||||
|
||||
private get exe(): string {
|
||||
return vscode.workspace.getConfiguration("hmapdev").get<string>("path", "hmapdev") || "hmapdev";
|
||||
}
|
||||
|
||||
/** 记录一条消息到输出通道(加上工具链前缀,便于与构建输出区分)。 */
|
||||
log(line: string): void {
|
||||
this.out.appendLine(line);
|
||||
}
|
||||
|
||||
async version(refresh = false): Promise<string> {
|
||||
if (this.versionCache !== undefined && !refresh) {
|
||||
return this.versionCache;
|
||||
}
|
||||
const r = await execFile(this.exe, ["version"], process.cwd(), 20_000);
|
||||
if (r.code !== 0 && !r.stdout) {
|
||||
this.missing = true;
|
||||
this.versionCache = "";
|
||||
return "";
|
||||
}
|
||||
this.missing = false;
|
||||
this.versionCache = parseToolchainVersion(r.stdout + r.stderr);
|
||||
return this.versionCache;
|
||||
}
|
||||
|
||||
async sdkList(refresh = false): Promise<string[] | undefined> {
|
||||
if (this.sdkCache !== undefined && !refresh) {
|
||||
return this.sdkCache;
|
||||
}
|
||||
const r = await execFile(this.exe, ["sdk", "list"], process.cwd(), 20_000);
|
||||
if (r.code !== 0 && !r.stdout) {
|
||||
this.sdkCache = undefined; // 探测不到就不做「未安装」判断,避免误报
|
||||
return undefined;
|
||||
}
|
||||
this.sdkCache = parseSdkList(r.stdout + r.stderr);
|
||||
return this.sdkCache;
|
||||
}
|
||||
|
||||
isMissing(): boolean {
|
||||
return this.missing;
|
||||
}
|
||||
|
||||
/** 在集成终端里执行(构建/运行这类长命令:要能看进度、能 Ctrl-C)。 */
|
||||
runInTerminal(args: string[], cwd: string, name: string): vscode.Terminal {
|
||||
const term = vscode.window.createTerminal({ name, cwd });
|
||||
term.show(true);
|
||||
const cmd = [this.exe, ...args].map((a) => (/\s/.test(a) ? JSON.stringify(a) : a)).join(" ");
|
||||
this.log(`$ ${cmd}`);
|
||||
term.sendText(cmd, true);
|
||||
return term;
|
||||
}
|
||||
|
||||
/** 一次性执行并把输出写进输出通道(查询类命令)。 */
|
||||
async runAndLog(args: string[], cwd: string): Promise<number> {
|
||||
this.log(`$ ${this.exe} ${args.join(" ")}`);
|
||||
const r = await execFile(this.exe, args, cwd, 60_000);
|
||||
if (r.stdout) {
|
||||
this.out.append(r.stdout);
|
||||
}
|
||||
if (r.stderr) {
|
||||
this.out.append(r.stderr);
|
||||
}
|
||||
return r.code;
|
||||
}
|
||||
|
||||
/**
|
||||
* 跟随内核日志:定位 <dataDir>/log 下最新的 homed 日志并按插件名过滤。
|
||||
*
|
||||
* 为什么这是「调试插件」的正路:插件是子进程、跑在内核里,真正的问题几乎都
|
||||
* 表现为内核日志里的几行(握手失败/崩溃重启/工具报错),在 IDE 里跟住它比
|
||||
* 反复手动 tail 高效得多。
|
||||
*/
|
||||
tailKernelLog(dataDir: string, filter: string): cp.ChildProcess | undefined {
|
||||
const logDir = path.join(dataDir, "log");
|
||||
if (!fs.existsSync(logDir)) {
|
||||
this.log(`error: 日志目录不存在:${logDir}(hmapdev.kernelDataDir 是否指对?)`);
|
||||
return undefined;
|
||||
}
|
||||
const newest = fs
|
||||
.readdirSync(logDir)
|
||||
.filter((f) => f.startsWith("homed_") && f.endsWith(".log"))
|
||||
.map((f) => ({ f, m: fs.statSync(path.join(logDir, f)).mtimeMs }))
|
||||
.sort((a, b) => b.m - a.m)[0];
|
||||
if (!newest) {
|
||||
this.log(`error: ${logDir} 下没有 homed_*.log`);
|
||||
return undefined;
|
||||
}
|
||||
const file = path.join(logDir, newest.f);
|
||||
this.log(`跟随 ${file}${filter ? `(过滤 ${filter})` : ""}`);
|
||||
const child = cp.spawn("tail", ["-F", file], { stdio: ["ignore", "pipe", "pipe"] });
|
||||
const emit = (buf: Buffer) => {
|
||||
for (const line of buf.toString("utf8").split(/\r?\n/)) {
|
||||
if (!line) {
|
||||
continue;
|
||||
}
|
||||
if (!filter || line.includes(filter)) {
|
||||
this.out.appendLine(line);
|
||||
}
|
||||
}
|
||||
};
|
||||
child.stdout?.on("data", emit);
|
||||
child.stderr?.on("data", emit);
|
||||
return child;
|
||||
}
|
||||
}
|
||||
19
tools/vscode-hmapdev/tsconfig.json
Normal file
19
tools/vscode-hmapdev/tsconfig.json
Normal file
@ -0,0 +1,19 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"target": "ES2020",
|
||||
"module": "commonjs",
|
||||
"moduleResolution": "node",
|
||||
"lib": ["ES2020"],
|
||||
"outDir": "out",
|
||||
"rootDir": "src",
|
||||
"strict": true,
|
||||
"noImplicitOverride": true,
|
||||
"noUnusedLocals": true,
|
||||
"sourceMap": true,
|
||||
"esModuleInterop": true,
|
||||
"skipLibCheck": true,
|
||||
"types": ["node", "vscode"]
|
||||
},
|
||||
"include": ["src/**/*.ts"],
|
||||
"exclude": ["node_modules", "out"]
|
||||
}
|
||||
Reference in New Issue
Block a user