mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
fix: use backend-selected chat agent for desktop, git, terminal (#26959)
This commit is contained in:
Danielle Maywood
@@ -0,0 +1,86 @@
|
||||
package agentselect
|
||||
|
||||
import (
|
||||
"cmp"
|
||||
"slices"
|
||||
"strings"
|
||||
|
||||
"golang.org/x/xerrors"
|
||||
|
||||
"github.com/coder/coder/v2/coderd/database"
|
||||
)
|
||||
|
||||
// Suffix marks chat-designated agents during the current PoC. This naming
|
||||
// convention is an implementation detail, not a stable contract.
|
||||
const Suffix = "-coderd-chat"
|
||||
|
||||
// IsChatAgent reports whether name uses the chat-agent suffix convention.
|
||||
func IsChatAgent(name string) bool {
|
||||
return strings.HasSuffix(strings.ToLower(name), Suffix)
|
||||
}
|
||||
|
||||
// FindChatAgent picks the best workspace agent for a chat session from the
|
||||
// provided candidates. It applies these rules in order:
|
||||
// 1. Filter to root agents only (ParentID is null).
|
||||
// 2. Sort stably and deterministically by DisplayOrder ASC, then Name ASC
|
||||
// (case-insensitive), then Name ASC, then ID ASC.
|
||||
// 3. If exactly one root agent name ends with Suffix (case-insensitive),
|
||||
// return it.
|
||||
// 4. If zero root agents match the suffix, return the first root agent after
|
||||
// sorting (deterministic fallback).
|
||||
// 5. If more than one root agent matches the suffix, return an error with an
|
||||
// actionable message.
|
||||
// 6. If no root agents exist at all, return an error.
|
||||
func FindChatAgent(
|
||||
agents []database.WorkspaceAgent,
|
||||
) (database.WorkspaceAgent, error) {
|
||||
rootAgents := make([]database.WorkspaceAgent, 0, len(agents))
|
||||
matchingAgents := make([]database.WorkspaceAgent, 0, 1)
|
||||
for _, agent := range agents {
|
||||
if agent.ParentID.Valid {
|
||||
continue
|
||||
}
|
||||
rootAgents = append(rootAgents, agent)
|
||||
if IsChatAgent(agent.Name) {
|
||||
matchingAgents = append(matchingAgents, agent)
|
||||
}
|
||||
}
|
||||
|
||||
if len(rootAgents) == 0 {
|
||||
return database.WorkspaceAgent{}, xerrors.New(
|
||||
"no eligible workspace agents found",
|
||||
)
|
||||
}
|
||||
|
||||
compareAgents := func(a, b database.WorkspaceAgent) int {
|
||||
if order := cmp.Compare(a.DisplayOrder, b.DisplayOrder); order != 0 {
|
||||
return order
|
||||
}
|
||||
if order := cmp.Compare(strings.ToLower(a.Name), strings.ToLower(b.Name)); order != 0 {
|
||||
return order
|
||||
}
|
||||
if order := cmp.Compare(a.Name, b.Name); order != 0 {
|
||||
return order
|
||||
}
|
||||
return cmp.Compare(a.ID.String(), b.ID.String())
|
||||
}
|
||||
slices.SortStableFunc(rootAgents, compareAgents)
|
||||
slices.SortStableFunc(matchingAgents, compareAgents)
|
||||
|
||||
switch len(matchingAgents) {
|
||||
case 0:
|
||||
return rootAgents[0], nil
|
||||
case 1:
|
||||
return matchingAgents[0], nil
|
||||
default:
|
||||
names := make([]string, 0, len(matchingAgents))
|
||||
for _, agent := range matchingAgents {
|
||||
names = append(names, agent.Name)
|
||||
}
|
||||
return database.WorkspaceAgent{}, xerrors.Errorf(
|
||||
"multiple agents match the chat suffix %q: %s; only one agent should use this suffix",
|
||||
Suffix,
|
||||
strings.Join(names, ", "),
|
||||
)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,231 @@
|
||||
package agentselect_test
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"testing"
|
||||
|
||||
"github.com/google/uuid"
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
"github.com/coder/coder/v2/coderd/database"
|
||||
"github.com/coder/coder/v2/coderd/x/chatd/agentselect"
|
||||
)
|
||||
|
||||
func TestFindChatAgent(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
newRootAgentWithID := func(id, name string, displayOrder int32) database.WorkspaceAgent {
|
||||
return database.WorkspaceAgent{
|
||||
ID: uuid.MustParse(id),
|
||||
Name: name,
|
||||
DisplayOrder: displayOrder,
|
||||
}
|
||||
}
|
||||
|
||||
newRootAgent := func(name string, displayOrder int32) database.WorkspaceAgent {
|
||||
return newRootAgentWithID(uuid.NewString(), name, displayOrder)
|
||||
}
|
||||
|
||||
newChildAgent := func(name string, displayOrder int32) database.WorkspaceAgent {
|
||||
agent := newRootAgent(name, displayOrder)
|
||||
agent.ParentID = uuid.NullUUID{UUID: uuid.New(), Valid: true}
|
||||
return agent
|
||||
}
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
agents []database.WorkspaceAgent
|
||||
wantIndex int
|
||||
wantErrContains []string
|
||||
}{
|
||||
{
|
||||
name: "SingleSuffixMatch",
|
||||
agents: []database.WorkspaceAgent{
|
||||
newRootAgent("alpha", 0),
|
||||
newRootAgent("dev-coderd-chat", 2),
|
||||
newRootAgent("zeta", 1),
|
||||
},
|
||||
wantIndex: 1,
|
||||
},
|
||||
{
|
||||
name: "SuffixMatchCaseInsensitive",
|
||||
agents: []database.WorkspaceAgent{
|
||||
newRootAgent("alpha", 0),
|
||||
newRootAgent("Dev-Coderd-Chat", 2),
|
||||
newRootAgent("zeta", 1),
|
||||
},
|
||||
wantIndex: 1,
|
||||
},
|
||||
{
|
||||
name: "NoSuffixMatchFallbackDeterministic",
|
||||
agents: []database.WorkspaceAgent{
|
||||
newRootAgent("zeta", 2),
|
||||
newRootAgent("bravo", 1),
|
||||
newRootAgent("alpha", 1),
|
||||
},
|
||||
wantIndex: 2,
|
||||
},
|
||||
{
|
||||
name: "NoSuffixMatchFallbackByName",
|
||||
agents: []database.WorkspaceAgent{
|
||||
newRootAgent("Bravo", 3),
|
||||
newRootAgent("alpha", 3),
|
||||
newRootAgent("charlie", 3),
|
||||
},
|
||||
wantIndex: 1,
|
||||
},
|
||||
{
|
||||
name: "CaseOnlyNameTieFallbackDeterministic",
|
||||
agents: []database.WorkspaceAgent{
|
||||
newRootAgent("Dev", 0),
|
||||
newRootAgent("dev", 0),
|
||||
},
|
||||
wantIndex: 0,
|
||||
},
|
||||
{
|
||||
name: "ExactNameTieFallbackByID",
|
||||
agents: []database.WorkspaceAgent{
|
||||
newRootAgentWithID("00000000-0000-0000-0000-000000000002", "dev", 0),
|
||||
newRootAgentWithID("00000000-0000-0000-0000-000000000001", "dev", 0),
|
||||
},
|
||||
wantIndex: 1,
|
||||
},
|
||||
{
|
||||
name: "MultipleSuffixMatchesError",
|
||||
agents: []database.WorkspaceAgent{
|
||||
newRootAgent("alpha-coderd-chat", 2),
|
||||
newRootAgent("beta-coderd-chat", 1),
|
||||
newRootAgent("gamma", 0),
|
||||
},
|
||||
wantErrContains: []string{
|
||||
fmt.Sprintf(
|
||||
"multiple agents match the chat suffix %q",
|
||||
agentselect.Suffix,
|
||||
),
|
||||
"alpha-coderd-chat",
|
||||
"beta-coderd-chat",
|
||||
"only one agent should use this suffix",
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "ChildAgentSuffixIgnored",
|
||||
agents: []database.WorkspaceAgent{
|
||||
newRootAgent("alpha", 1),
|
||||
newChildAgent("child-coderd-chat", 0),
|
||||
newRootAgent("bravo", 0),
|
||||
},
|
||||
wantIndex: 2,
|
||||
},
|
||||
{
|
||||
name: "ChildAgentSuffixIgnoredWithRootMatch",
|
||||
agents: []database.WorkspaceAgent{
|
||||
newRootAgent("alpha", 0),
|
||||
newChildAgent("child-coderd-chat", 1),
|
||||
newRootAgent("root-coderd-chat", 2),
|
||||
},
|
||||
wantIndex: 2,
|
||||
},
|
||||
{
|
||||
name: "EmptyAgentList",
|
||||
agents: []database.WorkspaceAgent{},
|
||||
wantErrContains: []string{
|
||||
"no eligible workspace agents found",
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "OnlyChildAgents",
|
||||
agents: []database.WorkspaceAgent{
|
||||
newChildAgent("alpha", 0),
|
||||
newChildAgent("beta-coderd-chat", 1),
|
||||
},
|
||||
wantErrContains: []string{
|
||||
"no eligible workspace agents found",
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "SingleRootAgent",
|
||||
agents: []database.WorkspaceAgent{
|
||||
newRootAgent("solo", 5),
|
||||
},
|
||||
wantIndex: 0,
|
||||
},
|
||||
{
|
||||
name: "SuffixAgentWinsRegardlessOfOrder",
|
||||
agents: []database.WorkspaceAgent{
|
||||
newRootAgent("alpha", 0),
|
||||
newRootAgent("zeta", 1),
|
||||
newRootAgent("preferred-coderd-chat", 99),
|
||||
},
|
||||
wantIndex: 2,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
tt := tt
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
got, err := agentselect.FindChatAgent(tt.agents)
|
||||
if len(tt.wantErrContains) > 0 {
|
||||
require.Error(t, err)
|
||||
for _, wantErr := range tt.wantErrContains {
|
||||
require.ErrorContains(t, err, wantErr)
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, tt.agents[tt.wantIndex], got)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestIsChatAgent(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
input string
|
||||
want bool
|
||||
}{
|
||||
{
|
||||
name: "ExactSuffix",
|
||||
input: "agent-coderd-chat",
|
||||
want: true,
|
||||
},
|
||||
{
|
||||
name: "UppercaseSuffix",
|
||||
input: "agent-CODERD-CHAT",
|
||||
want: true,
|
||||
},
|
||||
{
|
||||
name: "MixedCaseSuffix",
|
||||
input: "agent-Coderd-Chat",
|
||||
want: true,
|
||||
},
|
||||
{
|
||||
name: "NoSuffix",
|
||||
input: "my-agent",
|
||||
want: false,
|
||||
},
|
||||
{
|
||||
name: "SuffixOnly",
|
||||
input: "-coderd-chat",
|
||||
want: true,
|
||||
},
|
||||
{
|
||||
name: "PartialSuffix",
|
||||
input: "agent-coderd",
|
||||
want: false,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
tt := tt
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
require.Equal(t, tt.want, agentselect.IsChatAgent(tt.input))
|
||||
})
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user