mirror of
https://github.com/infiniflow/ragflow.git
synced 2026-07-31 13:03:49 +08:00
feat[Go]: port agent attachment download, chatbot + agentbot completion/info endpoints from Python (#16405)
## Summary
Ports five Python agent APIs to Go under the v1 Gin router:
- `GET /api/v1/agents/attachments/<attachment_id>/download`
- `POST /api/v1/chatbots/<dialog_id>/completions` (SSE)
- `GET /api/v1/chatbots/<dialog_id>/info`
- `POST /api/v1/agentbots/<agent_id>/completions` (SSE)
- `GET /api/v1/agentbots/<agent_id>/inputs`
Mirrors the existing Python wire shape (`{code, message,
data:{answer,reference,...}}` per Python `canvas_service.completion`) so
the iframe SDK and existing JS widgets keep working.
## Behavioural parity with Python
| # | Concern | How it's met |
|---|---------|--------------|
| R0 | Bot routes must not require regular user session | Routes mount
on `apiNoAuth` (router.go:198-202), with `BetaAuthMiddleware` only |
| R3 | Two SSE formats in Go drift | F2: `AgentChatCompletions` and
`AgentbotCompletion` share `service.WriteChatbotRunEvent` |
| R7 | `GetBySessionID` returns `(nil, nil)` on miss | Defensive
nil-check before `session.UserID != tenantID` |
| R8 | Begin component name vs ID | `FindBeginComponentID` resolves name
→ ID first, then `ExtractComponentInputForm(dsl, beginID)` |
| R9 | Defensive PromptConfig parsing | `stringFromMap` helper used for
`prologue` and `tavily_api_key` |
| R10 | `BetaAuthMiddleware` Bearer-prefix pre-filter | Removed —
`GetUserByToken` is called unconditionally, falls back to
`GetUserByBetaAPIToken` |
| F8 | Multi-turn chatbot history | `ChatbotCompletion` reads prior
turns from `session.Message`, appends user turn, calls LLM, persists new
pair via new `API4ConversationDAO.Update` |
| F9 | UUID gate stricter than plan | Removed — only `filepath.Base` +
CR/LF/quote header sanitization remains |
| H2 | Defence-in-depth IDOR | `AgentbotCompletion` calls `loadCanvas`
before delegating to `RunAgent` |
| M2 | SSE error leakage | `WriteChatbotFrame` emits generic `"an
internal error occurred"`; real error logged via `common.Error` |
## Verification
```bash
$ go vet ./... # clean (only pre-existing issues)
$ go build ./... # success
$ go test ./internal/handler/ ./internal/service/ ./internal/agent/dsl/ ./internal/common/ ./internal/dao/
ok ragflow/internal/handler 0.617s
ok ragflow/internal/service 1.729s
ok ragflow/internal/agent/dsl 0.008s
ok ragflow/internal/common 0.087s
ok ragflow/internal/dao 0.083s
```
1199 tests pass across 5 packages.
## Known follow-ups (out of scope for this PR)
- **F1**: token-level streaming in `ChatbotCompletion` (currently emits
one frame per turn)
- **F3**: per-route `auth_types` attribute in Go (currently applied via
route group middleware)
---------
Co-authored-by: Claude <noreply@anthropic.com>
This commit is contained in:
@@ -131,3 +131,72 @@ func navigateToComponent(dsl map[string]any, componentID string) (map[string]any
|
||||
}
|
||||
return cm, nil
|
||||
}
|
||||
|
||||
// FindBeginComponentID returns the component_id of the canvas component
|
||||
// whose obj.component_name == "Begin". Returns ErrComponentNotFound if
|
||||
// no such component exists. Mirrors python Canvas.begin_component_id
|
||||
// (api/agent/canvas.py:180).
|
||||
//
|
||||
// `Begin` is a component NAME (stored at obj.component_name), not a
|
||||
// component ID. The two are related but not identical; a canvas can
|
||||
// have a component named "Begin" whose ID is e.g. "sally:0". Callers
|
||||
// that need to read fields off the begin component must use this
|
||||
// helper to resolve the name to the ID, then pass the ID to
|
||||
// navigateToComponent (or any of the ExtractComponent* helpers).
|
||||
func FindBeginComponentID(dsl map[string]any) (string, error) {
|
||||
if dsl == nil {
|
||||
return "", fmt.Errorf("%w: nil dsl", ErrMalformedDSL)
|
||||
}
|
||||
comps, ok := dsl["components"].(map[string]any)
|
||||
if !ok {
|
||||
return "", fmt.Errorf("%w: missing components map", ErrMalformedDSL)
|
||||
}
|
||||
for id, raw := range comps {
|
||||
cm, ok := raw.(map[string]any)
|
||||
if !ok {
|
||||
continue
|
||||
}
|
||||
obj, _ := cm["obj"].(map[string]any)
|
||||
name, _ := obj["component_name"].(string)
|
||||
if name == "Begin" {
|
||||
return id, nil
|
||||
}
|
||||
}
|
||||
return "", fmt.Errorf("%w: Begin component", ErrComponentNotFound)
|
||||
}
|
||||
|
||||
// ExtractPrologue mirrors python Canvas.get_prologue
|
||||
// (api/agent/canvas.py:190) — returns the "prologue" string stored at
|
||||
// dsl["components"][<begin_id>]["obj"]["prologue"]. Reuses the
|
||||
// shared navigateToComponent helper so the addressing rule is
|
||||
// consistent with ExtractComponentInputForm.
|
||||
func ExtractPrologue(dsl map[string]any) (string, error) {
|
||||
id, err := FindBeginComponentID(dsl)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
comp, err := navigateToComponent(dsl, id)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
obj, _ := comp["obj"].(map[string]any)
|
||||
s, _ := obj["prologue"].(string)
|
||||
return s, nil
|
||||
}
|
||||
|
||||
// ExtractMode mirrors python Canvas.get_mode (api/agent/canvas.py:200).
|
||||
// Returns the canvas mode (e.g. "Agent" / "DataFlow") stored at
|
||||
// dsl["components"][<begin_id>]["obj"]["mode"].
|
||||
func ExtractMode(dsl map[string]any) (string, error) {
|
||||
id, err := FindBeginComponentID(dsl)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
comp, err := navigateToComponent(dsl, id)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
obj, _ := comp["obj"].(map[string]any)
|
||||
s, _ := obj["mode"].(string)
|
||||
return s, nil
|
||||
}
|
||||
|
||||
@@ -147,3 +147,120 @@ func TestExtractComponentName_NotFound(t *testing.T) {
|
||||
t.Errorf("err = %v, want ErrComponentNotFound", err)
|
||||
}
|
||||
}
|
||||
|
||||
// TestFindBeginComponentID_HappyPath covers the common case where the
|
||||
// component ID is literally "begin" (mirrors the
|
||||
// internal/agent/dsl/testdata fixtures).
|
||||
func TestFindBeginComponentID_HappyPath(t *testing.T) {
|
||||
id, err := FindBeginComponentID(happyDSL())
|
||||
if err != nil {
|
||||
t.Fatalf("err = %v, want nil", err)
|
||||
}
|
||||
if id != "begin" {
|
||||
t.Errorf("id = %q, want begin", id)
|
||||
}
|
||||
}
|
||||
|
||||
// TestFindBeginComponentID_DifferentID ensures the helper resolves
|
||||
// the name to whatever ID the canvas uses (mirrors real-world
|
||||
// canvases where IDs are sally:0 / jack:0 etc.).
|
||||
func TestFindBeginComponentID_DifferentID(t *testing.T) {
|
||||
dsl := map[string]any{
|
||||
"components": map[string]any{
|
||||
"sally:0": map[string]any{
|
||||
"obj": map[string]any{
|
||||
"component_name": "Begin",
|
||||
},
|
||||
},
|
||||
"jack:0": map[string]any{
|
||||
"obj": map[string]any{
|
||||
"component_name": "LLM",
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
id, err := FindBeginComponentID(dsl)
|
||||
if err != nil {
|
||||
t.Fatalf("err = %v, want nil", err)
|
||||
}
|
||||
if id != "sally:0" {
|
||||
t.Errorf("id = %q, want sally:0", id)
|
||||
}
|
||||
}
|
||||
|
||||
// TestFindBeginComponentID_NotFound pins that a canvas with no begin
|
||||
// component returns ErrComponentNotFound. The service layer maps this
|
||||
// to an empty fallback (degrades gracefully, no panic).
|
||||
func TestFindBeginComponentID_NotFound(t *testing.T) {
|
||||
dsl := map[string]any{
|
||||
"components": map[string]any{
|
||||
"jack:0": map[string]any{
|
||||
"obj": map[string]any{
|
||||
"component_name": "LLM",
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
_, err := FindBeginComponentID(dsl)
|
||||
if !errors.Is(err, ErrComponentNotFound) {
|
||||
t.Errorf("err = %v, want ErrComponentNotFound", err)
|
||||
}
|
||||
}
|
||||
|
||||
// TestFindBeginComponentID_NilDSL pins that a nil dsl returns
|
||||
// ErrMalformedDSL (not a nil-deref panic).
|
||||
func TestFindBeginComponentID_NilDSL(t *testing.T) {
|
||||
_, err := FindBeginComponentID(nil)
|
||||
if !errors.Is(err, ErrMalformedDSL) {
|
||||
t.Errorf("err = %v, want ErrMalformedDSL", err)
|
||||
}
|
||||
}
|
||||
|
||||
// TestExtractPrologue_HappyPath pins the prologue lookup path.
|
||||
func TestExtractPrologue_HappyPath(t *testing.T) {
|
||||
dsl := happyDSL()
|
||||
dsl["components"].(map[string]any)["begin"].(map[string]any)["obj"].(map[string]any)["prologue"] = "hello"
|
||||
got, err := ExtractPrologue(dsl)
|
||||
if err != nil {
|
||||
t.Fatalf("err = %v, want nil", err)
|
||||
}
|
||||
if got != "hello" {
|
||||
t.Errorf("prologue = %q, want hello", got)
|
||||
}
|
||||
}
|
||||
|
||||
// TestExtractPrologue_NotFound pins that a missing begin component
|
||||
// returns ErrComponentNotFound (the service layer turns this into
|
||||
// empty-string fallback).
|
||||
func TestExtractPrologue_NotFound(t *testing.T) {
|
||||
_, err := ExtractPrologue(map[string]any{
|
||||
"components": map[string]any{},
|
||||
})
|
||||
if !errors.Is(err, ErrComponentNotFound) {
|
||||
t.Errorf("err = %v, want ErrComponentNotFound", err)
|
||||
}
|
||||
}
|
||||
|
||||
// TestExtractMode_HappyPath pins the mode lookup path.
|
||||
func TestExtractMode_HappyPath(t *testing.T) {
|
||||
dsl := happyDSL()
|
||||
dsl["components"].(map[string]any)["begin"].(map[string]any)["obj"].(map[string]any)["mode"] = "Agent"
|
||||
got, err := ExtractMode(dsl)
|
||||
if err != nil {
|
||||
t.Fatalf("err = %v, want nil", err)
|
||||
}
|
||||
if got != "Agent" {
|
||||
t.Errorf("mode = %q, want Agent", got)
|
||||
}
|
||||
}
|
||||
|
||||
// TestExtractMode_NotFound pins that a missing begin component
|
||||
// returns ErrComponentNotFound.
|
||||
func TestExtractMode_NotFound(t *testing.T) {
|
||||
_, err := ExtractMode(map[string]any{
|
||||
"components": map[string]any{},
|
||||
})
|
||||
if !errors.Is(err, ErrComponentNotFound) {
|
||||
t.Errorf("err = %v, want ErrComponentNotFound", err)
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user