Files
HomeAgent/internal/plugins/webui/handler_openai.go
JianFeeeee 6d38a164eb chore(module): Go module 路径随托管地迁移 gitcode → github
## 背景

仓库早已迁移到 GitHub(`github.com/JianFeeeee/HomeAgent`,CI/CD 都在那边跑),
gitcode 保留为**国内只读镜像**(`ci.yml` 的 sync-gitcode-main 快进推送)。
但 go.mod 的 module 路径一直是 `gitcode.com/JianFeeeee/...` —— 既与权威源
不符,`meta.SourceURL`(AGPL §13 的源码提供入口)也指向镜像而非实际运行的代码。

## 关键区分(这是本次改动安全的前提)

两个 module 是**不同**的,影响面差一个数量级:

| module | 谁依赖 | 改它的后果 |
|---|---|---|
| `.../HomeAgent`(主仓) | **只有主仓自己** | 内部重构,零外部影响 |
| `.../homeagent-sdk`(SDK 仓) | 主仓 49 文件 + 所有外部插件 | 需重编插件 |

★ 实测确认:**插件不 import 主仓 module**(`strings qq/plugin.bin | grep HomeAgent` = 0),
只依赖 SDK 仓。而插件与内核的边界是 **RPC 方法名字符串**
(`plugin.init` / `tool.invoke`…,见 proc/protocol.go),**与 Go module 名无关**。
⇒ module 改名**不改变任何 wire 协议**,现网已装的插件照常运行。

SDK 的 GitHub 仓名是 `homeagentsdk`(无连字符),module 路径必须与之精确匹配,
否则 `go get` 会因路径不符失败,故取 `github.com/JianFeeeee/homeagentsdk`。

## 改动

- `go.mod` / `go.sum`:两个 module 路径 + require/replace
- 277 个 Go 文件 + Makefile + 打包脚本的 import 与 ldflags 路径
- SDK 仓 `meta.CoreModule`、`tools/hmapdev` 的 module 声明与工程模板
- 对外文档/链接的仓库地址(README、PLUGIN_DEV、OVERVIEW 等)

## 明确**保留** gitcode 的地方(镜像机制,不能动)

- `GITCODE_TOKEN`、`GC_URL="…@gitcode.com"`(CI 同步 job)
- `gitcode.com/api/v5/...`(release 附件上传)
- git remote `gitcode`(镜像拉取/推送)
- `docs/zh/ci-cd-runbook.md`(整篇讲镜像运维)

## 验证

- `go build ./...` / `go vet ./...` 绿
- `go test ./... -count=1` → 48 包 ok / 0 FAIL
- hmapdev 工具链编译通过(`third_party/homeagent-sdk/tools/hmapdev`)
- 全仓残留检查:module 形态的 `gitcode.com/JianFeeeee` = 0
- 镜像机制抽验:GC_URL / @gitcode / api/v5 / remote 均完好

## 顺带修正

`hmapdev/templates.go` 的注释此前写「gitcode 的模块不在 proxy.golang.org 上」——
module 已迁 GitHub,该论断不再成立。改为如实说明**为何仍默认 replace 到本机 SDK**:
离线可构建、避免版本漂移、内网可用。理由与托管地无关,故 replace 保留。
2026-10-08 10:40:17 +08:00

340 lines
11 KiB
Go
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

