Skip to content

feat/autofix: get explanations from agent fix response, fall back to AI Explain #150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
BBerabi wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat/autofix: get explanations from agent fix response, fall back to AI Explain #150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
782815e
feat/autofix: get explanations directly from agent fix response
BBerabi May 28, 2026
f53cb0a
feat/autofix: only call AI Explain when the autofix response lacks an…
BBerabi Jul 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion llm/api_client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ func (d *DeepCodeLLMBindingImpl) submitRequest(ctx context.Context, url *url.URL
return nil, err
}

req, err := http.NewRequestWithContext(ctx, http.MethodPost, url.String(), bodyBuffer)
req, err := http.NewRequestWithContext(span.Context(), http.MethodPost, url.String(), bodyBuffer)
if err != nil {
logger.Err(err).Str("requestBody", string(requestBody)).Msg("error creating request")
return nil, err
Expand Down
67 changes: 66 additions & 1 deletion llm/binding.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,72 @@ func (d *DeepCodeLLMBindingImpl) GetAutofixDiffs(ctx context.Context, _ string,
if err != nil {
return nil, status, err
}
return autofixResponse.toUnifiedDiffSuggestions(d.logger, options.BaseDir, options.FilePath), status, err

unifiedDiffSuggestions = autofixResponse.toUnifiedDiffSuggestions(d.logger, options.BaseDir, options.FilePath)
d.enrichWithExplain(span.Context(), options, unifiedDiffSuggestions)

return unifiedDiffSuggestions, status, err
}

// enrichWithExplain fills in the Explanation for suggestions whose Autofix response did not
// already include one, falling back to the deprecated AI Explain service. Suggestions that
// already carry an explanation are left untouched, and the call is skipped entirely once none
// are missing or no ExplainEndpoint was configured.
func (d *DeepCodeLLMBindingImpl) enrichWithExplain(ctx context.Context, options AutofixOptions, suggestions []AutofixUnifiedDiffSuggestion) {
method := "code.EnrichWithExplain"
logger := d.logger.With().Str("method", method).Logger()

missingIndices := make([]int, 0, len(suggestions))
for i := range suggestions {
if suggestions[i].Explanation == "" {
missingIndices = append(missingIndices, i)
}
}
if len(missingIndices) == 0 {
return
}

if options.ExplainEndpoint == nil {
logger.Debug().Msg("No ExplainEndpoint configured, skipping AI Explain fallback")
return
}

span := d.instrumentor.StartSpan(ctx, method)
defer d.instrumentor.Finish(span)

diffs := make([]string, 0, len(missingIndices))
for _, idx := range missingIndices {
diffs = append(diffs, concatDiffs(suggestions[idx]))
}

response, err := d.runExplain(span.Context(), ExplainOptions{
RuleKey: options.RuleID,
Diffs: diffs,
Endpoint: options.ExplainEndpoint,
})
if err != nil {
logger.Err(err).Msg("Failed to obtain fallback explanations from AI Explain")
return
}

explanations := getOrderedResponse(response)
for i, idx := range missingIndices {
if i >= len(explanations) {
logger.Debug().Msgf("Failed to get fallback explanation for suggestion index %v", idx)
break
}
suggestions[idx].Explanation = explanations[i]
}
}

// concatDiffs concatenates the diffs of a suggestion across all its files, as the (deprecated)
// AI Explain service expects a single diff string per suggestion.
func concatDiffs(suggestion AutofixUnifiedDiffSuggestion) string {
diff := ""
for _, v := range suggestion.UnifiedDiffsPerFile {
diff += v
}
return diff
}

func (d *DeepCodeLLMBindingImpl) ExplainWithOptions(ctx context.Context, options ExplainOptions) (ExplainResult, error) {
Expand Down
61 changes: 61 additions & 0 deletions llm/binding_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,67 @@ func TestExplainWithOptions(t *testing.T) {
})
}

