Skip to content

RAGFlow is an agent-native database: a Retrieval-Augmented Generation (RAG) engine that grew into context infrastructure.

Fix: agent session by default should not return dsl (#21989)

Wang Qi6df56e3640a6
diff --git a/internal/dao/api_for_conversation.go b/internal/dao/api_for_conversation.go
index 0ba9fb8cab..593fc8e443 100644
--- a/internal/dao/api_for_conversation.go
+++ b/internal/dao/api_for_conversation.go
@@ -115,12 +115,16 @@ func (dao *API4ConversationDAO) Stats(ctx context.Context, db *gorm.DB, tenantID
return rows, err
}
-func (dao *API4ConversationDAO) GetBySessionID(ctx context.Context, db *gorm.DB, sessionID, agentID string, options ...ConversationHistoryOptions) (*entity.API4Conversation, error) {
+func (dao *API4ConversationDAO) GetBySessionID(ctx context.Context, db *gorm.DB, sessionID, agentID string, includeDSL bool, options ...ConversationHistoryOptions) (*entity.API4Conversation, error) {
historyOptions := ConversationHistoryOptions{}
if len(options) > 0 {
historyOptions = options[0]
}
- result, err := dao.GetMetadataBySessionID(ctx, db, sessionID, agentID)
+ query := db
+ if !includeDSL {
+ query = query.Omit("dsl")
+ }
+ result, err := dao.GetMetadataBySessionID(ctx, query, sessionID, agentID)
if err != nil || result == nil {
return result, err
}
diff --git a/internal/dao/api_token_test.go b/internal/dao/api_token_test.go
index ea2a1a074d..a4bc1ae05f 100644
--- a/internal/dao/api_token_test.go
+++ b/internal/dao/api_token_test.go
@@ -64,7 +64,7 @@ func TestAPI4ConversationDAOGetBySessionID(t *testing.T) {
createAPI4ConversationForDAOTest(t, "session-1", "agent-1")
ctx := t.Context()
- session, err := NewAPI4ConversationDAO().GetBySessionID(ctx, DB, "session-1", "agent-1")
+ session, err := NewAPI4ConversationDAO().GetBySessionID(ctx, DB, "session-1", "agent-1", true)
if err != nil {
t.Fatalf("GetBySessionID failed: %v", err)
}
@@ -86,7 +86,7 @@ func TestAPI4ConversationDAOGetBySessionIDWrongAgent(t *testing.T) {
createAPI4ConversationForDAOTest(t, "session-1", "agent-1")
ctx := t.Context()
- session, err := NewAPI4ConversationDAO().GetBySessionID(ctx, DB, "session-1", "agent-2")
+ session, err := NewAPI4ConversationDAO().GetBySessionID(ctx, DB, "session-1", "agent-2", true)
if err != nil {
t.Fatalf("GetBySessionID failed: %v", err)
}
@@ -102,7 +102,7 @@ func TestAPI4ConversationDAOGetBySessionIDNoRows(t *testing.T) {
createAPI4ConversationForDAOTest(t, "session-1", "agent-1")
ctx := t.Context()
- session, err := NewAPI4ConversationDAO().GetBySessionID(ctx, DB, "missing-session", "agent-1")
+ session, err := NewAPI4ConversationDAO().GetBySessionID(ctx, DB, "missing-session", "agent-1", true)
if err != nil {
t.Fatalf("GetBySessionID failed: %v", err)
}
diff --git a/internal/handler/agent.go b/internal/handler/agent.go
index fd9223c674..9c1d225727 100644
--- a/internal/handler/agent.go
+++ b/internal/handler/agent.go
@@ -978,13 +978,18 @@ func (h *AgentHandler) CreateAgentSession(c *gin.Context) {
func (h *AgentHandler) GetAgentSession(c *gin.Context) {
canvasID := c.Param("canvas_id")
sessionID := c.Param("session_id")
+ includeDSL, err := strconv.ParseBool(c.DefaultQuery("include_dsl", "false"))
+ if err != nil {
+ common.RespondError(c, common.CodeArgumentError, "include_dsl must be a boolean")
+ return
+ }
ctx := c.Request.Context()
options, err := sessionHistoryQuery(c)
if err != nil {
common.RespondError(c, common.CodeArgumentError, err.Error())
return
}
- row, code, err := h.agentService.GetAgentSession(ctx, canvasID, sessionID, options)
+ row, code, err := h.agentService.GetAgentSession(ctx, canvasID, sessionID, includeDSL, options)
if err != nil {
common.RespondError(c, code, err.Error())
return
diff --git a/internal/handler/session_history_test.go b/internal/handler/session_history_test.go
index 63661df58b..fa23618a46 100644
--- a/internal/handler/session_history_test.go
+++ b/internal/handler/session_history_test.go
@@ -165,3 +165,80 @@ func TestSessionHistoryQueryFlags(t *testing.T) {
}
}
}
+
+func TestGetAgentSessionIncludeDSL(t *testing.T) {
+ for _, tt := range []struct {
+ name string
+ query string
+ dsl string
+ code common.ErrorCode
+ includeDSL bool
+ }{
+ {name: "default", dsl: `{"components":{}}`, code: common.CodeSuccess},
+ {name: "false", query: "include_dsl=false", dsl: `{"components":{}}`, code: common.CodeSuccess},
+ {name: "true", query: "include_dsl=true", dsl: `{"components":{}}`, code: common.CodeSuccess, includeDSL: true},
+ {name: "default skips invalid DSL", dsl: `"invalid"`, code: common.CodeSuccess},
+ {name: "false skips invalid DSL", query: "include_dsl=false", dsl: `"invalid"`, code: common.CodeSuccess},
+ {name: "true reports invalid DSL", query: "include_dsl=true", dsl: `"invalid"`, code: common.CodeServerError, includeDSL: true},
+ {name: "invalid boolean", query: "include_dsl=invalid", dsl: `{}`, code: common.CodeArgumentError},
+ {name: "empty boolean", query: "include_dsl=", dsl: `{}`, code: common.CodeArgumentError},
+ } {
+ t.Run(tt.name, func(t *testing.T) {
+ c, w, db := setupGinContextWithUserAndDB(t, http.MethodGet, "/api/v1/agents/agent/sessions/session?"+tt.query)
+ c.Params = gin.Params{{Key: "canvas_id", Value: "agent"}, {Key: "session_id", Value: "session"}}
+ if err := db.Create(&entity.UserCanvas{ID: "agent", UserID: "user-1"}).Error; err != nil {
+ t.Fatal(err)
+ }
+ if err := dao.NewAPI4ConversationDAO().Create(c.Request.Context(), db, &entity.API4Conversation{
+ ID: "session", DialogID: "agent", UserID: "user-1",
+ Message: json.RawMessage(`[{"id":"answer","role":"assistant","content":"answer"}]`),
+ }); err != nil {
+ t.Fatal(err)
+ }
+ if err := db.Model(&entity.API4Conversation{}).Where("id = ?", "session").Update("dsl", tt.dsl).Error; err != nil {
+ t.Fatal(err)
+ }
+ var sessionSQL string
+ if err := db.Callback().Query().After("gorm:query").Register("capture_session_dsl", func(tx *gorm.DB) {
+ if tx.Statement.Table == "api_4_conversation" {
+ sessionSQL = tx.Statement.SQL.String()
+ }
+ }); err != nil {
+ t.Fatal(err)
+ }
+ NewAgentHandler(c.Request.Context(), service.NewAgentService(), nil).GetAgentSession(c)
+ var response struct {
+ Code common.ErrorCode `json:"code"`
+ Data map[string]json.RawMessage `json:"data"`
+ }
+ if err := json.Unmarshal(w.Body.Bytes(), &response); err != nil {
+ t.Fatal(err)
+ }
+ if response.Code != tt.code {
+ t.Fatalf("unexpected response: %s", w.Body.String())
+ }
+ if tt.code == common.CodeArgumentError {
+ if sessionSQL != "" {
+ t.Fatalf("invalid query reached the database: %s", sessionSQL)
+ }
+ return
+ }
+ if sessionSQL == "" || strings.Contains(sessionSQL, "`dsl`") != tt.includeDSL {
+ t.Fatalf("unexpected DSL selection: %s", sessionSQL)
+ }
+ if tt.code != common.CodeSuccess {
+ return
+ }
+ if _, exists := response.Data["dsl"]; exists != tt.includeDSL {
+ t.Fatalf("unexpected DSL in response: %s", w.Body.String())
+ }
+ if tt.includeDSL && string(response.Data["dsl"]) != tt.dsl {
+ t.Fatalf("unexpected DSL value: %s", response.Data["dsl"])
+ }
+ var messages []map[string]interface{}
+ if err := json.Unmarshal(response.Data["message"], &messages); err != nil || len(messages) != 1 || messages[0]["content"] != "answer" {
+ t.Fatalf("unexpected session history: %s, %v", w.Body.String(), err)
+ }
+ })
+ }
+}
diff --git a/internal/service/agent_deferred_failure_test.go b/internal/service/agent_deferred_failure_test.go
index cf52e7bb6f..d8a4078866 100644
--- a/internal/service/agent_deferred_failure_test.go
+++ b/internal/service/agent_deferred_failure_test.go
@@ -151,7 +151,7 @@ func TestRunAgent_DeferredAgentModelFailureStaysInChatStream(t *testing.T) {
func assertPersistedAssistantFailure(t *testing.T, sessionID, agentID, wantText string) {
t.Helper()
- conv, err := dao.NewAPI4ConversationDAO().GetBySessionID(t.Context(), dao.DB, sessionID, agentID)
+ conv, err := dao.NewAPI4ConversationDAO().GetBySessionID(t.Context(), dao.DB, sessionID, agentID, false)
if err != nil {
t.Fatalf("reload conversation: %v", err)
}
diff --git a/internal/service/agent_sessions.go b/internal/service/agent_sessions.go
index 10a2161680..b686872fd5 100644
--- a/internal/service/agent_sessions.go
+++ b/internal/service/agent_sessions.go
@@ -317,7 +317,7 @@ func (s *AgentService) ListAgentSessions(ctx context.Context, agentID string, re
}
// GetAgentSession fetches a single conversation belonging to agentID.
-func (s *AgentService) GetAgentSession(ctx context.Context, agentID, sessionID string, options ...dao.ConversationHistoryOptions) (*entity.API4Conversation, common.ErrorCode, error) {
+func (s *AgentService) GetAgentSession(ctx context.Context, agentID, sessionID string, includeDSL bool, options ...dao.ConversationHistoryOptions) (*entity.API4Conversation, common.ErrorCode, error) {
if sessionID == "" {
return nil, common.CodeArgumentError, fmt.Errorf("session_id is required")
}
@@ -332,7 +332,7 @@ func (s *AgentService) GetAgentSession(ctx context.Context, agentID, sessionID s
return nil, common.CodeOperatingError, errors.New("agent not found or no permission")
}
- data, err := s.api4ConversationDAO.GetBySessionID(ctx, dao.DB, sessionID, agentID, sessionHistoryOptions(options...))
+ data, err := s.api4ConversationDAO.GetBySessionID(ctx, dao.DB, sessionID, agentID, includeDSL, sessionHistoryOptions(options...))
if err != nil {
return nil, common.CodeServerError, fmt.Errorf("failed to fetch session: %w", err)
}
diff --git a/internal/service/agent_test.go b/internal/service/agent_test.go
index e793f433e7..c773099a99 100644
--- a/internal/service/agent_test.go
+++ b/internal/service/agent_test.go
@@ -1097,7 +1097,7 @@ func TestGetAgentSessionServiceSuccess(t *testing.T) {
}); err != nil {
t.Fatal(err)
}
- session, code, err := NewAgentService().GetAgentSession(ctx, "canvas-1", "session-1", dao.ConversationHistoryOptions{IncludeReference: true})
+ session, code, err := NewAgentService().GetAgentSession(ctx, "canvas-1", "session-1", false, dao.ConversationHistoryOptions{IncludeReference: true})
if err != nil {
t.Fatalf("GetAgentSession failed: %v", err)
}
@@ -1324,7 +1324,7 @@ func TestGetAgentSessionServiceNotFoundWhenSessionBelongsToAnotherAgent(t *testi
createAgentSessionTestConversation(t, "session-other", "canvas-other", "user-1", 1000)
ctx := serviceTestContext(t, "user-1", "user-1")
- session, code, err := NewAgentService().GetAgentSession(ctx, "canvas-1", "session-other")
+ session, code, err := NewAgentService().GetAgentSession(ctx, "canvas-1", "session-other", false)
if err == nil {
t.Fatal("expected not found error")
}
@@ -2815,7 +2815,7 @@ func TestGetAgentSession_RejectsIDOR(t *testing.T) {
createAgentSessionTestConversation(t, "session-1", "agent-1", "user-1", 1000)
ctx := serviceTestContext(t, "user-1", "user-1")
- data, code, err := NewAgentService().GetAgentSession(ctx, "agent-2", "session-1")
+ data, code, err := NewAgentService().GetAgentSession(ctx, "agent-2", "session-1", false)
if err == nil {
t.Fatal("expected non-nil error for cross-agent session access")
}
@@ -2838,7 +2838,7 @@ func TestGetAgentSession_SuccessWhenAgentMatches(t *testing.T) {
createAgentSessionTestConversation(t, "session-1", "agent-1", "user-1", 1000)
ctx := serviceTestContext(t, "user-1", "user-1")
- data, code, err := NewAgentService().GetAgentSession(ctx, "agent-1", "session-1")
+ data, code, err := NewAgentService().GetAgentSession(ctx, "agent-1", "session-1", false)
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
@@ -2880,7 +2880,7 @@ func TestDeleteAgentSessionItem_RejectsIDOR(t *testing.T) {
}
// The session must still exist — the cross-agent delete was a no-op.
- verify, _, err := NewAgentService().GetAgentSession(ctx, "agent-1", "session-1")
+ verify, _, err := NewAgentService().GetAgentSession(ctx, "agent-1", "session-1", false)
if err != nil {
t.Fatalf("session should still exist for the legitimate owner: %v", err)
}
diff --git a/internal/service/bot_completion.go b/internal/service/bot_completion.go
index 0b90d77df5..cca9c06a72 100644
--- a/internal/service/bot_completion.go
+++ b/internal/service/bot_completion.go
@@ -373,7 +373,7 @@ func (s *BotService) ChatbotCompletion(
}
}
- session, err := s.api4ConversationDAO.GetBySessionID(ctx, dao.DB, req.SessionID, dialogID)
+ session, err := s.api4ConversationDAO.GetBySessionID(ctx, dao.DB, req.SessionID, dialogID, true)
if err != nil {
return nil, common.CodeServerError, err
}
diff --git a/internal/service/bot_completion_history_test.go b/internal/service/bot_completion_history_test.go
index 3e173cbbfe..0d94c248c8 100644
--- a/internal/service/bot_completion_history_test.go
+++ b/internal/service/bot_completion_history_test.go
@@ -448,7 +448,7 @@ func TestBotService_ChatbotCompletion_NewSessionSkipsLLM(t *testing.T) {
// The persisted session must hold exactly the prologue turn —
// no empty user message may be written.
ctx := t.Context()
- row, derr := dao.NewAPI4ConversationDAO().GetBySessionID(ctx, dao.DB, got[0].SessionID, "dlg-1")
+ row, derr := dao.NewAPI4ConversationDAO().GetBySessionID(ctx, dao.DB, got[0].SessionID, "dlg-1", true)
if derr != nil || row == nil {
t.Fatalf("session not persisted: row=%v err=%v", row, derr)
}
@@ -525,7 +525,7 @@ func TestPersistChatbotTurn_AppendsPairAndReference(t *testing.T) {
if err := svc.persistChatbotQuestion(ctx, sess, "What is Go?", "msg-p1", 2); err != nil {
t.Fatalf("persist question: %v", err)
}
- questionRow, err := dao.NewAPI4ConversationDAO().GetBySessionID(ctx, dao.DB, "sess-p1", "dlg-p1", dao.ConversationHistoryOptions{IncludeReference: true})
+ questionRow, err := dao.NewAPI4ConversationDAO().GetBySessionID(ctx, dao.DB, "sess-p1", "dlg-p1", true, dao.ConversationHistoryOptions{IncludeReference: true})
if err != nil || questionRow == nil {
t.Fatalf("read pending question: %v", err)
}
@@ -536,7 +536,7 @@ func TestPersistChatbotTurn_AppendsPairAndReference(t *testing.T) {
t.Fatalf("persistChatbotTurn: %v", err)
}
- row, err := dao.NewAPI4ConversationDAO().GetBySessionID(ctx, dao.DB, "sess-p1", "dlg-p1", dao.ConversationHistoryOptions{IncludeReference: true})
+ row, err := dao.NewAPI4ConversationDAO().GetBySessionID(ctx, dao.DB, "sess-p1", "dlg-p1", true, dao.ConversationHistoryOptions{IncludeReference: true})
if err != nil || row == nil {
t.Fatalf("re-read session: row=%v err=%v", row, err)
}
@@ -592,7 +592,7 @@ func TestPersistChatbotTurn_NilReferenceDefaultsToEmpty(t *testing.T) {
t.Fatalf("persistChatbotTurn: %v", err)
}
- row, err := dao.NewAPI4ConversationDAO().GetBySessionID(ctx, dao.DB, "sess-p2", "dlg-p1", dao.ConversationHistoryOptions{IncludeReference: true})
+ row, err := dao.NewAPI4ConversationDAO().GetBySessionID(ctx, dao.DB, "sess-p2", "dlg-p1", true, dao.ConversationHistoryOptions{IncludeReference: true})
if err != nil || row == nil {
t.Fatalf("re-read session: row=%v err=%v", row, err)
}
@@ -654,7 +654,7 @@ func TestPersistChatbotTurn_ConcurrentSameSession(t *testing.T) {
}
wg.Wait()
- row, err := dao.NewAPI4ConversationDAO().GetBySessionID(ctx, dao.DB, "sess-p3", "dlg-p1", dao.ConversationHistoryOptions{IncludeReference: true})
+ row, err := dao.NewAPI4ConversationDAO().GetBySessionID(ctx, dao.DB, "sess-p3", "dlg-p1", true, dao.ConversationHistoryOptions{IncludeReference: true})
if err != nil || row == nil {
t.Fatalf("re-read session: row=%v err=%v", row, err)
}
@@ -757,7 +757,7 @@ func TestStreamChatbotTurn_FinalFrameAndPersistenceUseRawStreamText(t *testing.T
t.Errorf("delta frames must forward their own delta: %+v %+v", frames[0], frames[1])
}
- row, err := dao.NewAPI4ConversationDAO().GetBySessionID(t.Context(), dao.DB, "sess-s1", "dlg-s1")
+ row, err := dao.NewAPI4ConversationDAO().GetBySessionID(t.Context(), dao.DB, "sess-s1", "dlg-s1", true)
if err != nil || row == nil {
t.Fatalf("re-read session: row=%v err=%v", row, err)
}
@@ -792,7 +792,7 @@ func TestStreamChatbotTurn_ThinkMarkersPersistedAsTags(t *testing.T) {
for range svc.streamChatbotTurn(t.Context(), sess, "q2", "msg-s2", results) {
}
- row, err := dao.NewAPI4ConversationDAO().GetBySessionID(t.Context(), dao.DB, "sess-s2", "dlg-s1")
+ row, err := dao.NewAPI4ConversationDAO().GetBySessionID(t.Context(), dao.DB, "sess-s2", "dlg-s1", true)
if err != nil || row == nil {
t.Fatalf("re-read session: row=%v err=%v", row, err)
}
@@ -833,7 +833,7 @@ func TestStreamChatbotTurn_SingleShotFinalKeepsText(t *testing.T) {
t.Errorf("single-shot final must carry the text, got %q", frames[0].Data)
}
- row, err := dao.NewAPI4ConversationDAO().GetBySessionID(t.Context(), dao.DB, "sess-s3", "dlg-s1")
+ row, err := dao.NewAPI4ConversationDAO().GetBySessionID(t.Context(), dao.DB, "sess-s3", "dlg-s1", true)
if err != nil || row == nil {
t.Fatalf("re-read session: row=%v err=%v", row, err)
}
@@ -869,7 +869,7 @@ func TestStreamChatbotTurn_ErrorKeptOnWireAndNotPersisted(t *testing.T) {
t.Errorf("error final must carry the text, got %q", frames[0].Data)
}
- row, err := dao.NewAPI4ConversationDAO().GetBySessionID(t.Context(), dao.DB, "sess-s4", "dlg-s1")
+ row, err := dao.NewAPI4ConversationDAO().GetBySessionID(t.Context(), dao.DB, "sess-s4", "dlg-s1", true)
if err != nil || row == nil {
t.Fatalf("re-read session: row=%v err=%v", row, err)
}
@@ -911,7 +911,7 @@ func TestStreamChatbotTurn_ErrorAfterDeltasKeptOnWire(t *testing.T) {
t.Errorf("error final after deltas must carry the error text, got %+v", frames[1])
}
- row, err := dao.NewAPI4ConversationDAO().GetBySessionID(t.Context(), dao.DB, "sess-s5", "dlg-s1")
+ row, err := dao.NewAPI4ConversationDAO().GetBySessionID(t.Context(), dao.DB, "sess-s5", "dlg-s1", true)
if err != nil || row == nil {
t.Fatalf("re-read session: row=%v err=%v", row, err)
}
@@ -958,7 +958,7 @@ func TestStreamChatbotTurn_ReasoningFieldForwardedAsStreamText(t *testing.T) {
t.Errorf("final frame answer = %q, want empty (deltas already streamed)", frames[4].Data)
}
- row, err := dao.NewAPI4ConversationDAO().GetBySessionID(t.Context(), dao.DB, "sess-s6", "dlg-s1")
+ row, err := dao.NewAPI4ConversationDAO().GetBySessionID(t.Context(), dao.DB, "sess-s6", "dlg-s1", true)
if err != nil || row == nil {
t.Fatalf("re-read session: row=%v err=%v", row, err)
}
@@ -1009,7 +1009,7 @@ func TestStreamChatbotTurn_ContextCancellationUnblocksFullChannel(t *testing.T)
verified:
// The user question is preserved in history; failure/cancellation leaves it intact.
- row, err := dao.NewAPI4ConversationDAO().GetBySessionID(context.Background(), dao.DB, "sess-cancel-leak", "dlg-s1")
+ row, err := dao.NewAPI4ConversationDAO().GetBySessionID(context.Background(), dao.DB, "sess-cancel-leak", "dlg-s1", true)
if err != nil {
t.Fatalf("re-read session: %v", err)
}