open-code-review/internal/tool/code_comment.go
kite a2e08b77a1
Some checks are pending
CI / test (push) Waiting to run
feat(review): add structured category and severity to findings (#311)
Add two structured fields, category and severity, to every review finding
so CI integrations can sort, group, filter, or gate builds without
re-parsing natural-language comment text.

- Tool schema (tools.json): add category/severity as enum-constrained,
  required properties of code_comment. severity is limited to
  critical/high/medium/low (info dropped, since LLMs struggle to
  distinguish low from info).
- System prompt (task_template.json) is intentionally left untouched to
  avoid the review-quality regression observed on the benchmark suite;
  the tool schema alone drives field population.
- JSON output: category/severity are flat siblings of content/start_line,
  omitted entirely when empty (backward compatible).
- CLI output: render an inline [category - severity] badge before the
  comment, colored by severity.
- Sync docs across all five README locales.
2026-07-07 13:08:41 +08:00

88 lines
2.2 KiB
Go

package tool
import (
"context"
"encoding/json"
"fmt"
"github.com/open-code-review/open-code-review/internal/model"
)
// CodeCommentProvider submits review comments to the per-Agent CommentCollector.
type CodeCommentProvider struct {
Collector *CommentCollector
}
func (p *CodeCommentProvider) Tool() Tool { return CodeComment }
func (p *CodeCommentProvider) Execute(_ context.Context, args map[string]any) (string, error) {
if p.Collector == nil {
return "Error: comment collector is not configured", nil
}
comments, errMsg := ParseComments(args)
if errMsg != "" {
return errMsg, nil
}
for i := range comments {
p.Collector.Add(comments[i])
}
return CommentSucceed, nil
}
// ParseComments extracts LlmComment entries from tool call arguments without writing
// to the Collector. Returns parsed comments and an error message (empty on success).
func ParseComments(args map[string]any) ([]model.LlmComment, string) {
var rawComments []any
if arr, ok := args["comments"].([]any); ok && len(arr) > 0 {
rawComments = arr
} else if s, ok := args["comments"].(string); ok && s != "" {
if err := json.Unmarshal([]byte(s), &rawComments); err != nil {
return nil, fmt.Sprintf("Error: failed to parse 'comments' JSON string: %v", err)
}
}
if len(rawComments) == 0 {
raw, _ := json.Marshal(args)
return nil, fmt.Sprintf("Error: 'comments' array is required. Got args: %s", string(raw))
}
var comments []model.LlmComment
for _, raw := range rawComments {
obj, ok := raw.(map[string]any)
if !ok {
continue
}
cm := model.LlmComment{}
if content, ok := obj["content"].(string); ok {
cm.Content = content
}
if suggestion, ok := obj["suggestion_code"].(string); ok {
cm.SuggestionCode = suggestion
}
if existing, ok := obj["existing_code"].(string); ok {
cm.ExistingCode = existing
}
if thinking, ok := obj["thinking"].(string); ok {
cm.Thinking = thinking
}
if category, ok := obj["category"].(string); ok {
cm.Category = category
}
if severity, ok := obj["severity"].(string); ok {
cm.Severity = severity
}
if path, ok := args["path"].(string); ok {
cm.Path = path
}
if cm.Path == "" || cm.Content == "" {
continue
}
comments = append(comments, cm)
}
return comments, ""
}