func TestEnrichWithExplain(t *testing.T) {
t.Run("skips when no suggestions are missing an explanation", func(t *testing.T) {
d, mockHTTPClient := getHTTPMockedBinding(t)
mockHTTPClient.EXPECT().Do(gomock.Any()).Times(0)

suggestions := []AutofixUnifiedDiffSuggestion{
{FixId: "fix-1", Explanation: "explanation 1", UnifiedDiffsPerFile: map[string]string{"a.go": "diff1"}},
{FixId: "fix-2", Explanation: "explanation 2", UnifiedDiffsPerFile: map[string]string{"b.go": "diff2"}},
}
endpoint := &url.URL{Scheme: "http", Host: "test.com"}

d.enrichWithExplain(t.Context(), AutofixOptions{ExplainEndpoint: endpoint}, suggestions)

assert.Equal(t, "explanation 1", suggestions[0].Explanation)
assert.Equal(t, "explanation 2", suggestions[1].Explanation)
})

t.Run("skips when no ExplainEndpoint is configured", func(t *testing.T) {
d, mockHTTPClient := getHTTPMockedBinding(t)
mockHTTPClient.EXPECT().Do(gomock.Any()).Times(0)

suggestions := []AutofixUnifiedDiffSuggestion{
{FixId: "fix-1", UnifiedDiffsPerFile: map[string]string{"a.go": "diff1"}},
}

d.enrichWithExplain(t.Context(), AutofixOptions{}, suggestions)

assert.Equal(t, "", suggestions[0].Explanation)
})

t.Run("fills in only the missing explanations", func(t *testing.T) {
d, mockHTTPClient := getHTTPMockedBinding(t)

explainResponseJSON := explainResponse{
Status: completeStatus,
Explanation: map[string]string{
"explanation1": "fallback explanation for fix-2",
},
}
expectedResponseBody, err := json.Marshal(explainResponseJSON)
assert.NoError(t, err)
mockResponse := http2.Response{
Status: "200 Ok",
StatusCode: 200,
Body: io.NopCloser(strings.NewReader(string(expectedResponseBody))),
}
mockHTTPClient.EXPECT().Do(gomock.Any()).Return(&mockResponse, nil).Times(1)

suggestions := []AutofixUnifiedDiffSuggestion{
{FixId: "fix-1", Explanation: "explanation from response", UnifiedDiffsPerFile: map[string]string{"a.go": "diff1"}},
{FixId: "fix-2", UnifiedDiffsPerFile: map[string]string{"b.go": "diff2"}},
}
endpoint := &url.URL{Scheme: "http", Host: "test.com"}

d.enrichWithExplain(t.Context(), AutofixOptions{RuleID: "rule-key", ExplainEndpoint: endpoint}, suggestions)

assert.Equal(t, "explanation from response", suggestions[0].Explanation)
assert.Equal(t, "fallback explanation for fix-2", suggestions[1].Explanation)
})
}

func getHTTPMockedBinding(t *testing.T) (*DeepCodeLLMBindingImpl, *mocks.MockHTTPClient) {
t.Helper()
ctrl := gomock.NewController(t)
Expand Down
1 change: 1 addition & 0 deletions llm/convert.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ func (s *AutofixResponse) toUnifiedDiffSuggestions(logger *zerolog.Logger, baseD
d := AutofixUnifiedDiffSuggestion{
FixId: suggestion.Id,
UnifiedDiffsPerFile: map[string]string{},
Explanation: suggestion.Explanation,
}

d.UnifiedDiffsPerFile[decodedPath] = unifiedDiff
Expand Down
11 changes: 9 additions & 2 deletions llm/types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,9 @@ type AutofixResponse struct {
AutofixSuggestions []autofixResponseSingleFix `json:"fixes"`
}
type autofixResponseSingleFix struct {
Id string `json:"id"`
Value string `json:"value"`
Id string `json:"id"`
Value string `json:"value"`
Explanation string `json:"explanation"`
}

// AutofixUnifiedDiffSuggestion represents the diff between the original and the fixed source code.
Expand Down Expand Up @@ -136,6 +137,12 @@ type AutofixOptions struct {
Host string
CodeRequestContext CodeRequestContext
IdeExtensionDetails AutofixIdeExtensionDetails

// ExplainEndpoint is the (deprecated) AI Explain endpoint. It is only used as a fallback to
// obtain explanations for autofix suggestions whose response did not already include one, e.g.
// when served by an older Autofix backend. If nil, no fallback call is made and suggestions
// without an explanation are returned as-is.
ExplainEndpoint *url.URL
}

type AutofixFeedbackOptions struct {
Expand Down
Loading