Skip to content

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

fix(agent): classify ExeSQL config errors (#20337)

Sbaaoui Idriss71c3e5c5d7c6
diff --git a/internal/agent/tool/exesql.go b/internal/agent/tool/exesql.go
index bf9a3bba70..3c967ff90c 100644
--- a/internal/agent/tool/exesql.go
+++ b/internal/agent/tool/exesql.go
@@ -161,7 +161,7 @@ func NewExeSQLConnParams(params map[string]any) (ExeSQLConnParams, error) {
conn.MaxRecords = v
}
if conn.DBType == "" || conn.Host == "" || conn.Username == "" || conn.Database == "" {
- return conn, fmt.Errorf("ExeSQL: missing required connection params (db_type/host/database/username)")
+ return conn, fmt.Errorf("%w: missing required connection params (db_type/host/database/username)", ErrExeSQLNoCredentials)
}
return conn, nil
}
diff --git a/internal/service/agent.go b/internal/service/agent.go
index 5cbc5f2709..4da2ebe9f9 100644
--- a/internal/service/agent.go
+++ b/internal/service/agent.go
@@ -2199,6 +2199,9 @@ func (s *AgentService) buildRunFunc(canvasID string, versionRow *entity.UserCanv
zap.String("type", fmt.Sprintf("%T", err)),
zap.Error(err))
s.markRunFailed(ctx2, runID, "compile: "+err.Error())
+ if errors.Is(err, agenttool.ErrExeSQLNoCredentials) {
+ return nil, runtime.NewUserFacingError("ExeSQL configuration is incomplete. Set the database connection details before running the agent.")
+ }
return nil, canvas.NewInternalRunError(
fmt.Errorf("canvas compile: %w: %w", ErrAgentStorageError, err),
)
diff --git a/internal/service/agent_run_e2e_test.go b/internal/service/agent_run_e2e_test.go
index f2c47c1375..0cce7f5964 100644
--- a/internal/service/agent_run_e2e_test.go
+++ b/internal/service/agent_run_e2e_test.go
@@ -1557,6 +1557,38 @@ func TestRunAgent_RealCanvas_CompileFails(t *testing.T) {
}
}
+func TestRunAgent_ExeSQLConfigErrorIsUserFacing(t *testing.T) {
+ testDB := setupServiceTestDB(t)
+ if err := testDB.AutoMigrate(
+ &entity.UserCanvas{}, &entity.UserCanvasVersion{}, &entity.APIToken{},
+ &entity.API4Conversation{}, &entity.TenantModelProvider{},
+ &entity.TenantModelInstance{}, &entity.TenantModel{},
+ ); err != nil {
+ t.Fatalf("migrate: %v", err)
+ }
+ orig := dao.DB
+ dao.DB = testDB
+ t.Cleanup(func() { dao.DB = orig })
+
+ dsl := map[string]any{"components": map[string]any{
+ "begin_0": map[string]any{"obj": map[string]any{"component_name": "Begin", "params": map[string]any{}}, "downstream": []any{"sql_0"}},
+ "sql_0": map[string]any{"obj": map[string]any{"component_name": "ExeSQL", "params": map[string]any{"db_type": "mysql", "host": "", "database": "", "username": ""}}, "upstream": []any{"begin_0"}},
+ }}
+ makeCanvasWithDSL(t, "canvas-exesql-config", "user-1", "tenant-1", "v-exesql-config", dsl)
+
+ events, err := NewAgentService().RunAgent(WithAgentSessionID(t.Context(), "session-exesql-config"), "user-1", "canvas-exesql-config", "session-exesql-config", "", "hello", nil)
+ if err != nil {
+ t.Fatalf("RunAgent returned sync error: %v", err)
+ }
+ _, _, errs, _, _ := drainAgentEvents(t, events)
+ if len(errs) == 0 || errs[0].Kind != "user" {
+ t.Fatalf("errors = %+v, want user-facing ExeSQL configuration error", errs)
+ }
+ if errs[0].Message != "ExeSQL configuration is incomplete. Set the database connection details before running the agent." {
+ t.Fatalf("error message = %q", errs[0].Message)
+ }
+}
+
// TestRunAgent_AllFixture_CategorizeResume drives the categorize branch
// of all.json through the real checkpoint-backed interrupt/resume path:
//