Right now, the only way to create a chat is through `POST /api/v2/chats`. That's fine for clients, but an integration running inside coderd (say, a Slack bot) would have to store or mint an API key just to call its own server. So, we'll pull chat creation out of the handler into a shared function, and add `api.CreateChatAsUser` for in-process callers. They get the same validation, errors, and audit entry as the endpoint, and the endpoint's behaviour doesn't change. This is the same pattern `chatCreateWorkspace` already uses to let chatd create workspaces as a user. I've also exported the chat daemon for in-process callers. Chat errors are now just values that carry the endpoint's status, message, and cause, so in-process callers can use `errors.As` on them (e.g. to spot a prompt hook denial) rather than decoding an HTTP response. The audit entry is written in the background, as auto-archive already does, rather than through a fake request. As with an API key, a dormant user is activated on use, whilst a suspended or deleted user gets a 403. The PRs above this one do the same for sending, interrupting, and updating chats.
135 lines
3.9 KiB
Go
135 lines
3.9 KiB
Go
package coderdtest
|
|
|
|
import (
|
|
"context"
|
|
"testing"
|
|
|
|
"github.com/google/uuid"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/coder/coder/v2/coderd"
|
|
"github.com/coder/coder/v2/coderd/database"
|
|
"github.com/coder/coder/v2/coderd/database/dbauthz"
|
|
"github.com/coder/coder/v2/coderd/x/chatd"
|
|
"github.com/coder/coder/v2/coderd/x/chatd/chatprovider"
|
|
"github.com/coder/coder/v2/coderd/x/chatd/chattest"
|
|
"github.com/coder/coder/v2/codersdk"
|
|
"github.com/coder/coder/v2/testutil"
|
|
)
|
|
|
|
const (
|
|
// TestChatProviderOpenAICompat is the default provider for chat runtime tests.
|
|
TestChatProviderOpenAICompat = "openai-compat"
|
|
// TestChatProviderAPIKey is a non-secret API key for local chat providers.
|
|
TestChatProviderAPIKey = "test-api-key"
|
|
// TestChatModelOpenAICompat is the default model for chat runtime tests.
|
|
TestChatModelOpenAICompat = "gpt-4o-mini"
|
|
)
|
|
|
|
// OpenAICompatProviderAPIKeys returns provider keys that route OpenAI-compatible
|
|
// chat calls to baseURL.
|
|
func OpenAICompatProviderAPIKeys(baseURL string) chatprovider.ProviderAPIKeys {
|
|
return chatprovider.ProviderAPIKeys{
|
|
ByProvider: map[string]string{
|
|
TestChatProviderOpenAICompat: TestChatProviderAPIKey,
|
|
},
|
|
BaseURLByProvider: map[string]string{
|
|
TestChatProviderOpenAICompat: baseURL,
|
|
},
|
|
}
|
|
}
|
|
|
|
// FakeOpenAICompatProviderAPIKeys starts a fake OpenAI-compatible provider and
|
|
// returns provider keys for coderdtest.Options.
|
|
func FakeOpenAICompatProviderAPIKeys(t testing.TB) chatprovider.ProviderAPIKeys {
|
|
t.Helper()
|
|
return OpenAICompatProviderAPIKeys(chattest.OpenAI(t))
|
|
}
|
|
|
|
// CreateOpenAICompatChatModel creates the default provider and ChatModel used
|
|
// by chat runtime tests. Tests can pass a baseURL to route chat work to a
|
|
// specific local provider. If baseURL is empty, this helper starts a fake
|
|
// OpenAI-compatible provider.
|
|
func CreateOpenAICompatChatModel(
|
|
t testing.TB,
|
|
client *codersdk.ExperimentalClient,
|
|
baseURL string,
|
|
) codersdk.ChatModel {
|
|
t.Helper()
|
|
|
|
if baseURL == "" {
|
|
baseURL = chattest.OpenAI(t)
|
|
}
|
|
|
|
ctx := testutil.Context(t, testutil.WaitLong)
|
|
provider, err := client.CreateAIProvider(ctx, codersdk.CreateAIProviderRequest{
|
|
Type: codersdk.AIProviderType(TestChatProviderOpenAICompat),
|
|
Name: "test-" + uuid.NewString(),
|
|
BaseURL: baseURL,
|
|
Enabled: true,
|
|
APIKeys: []string{TestChatProviderAPIKey},
|
|
})
|
|
require.NoError(t, err)
|
|
defaultOrg, err := client.OrganizationByName(ctx, codersdk.DefaultOrganization)
|
|
require.NoError(t, err)
|
|
contextLimit := int64(4096)
|
|
isDefault := true
|
|
model, err := client.CreateChatModel(ctx, defaultOrg.ID, codersdk.CreateChatModelRequest{
|
|
AIProviderID: &provider.ID,
|
|
Model: TestChatModelOpenAICompat,
|
|
ContextLimit: &contextLimit,
|
|
IsDefault: &isDefault,
|
|
})
|
|
require.NoError(t, err)
|
|
return model
|
|
}
|
|
|
|
// WaitForChatSettled waits for a chat to leave active processing and drains
|
|
// tracked chat daemon work before returning the final row.
|
|
func WaitForChatSettled(
|
|
ctx context.Context,
|
|
t testing.TB,
|
|
api *coderd.API,
|
|
chatID uuid.UUID,
|
|
) database.Chat {
|
|
t.Helper()
|
|
|
|
require.NotNil(t, api)
|
|
waitForChatTerminalState(ctx, t, api.Database, chatID)
|
|
|
|
server := api.ChatDaemon()
|
|
require.NotNil(t, server)
|
|
chatd.WaitUntilIdleForTest(server)
|
|
|
|
chat, err := getChatByIDAsSystem(ctx, api.Database, chatID)
|
|
require.NoError(t, err)
|
|
return chat
|
|
}
|
|
|
|
func waitForChatTerminalState(
|
|
ctx context.Context,
|
|
t testing.TB,
|
|
db database.Store,
|
|
chatID uuid.UUID,
|
|
) {
|
|
t.Helper()
|
|
|
|
require.Eventually(t, func() bool {
|
|
chat, err := getChatByIDAsSystem(ctx, db, chatID)
|
|
if err != nil {
|
|
return false
|
|
}
|
|
return chat.Status != database.ChatStatusRunning
|
|
}, testutil.WaitLong, testutil.IntervalFast)
|
|
}
|
|
|
|
func getChatByIDAsSystem(
|
|
ctx context.Context,
|
|
db database.Store,
|
|
chatID uuid.UUID,
|
|
) (database.Chat, error) {
|
|
// Test helper needs system scope to observe chatd-owned status changes.
|
|
//nolint:gocritic
|
|
return db.GetChatByID(dbauthz.AsSystemRestricted(ctx), chatID)
|
|
}
|