mirror of
https://github.com/coder/coder.git
synced 2026-10-31 11:02:50 +08:00
Michael Suchacz
48e1e28638
## Problem Chat `45b87e40-ffe7-49e5-8932-5fd0bdb9e542` on dev.coder.com failed 57 of 75 `edit_files` tool calls. Every failure was the same: the model omitted `files[].path` (it batched edits per file but only filled in `edits`), and the error relayed back to the model was: ``` POST http://[fd7a:115c:...]:4/api/v0/edit-files: unexpected status code 400: "path" is required ``` The model retried the identical malformed call dozens of times. Two gaps made this sticky: 1. The `edit_files` input schema had no field descriptions, so `path` was only a bare required property. 2. The agent API error reached the model wrapped in HTTP transport noise (method, internal tailnet URL, status code) with no indication of which `files` entry was broken. ## Changes - Add `description` tags to every `edit_files` schema field and state the path requirement in the tool description. - Validate `files` entries in the tool before plan-turn checks and the workspace connection lookup, returning entry-indexed errors such as `files[1].path is required; provide the absolute path of the file to edit; no files in this batch were applied`. - Relay agent API failures with `Message`, `Helper`, `Detail`, and `Validations` from `codersdk.Error` instead of the raw transport-prefixed string. ## Validation - `go test ./coderd/x/chatd/chattool` passes; new tests cover the schema description, entry-indexed validation errors, and transport-noise stripping (each verified red-green by toggling the fix off). - `go build ./...`, `go vet`, and pre-commit (fmt + lint) pass. > Mux created this PR on Mike's behalf.
783 lines
25 KiB
Go
783 lines
25 KiB
Go
package chattool_test
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"net/http"
|
|
"testing"
|
|
|
|
"charm.land/fantasy"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
"go.uber.org/mock/gomock"
|
|
"golang.org/x/xerrors"
|
|
|
|
"github.com/coder/coder/v2/coderd/x/chatd/chattool"
|
|
"github.com/coder/coder/v2/codersdk"
|
|
"github.com/coder/coder/v2/codersdk/workspacesdk"
|
|
"github.com/coder/coder/v2/codersdk/workspacesdk/agentconnmock"
|
|
)
|
|
|
|
func TestEditFiles(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
// Verify the generated tool schema exposes old_text/new_text
|
|
// (not the deprecated search/replace) so the rename is
|
|
// auditable without running a separate program.
|
|
t.Run("SchemaUsesOldTextNewText", func(t *testing.T) {
|
|
t.Parallel()
|
|
tool := chattool.EditFiles(chattool.EditFilesOptions{})
|
|
info := tool.Info()
|
|
|
|
// Dig into: files -> items -> properties -> edits -> items -> properties
|
|
filesSchema := info.Parameters["files"]
|
|
require.NotNil(t, filesSchema, "missing files parameter")
|
|
filesMap, ok := filesSchema.(map[string]any)
|
|
require.True(t, ok)
|
|
items, ok := filesMap["items"].(map[string]any)
|
|
require.True(t, ok)
|
|
props, ok := items["properties"].(map[string]any)
|
|
require.True(t, ok)
|
|
editsSchema, ok := props["edits"].(map[string]any)
|
|
require.True(t, ok)
|
|
editItems, ok := editsSchema["items"].(map[string]any)
|
|
require.True(t, ok)
|
|
editProps, ok := editItems["properties"].(map[string]any)
|
|
require.True(t, ok)
|
|
|
|
assert.Contains(t, editProps, "old_text", "schema should expose old_text")
|
|
assert.Contains(t, editProps, "new_text", "schema should expose new_text")
|
|
assert.Contains(t, editProps, "replace_all", "schema should expose replace_all")
|
|
assert.NotContains(t, editProps, "search", "schema should not expose deprecated search")
|
|
assert.NotContains(t, editProps, "replace", "schema should not expose deprecated replace")
|
|
|
|
// Requiredness alone did not stop models from omitting path,
|
|
// so the schema must also describe it.
|
|
pathSchema, ok := props["path"].(map[string]any)
|
|
require.True(t, ok)
|
|
pathDesc, _ := pathSchema["description"].(string)
|
|
assert.Contains(t, pathDesc, "absolute path")
|
|
|
|
// Verify required fields.
|
|
editRequired, ok := editItems["required"].([]string)
|
|
require.True(t, ok)
|
|
assert.Contains(t, editRequired, "old_text")
|
|
assert.Contains(t, editRequired, "new_text")
|
|
assert.NotContains(t, editRequired, "replace_all", "replace_all should be optional")
|
|
})
|
|
|
|
t.Run("MalformedEntriesReturnEntryIndexedErrors", func(t *testing.T) {
|
|
t.Parallel()
|
|
cases := []struct {
|
|
name string
|
|
input string
|
|
wantErr string
|
|
}{
|
|
{
|
|
name: "MissingPath",
|
|
input: `{"files":[` +
|
|
`{"path":"/home/coder/a.txt","edits":[{"old_text":"old","new_text":"new"}]},` +
|
|
`{"edits":[{"old_text":"old","new_text":"new"}]}` +
|
|
`]}`,
|
|
wantErr: "files[1].path is required; provide the absolute path of the file to edit; no files in this batch were applied",
|
|
},
|
|
{
|
|
name: "EmptyEdits",
|
|
input: `{"files":[{"path":"/home/coder/a.txt","edits":[]}]}`,
|
|
wantErr: "files[0].edits must contain at least one edit; no files in this batch were applied",
|
|
},
|
|
}
|
|
for _, tc := range cases {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
t.Parallel()
|
|
ctrl := gomock.NewController(t)
|
|
mockConn := agentconnmock.NewMockAgentConn(ctrl)
|
|
tool := chattool.EditFiles(chattool.EditFilesOptions{
|
|
GetWorkspaceConn: func(context.Context) (workspacesdk.AgentConn, error) {
|
|
return mockConn, nil
|
|
},
|
|
})
|
|
|
|
resp, err := tool.Run(context.Background(), fantasy.ToolCall{
|
|
ID: "call-1",
|
|
Name: "edit_files",
|
|
Input: tc.input,
|
|
})
|
|
require.NoError(t, err)
|
|
assert.True(t, resp.IsError)
|
|
assert.Equal(t, tc.wantErr, resp.Content)
|
|
})
|
|
}
|
|
})
|
|
|
|
t.Run("AgentAPIErrorOmitsTransportNoise", func(t *testing.T) {
|
|
t.Parallel()
|
|
ctrl := gomock.NewController(t)
|
|
mockConn := agentconnmock.NewMockAgentConn(ctrl)
|
|
sdkErr := codersdk.NewTestError(http.StatusBadRequest, "POST", "http://[fd7a::1]:4/api/v0/edit-files")
|
|
sdkErr.Message = `file path must be absolute: "a.txt"`
|
|
sdkErr.Helper = "Use an absolute path."
|
|
sdkErr.Detail = "some detail"
|
|
sdkErr.Validations = []codersdk.ValidationError{{Field: "path", Detail: "must be absolute"}}
|
|
mockConn.EXPECT().EditFiles(gomock.Any(), gomock.Any()).
|
|
Return(workspacesdk.FileEditResponse{}, xerrors.Errorf("do request: %w", sdkErr))
|
|
|
|
tool := chattool.EditFiles(chattool.EditFilesOptions{
|
|
GetWorkspaceConn: func(context.Context) (workspacesdk.AgentConn, error) {
|
|
return mockConn, nil
|
|
},
|
|
})
|
|
|
|
resp, err := tool.Run(context.Background(), fantasy.ToolCall{
|
|
ID: "call-1",
|
|
Name: "edit_files",
|
|
Input: `{"files":[{"path":"a.txt","edits":[{"old_text":"old","new_text":"new"}]}]}`,
|
|
})
|
|
require.NoError(t, err)
|
|
assert.True(t, resp.IsError)
|
|
assert.Equal(t, "file path must be absolute: \"a.txt\": Use an absolute path.: some detail\n- path: must be absolute", resp.Content)
|
|
})
|
|
|
|
t.Run("PlanTurnRejectsNonPlanPath", func(t *testing.T) {
|
|
t.Parallel()
|
|
ctrl := gomock.NewController(t)
|
|
mockConn := agentconnmock.NewMockAgentConn(ctrl)
|
|
planPath := "/home/coder/.coder/plans/PLAN-test-uuid.md"
|
|
getWorkspaceConnCalled := false
|
|
tool := chattool.EditFiles(chattool.EditFilesOptions{
|
|
GetWorkspaceConn: func(context.Context) (workspacesdk.AgentConn, error) {
|
|
getWorkspaceConnCalled = true
|
|
return mockConn, nil
|
|
},
|
|
ResolvePlanPath: func(context.Context) (string, string, error) {
|
|
return planPath, "/home/coder", nil
|
|
},
|
|
IsPlanTurn: true,
|
|
})
|
|
|
|
resp, err := tool.Run(context.Background(), fantasy.ToolCall{
|
|
ID: "call-1",
|
|
Name: "edit_files",
|
|
Input: `{"files":[{"path":"/home/coder/README.md","edits":[{"search":"old","replace":"new"}]}]}`,
|
|
})
|
|
require.NoError(t, err)
|
|
assert.True(t, resp.IsError)
|
|
assert.Equal(t, "during plan turns, edit_files is restricted to "+planPath, resp.Content)
|
|
assert.False(t, getWorkspaceConnCalled)
|
|
})
|
|
|
|
t.Run("PlanTurnRejectsMixedPaths", func(t *testing.T) {
|
|
t.Parallel()
|
|
ctrl := gomock.NewController(t)
|
|
mockConn := agentconnmock.NewMockAgentConn(ctrl)
|
|
planPath := "/home/coder/.coder/plans/PLAN-test-uuid.md"
|
|
getWorkspaceConnCalled := false
|
|
tool := chattool.EditFiles(chattool.EditFilesOptions{
|
|
GetWorkspaceConn: func(context.Context) (workspacesdk.AgentConn, error) {
|
|
getWorkspaceConnCalled = true
|
|
return mockConn, nil
|
|
},
|
|
ResolvePlanPath: func(context.Context) (string, string, error) {
|
|
return planPath, "/home/coder", nil
|
|
},
|
|
IsPlanTurn: true,
|
|
})
|
|
|
|
resp, err := tool.Run(context.Background(), fantasy.ToolCall{
|
|
ID: "call-1",
|
|
Name: "edit_files",
|
|
Input: `{"files":[` +
|
|
`{"path":"` + planPath + `","edits":[{"search":"old","replace":"new"}]},` +
|
|
`{"path":"/home/coder/README.md","edits":[{"search":"old","replace":"new"}]}` +
|
|
`]}`,
|
|
})
|
|
require.NoError(t, err)
|
|
assert.True(t, resp.IsError)
|
|
assert.Equal(t, "during plan turns, edit_files is restricted to "+planPath, resp.Content)
|
|
assert.False(t, getWorkspaceConnCalled)
|
|
})
|
|
|
|
t.Run("PlanTurnAllowsResolvedPlanPath", func(t *testing.T) {
|
|
t.Parallel()
|
|
ctrl := gomock.NewController(t)
|
|
mockConn := agentconnmock.NewMockAgentConn(ctrl)
|
|
planPath := "/home/coder/.coder/plans/PLAN-test-uuid.md"
|
|
resolvePlanPathCalls := 0
|
|
mockConn.EXPECT().ResolvePath(gomock.Any(), planPath).Return(planPath, nil)
|
|
request := workspacesdk.FileEditRequest{
|
|
Files: []workspacesdk.FileEdits{{
|
|
Path: planPath,
|
|
Edits: []workspacesdk.FileEdit{{
|
|
Search: "old",
|
|
Replace: "new",
|
|
}},
|
|
}},
|
|
IncludeDiff: true,
|
|
}
|
|
mockConn.EXPECT().EditFiles(gomock.Any(), request).Return(workspacesdk.FileEditResponse{}, nil)
|
|
|
|
tool := chattool.EditFiles(chattool.EditFilesOptions{
|
|
GetWorkspaceConn: func(context.Context) (workspacesdk.AgentConn, error) {
|
|
return mockConn, nil
|
|
},
|
|
ResolvePlanPath: func(context.Context) (string, string, error) {
|
|
resolvePlanPathCalls++
|
|
return planPath, "/home/coder", nil
|
|
},
|
|
IsPlanTurn: true,
|
|
})
|
|
|
|
resp, err := tool.Run(context.Background(), fantasy.ToolCall{
|
|
ID: "call-1",
|
|
Name: "edit_files",
|
|
Input: `{"files":[{"path":"` + planPath + `","edits":[{"search":"old","replace":"new"}]}]}`,
|
|
})
|
|
require.NoError(t, err)
|
|
assert.False(t, resp.IsError)
|
|
assert.Equal(t, 1, resolvePlanPathCalls)
|
|
})
|
|
|
|
t.Run("PlanTurnAllowsLegacyAgentWithoutResolvePath", func(t *testing.T) {
|
|
t.Parallel()
|
|
ctrl := gomock.NewController(t)
|
|
mockConn := agentconnmock.NewMockAgentConn(ctrl)
|
|
planPath := "/home/coder/.coder/plans/PLAN-test-uuid.md"
|
|
mockConn.EXPECT().
|
|
ResolvePath(gomock.Any(), planPath).
|
|
Return("", statusError{statusCode: http.StatusNotFound, message: "missing resolve-path endpoint"})
|
|
request := workspacesdk.FileEditRequest{
|
|
Files: []workspacesdk.FileEdits{{
|
|
Path: planPath,
|
|
Edits: []workspacesdk.FileEdit{{
|
|
Search: "old",
|
|
Replace: "new",
|
|
}},
|
|
}},
|
|
IncludeDiff: true,
|
|
}
|
|
mockConn.EXPECT().EditFiles(gomock.Any(), request).Return(workspacesdk.FileEditResponse{}, nil)
|
|
|
|
tool := chattool.EditFiles(chattool.EditFilesOptions{
|
|
GetWorkspaceConn: func(context.Context) (workspacesdk.AgentConn, error) {
|
|
return mockConn, nil
|
|
},
|
|
ResolvePlanPath: func(context.Context) (string, string, error) {
|
|
return planPath, "/home/coder", nil
|
|
},
|
|
IsPlanTurn: true,
|
|
})
|
|
|
|
resp, err := tool.Run(context.Background(), fantasy.ToolCall{
|
|
ID: "call-1",
|
|
Name: "edit_files",
|
|
Input: `{"files":[{"path":"` + planPath + `","edits":[{"search":"old","replace":"new"}]}]}`,
|
|
})
|
|
require.NoError(t, err)
|
|
assert.False(t, resp.IsError)
|
|
})
|
|
|
|
t.Run("PlanTurnRejectsSymlinkedPlanPath", func(t *testing.T) {
|
|
t.Parallel()
|
|
ctrl := gomock.NewController(t)
|
|
mockConn := agentconnmock.NewMockAgentConn(ctrl)
|
|
planPath := "/home/coder/.coder/plans/PLAN-test-uuid.md"
|
|
mockConn.EXPECT().ResolvePath(gomock.Any(), planPath).Return("/home/coder/README.md", nil)
|
|
tool := chattool.EditFiles(chattool.EditFilesOptions{
|
|
GetWorkspaceConn: func(context.Context) (workspacesdk.AgentConn, error) {
|
|
return mockConn, nil
|
|
},
|
|
ResolvePlanPath: func(context.Context) (string, string, error) {
|
|
return planPath, "/home/coder", nil
|
|
},
|
|
IsPlanTurn: true,
|
|
})
|
|
|
|
resp, err := tool.Run(context.Background(), fantasy.ToolCall{
|
|
ID: "call-1",
|
|
Name: "edit_files",
|
|
Input: `{"files":[{"path":"` + planPath + `","edits":[{"search":"old","replace":"new"}]}]}`,
|
|
})
|
|
require.NoError(t, err)
|
|
assert.True(t, resp.IsError)
|
|
assert.Equal(t, "the chat-specific plan path /home/coder/.coder/plans/PLAN-test-uuid.md resolves to /home/coder/README.md; symlinked plan paths are not allowed during plan turns", resp.Content)
|
|
})
|
|
|
|
t.Run("RejectsPlanPathsWhenResolvePlanPathIsConfigured", func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
tests := []struct {
|
|
name string
|
|
input string
|
|
expectedRejectedPath string
|
|
}{
|
|
{
|
|
name: "SingleHomeRootPlanPath",
|
|
input: `{"files":[{"path":"/Users/dev/plan.md","edits":[{"search":"old","replace":"new"}]}]}`,
|
|
expectedRejectedPath: "/Users/dev/plan.md",
|
|
},
|
|
{
|
|
name: "MultiFileBatchWithHomeRootPlanPath",
|
|
input: `{"files":[` +
|
|
`{"path":"/Users/dev/subdir/plan.md","edits":[{"search":"old","replace":"new"}]},` +
|
|
`{"path":"/Users/dev/plan.md","edits":[{"search":"old","replace":"new"}]}` +
|
|
`]}`,
|
|
expectedRejectedPath: "/Users/dev/plan.md",
|
|
},
|
|
}
|
|
|
|
for _, testCase := range tests {
|
|
t.Run(testCase.name, func(t *testing.T) {
|
|
t.Parallel()
|
|
ctrl := gomock.NewController(t)
|
|
mockConn := agentconnmock.NewMockAgentConn(ctrl)
|
|
resolvePlanPathCalls := 0
|
|
tool := chattool.EditFiles(chattool.EditFilesOptions{
|
|
GetWorkspaceConn: func(context.Context) (workspacesdk.AgentConn, error) {
|
|
return mockConn, nil
|
|
},
|
|
ResolvePlanPath: func(context.Context) (string, string, error) {
|
|
resolvePlanPathCalls++
|
|
return "/Users/dev/.coder/plans/PLAN-chat.md", "/Users/dev", nil
|
|
},
|
|
})
|
|
|
|
resp, err := tool.Run(context.Background(), fantasy.ToolCall{
|
|
ID: "call-1",
|
|
Name: "edit_files",
|
|
Input: testCase.input,
|
|
})
|
|
require.NoError(t, err)
|
|
assert.True(t, resp.IsError)
|
|
assert.Equal(t, 1, resolvePlanPathCalls)
|
|
assert.Equal(
|
|
t,
|
|
editFilesBatchRejectedMessage(sharedPlanPathResolvedMessage(
|
|
testCase.expectedRejectedPath,
|
|
"/Users/dev/.coder/plans/PLAN-chat.md",
|
|
)),
|
|
resp.Content,
|
|
)
|
|
})
|
|
}
|
|
})
|
|
|
|
t.Run("RejectsSharedPlanPathWhenResolverFails", func(t *testing.T) {
|
|
t.Parallel()
|
|
ctrl := gomock.NewController(t)
|
|
mockConn := agentconnmock.NewMockAgentConn(ctrl)
|
|
tool := chattool.EditFiles(chattool.EditFilesOptions{
|
|
GetWorkspaceConn: func(context.Context) (workspacesdk.AgentConn, error) {
|
|
return mockConn, nil
|
|
},
|
|
ResolvePlanPath: func(context.Context) (string, string, error) {
|
|
return "", "", xerrors.New("workspace unavailable")
|
|
},
|
|
})
|
|
|
|
resp, err := tool.Run(context.Background(), fantasy.ToolCall{
|
|
ID: "call-1",
|
|
Name: "edit_files",
|
|
Input: `{"files":[{"path":"/home/coder/plan.md","edits":[{"search":"old","replace":"new"}]}]}`,
|
|
})
|
|
require.NoError(t, err)
|
|
assert.True(t, resp.IsError)
|
|
assert.Equal(t, editFilesBatchRejectedMessage(planPathVerificationMessage("/home/coder/plan.md")), resp.Content)
|
|
})
|
|
|
|
t.Run("RejectsRelativePlanPathsWhenResolvePlanPathIsConfigured", func(t *testing.T) {
|
|
t.Parallel()
|
|
ctrl := gomock.NewController(t)
|
|
mockConn := agentconnmock.NewMockAgentConn(ctrl)
|
|
resolvePlanPathCalled := false
|
|
tool := chattool.EditFiles(chattool.EditFilesOptions{
|
|
GetWorkspaceConn: func(context.Context) (workspacesdk.AgentConn, error) {
|
|
return mockConn, nil
|
|
},
|
|
ResolvePlanPath: func(context.Context) (string, string, error) {
|
|
resolvePlanPathCalled = true
|
|
return "/home/coder/.coder/plans/PLAN-chat.md", "/home/coder", nil
|
|
},
|
|
})
|
|
|
|
resp, err := tool.Run(context.Background(), fantasy.ToolCall{
|
|
ID: "call-1",
|
|
Name: "edit_files",
|
|
Input: `{"files":[{"path":"plan.md","edits":[{"search":"old","replace":"new"}]}]}`,
|
|
})
|
|
require.NoError(t, err)
|
|
assert.True(t, resp.IsError)
|
|
assert.False(t, resolvePlanPathCalled)
|
|
assert.Equal(t, editFilesBatchRejectedMessage(relativePlanPathMessage()), resp.Content)
|
|
})
|
|
|
|
t.Run("PerChatPlanPathIsAllowed", func(t *testing.T) {
|
|
t.Parallel()
|
|
ctrl := gomock.NewController(t)
|
|
mockConn := agentconnmock.NewMockAgentConn(ctrl)
|
|
chatPlanPath := "/home/coder/.coder/plans/PLAN-123e4567-e89b-12d3-a456-426614174000.md"
|
|
request := workspacesdk.FileEditRequest{
|
|
Files: []workspacesdk.FileEdits{{
|
|
Path: chatPlanPath,
|
|
Edits: []workspacesdk.FileEdit{{
|
|
Search: "old",
|
|
Replace: "new",
|
|
}},
|
|
}},
|
|
IncludeDiff: true,
|
|
}
|
|
mockConn.EXPECT().EditFiles(gomock.Any(), request).Return(workspacesdk.FileEditResponse{}, nil)
|
|
|
|
resolvePlanPathCalled := false
|
|
tool := chattool.EditFiles(chattool.EditFilesOptions{
|
|
GetWorkspaceConn: func(context.Context) (workspacesdk.AgentConn, error) {
|
|
return mockConn, nil
|
|
},
|
|
ResolvePlanPath: func(context.Context) (string, string, error) {
|
|
resolvePlanPathCalled = true
|
|
return chatPlanPath, "/home/coder", nil
|
|
},
|
|
})
|
|
|
|
resp, err := tool.Run(context.Background(), fantasy.ToolCall{
|
|
ID: "call-1",
|
|
Name: "edit_files",
|
|
Input: `{"files":[{"path":"` + chatPlanPath + `","edits":[{"search":"old","replace":"new"}]}]}`,
|
|
})
|
|
require.NoError(t, err)
|
|
assert.False(t, resp.IsError)
|
|
assert.False(t, resolvePlanPathCalled)
|
|
})
|
|
|
|
t.Run("NestedPlanPathAllowedWhenResolverFails", func(t *testing.T) {
|
|
t.Parallel()
|
|
ctrl := gomock.NewController(t)
|
|
mockConn := agentconnmock.NewMockAgentConn(ctrl)
|
|
request := workspacesdk.FileEditRequest{
|
|
Files: []workspacesdk.FileEdits{{
|
|
Path: "/home/coder/myproject/plan.md",
|
|
Edits: []workspacesdk.FileEdit{{
|
|
Search: "old",
|
|
Replace: "new",
|
|
}},
|
|
}},
|
|
IncludeDiff: true,
|
|
}
|
|
mockConn.EXPECT().EditFiles(gomock.Any(), request).Return(workspacesdk.FileEditResponse{}, nil)
|
|
|
|
tool := chattool.EditFiles(chattool.EditFilesOptions{
|
|
GetWorkspaceConn: func(context.Context) (workspacesdk.AgentConn, error) {
|
|
return mockConn, nil
|
|
},
|
|
ResolvePlanPath: func(context.Context) (string, string, error) {
|
|
return "", "", xerrors.New("workspace unavailable")
|
|
},
|
|
})
|
|
|
|
resp, err := tool.Run(context.Background(), fantasy.ToolCall{
|
|
ID: "call-1",
|
|
Name: "edit_files",
|
|
Input: `{"files":[{"path":"/home/coder/myproject/plan.md","edits":[{"search":"old","replace":"new"}]}]}`,
|
|
})
|
|
require.NoError(t, err)
|
|
assert.False(t, resp.IsError)
|
|
})
|
|
|
|
t.Run("NestedPlanPathUnderHomeIsAllowed", func(t *testing.T) {
|
|
t.Parallel()
|
|
ctrl := gomock.NewController(t)
|
|
mockConn := agentconnmock.NewMockAgentConn(ctrl)
|
|
request := workspacesdk.FileEditRequest{
|
|
Files: []workspacesdk.FileEdits{{
|
|
Path: "/home/coder/myproject/plan.md",
|
|
Edits: []workspacesdk.FileEdit{{
|
|
Search: "old",
|
|
Replace: "new",
|
|
}},
|
|
}},
|
|
IncludeDiff: true,
|
|
}
|
|
mockConn.EXPECT().EditFiles(gomock.Any(), request).Return(workspacesdk.FileEditResponse{}, nil)
|
|
|
|
planPathCalled := false
|
|
tool := chattool.EditFiles(chattool.EditFilesOptions{
|
|
GetWorkspaceConn: func(context.Context) (workspacesdk.AgentConn, error) {
|
|
return mockConn, nil
|
|
},
|
|
ResolvePlanPath: func(context.Context) (string, string, error) {
|
|
planPathCalled = true
|
|
return "/home/coder/.coder/plans/PLAN-chat.md", "/home/coder", nil
|
|
},
|
|
})
|
|
|
|
resp, err := tool.Run(context.Background(), fantasy.ToolCall{
|
|
ID: "call-1",
|
|
Name: "edit_files",
|
|
Input: `{"files":[{"path":"/home/coder/myproject/plan.md","edits":[{"search":"old","replace":"new"}]}]}`,
|
|
})
|
|
require.NoError(t, err)
|
|
assert.False(t, resp.IsError)
|
|
assert.True(t, planPathCalled)
|
|
})
|
|
|
|
t.Run("AllowsNonSharedPath", func(t *testing.T) {
|
|
t.Parallel()
|
|
ctrl := gomock.NewController(t)
|
|
mockConn := agentconnmock.NewMockAgentConn(ctrl)
|
|
request := workspacesdk.FileEditRequest{
|
|
Files: []workspacesdk.FileEdits{{
|
|
Path: "/home/dev/my-plan.md",
|
|
Edits: []workspacesdk.FileEdit{{
|
|
Search: "old",
|
|
Replace: "new",
|
|
}},
|
|
}},
|
|
IncludeDiff: true,
|
|
}
|
|
mockConn.EXPECT().EditFiles(gomock.Any(), request).Return(workspacesdk.FileEditResponse{}, nil)
|
|
|
|
resolvePlanPathCalled := false
|
|
tool := chattool.EditFiles(chattool.EditFilesOptions{
|
|
GetWorkspaceConn: func(context.Context) (workspacesdk.AgentConn, error) {
|
|
return mockConn, nil
|
|
},
|
|
ResolvePlanPath: func(context.Context) (string, string, error) {
|
|
resolvePlanPathCalled = true
|
|
return "", "", xerrors.New("should not be called")
|
|
},
|
|
})
|
|
|
|
resp, err := tool.Run(context.Background(), fantasy.ToolCall{
|
|
ID: "call-1",
|
|
Name: "edit_files",
|
|
Input: `{"files":[{"path":"/home/dev/my-plan.md","edits":[{"search":"old","replace":"new"}]}]}`,
|
|
})
|
|
require.NoError(t, err)
|
|
assert.False(t, resp.IsError)
|
|
assert.False(t, resolvePlanPathCalled)
|
|
})
|
|
|
|
t.Run("AllowsSharedPlanPathWhenResolvePlanPathIsNil", func(t *testing.T) {
|
|
t.Parallel()
|
|
ctrl := gomock.NewController(t)
|
|
mockConn := agentconnmock.NewMockAgentConn(ctrl)
|
|
request := workspacesdk.FileEditRequest{
|
|
Files: []workspacesdk.FileEdits{{
|
|
Path: chattool.LegacySharedPlanPath,
|
|
Edits: []workspacesdk.FileEdit{{
|
|
Search: "old",
|
|
Replace: "new",
|
|
}},
|
|
}},
|
|
IncludeDiff: true,
|
|
}
|
|
mockConn.EXPECT().EditFiles(gomock.Any(), request).Return(workspacesdk.FileEditResponse{}, nil)
|
|
|
|
tool := chattool.EditFiles(chattool.EditFilesOptions{
|
|
GetWorkspaceConn: func(context.Context) (workspacesdk.AgentConn, error) {
|
|
return mockConn, nil
|
|
},
|
|
})
|
|
|
|
resp, err := tool.Run(context.Background(), fantasy.ToolCall{
|
|
ID: "call-1",
|
|
Name: "edit_files",
|
|
Input: `{"files":[{"path":"` + chattool.LegacySharedPlanPath + `","edits":[{"search":"old","replace":"new"}]}]}`,
|
|
})
|
|
require.NoError(t, err)
|
|
assert.False(t, resp.IsError)
|
|
})
|
|
}
|
|
|
|
func TestEditFiles_OldTextNewTextFieldsPreferred(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
ctrl := gomock.NewController(t)
|
|
mockConn := agentconnmock.NewMockAgentConn(ctrl)
|
|
targetPath := "/home/coder/main.go"
|
|
|
|
// The agent API should map old_text->Search and new_text->Replace.
|
|
mockConn.EXPECT().
|
|
EditFiles(gomock.Any(), workspacesdk.FileEditRequest{
|
|
Files: []workspacesdk.FileEdits{{
|
|
Path: targetPath,
|
|
Edits: []workspacesdk.FileEdit{{
|
|
Search: "old content",
|
|
Replace: "new content",
|
|
}},
|
|
}},
|
|
IncludeDiff: true,
|
|
}).
|
|
Return(workspacesdk.FileEditResponse{}, nil)
|
|
|
|
tool := chattool.EditFiles(chattool.EditFilesOptions{
|
|
GetWorkspaceConn: func(context.Context) (workspacesdk.AgentConn, error) {
|
|
return mockConn, nil
|
|
},
|
|
})
|
|
|
|
resp, err := tool.Run(context.Background(), fantasy.ToolCall{
|
|
ID: "call-1",
|
|
Name: "edit_files",
|
|
Input: `{"files":[{"path":"` + targetPath + `","edits":[{"old_text":"old content","new_text":"new content"}]}]}`,
|
|
})
|
|
require.NoError(t, err)
|
|
assert.False(t, resp.IsError)
|
|
}
|
|
|
|
func TestEditFiles_DeprecatedSearchReplaceFieldsStillWork(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
ctrl := gomock.NewController(t)
|
|
mockConn := agentconnmock.NewMockAgentConn(ctrl)
|
|
targetPath := "/home/coder/main.go"
|
|
|
|
// Agents with cached schemas may still send "search"/"replace".
|
|
// Also exercises replace_all through the new unmarshal+convert path.
|
|
mockConn.EXPECT().
|
|
EditFiles(gomock.Any(), workspacesdk.FileEditRequest{
|
|
Files: []workspacesdk.FileEdits{{
|
|
Path: targetPath,
|
|
Edits: []workspacesdk.FileEdit{{
|
|
Search: "old",
|
|
Replace: "replacement",
|
|
ReplaceAll: true,
|
|
}},
|
|
}},
|
|
IncludeDiff: true,
|
|
}).
|
|
Return(workspacesdk.FileEditResponse{}, nil)
|
|
|
|
tool := chattool.EditFiles(chattool.EditFilesOptions{
|
|
GetWorkspaceConn: func(context.Context) (workspacesdk.AgentConn, error) {
|
|
return mockConn, nil
|
|
},
|
|
})
|
|
|
|
resp, err := tool.Run(context.Background(), fantasy.ToolCall{
|
|
ID: "call-1",
|
|
Name: "edit_files",
|
|
Input: `{"files":[{"path":"` + targetPath + `","edits":[{"search":"old","replace":"replacement","replace_all":true}]}]}`,
|
|
})
|
|
require.NoError(t, err)
|
|
assert.False(t, resp.IsError)
|
|
}
|
|
|
|
func TestEditFiles_DeprecatedFieldsAreCaseSensitive(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
ctrl := gomock.NewController(t)
|
|
mockConn := agentconnmock.NewMockAgentConn(ctrl)
|
|
targetPath := "/home/coder/main.go"
|
|
mockConn.EXPECT().
|
|
EditFiles(gomock.Any(), workspacesdk.FileEditRequest{
|
|
Files: []workspacesdk.FileEdits{{
|
|
Path: targetPath,
|
|
Edits: []workspacesdk.FileEdit{{}},
|
|
}},
|
|
IncludeDiff: true,
|
|
}).
|
|
Return(workspacesdk.FileEditResponse{}, nil)
|
|
|
|
tool := chattool.EditFiles(chattool.EditFilesOptions{
|
|
GetWorkspaceConn: func(context.Context) (workspacesdk.AgentConn, error) {
|
|
return mockConn, nil
|
|
},
|
|
})
|
|
|
|
resp, err := tool.Run(context.Background(), fantasy.ToolCall{
|
|
ID: "call-1",
|
|
Name: "edit_files",
|
|
Input: `{"files":[{"path":"` + targetPath + `","edits":[{"SEARCH":"old","REPLACE":"replacement"}]}]}`,
|
|
})
|
|
require.NoError(t, err)
|
|
assert.False(t, resp.IsError)
|
|
}
|
|
|
|
func TestEditFiles_NewFieldNamesTakePrecedenceOverOld(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
ctrl := gomock.NewController(t)
|
|
mockConn := agentconnmock.NewMockAgentConn(ctrl)
|
|
targetPath := "/home/coder/main.go"
|
|
|
|
// If both old and new field names are present, new names win.
|
|
mockConn.EXPECT().
|
|
EditFiles(gomock.Any(), workspacesdk.FileEditRequest{
|
|
Files: []workspacesdk.FileEdits{{
|
|
Path: targetPath,
|
|
Edits: []workspacesdk.FileEdit{{
|
|
Search: "from-oldText",
|
|
Replace: "from-newText",
|
|
}},
|
|
}},
|
|
IncludeDiff: true,
|
|
}).
|
|
Return(workspacesdk.FileEditResponse{}, nil)
|
|
|
|
tool := chattool.EditFiles(chattool.EditFilesOptions{
|
|
GetWorkspaceConn: func(context.Context) (workspacesdk.AgentConn, error) {
|
|
return mockConn, nil
|
|
},
|
|
})
|
|
|
|
resp, err := tool.Run(context.Background(), fantasy.ToolCall{
|
|
ID: "call-1",
|
|
Name: "edit_files",
|
|
Input: `{"files":[{"path":"` + targetPath + `","edits":[{"old_text":"from-oldText","search":"from-search","new_text":"from-newText","replace":"from-replace"}]}]}`,
|
|
})
|
|
require.NoError(t, err)
|
|
assert.False(t, resp.IsError)
|
|
}
|
|
|
|
func TestEditFiles_ToolResponseCarriesFileResults(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
ctrl := gomock.NewController(t)
|
|
mockConn := agentconnmock.NewMockAgentConn(ctrl)
|
|
targetPath := "/home/coder/target.txt"
|
|
expectedFiles := []workspacesdk.FileEditResult{
|
|
{
|
|
Path: targetPath,
|
|
Diff: "--- " + targetPath + "\n+++ " + targetPath + "\n@@ -1 +1 @@\n-old\n+new\n",
|
|
},
|
|
}
|
|
// The tool must opt into diffs (IncludeDiff: true) and forward
|
|
// the agent's per-file results through to its response.
|
|
mockConn.EXPECT().
|
|
EditFiles(gomock.Any(), workspacesdk.FileEditRequest{
|
|
Files: []workspacesdk.FileEdits{{
|
|
Path: targetPath,
|
|
Edits: []workspacesdk.FileEdit{{
|
|
Search: "old",
|
|
Replace: "new",
|
|
}},
|
|
}},
|
|
IncludeDiff: true,
|
|
}).
|
|
Return(workspacesdk.FileEditResponse{Files: expectedFiles}, nil)
|
|
|
|
tool := chattool.EditFiles(chattool.EditFilesOptions{
|
|
GetWorkspaceConn: func(context.Context) (workspacesdk.AgentConn, error) {
|
|
return mockConn, nil
|
|
},
|
|
})
|
|
|
|
resp, err := tool.Run(context.Background(), fantasy.ToolCall{
|
|
ID: "call-1",
|
|
Name: "edit_files",
|
|
Input: `{"files":[{"path":"` + targetPath + `","edits":[{"search":"old","replace":"new"}]}]}`,
|
|
})
|
|
require.NoError(t, err)
|
|
assert.False(t, resp.IsError)
|
|
|
|
var decoded struct {
|
|
OK bool `json:"ok"`
|
|
Files []workspacesdk.FileEditResult `json:"files"`
|
|
}
|
|
require.NoError(t, json.Unmarshal([]byte(resp.Content), &decoded))
|
|
assert.True(t, decoded.OK)
|
|
require.Len(t, decoded.Files, 1)
|
|
assert.Equal(t, targetPath, decoded.Files[0].Path)
|
|
assert.Equal(t, expectedFiles[0].Diff, decoded.Files[0].Diff)
|
|
}
|