opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

fix: server-side diffs and stricter fuzzy splicing for edit_files (#24454)

Browse Source 
Fixes three classes of edit_files bugs and adds structured per-file
diff output for tool callers:

- New IncludeDiff flag on FileEditRequest; when set, the agent
  returns FileEditResponse.Files[]{Path, Diff} with unified diffs
  computed via go-udiff v0.4.1 Lines + ToUnified (not Unified,
  which calls log.Fatalf on internal error).
- Fuzzy match comparators split each line into leading whitespace,
  body, trailing whitespace, and ending. The splice substitutes at
  each position: on agreement between search and replace the file's
  bytes win; on disagreement the replacement's bytes are spliced
  verbatim. Carve-outs for empty-body lines, multi-line EOF splices,
  and level-aware indent translation for inserted lines.
- Indent-unit detection (GCD for spaces, tab-priority) lets a 4sp
  LLM search insert correctly into tab or 2sp files. Falls back to
  the previous cLead-inheritance path when units can't be detected
  cleanly.
- Empty search is rejected with "search string must not be empty".
- Duplicate file paths in one request are rejected; symlink aliases
  resolved via api.resolvePath before the dedup check.
- Frontend EditFilesRenderer consumes the structured files array by
  explicit path (no label munging) with per-file synthetic fallback
  for older agents or mismatched paths. On error, no diff is
  rendered so the synthetic fallback doesn't misrepresent a
  rejected edit as applied.

Breaking change: AgentConn.EditFiles changes from (ctx, req) error
to (ctx, req) (FileEditResponse, error) in codersdk/workspacesdk.
Source-breaking for external Go consumers; no compat shim per plan
owner.

Out of scope (tracked in CODAGT-214): level-aware indent for
middle-substituted splice lines. Locked in
TestEditFiles_FuzzyIndent_InsertionLevelAware's Lock_* cases plus
TestEditFiles_ReplaceAll_FuzzyIndentGap.
This commit is contained in:
Mathias Fredriksson
2026-04-18 16:39:34 +03:00
committed by GitHub
parent 23f9e26796
commit 6b0bb02e5d
15 changed files with 3032 additions and 144 deletions
Download Patch File Download Diff File Expand all files Collapse all files
coderd/x/chatd/chattool/editfiles.go
+9 -2
View File
@@ -96,8 +96,15 @@ func executeEditFilesTool(
}
}
if err := conn.EditFiles(ctx, workspacesdk.FileEditRequest{Files: args.Files}); err != nil {
resp, err := conn.EditFiles(ctx, workspacesdk.FileEditRequest{
Files: args.Files,
IncludeDiff: true,
})
if err != nil {
return fantasy.NewTextErrorResponse(err.Error()), nil
}
return toolResponse(map[string]any{"ok": true}), nil
return toolResponse(map[string]any{
"ok": true,
"files": resp.Files,
}), nil
}
coderd/x/chatd/chattool/editfiles_test.go
+123 -49
View File
@@ -2,6 +2,7 @@ package chattool_test
import (
"context"
"encoding/json"
"net/http"
"testing"
@@ -85,14 +86,17 @@ func TestEditFiles(t *testing.T) {
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",
request := workspacesdk.FileEditRequest{
Files: []workspacesdk.FileEdits{{
Path: planPath,
Edits: []workspacesdk.FileEdit{{
Search: "old",
Replace: "new",
}},
}},
}}}
mockConn.EXPECT().EditFiles(gomock.Any(), request).Return(nil)
IncludeDiff: true,
}
mockConn.EXPECT().EditFiles(gomock.Any(), request).Return(workspacesdk.FileEditResponse{}, nil)
tool := chattool.EditFiles(chattool.EditFilesOptions{
GetWorkspaceConn: func(context.Context) (workspacesdk.AgentConn, error) {
@@ -123,14 +127,17 @@ func TestEditFiles(t *testing.T) {
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",
request := workspacesdk.FileEditRequest{
Files: []workspacesdk.FileEdits{{
Path: planPath,
Edits: []workspacesdk.FileEdit{{
Search: "old",
Replace: "new",
}},
}},
}}}
mockConn.EXPECT().EditFiles(gomock.Any(), request).Return(nil)
IncludeDiff: true,
}
mockConn.EXPECT().EditFiles(gomock.Any(), request).Return(workspacesdk.FileEditResponse{}, nil)
tool := chattool.EditFiles(chattool.EditFilesOptions{
GetWorkspaceConn: func(context.Context) (workspacesdk.AgentConn, error) {
@@ -290,14 +297,17 @@ func TestEditFiles(t *testing.T) {
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",
request := workspacesdk.FileEditRequest{
Files: []workspacesdk.FileEdits{{
Path: chatPlanPath,
Edits: []workspacesdk.FileEdit{{
Search: "old",
Replace: "new",
}},
}},
}}}
mockConn.EXPECT().EditFiles(gomock.Any(), request).Return(nil)
IncludeDiff: true,
}
mockConn.EXPECT().EditFiles(gomock.Any(), request).Return(workspacesdk.FileEditResponse{}, nil)
resolvePlanPathCalled := false
tool := chattool.EditFiles(chattool.EditFilesOptions{
@@ -324,14 +334,17 @@ func TestEditFiles(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",
request := workspacesdk.FileEditRequest{
Files: []workspacesdk.FileEdits{{
Path: "/home/coder/myproject/plan.md",
Edits: []workspacesdk.FileEdit{{
Search: "old",
Replace: "new",
}},
}},
}}}
mockConn.EXPECT().EditFiles(gomock.Any(), request).Return(nil)
IncludeDiff: true,
}
mockConn.EXPECT().EditFiles(gomock.Any(), request).Return(workspacesdk.FileEditResponse{}, nil)
tool := chattool.EditFiles(chattool.EditFilesOptions{
GetWorkspaceConn: func(context.Context) (workspacesdk.AgentConn, error) {
@@ -355,14 +368,17 @@ func TestEditFiles(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",
request := workspacesdk.FileEditRequest{
Files: []workspacesdk.FileEdits{{
Path: "/home/coder/myproject/plan.md",
Edits: []workspacesdk.FileEdit{{
Search: "old",
Replace: "new",
}},
}},
}}}
mockConn.EXPECT().EditFiles(gomock.Any(), request).Return(nil)
IncludeDiff: true,
}
mockConn.EXPECT().EditFiles(gomock.Any(), request).Return(workspacesdk.FileEditResponse{}, nil)
planPathCalled := false
tool := chattool.EditFiles(chattool.EditFilesOptions{
@@ -389,14 +405,17 @@ func TestEditFiles(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",
request := workspacesdk.FileEditRequest{
Files: []workspacesdk.FileEdits{{
Path: "/home/dev/my-plan.md",
Edits: []workspacesdk.FileEdit{{
Search: "old",
Replace: "new",
}},
}},
}}}
mockConn.EXPECT().EditFiles(gomock.Any(), request).Return(nil)
IncludeDiff: true,
}
mockConn.EXPECT().EditFiles(gomock.Any(), request).Return(workspacesdk.FileEditResponse{}, nil)
resolvePlanPathCalled := false
tool := chattool.EditFiles(chattool.EditFilesOptions{
@@ -423,14 +442,17 @@ func TestEditFiles(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",
request := workspacesdk.FileEditRequest{
Files: []workspacesdk.FileEdits{{
Path: chattool.LegacySharedPlanPath,
Edits: []workspacesdk.FileEdit{{
Search: "old",
Replace: "new",
}},
}},
}}}
mockConn.EXPECT().EditFiles(gomock.Any(), request).Return(nil)
IncludeDiff: true,
}
mockConn.EXPECT().EditFiles(gomock.Any(), request).Return(workspacesdk.FileEditResponse{}, nil)
tool := chattool.EditFiles(chattool.EditFilesOptions{
GetWorkspaceConn: func(context.Context) (workspacesdk.AgentConn, error) {
@@ -447,3 +469,55 @@ func TestEditFiles(t *testing.T) {
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)
}