WeKnora/internal/database/migration_sqlite_agent_allo...

95 lines
3.8 KiB
Go
Raw Normal View History

fix(agent): make agent tool selection match the tools the runtime registers (#4211) The tools a smart-reasoning agent may use were defined in three places that never checked each other: the agent editor's checkboxes, the stored allowed_tools, and what registerTools registers. The editor drew from a hard-coded list that had drifted (search_conversations, a default tool, had no checkbox), hid stored entries outside that list, and could not untick a tool whose knowledge base capability was missing. The save API stored any name. And an empty list could not mean "no tools": three places treated it as "use the default tools", so clearing every checkbox gave an agent without a knowledge base search_conversations, while the editor's preview said it had none. One source for the tool list: GET /api/v1/agents/tools serves the tools of AvailableToolDefinitions with their group, danger flag and knowledge base requirement, the default tools, and the tools other agent settings register whatever the list says. The editor renders from it, falling back to the catalog's label for a tool it has no translation for. Stored values stay visible: a missing capability only blocks ticking a tool, and stored names the catalog does not offer are shown ticked in their own section and can be removed. An empty list now means no built-in tools; only a list that was never set selects the defaults. tools.EffectiveAllowedTools makes that decision for tool registration, the session config and the rerank requirement. Migration 000116 (SQLite 000035) writes the default tools into the empty list of every existing smart-reasoning agent, so they keep the tools they ran with. The knowledge base filter follows the stored list, so such an agent with an "all" scope now gets the same scope as one that ticked the defaults: bases search_knowledge cannot use leave it. The editor writes the defaults into an unset list it loads, so saving does not silently turn the defaults into no tools. Saving validates the list: retired names are rewritten, switch-managed and retired skill tools are dropped, names the request adds that no tool answers to are rejected with a 400 that lists them, and unknown names already stored are kept so an existing agent can still be saved. The response reports what was kept or dropped.
2026-10-13 03:29:24 +00:00
package database
import (
"database/sql"
"encoding/json"
"path/filepath"
"testing"
"github.com/Tencent/WeKnora/internal/agent/tools"
"github.com/stretchr/testify/require"
)
// agentToolListRows is the custom_agents data both upgrade tests start from:
// every way an allowed_tools value can be stored, in both agent modes.
var agentToolListRows = map[string]string{
"reasoning-empty": `{"agent_mode":"smart-reasoning","allowed_tools":[]}`,
"reasoning-null": `{"agent_mode":"smart-reasoning","allowed_tools":null}`,
"reasoning-missing": `{"agent_mode":"smart-reasoning"}`,
"reasoning-picked": `{"agent_mode":"smart-reasoning","allowed_tools":["thinking"]}`,
"quick-empty": `{"agent_mode":"quick-answer","allowed_tools":[]}`,
// Malformed values must neither break the migration nor be rewritten.
"reasoning-string": `{"agent_mode":"smart-reasoning","allowed_tools":"thinking"}`,
"reasoning-object": `{"agent_mode":"smart-reasoning","allowed_tools":{}}`,
}
// requireAgentToolListsUpgraded checks that an upgrade keeps every agent's
// effective tools: the empty smart-reasoning list, which used to select the
// default tools, now names them, and nothing else changes.
func requireAgentToolListsUpgraded(t *testing.T, db *sql.DB, query string) {
t.Helper()
for _, id := range []string{"reasoning-string", "reasoning-object"} {
var raw string
require.NoError(t, db.QueryRow(query, id).Scan(&raw), id)
var got, want struct {
AllowedTools json.RawMessage `json:"allowed_tools"`
}
require.NoError(t, json.Unmarshal([]byte(raw), &got), id)
require.NoError(t, json.Unmarshal([]byte(agentToolListRows[id]), &want), id)
require.JSONEq(t, string(want.AllowedTools), string(got.AllowedTools), "%s must be left as it is", id)
}
want := map[string][]string{
"reasoning-empty": tools.DefaultAllowedTools(),
"reasoning-null": nil,
"reasoning-missing": nil,
"reasoning-picked": {"thinking"},
"quick-empty": {},
}
for id, expected := range want {
var raw string
require.NoError(t, db.QueryRow(query, id).Scan(&raw), id)
var config struct {
AllowedTools []string `json:"allowed_tools"`
}
require.NoError(t, json.Unmarshal([]byte(raw), &config), id)
require.Equal(t, expected, config.AllowedTools, id)
// The default tools still apply to the agents that never set a list.
before := tools.EffectiveAllowedTools(decodeAllowedTools(t, agentToolListRows[id]))
require.ElementsMatch(t, before, tools.EffectiveAllowedTools(config.AllowedTools),
"%s must keep its effective tools", id)
}
}
// decodeAllowedTools reads a pre-upgrade row under the old meaning, in which
// an empty list also selected the default tools.
func decodeAllowedTools(t *testing.T, raw string) []string {
t.Helper()
var config struct {
AgentMode string `json:"agent_mode"`
AllowedTools []string `json:"allowed_tools"`
}
require.NoError(t, json.Unmarshal([]byte(raw), &config))
if config.AgentMode == "smart-reasoning" && config.AllowedTools != nil && len(config.AllowedTools) == 0 {
return nil
}
return config.AllowedTools
}
func TestSQLiteMigrationsKeepAgentToolsWhenAnEmptyListMeansNone(t *testing.T) {
repoRoot := sqliteRepoRoot(t)
chdirAndRestore(t, copySQLiteMigrationsThrough(t, repoRoot, 34))
dbPath := filepath.Join(t.TempDir(), "upgrade-agent-tools.db")
opts := MigrationOptions{SQLiteDBPath: dbPath}
require.NoError(t, RunMigrationsWithOptions("sqlite3://unused", opts))
db := openSQLiteDB(t, dbPath)
for id, config := range agentToolListRows {
_, err := db.Exec(`INSERT INTO custom_agents (id, name, tenant_id, config) VALUES (?, ?, 1, ?)`,
id, id, config)
require.NoError(t, err)
}
chdirAndRestore(t, repoRoot)
require.NoError(t, RunMigrationsWithOptions("sqlite3://unused", opts))
requireAgentToolListsUpgraded(t, db, `SELECT config FROM custom_agents WHERE id = ?`)
}