Files
coder/coderd/x/chatd/generation_preparer_internal_test.go
T

354 lines
12 KiB
Go

package chatd //nolint:testpackage // Exercises unexported re-derivation helpers.
import (
"database/sql"
"encoding/json"
"testing"
fantasyopenai "charm.land/fantasy/providers/openai"
"github.com/google/uuid"
"github.com/sqlc-dev/pqtype"
"github.com/stretchr/testify/require"
"cdr.dev/slog/v3/sloggers/slogtest"
"github.com/coder/coder/v2/coderd/database"
"github.com/coder/coder/v2/coderd/database/dbgen"
"github.com/coder/coder/v2/coderd/database/dbtestutil"
"github.com/coder/coder/v2/coderd/util/ptr"
"github.com/coder/coder/v2/coderd/x/chatd/chatprompt"
"github.com/coder/coder/v2/coderd/x/chatd/chatprovider"
"github.com/coder/coder/v2/coderd/x/chatd/chatstate"
"github.com/coder/coder/v2/codersdk"
)
func mustMarshalText(t *testing.T, parts ...string) pqtype.NullRawMessage {
t.Helper()
messageParts := make([]codersdk.ChatMessagePart, 0, len(parts))
for _, p := range parts {
messageParts = append(messageParts, codersdk.ChatMessageText(p))
}
content, err := chatprompt.MarshalParts(messageParts)
require.NoError(t, err)
return content
}
func textMessage(t *testing.T, id int64, role database.ChatMessageRole, parts ...string) database.ChatMessage {
t.Helper()
return database.ChatMessage{
ID: id,
Role: role,
Content: mustMarshalText(t, parts...),
ContentVersion: chatprompt.CurrentContentVersion,
}
}
func TestLatestAssistantText(t *testing.T) {
t.Parallel()
t.Run("ReturnsMostRecentAssistantMessage", func(t *testing.T) {
t.Parallel()
messages := []database.ChatMessage{
textMessage(t, 1, database.ChatMessageRoleUser, "hi"),
textMessage(t, 2, database.ChatMessageRoleAssistant, "first answer"),
textMessage(t, 3, database.ChatMessageRoleTool, "tool result"),
textMessage(t, 4, database.ChatMessageRoleAssistant, " final answer "),
}
require.Equal(t, "final answer", latestAssistantText(messages))
})
t.Run("ConcatenatesTextParts", func(t *testing.T) {
t.Parallel()
messages := []database.ChatMessage{
textMessage(t, 1, database.ChatMessageRoleAssistant, "foo", "bar"),
}
require.Equal(t, "foobar", latestAssistantText(messages))
})
t.Run("NoAssistantMessage", func(t *testing.T) {
t.Parallel()
messages := []database.ChatMessage{
textMessage(t, 1, database.ChatMessageRoleUser, "hi"),
textMessage(t, 2, database.ChatMessageRoleTool, "tool result"),
}
require.Empty(t, latestAssistantText(messages))
})
t.Run("EmptyAssistantText", func(t *testing.T) {
t.Parallel()
messages := []database.ChatMessage{
textMessage(t, 1, database.ChatMessageRoleAssistant, " "),
}
require.Empty(t, latestAssistantText(messages))
})
t.Run("EmptyHistory", func(t *testing.T) {
t.Parallel()
require.Empty(t, latestAssistantText(nil))
})
}
func TestPrepareGenerationClampsRequestedReasoningEffortToMax(t *testing.T) {
t.Parallel()
db, ps := dbtestutil.NewDB(t)
ctx := chatdTestContext(t)
user := dbgen.User(t, db, database.User{})
apiKey, _ := dbgen.APIKey(t, db, database.APIKey{UserID: user.ID})
org := dbgen.Organization(t, db, database.Organization{})
dbgen.OrganizationMember(t, db, database.OrganizationMember{
UserID: user.ID,
OrganizationID: org.ID,
})
provider := dbgen.AIProviderWithOptionalKey(t, db, database.AIProvider{
Type: database.AIProviderTypeOpenai,
}, "test-key")
modelConfigRaw, err := json.Marshal(codersdk.ChatModelCallConfig{
ReasoningEffort: &codersdk.ChatModelReasoningEffortConfig{
Default: ptr.Ref(codersdk.ChatModelReasoningEffortLow),
Max: ptr.Ref(codersdk.ChatModelReasoningEffortMedium),
},
})
require.NoError(t, err)
modelConfig := dbgen.ChatModelConfig(t, db, database.ChatModelConfig{
Model: "gpt-4o-mini",
Options: modelConfigRaw,
AIProviderID: uuid.NullUUID{UUID: provider.ID, Valid: true},
}, func(p *database.InsertChatModelConfigParams) {
p.Enabled = true
})
created, err := chatstate.CreateChat(ctx, db, ps, chatstate.CreateChatInput{
OrganizationID: org.ID,
OwnerID: user.ID,
LastModelConfigID: modelConfig.ID,
Title: "clamp reasoning effort",
ClientType: database.ChatClientTypeApi,
InitialMessages: []chatstate.Message{
{
Role: database.ChatMessageRoleUser,
Content: mustMarshalText(t, "hello"),
Visibility: database.ChatMessageVisibilityBoth,
ModelConfigID: uuid.NullUUID{UUID: modelConfig.ID, Valid: true},
ReasoningEffort: database.NullChatReasoningEffort{
ChatReasoningEffort: database.ChatReasoningEffortHigh,
Valid: true,
},
CreatedBy: uuid.NullUUID{UUID: user.ID, Valid: true},
ContentVersion: chatprompt.CurrentContentVersion,
APIKeyID: sql.NullString{String: apiKey.ID, Valid: true},
},
},
})
require.NoError(t, err)
server := newInternalTestServer(
t,
db,
ps,
chatprovider.ProviderAPIKeys{},
withInternalTestServerTransportFactory(&aibridgeTestFactory{}),
)
prepared, err := server.prepareGeneration(ctx, generationPrepareInput{
Chat: created.Chat,
Messages: created.InitialMessages,
})
require.NoError(t, err)
t.Cleanup(prepared.Cleanup)
providerOptions, ok := prepared.ProviderOptions[fantasyopenai.Name].(*fantasyopenai.ResponsesProviderOptions)
require.True(t, ok, "%T", prepared.ProviderOptions[fantasyopenai.Name])
require.NotNil(t, providerOptions.ReasoningEffort)
require.Equal(t, fantasyopenai.ReasoningEffortMedium, *providerOptions.ReasoningEffort)
}
// TestDeriveFinalTurnRunResult exercises the re-derivation path that replaces
// the old in-memory generationSideEffects stash. The server here never ran
// prepareGeneration, so a passing test proves the finish-turn inputs are
// rebuilt purely from persisted state.
func TestDeriveFinalTurnRunResult(t *testing.T) {
t.Parallel()
logger := slogtest.Make(t, &slogtest.Options{IgnoreErrors: true})
setup := func(t *testing.T) (*Server, database.Chat) {
t.Helper()
db, ps := dbtestutil.NewDB(t)
ctx := chatdTestContext(t)
user := dbgen.User(t, db, database.User{})
org := dbgen.Organization(t, db, database.Organization{})
dbgen.OrganizationMember(t, db, database.OrganizationMember{
UserID: user.ID,
OrganizationID: org.ID,
})
dbgen.ChatProvider(t, db, database.ChatProvider{
Provider: "openai",
DisplayName: "OpenAI",
APIKey: "test-key",
Enabled: true,
CreatedBy: uuid.NullUUID{UUID: user.ID, Valid: true},
})
modelCfg := dbgen.ChatModelConfig(t, db, database.ChatModelConfig{
Model: "gpt-4o-mini",
DisplayName: "gpt-4o-mini",
Options: json.RawMessage(`{}`),
}, func(p *database.InsertChatModelConfigParams) {
p.Enabled = true
p.IsDefault = true
})
apiKey, _ := dbgen.APIKey(t, db, database.APIKey{UserID: user.ID})
created, err := chatstate.CreateChat(ctx, db, ps, chatstate.CreateChatInput{
OrganizationID: org.ID,
OwnerID: user.ID,
LastModelConfigID: modelCfg.ID,
Title: "derive-chat",
ClientType: database.ChatClientTypeUi,
InitialMessages: []chatstate.Message{
{
Role: database.ChatMessageRoleUser,
Content: mustMarshalText(t, "what is the answer?"),
Visibility: database.ChatMessageVisibilityBoth,
ContentVersion: chatprompt.CurrentContentVersion,
CreatedBy: uuid.NullUUID{UUID: user.ID, Valid: true},
ModelConfigID: uuid.NullUUID{UUID: modelCfg.ID, Valid: true},
APIKeyID: sql.NullString{String: apiKey.ID, Valid: true},
},
},
})
require.NoError(t, err)
server := newInternalTestServer(
t, db, ps, chatprovider.ProviderAPIKeys{},
withInternalTestServerTransportFactory(&aibridgeTestFactory{}),
)
return server, created.Chat
}
commitAssistant := func(t *testing.T, server *Server, chat database.Chat, text string) {
t.Helper()
ctx := chatdTestContext(t)
machine := chatstate.NewChatMachine(server.db, server.pubsub, chat.ID)
require.NoError(t, machine.Update(ctx, func(tx *chatstate.Tx, store database.Store) error {
_, err := tx.CommitStep(chatstate.CommitStepInput{
Messages: []chatstate.Message{
{
Role: database.ChatMessageRoleAssistant,
Content: mustMarshalText(t, text),
Visibility: database.ChatMessageVisibilityBoth,
ContentVersion: chatprompt.CurrentContentVersion,
ModelConfigID: uuid.NullUUID{UUID: chat.LastModelConfigID, Valid: true},
},
},
})
return err
}))
}
t.Run("WaitingDerivesFromHistory", func(t *testing.T) {
t.Parallel()
server, chat := setup(t)
ctx := chatdTestContext(t)
commitAssistant(t, server, chat, "the answer is 42")
rows, err := server.db.GetChatMessagesForPromptByChatID(ctx, chat.ID)
require.NoError(t, err)
require.NotEmpty(t, rows)
var lastUserID int64
for _, row := range rows {
if row.Role == database.ChatMessageRoleUser {
lastUserID = row.ID
}
}
tipID := rows[len(rows)-1].ID
chat.Status = database.ChatStatusWaiting
result := server.deriveFinalTurnRunResult(ctx, chat, logger)
require.Equal(t, "the answer is 42", result.FinalAssistantText)
require.Equal(t, lastUserID, result.TriggerMessageID)
require.Equal(t, tipID, result.HistoryTipMessageID)
require.NotNil(t, result.StatusLabelModel)
require.Equal(t, "openai", result.FallbackProvider)
require.Equal(t, "gpt-4o-mini", result.FallbackModel)
})
t.Run("NonWaitingReturnsEmpty", func(t *testing.T) {
t.Parallel()
server, chat := setup(t)
ctx := chatdTestContext(t)
commitAssistant(t, server, chat, "the answer is 42")
chat.Status = database.ChatStatusError
result := server.deriveFinalTurnRunResult(ctx, chat, logger)
require.Equal(t, runChatResult{}, result)
})
t.Run("WaitingWithoutAssistantReturnsEmpty", func(t *testing.T) {
t.Parallel()
server, chat := setup(t)
ctx := chatdTestContext(t)
// No assistant message was committed, so there is nothing to label.
chat.Status = database.ChatStatusWaiting
result := server.deriveFinalTurnRunResult(ctx, chat, logger)
require.Equal(t, runChatResult{}, result)
})
t.Run("ModelResolveErrorKeepsTextAndIDs", func(t *testing.T) {
t.Parallel()
db, ps := dbtestutil.NewDB(t)
ctx := chatdTestContext(t)
user := dbgen.User(t, db, database.User{})
org := dbgen.Organization(t, db, database.Organization{})
dbgen.OrganizationMember(t, db, database.OrganizationMember{
UserID: user.ID,
OrganizationID: org.ID,
})
// A disabled AI provider makes resolveChatModel fail, exercising the
// degraded path that still returns the re-derived text and IDs.
provider := insertInternalAIProvider(t, db, database.AIProviderTypeOpenai, "provider-api-key", false)
modelCfg := dbgen.ChatModelConfig(t, db, database.ChatModelConfig{
Model: "gpt-4o-mini",
DisplayName: "gpt-4o-mini",
AIProviderID: uuid.NullUUID{UUID: provider.ID, Valid: true},
})
apiKey, _ := dbgen.APIKey(t, db, database.APIKey{UserID: user.ID})
created, err := chatstate.CreateChat(ctx, db, ps, chatstate.CreateChatInput{
OrganizationID: org.ID,
OwnerID: user.ID,
LastModelConfigID: modelCfg.ID,
Title: "derive-chat-error",
ClientType: database.ChatClientTypeUi,
InitialMessages: []chatstate.Message{
{
Role: database.ChatMessageRoleUser,
Content: mustMarshalText(t, "what is the answer?"),
Visibility: database.ChatMessageVisibilityBoth,
ContentVersion: chatprompt.CurrentContentVersion,
CreatedBy: uuid.NullUUID{UUID: user.ID, Valid: true},
ModelConfigID: uuid.NullUUID{UUID: modelCfg.ID, Valid: true},
APIKeyID: sql.NullString{String: apiKey.ID, Valid: true},
},
},
})
require.NoError(t, err)
chat := created.Chat
server := newInternalTestServer(t, db, ps, chatprovider.ProviderAPIKeys{})
commitAssistant(t, server, chat, "the answer is 42")
chat.Status = database.ChatStatusWaiting
result := server.deriveFinalTurnRunResult(ctx, chat, logger)
require.Equal(t, "the answer is 42", result.FinalAssistantText)
require.NotZero(t, result.TriggerMessageID)
require.NotZero(t, result.HistoryTipMessageID)
require.Nil(t, result.StatusLabelModel)
require.Empty(t, result.FallbackProvider)
require.Empty(t, result.FallbackModel)
})
}