Files
coder/coderd/x/chatd/toolinput_internal_test.go
T
Hugo Dutka decaf6e8c5 fix(coderd/x/chatd): shorten tool input validation errors (#32078)
Nested builtin tool input errors repeat an absolute schema path at every
recursion level. Unwrap the validator's error chain to retain only the
innermost path wrapper and its cause, with a comment explaining the
dependency's wrapping behavior. Also remove the redundant sentence about
exact property names and duplicate keys from the retry guidance.

Existing schema-validation tests now assert complete tool error messages
for root failures, nested properties, arrays, and maps. Validation
behavior and diagnostics embedded in the cause are preserved.

Refs #31541.
2026-11-12 11:50:42 +01:00

283 lines
11 KiB
Go

package chatd
import (
"context"
"encoding/json"
"testing"
"charm.land/fantasy"
"github.com/google/uuid"
"github.com/stretchr/testify/require"
"github.com/coder/coder/v2/coderd/database"
"github.com/coder/coder/v2/coderd/database/dbgen"
"github.com/coder/coder/v2/coderd/database/dbtestutil"
"github.com/coder/coder/v2/coderd/x/chatd/chathooks"
"github.com/coder/coder/v2/coderd/x/chatd/chatprompt"
"github.com/coder/coder/v2/coderd/x/chatd/chatprovider"
"github.com/coder/coder/v2/coderd/x/chatd/chatstate"
"github.com/coder/coder/v2/codersdk/workspacesdk"
)
func TestPartitionToolCallsValidatesSchema(t *testing.T) {
t.Parallel()
type target struct {
Path string `json:"path"`
}
type input struct {
Target target `json:"target"`
Count int `json:"count,omitempty"`
Parameters map[string]string `json:"parameters,omitempty"`
Targets []map[string]target `json:"targets,omitempty"`
Nested map[string]map[string]string `json:"nested,omitempty"`
}
for _, tt := range []struct {
input string
wantErr string
}{
{input: `{}`, wantErr: `validating root: required: missing properties: ["target"]`},
{input: `{"target":{}}`, wantErr: `validating /properties/target: required: missing properties: ["path"]`},
{input: `{"target":{"path":1}}`, wantErr: `validating /properties/target/properties/path: type: 1 has type "integer", want "string"`},
{input: `{"target":{"path":"a"},"count":1.5}`, wantErr: `validating /properties/count: type: 1.5 has type "number", want "integer"`},
{input: `null`, wantErr: `validating root: type: <invalid reflect.Value> has type "null", want "object"`},
{input: `[]`, wantErr: `validating root: type: [] has type "array", want "object"`},
{input: `{"target":{"path":"a"},"parameters":{"cpu":42}}`, wantErr: `validating /properties/parameters/additionalProperties: type: 42 has type "integer", want "string"`},
{input: `{"target":{"path":"a"},"targets":[{"first":{}}]}`, wantErr: `validating /properties/targets/items/additionalProperties: required: missing properties: ["path"]`},
{input: `{"target":{"path":"a"},"nested":{"first":{"cpu":42}}}`, wantErr: `validating /properties/nested/additionalProperties/additionalProperties: type: 42 has type "integer", want "string"`},
{input: `{"target":{"path":"a"},"extra":1}`},
{input: `{"target":{"path":"a"},"count":1,"parameters":{"cpu":"2","CPU":"4"},"targets":[{"first":{"path":"b"}}],"nested":{"first":{"cpu":"2"}}}`},
} {
t.Run(tt.input, func(t *testing.T) {
t.Parallel()
tool := fantasy.NewAgentTool("test", "", func(context.Context, input, fantasy.ToolCall) (fantasy.ToolResponse, error) {
return fantasy.ToolResponse{}, nil
})
prepared := turnEnvironment{Tools: []fantasy.AgentTool{tool}, BuiltinToolNames: map[string]bool{"test": true}}
call := fantasy.ToolCallContent{ToolName: "test", Input: tt.input}
allowed, _, rejected := partitionInvalidToolCalls(prepared, []fantasy.ToolCallContent{call})
if tt.wantErr != "" {
require.Empty(t, allowed)
require.Len(t, rejected, 1)
err := rejected[0].Result.(fantasy.ToolResultOutputContentError).Error
require.EqualError(t, err, "This tool call was not executed because its input is invalid: "+tt.wantErr+
". Retry with a JSON object matching the tool schema, including all required properties and their declared types.")
} else {
require.Empty(t, rejected)
require.Equal(t, []fantasy.ToolCallContent{call}, allowed)
}
})
}
}
func TestPartitionToolCallsValidatesACPSpawnSchema(t *testing.T) {
t.Parallel()
for _, tt := range []struct {
input string
wantErr string
}{
{input: `{"harness_id":"claude-code","prompt":"Report which MCP servers are available to you.","working_directory":"/home/coder/coder"}`, wantErr: `missing properties: ["agent"]`},
{input: `{"prompt":"task","working_directory":"/work","agent":{}}`, wantErr: `missing properties: ["harness_id"]`},
{input: `{"prompt":"task","working_directory":"/work","agent":{"harness_id":"unknown"}}`, wantErr: "enum"},
{input: `{"prompt":"task","working_directory":"/work","agent":{"harness_id":"claude-code","config":{"mode":"invalid"}}}`, wantErr: "enum"},
{input: `{"prompt":"task","working_directory":"/work","agent":{"harness_id":"other","config":{"mode":"code"}}}`, wantErr: "unexpected additional properties"},
{input: `{"prompt":"task","working_directory":"/work","agent":{"harness_id":"claude-code","extra":true}}`, wantErr: "unexpected additional properties"},
{input: `{"prompt":"task","working_directory":"/work","agent":{"harness_id":"claude-code","config":{"mode":"code"}}}`},
{input: `{"prompt":"task","working_directory":"/work","agent":{"harness_id":"other"}}`},
} {
t.Run(tt.input, func(t *testing.T) {
t.Parallel()
tools := newACPTools(acpToolset{harnesses: []workspacesdk.ACPHarness{
{Slug: "claude-code", ConfigOptions: []workspacesdk.ACPConfigOption{
{ID: "mode", Values: []workspacesdk.ACPConfigValue{{ID: "code"}}},
}},
{Slug: "other"},
}})
prepared := turnEnvironment{Tools: tools, BuiltinToolNames: map[string]bool{"acp_spawn_agent": true}}
call := fantasy.ToolCallContent{ToolName: "acp_spawn_agent", Input: tt.input}
allowed, _, rejected := partitionInvalidToolCalls(prepared, []fantasy.ToolCallContent{call})
if tt.wantErr != "" {
require.Empty(t, allowed)
require.Len(t, rejected, 1)
result := rejected[0].Result.(fantasy.ToolResultOutputContentError)
require.ErrorContains(t, result.Error, tt.wantErr)
return
}
require.Empty(t, rejected)
require.Len(t, allowed, 1)
})
}
}
func TestPartitionInvalidToolCallsGatesOnBuiltins(t *testing.T) {
t.Parallel()
fetch := fetchToolStub()
ambiguous := fantasy.ToolCallContent{
ToolCallID: "call_ambiguous",
ToolName: "fetch",
Input: `{"URL":"https://example.test","url":"https://other.test"}`,
}
clean := fantasy.ToolCallContent{
ToolCallID: "call_clean",
ToolName: "fetch",
Input: `{"url":"https://example.test"}`,
}
t.Run("builtin", func(t *testing.T) {
t.Parallel()
prepared := turnEnvironment{
Tools: []fantasy.AgentTool{fetch},
BuiltinToolNames: map[string]bool{"fetch": true},
}
allowed, allowedIndexes, rejected := partitionInvalidToolCalls(prepared, []fantasy.ToolCallContent{ambiguous, clean})
require.Len(t, rejected, 1)
require.Equal(t, "call_ambiguous", rejected[0].ToolCallID)
require.Len(t, allowed, 1)
require.Equal(t, "call_clean", allowed[0].ToolCallID)
require.Equal(t, []int{1}, allowedIndexes, "allowed indexes point at positions in the input slice")
})
t.Run("non-builtin", func(t *testing.T) {
t.Parallel()
prepared := turnEnvironment{Tools: []fantasy.AgentTool{fetch}}
missingRequired := fantasy.ToolCallContent{ToolName: "fetch", Input: `{}`}
allowed, allowedIndexes, rejected := partitionInvalidToolCalls(prepared, []fantasy.ToolCallContent{ambiguous, clean, missingRequired})
require.Empty(t, rejected)
require.Len(t, allowed, 3)
require.Equal(t, []int{0, 1, 2}, allowedIndexes)
require.NoError(t, validateOverriddenToolInputs(prepared, chathooks.PreToolUseExecutionResult{
Allowed: []fantasy.ToolCallContent{missingRequired},
Overrides: map[string]json.RawMessage{missingRequired.ToolCallID: json.RawMessage(missingRequired.Input)},
}))
})
}
func TestValidateOverriddenToolInputs(t *testing.T) {
t.Parallel()
prepared := turnEnvironment{
Tools: []fantasy.AgentTool{fetchToolStub()},
BuiltinToolNames: map[string]bool{"fetch": true},
}
for _, tt := range []struct {
input string
wantErr string
}{
{input: `{"URL":"https://other.test"}`, wantErr: `input key "URL" differs from schema property "url" only by case`},
{input: `{}`, wantErr: `missing properties: ["url"]`},
{input: `{"url":1}`, wantErr: `want "string"`},
{input: `null`, wantErr: `want "object"`},
{input: `{"url":"https://other.test"}`},
} {
t.Run(tt.input, func(t *testing.T) {
t.Parallel()
overridden := chathooks.PreToolUseExecutionResult{
Allowed: []fantasy.ToolCallContent{{ToolCallID: "call_overridden", ToolName: "fetch", Input: tt.input}},
Overrides: map[string]json.RawMessage{
"call_overridden": json.RawMessage(tt.input),
},
}
err := validateOverriddenToolInputs(prepared, overridden)
if tt.wantErr == "" {
require.NoError(t, err)
} else {
require.ErrorContains(t, err, "hook input override for tool fetch:")
require.ErrorContains(t, err, tt.wantErr)
}
// Model-authored inputs are checked before hook dispatch instead.
untouched := chathooks.PreToolUseExecutionResult{Allowed: overridden.Allowed}
require.NoError(t, validateOverriddenToolInputs(prepared, untouched))
})
}
}
// TestBuiltinToolSchemasDescribeTheirInputs guards the validator's reach: it
// cannot detect a case-variant key for a builtin that declares no properties.
func TestBuiltinToolSchemasDescribeTheirInputs(t *testing.T) {
t.Parallel()
db, ps := dbtestutil.NewDB(t)
ctx := chatdTestContext(t)
user := dbgen.User(t, db, database.User{})
org := dbgen.Organization(t, db, database.Organization{})
dbgen.OrganizationMember(t, db, database.OrganizationMember{
UserID: user.ID,
OrganizationID: org.ID,
})
provider := dbgen.AIProviderWithOptionalKey(t, db, database.AIProvider{
Type: database.AIProviderTypeOpenai,
}, "test-key")
modelConfig := dbgen.ChatModelConfig(t, db, database.ChatModelConfig{
Model: "gpt-4o-mini",
AIProviderID: uuid.NullUUID{UUID: provider.ID, Valid: true},
OrganizationID: org.ID,
}, func(p *database.InsertChatModelConfigParams) {
p.Enabled = true
})
created, err := chatstate.CreateChat(ctx, db, ps, chatstate.CreateChatInput{
OrganizationID: org.ID,
OwnerID: user.ID,
LastModelConfigID: modelConfig.ID,
Title: "builtin tool schemas",
ClientType: database.ChatClientTypeApi,
InitialMessages: []chatstate.Message{{
Role: database.ChatMessageRoleUser,
Content: mustMarshalText(t, "hello"),
Visibility: database.ChatMessageVisibilityBoth,
ModelConfigID: uuid.NullUUID{UUID: modelConfig.ID, Valid: true},
CreatedBy: uuid.NullUUID{UUID: user.ID, Valid: true},
ContentVersion: chatprompt.CurrentContentVersion,
}},
})
require.NoError(t, err)
server := newInternalTestServer(
t,
db,
ps,
chatprovider.ProviderAPIKeys{},
withInternalTestServerTransportFactory(&aibridgeTestFactory{}),
)
prepared, err := server.buildTurnEnvironment(ctx, generationPrepareInput{
Chat: created.Chat,
Messages: created.InitialMessages,
})
require.NoError(t, err)
t.Cleanup(prepared.Close)
// These take an empty struct, so they carry no keys to validate.
noInput := map[string]bool{
"process_list": true,
"stop_workspace": true,
"list_subagent_models": true,
}
var unvalidated []string
require.NotEmpty(t, prepared.BuiltinToolNames)
for _, tool := range prepared.Tools {
info := tool.Info()
if !prepared.BuiltinToolNames[info.Name] || len(info.Parameters) > 0 || noInput[info.Name] {
continue
}
unvalidated = append(unvalidated, info.Name)
}
require.Empty(t, unvalidated,
"these builtin tools declare no schema properties, so their input is not validated")
}
func fetchToolStub() fantasy.AgentTool {
type input struct {
URL string `json:"url"`
}
return fantasy.NewAgentTool("fetch", "",
func(context.Context, input, fantasy.ToolCall) (fantasy.ToolResponse, error) {
return fantasy.ToolResponse{}, nil
})
}