package webui
import (
"context"
"fmt"
"time"
"encoding/json"
"net/http"
"sync"
agentIO "github.com/JianFeeeee/HomeAgent/internal/agent/io"
"github.com/JianFeeeee/HomeAgent/internal/sdk"
)
// OpenAI 兼容面:/v1/chat/completions(含流式)。
func (h *Handler) handleOpenAICompletions(w http.ResponseWriter, r *http.Request) {
if r.Method != http.MethodPost {
http.Error(w, "method not allowed", http.StatusMethodNotAllowed)
return
}
if h.sdk == nil {
writeJSON(w, http.StatusServiceUnavailable, map[string]string{"error": "IO manager not available"})
return
}
var req struct {
Model string `json:"model"`
Messages []openAIMessage `json:"messages"`
Stream bool `json:"stream"`
Temperature float64 `json:"temperature"`
MaxTokens int `json:"max_tokens"`
}
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
writeJSON(w, http.StatusBadRequest, map[string]string{"error": "invalid request: " + err.Error()})
return
}
if len(req.Messages) == 0 {
writeJSON(w, http.StatusBadRequest, map[string]string{"error": "messages is required"})
return
}
lastMsg := req.Messages[len(req.Messages)-1]
if lastMsg.Role != "user" {
writeJSON(w, http.StatusBadRequest, map[string]string{"error": "last message must be from user"})
return
}
// 带超时的上下文(同 handleChat:客户端断开立即取消;300s 约束长生成)
ctx, cancel := context.WithTimeout(r.Context(), 300*time.Second)
defer cancel()
// ★ 流式与非流式是**两条不同的实现路径**,不能共用「先同步等完再分帧」。
//
// 原实现两条路都走 InjectTextSyncNoMemory(同步等完整回复),流式只是
// 把已拼好的全文切成 3 个 chunk 吐出去 —— 实测首字节 7.79s、随后
// 整段到达,客户端的「生成中」/取消/进度条全部失效。
//
// 真流式必须**订阅增量事件边收边转**:先写 SSE 头(把响应状态锁定为
// 200,之后再出错也无法改状态码),随后把 EventContentDelta 逐块转成
// chunk,最后用同步调用拿到的完整回复收尾(补 usage、发 finish)。
if req.Stream {
h.streamOpenAI(ctx, w, req.Model, lastMsg.Content)
return
}
respCh := make(chan *agentIO.OutputEvent, 1)
go func() {
// NoMemory:本端点(OpenAI 兼容 /v1/chat/completions)的调用方是
// IDE、工具与脚本,送来的是**固定的提示词模板**("请分析这段代码"之类),
// 不是人类在对话。记进记忆会把真实对话挤掉,而且同一模板会反复刷屏。
// 原文仍进上下文,模型照旧看得到;只是不参与向量化/关键词提取/蒸馏。
respCh <- h.sdk.InjectTextSyncNoMemory("http", "http", lastMsg.Content)
}()
var response *agentIO.OutputEvent
select {
case response = <-respCh:
case <-ctx.Done():
writeJSON(w, http.StatusGatewayTimeout, map[string]string{"error": "agent timeout (300s)"})
return
}
if response == nil {
writeJSON(w, http.StatusServiceUnavailable, map[string]string{"error": "no response from agent"})
return
}
content, _ := response.Payload["content"].(string)
reasoningContent, _ := response.Payload["reasoning_content"].(string)
usage, _ := response.Payload["usage"].(map[string]interface{})
resp := map[string]interface{}{
"id": fmt.Sprintf("chatcmpl-%d", time.Now().UnixNano()),
"object": "chat.completion",
"created": time.Now().Unix(),
"model": req.Model,
"choices": []map[string]interface{}{
{
"index": 0,
"message": map[string]interface{}{
"role": "assistant",
"content": content,
},
"finish_reason": "stop",
},
},
}
if reasoningContent != "" {
resp["choices"].([]map[string]interface{})[0]["message"].(map[string]interface{})["reasoning_content"] = reasoningContent
}
if usage != nil {
resp["usage"] = usage
}
w.Header().Set("Content-Type", "application/json; charset=utf-8")
json.NewEncoder(w).Encode(resp)
}
// streamOpenAI 是 /v1/chat/completions 的真流式实现。
//
// 结构与 handleSSE 一致:订阅增量 → 收集 → 写 writer goroutine → 收尾。
// 关键差异:SSE 端点是在「最终回复已就绪」后才开始收尾,本端点必须**边收边发**。
func (h *Handler) streamOpenAI(ctx context.Context, w http.ResponseWriter, model, userText string) {
flusher, ok := w.(http.Flusher)
if !ok {
writeJSON(w, http.StatusInternalServerError, map[string]string{"error": "streaming not supported"})
return
}
// 先锁状态码:SSE 一旦写出第一个字节,之后上游再出错也只能以
// 「在流里报错」的方式告知(data: {"error":...}),无法改成 4xx/5xx。
// 这是所有 SSE 实现的固有限制,写明以免后人误以为能改。
w.Header().Set("Content-Type", "text/event-stream")
w.Header().Set("Cache-Control", "no-cache")
w.Header().Set("Connection", "keep-alive")
w.Header().Set("X-Accel-Buffering", "no") // 关掉 nginx/frp 的缓冲,否则流式白做
w.WriteHeader(http.StatusOK)
flusher.Flush()
completionID := fmt.Sprintf("chatcmpl-%d", time.Now().UnixNano())
created := time.Now().Unix()
// delta 收集通道。缓冲 2048 与 handleSSE 同理:LLM token 级高频小包,
// 缓冲过小会溢出丢帧。
deltaCh := make(chan deltaItem, 2048)
done := make(chan struct{})
// 写 goroutine:批量合并(16ms 窗口)后 flush,降 syscall 次数。
// 不 close(deltaCh) —— 订阅回调可能在 handler 返回后仍被总线异步触发,
// close 后再发会 panic(生产日志里出现过单日数千次)。
var wg sync.WaitGroup
wg.Add(1)
go func() {
defer wg.Done()
pending := make([]string, 0, 64)
flushPending := func() {
if len(pending) == 0 {
return
}
for _, line := range pending {
fmt.Fprintf(w, "%s\n", line)
}
flusher.Flush()
pending = pending[:0]
}
flushTicker := time.NewTicker(16 * time.Millisecond)
defer flushTicker.Stop()
for {
select {
case d := <-deltaCh:
if d.reset {
pending = pending[:0]
}
if d.content != "" {
pending = append(pending, openAIChunkLine(completionID, created, model,
map[string]interface{}{"content": d.content}, nil, nil))
}
if d.reasoning != "" {
pending = append(pending, openAIChunkLine(completionID, created, model,
map[string]interface{}{"content": "", "reasoning_content": d.reasoning}, nil, nil))
}
if len(pending) >= 128 {
flushPending()
}
case <-flushTicker.C:
flushPending()
case <-done:
flushPending()
return
}
}
}()
send := func(d deltaItem) {
select {
case deltaCh <- d:
case <-done:
}
}
// 订阅增量事件。必须在启动注入**之前**订阅,否则会漏掉开头几个分片。
var unsubs []func()
deltaSub := func(typ sdk.EventType, pick func(payload map[string]interface{}) (string, bool)) {
unsub := h.sdk.Subscribe(typ, func(evt *sdk.Event) {
text, ok := pick(evt.Payload)
if !ok {
return
}
send(deltaItem{content: text, reset: isResetMarked(evt.Payload)})
})
unsubs = append(unsubs, unsub)
}
deltaSub(sdk.EventContentDelta, func(p map[string]interface{}) (string, bool) {
v, _ := p["content"].(string)
return v, v != ""
})
deltaSub(sdk.EventReasoningDelta, func(p map[string]interface{}) (string, bool) {
v, _ := p["reasoning_content"].(string)
return v, v != ""
})
defer func() {
close(done)
wg.Wait()
for _, u := range unsubs {
u()
}
}()
// 同步拿最终回复:用于补 usage、发 finish chunk。
// 此时增量早已转发完毕,所以这次等待不会拖慢首字节。
respCh := make(chan *agentIO.OutputEvent, 1)
go func() {
respCh <- h.sdk.InjectTextSyncNoMemory("http", "http", userText)
}()
var response *agentIO.OutputEvent
select {
case response = <-respCh:
case <-ctx.Done():
fmt.Fprintf(w, "data: %s\n\n", `{"error":{"message":"agent timeout (300s)"}}`)
fmt.Fprintf(w, "data: [DONE]\n\n")
flusher.Flush()
return
}
var usage map[string]interface{}
if response != nil {
usage, _ = response.Payload["usage"].(map[string]interface{})
}
// finish chunk + [DONE]
fmt.Fprintf(w, "%s\n", openAIChunkLine(completionID, created, model,
map[string]interface{}{}, "stop", usage))
fmt.Fprintf(w, "data: [DONE]\n\n")
flusher.Flush()
}
// openAIChunkLine 把一个 chunk 序列化成一行 SSE。
func openAIChunkLine(id string, created int64, model string, delta map[string]interface{}, finishReason interface{}, usage map[string]interface{}) string {
choice := map[string]interface{}{
"index": 0,
"delta": delta,
}
if finishReason != nil {
choice["finish_reason"] = finishReason
} else {
choice["finish_reason"] = nil
}
chunk := map[string]interface{}{
"id": id,
"object": "chat.completion.chunk",
"created": created,
"model": model,
"choices": []map[string]interface{}{choice},
}
if usage != nil {
chunk["usage"] = usage
}
data, _ := json.Marshal(chunk)
return "data: " + string(data)
}
type deltaItem struct {
content string
reasoning string
// reset 为真表示上游要求清空已显示内容(流式作废回退),前端需要丢弃累积。
reset bool
}
// isResetMarked 判定增量事件是否要求重置。
//
// 内核在「流式失败、回退到非流式」时会发一个 content="" + reset=true 的
// 事件(见 internal/agent/core/process.go)。若忽略它,客户端会看到
// 半截内容后又接上完整内容(重复且自相矛盾)。
func isResetMarked(payload map[string]interface{}) bool {
reset, _ := payload["reset"].(bool)
return reset
}
type openAIMessage struct {
Role string `json:"role"`
Content string `json:"content"`
}
// handleOpenAIModels 实现 GET /v1/models。
//
// 为什么本端点「返回什么模型」并不重要,重要的是**结构合法**:
// OpenAI 客户端把它当作能力探测(probe)。请求方要的不是模型清单本身,
// 而是一个「这个端点讲 OpenAI 协议」的确认。
//
// 所以这里返回 HomeAgent 自身作为唯一条目:调用方无论填哪个 id 都会
// 被路由到同一个 agent(本端点的 model 参数确实只是透传)。
// 不谎报 GPT 之类的名字 —— 那会让用户以为能选模型,而实际不能。
func (h *Handler) handleOpenAIModels(w http.ResponseWriter, r *http.Request) {
if r.Method != http.MethodGet {
http.Error(w, "method not allowed", http.StatusMethodNotAllowed)
return
}
id := openAIModelID()
writeJSON(w, http.StatusOK, map[string]interface{}{
"object": "list",
"data": []map[string]interface{}{
{
"id": id,
"object": "model",
"created": time.Now().Unix(),
"owned_by": "homeagent",
},
},
})
}
// openAIModelID 返回对外暴露的模型标识。
//
// 与 /v1/chat/completions 接受任意 model 值保持一致:本端点不做模型选择,
// 请求里的 model 只是回显。给一个稳定的名字,便于客户端写死在配置里。
func openAIModelID() string { return "homeagent" }