mirror of
https://github.com/coder/coder.git
synced 2026-11-01 03:53:22 +08:00
Michael Suchacz
affeeaf9c8
Extends the Agent-chat MCP tools so an unattended UAT evidence loop can
fetch artifacts, monitor long runs, and find prior runs without burning
model context.
## Backend
- New `chat_files_token` crypto key feature (migration 000571) with
rotator support and a dedicated signing keycache on coderd.
- `POST /api/experimental/chats/files/{file}/download-url`
(authenticated) mints a short-lived (5 min) signed URL and returns it
with `sha256`, `size_bytes`, `name`, `mime_type`, and `expires_at`.
- `GET /api/experimental/chats/files/{file}/download?token=` (no session
token) redeems the signed URL: verifies the JWS, requires the token's
`file_id` to match the path, and re-checks the minting user's RBAC
access live at redemption. Clients can `curl -o` artifacts with zero
credentials in the URL consumer.
- `ChatFileMetadata` gains `size_bytes` (via `octet_length`, no bytes
fetched).
## MCP tools (`codersdk/toolsdk`)
- `coder_download_chat_file`: by `file_id` or `chat_id`+`file_name`;
returns the signed URL plus checksum and size instead of base64.
- `coder_await_chat`: blocks (bounded `wait_secs`, 1-120) until a chat
leaves `running`/`interrupting`, using the existing watch stream with
subscribe-before-read.
- `coder_list_chats`: label, query, and limit filtering; chat
projections now include labels.
- `coder_get_chat_messages`: `after_id` forward cursor with
`next_after_id` (exact incremental reads), plus per-message `files`
metadata so artifact-bearing messages are identifiable.
- `coder_get_chat`: file listings now include `size_bytes` and
`created_at`.
- `coder_list_templates`: exposes `agents_allowed` for pre-flight
checks.
## Testing
- coderd: mint/redeem happy path with an unauthenticated client,
expired/tampered/file-mismatched tokens, auth still required on the
plain file endpoint, non-owner mint rejection.
- toolsdk: harness + integration coverage for all new/changed tools,
including signed-URL redemption with checksum verification,
forward-cursor exactness, await transition/timeout paths, and label
filtering.
- Remote dogfood UAT (dev.coder.com Coder Agent) passed all six
acceptance scenarios end to end over both MCP transports.
Note: `go test ./codersdk/toolsdk/` has a pre-existing goleak flake on
main (leaked `agentssh` non-PTY session goroutines from SSH exec tests;
reproduced 3/3 on clean `b4971bc49f1`). It is unrelated to this diff.
> Mux acted on Mike's behalf to create this PR.
<!-- mux-attribution: model=claude-sonnet-4-6 thinking=high -->
1032 lines
32 KiB
Go
1032 lines
32 KiB
Go
package db2sdk_test
|
|
|
|
import (
|
|
"crypto/rand"
|
|
"database/sql"
|
|
"encoding/json"
|
|
"fmt"
|
|
"reflect"
|
|
"testing"
|
|
"time"
|
|
|
|
"charm.land/fantasy"
|
|
"github.com/google/uuid"
|
|
"github.com/sqlc-dev/pqtype"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/coder/coder/v2/coderd/database"
|
|
"github.com/coder/coder/v2/coderd/database/db2sdk"
|
|
"github.com/coder/coder/v2/coderd/database/dbgen"
|
|
"github.com/coder/coder/v2/coderd/database/dbtestutil"
|
|
"github.com/coder/coder/v2/coderd/database/dbtime"
|
|
"github.com/coder/coder/v2/codersdk"
|
|
"github.com/coder/coder/v2/provisionersdk/proto"
|
|
)
|
|
|
|
func TestProvisionerJobStatus(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
cases := []struct {
|
|
name string
|
|
job database.ProvisionerJob
|
|
status codersdk.ProvisionerJobStatus
|
|
}{
|
|
{
|
|
name: "canceling",
|
|
job: database.ProvisionerJob{
|
|
CanceledAt: sql.NullTime{
|
|
Time: dbtime.Now().Add(-time.Minute),
|
|
Valid: true,
|
|
},
|
|
},
|
|
status: codersdk.ProvisionerJobCanceling,
|
|
},
|
|
{
|
|
name: "canceled",
|
|
job: database.ProvisionerJob{
|
|
CanceledAt: sql.NullTime{
|
|
Time: dbtime.Now().Add(-time.Minute),
|
|
Valid: true,
|
|
},
|
|
CompletedAt: sql.NullTime{
|
|
Time: dbtime.Now().Add(-30 * time.Second),
|
|
Valid: true,
|
|
},
|
|
},
|
|
status: codersdk.ProvisionerJobCanceled,
|
|
},
|
|
{
|
|
name: "canceled_failed",
|
|
job: database.ProvisionerJob{
|
|
CanceledAt: sql.NullTime{
|
|
Time: dbtime.Now().Add(-time.Minute),
|
|
Valid: true,
|
|
},
|
|
CompletedAt: sql.NullTime{
|
|
Time: dbtime.Now().Add(-30 * time.Second),
|
|
Valid: true,
|
|
},
|
|
Error: sql.NullString{String: "badness", Valid: true},
|
|
},
|
|
status: codersdk.ProvisionerJobFailed,
|
|
},
|
|
{
|
|
name: "pending",
|
|
job: database.ProvisionerJob{},
|
|
status: codersdk.ProvisionerJobPending,
|
|
},
|
|
{
|
|
name: "succeeded",
|
|
job: database.ProvisionerJob{
|
|
StartedAt: sql.NullTime{
|
|
Time: dbtime.Now().Add(-time.Minute),
|
|
Valid: true,
|
|
},
|
|
CompletedAt: sql.NullTime{
|
|
Time: dbtime.Now().Add(-30 * time.Second),
|
|
Valid: true,
|
|
},
|
|
},
|
|
status: codersdk.ProvisionerJobSucceeded,
|
|
},
|
|
{
|
|
name: "completed_failed",
|
|
job: database.ProvisionerJob{
|
|
StartedAt: sql.NullTime{
|
|
Time: dbtime.Now().Add(-time.Minute),
|
|
Valid: true,
|
|
},
|
|
CompletedAt: sql.NullTime{
|
|
Time: dbtime.Now().Add(-30 * time.Second),
|
|
Valid: true,
|
|
},
|
|
Error: sql.NullString{String: "badness", Valid: true},
|
|
},
|
|
status: codersdk.ProvisionerJobFailed,
|
|
},
|
|
{
|
|
name: "updated",
|
|
job: database.ProvisionerJob{
|
|
StartedAt: sql.NullTime{
|
|
Time: dbtime.Now().Add(-time.Minute),
|
|
Valid: true,
|
|
},
|
|
UpdatedAt: dbtime.Now(),
|
|
},
|
|
status: codersdk.ProvisionerJobRunning,
|
|
},
|
|
}
|
|
|
|
// Share db for all job inserts.
|
|
db, _ := dbtestutil.NewDB(t)
|
|
org := dbgen.Organization(t, db, database.Organization{})
|
|
|
|
for i, tc := range cases {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
t.Parallel()
|
|
// Populate standard fields
|
|
now := dbtime.Now().Round(time.Minute)
|
|
tc.job.ID = uuid.New()
|
|
tc.job.CreatedAt = now
|
|
tc.job.UpdatedAt = now
|
|
tc.job.InitiatorID = org.ID
|
|
tc.job.OrganizationID = org.ID
|
|
tc.job.Input = []byte("{}")
|
|
tc.job.Provisioner = database.ProvisionerTypeEcho
|
|
// Unique tags for each job.
|
|
tc.job.Tags = map[string]string{fmt.Sprintf("%d", i): "true"}
|
|
|
|
inserted := dbgen.ProvisionerJob(t, db, nil, tc.job)
|
|
// Make sure the inserted job has the right values.
|
|
require.Equal(t, tc.job.StartedAt.Time.UTC(), inserted.StartedAt.Time.UTC(), "started at")
|
|
require.Equal(t, tc.job.CompletedAt.Time.UTC(), inserted.CompletedAt.Time.UTC(), "completed at")
|
|
require.Equal(t, tc.job.CanceledAt.Time.UTC(), inserted.CanceledAt.Time.UTC(), "canceled at")
|
|
require.Equal(t, tc.job.Error, inserted.Error, "error")
|
|
require.Equal(t, tc.job.ErrorCode, inserted.ErrorCode, "error code")
|
|
|
|
actual := codersdk.ProvisionerJobStatus(inserted.JobStatus)
|
|
require.Equal(t, tc.status, actual)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestTemplateVersionParameter_OK(t *testing.T) {
|
|
t.Parallel()
|
|
req := require.New(t)
|
|
|
|
// In this test we're just going to cover the fields that have to get parsed.
|
|
options := []*proto.RichParameterOption{
|
|
{
|
|
Name: "foo",
|
|
Description: "bar",
|
|
Value: "baz",
|
|
Icon: "David Bowie",
|
|
},
|
|
}
|
|
ob, err := json.Marshal(&options)
|
|
req.NoError(err)
|
|
|
|
db := database.TemplateVersionParameter{
|
|
Options: json.RawMessage(ob),
|
|
Description: "_The Rise and Fall of **Ziggy Stardust** and the Spiders from Mars_",
|
|
}
|
|
sdk, err := db2sdk.TemplateVersionParameter(db)
|
|
req.NoError(err)
|
|
req.Len(sdk.Options, 1)
|
|
req.Equal("foo", sdk.Options[0].Name)
|
|
req.Equal("bar", sdk.Options[0].Description)
|
|
req.Equal("baz", sdk.Options[0].Value)
|
|
req.Equal("David Bowie", sdk.Options[0].Icon)
|
|
req.Equal("The Rise and Fall of Ziggy Stardust and the Spiders from Mars", sdk.DescriptionPlaintext)
|
|
}
|
|
|
|
func TestTemplateVersionParameter_BadOptions(t *testing.T) {
|
|
t.Parallel()
|
|
req := require.New(t)
|
|
|
|
db := database.TemplateVersionParameter{
|
|
Options: json.RawMessage("not really JSON!"),
|
|
Description: "_The Rise and Fall of **Ziggy Stardust** and the Spiders from Mars_",
|
|
}
|
|
_, err := db2sdk.TemplateVersionParameter(db)
|
|
req.Error(err)
|
|
}
|
|
|
|
func TestTemplateVersionParameter_BadDescription(t *testing.T) {
|
|
t.Parallel()
|
|
req := require.New(t)
|
|
desc := make([]byte, 300)
|
|
_, err := rand.Read(desc)
|
|
req.NoError(err)
|
|
|
|
db := database.TemplateVersionParameter{
|
|
Options: json.RawMessage("[]"),
|
|
Description: string(desc),
|
|
}
|
|
sdk, err := db2sdk.TemplateVersionParameter(db)
|
|
// Although the markdown parser can return an error, the way we use it should not, even
|
|
// if we feed it garbage data.
|
|
req.NoError(err)
|
|
req.NotEmpty(sdk.DescriptionPlaintext, "broke the markdown parser with %v", desc)
|
|
}
|
|
|
|
func TestChatDebugRunSummary(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
startedAt := time.Now().UTC().Round(time.Second)
|
|
finishedAt := startedAt.Add(5 * time.Second)
|
|
|
|
run := database.ChatDebugRun{
|
|
ID: uuid.New(),
|
|
ChatID: uuid.New(),
|
|
Kind: "chat_turn",
|
|
Status: "completed",
|
|
Provider: sql.NullString{String: "openai", Valid: true},
|
|
Model: sql.NullString{String: "gpt-4o", Valid: true},
|
|
Summary: json.RawMessage(`{"step_count":3,"has_error":false}`),
|
|
StartedAt: startedAt,
|
|
UpdatedAt: finishedAt,
|
|
FinishedAt: sql.NullTime{Time: finishedAt, Valid: true},
|
|
}
|
|
|
|
sdk := db2sdk.ChatDebugRunSummary(run)
|
|
|
|
require.Equal(t, run.ID, sdk.ID)
|
|
require.Equal(t, run.ChatID, sdk.ChatID)
|
|
require.Equal(t, codersdk.ChatDebugRunKindChatTurn, sdk.Kind)
|
|
require.Equal(t, codersdk.ChatDebugStatusCompleted, sdk.Status)
|
|
require.NotNil(t, sdk.Provider)
|
|
require.Equal(t, "openai", *sdk.Provider)
|
|
require.NotNil(t, sdk.Model)
|
|
require.Equal(t, "gpt-4o", *sdk.Model)
|
|
require.Equal(t, map[string]any{"step_count": float64(3), "has_error": false}, sdk.Summary)
|
|
require.Equal(t, startedAt, sdk.StartedAt)
|
|
require.Equal(t, finishedAt, sdk.UpdatedAt)
|
|
require.NotNil(t, sdk.FinishedAt)
|
|
require.Equal(t, finishedAt, *sdk.FinishedAt)
|
|
}
|
|
|
|
func TestChatDebugRunSummary_NullableFieldsNil(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
run := database.ChatDebugRun{
|
|
ID: uuid.New(),
|
|
ChatID: uuid.New(),
|
|
Kind: "title_generation",
|
|
Status: "in_progress",
|
|
Summary: json.RawMessage(`{}`),
|
|
StartedAt: time.Now().UTC(),
|
|
UpdatedAt: time.Now().UTC(),
|
|
}
|
|
|
|
sdk := db2sdk.ChatDebugRunSummary(run)
|
|
|
|
require.Nil(t, sdk.Provider, "NULL Provider should map to nil")
|
|
require.Nil(t, sdk.Model, "NULL Model should map to nil")
|
|
require.Nil(t, sdk.FinishedAt, "NULL FinishedAt should map to nil")
|
|
}
|
|
|
|
func TestChatDebugStep(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
startedAt := time.Now().UTC().Round(time.Second)
|
|
finishedAt := startedAt.Add(2 * time.Second)
|
|
attempts := json.RawMessage(`[
|
|
{
|
|
"attempt_number": 1,
|
|
"status": "completed",
|
|
"raw_request": {"url": "https://example.com"},
|
|
"raw_response": {"status": "200"},
|
|
"duration_ms": 123,
|
|
"started_at": "2026-03-01T10:00:01Z",
|
|
"finished_at": "2026-03-01T10:00:02Z"
|
|
}
|
|
]`)
|
|
step := database.ChatDebugStep{
|
|
ID: uuid.New(),
|
|
RunID: uuid.New(),
|
|
ChatID: uuid.New(),
|
|
StepNumber: 1,
|
|
Operation: "stream",
|
|
Status: "completed",
|
|
NormalizedRequest: json.RawMessage(`{"messages":[]}`),
|
|
Attempts: attempts,
|
|
Metadata: json.RawMessage(`{"provider":"openai"}`),
|
|
StartedAt: startedAt,
|
|
UpdatedAt: finishedAt,
|
|
FinishedAt: sql.NullTime{Time: finishedAt, Valid: true},
|
|
}
|
|
|
|
sdk := db2sdk.ChatDebugStep(step)
|
|
|
|
// Verify all scalar fields are mapped correctly.
|
|
require.Equal(t, step.ID, sdk.ID)
|
|
require.Equal(t, step.RunID, sdk.RunID)
|
|
require.Equal(t, step.ChatID, sdk.ChatID)
|
|
require.Equal(t, step.StepNumber, sdk.StepNumber)
|
|
require.Equal(t, codersdk.ChatDebugStepOperationStream, sdk.Operation)
|
|
require.Equal(t, codersdk.ChatDebugStatusCompleted, sdk.Status)
|
|
require.Equal(t, startedAt, sdk.StartedAt)
|
|
require.Equal(t, finishedAt, sdk.UpdatedAt)
|
|
require.Equal(t, &finishedAt, sdk.FinishedAt)
|
|
|
|
// Verify JSON object fields are deserialized.
|
|
require.NotNil(t, sdk.NormalizedRequest)
|
|
require.Equal(t, map[string]any{"messages": []any{}}, sdk.NormalizedRequest)
|
|
require.NotNil(t, sdk.Metadata)
|
|
require.Equal(t, map[string]any{"provider": "openai"}, sdk.Metadata)
|
|
|
|
// Verify nullable fields are nil when the DB row has NULL values.
|
|
require.Nil(t, sdk.HistoryTipMessageID, "NULL HistoryTipMessageID should map to nil")
|
|
require.Nil(t, sdk.AssistantMessageID, "NULL AssistantMessageID should map to nil")
|
|
require.Nil(t, sdk.NormalizedResponse, "NULL NormalizedResponse should map to nil")
|
|
require.Nil(t, sdk.Usage, "NULL Usage should map to nil")
|
|
require.Nil(t, sdk.Error, "NULL Error should map to nil")
|
|
|
|
// Verify attempts are preserved with all fields.
|
|
require.Len(t, sdk.Attempts, 1)
|
|
require.Equal(t, float64(1), sdk.Attempts[0]["attempt_number"])
|
|
require.Equal(t, "completed", sdk.Attempts[0]["status"])
|
|
require.Equal(t, float64(123), sdk.Attempts[0]["duration_ms"])
|
|
require.Equal(t, map[string]any{"url": "https://example.com"}, sdk.Attempts[0]["raw_request"])
|
|
require.Equal(t, map[string]any{"status": "200"}, sdk.Attempts[0]["raw_response"])
|
|
}
|
|
|
|
func TestChatDebugStep_NullableFieldsPopulated(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
tipID := int64(42)
|
|
asstID := int64(99)
|
|
step := database.ChatDebugStep{
|
|
ID: uuid.New(),
|
|
RunID: uuid.New(),
|
|
ChatID: uuid.New(),
|
|
StepNumber: 2,
|
|
Operation: "generate",
|
|
Status: "completed",
|
|
HistoryTipMessageID: sql.NullInt64{Int64: tipID, Valid: true},
|
|
AssistantMessageID: sql.NullInt64{Int64: asstID, Valid: true},
|
|
NormalizedRequest: json.RawMessage(`{}`),
|
|
NormalizedResponse: pqtype.NullRawMessage{RawMessage: json.RawMessage(`{"text":"hi"}`), Valid: true},
|
|
Usage: pqtype.NullRawMessage{RawMessage: json.RawMessage(`{"tokens":10}`), Valid: true},
|
|
Error: pqtype.NullRawMessage{RawMessage: json.RawMessage(`{"code":"rate_limit"}`), Valid: true},
|
|
Attempts: json.RawMessage(`[]`),
|
|
Metadata: json.RawMessage(`{}`),
|
|
StartedAt: time.Now().UTC(),
|
|
UpdatedAt: time.Now().UTC(),
|
|
}
|
|
|
|
sdk := db2sdk.ChatDebugStep(step)
|
|
|
|
require.NotNil(t, sdk.HistoryTipMessageID)
|
|
require.Equal(t, tipID, *sdk.HistoryTipMessageID)
|
|
require.NotNil(t, sdk.AssistantMessageID)
|
|
require.Equal(t, asstID, *sdk.AssistantMessageID)
|
|
require.NotNil(t, sdk.NormalizedResponse)
|
|
require.Equal(t, map[string]any{"text": "hi"}, sdk.NormalizedResponse)
|
|
require.NotNil(t, sdk.Usage)
|
|
require.Equal(t, map[string]any{"tokens": float64(10)}, sdk.Usage)
|
|
require.NotNil(t, sdk.Error)
|
|
require.Equal(t, map[string]any{"code": "rate_limit"}, sdk.Error)
|
|
}
|
|
|
|
func TestChatDebugStep_PreservesMalformedAttempts(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
step := database.ChatDebugStep{
|
|
ID: uuid.New(),
|
|
RunID: uuid.New(),
|
|
ChatID: uuid.New(),
|
|
StepNumber: 1,
|
|
Operation: "stream",
|
|
Status: "completed",
|
|
NormalizedRequest: json.RawMessage(`{"messages":[]}`),
|
|
Attempts: json.RawMessage(`{"bad":true}`),
|
|
Metadata: json.RawMessage(`{"provider":"openai"}`),
|
|
StartedAt: time.Now().UTC(),
|
|
UpdatedAt: time.Now().UTC(),
|
|
}
|
|
|
|
sdk := db2sdk.ChatDebugStep(step)
|
|
require.Len(t, sdk.Attempts, 1)
|
|
require.Equal(t, "malformed attempts payload", sdk.Attempts[0]["error"])
|
|
require.NotEmpty(t, sdk.Attempts[0]["parse_error"], "parse_error should contain the unmarshal error")
|
|
require.Equal(t, `{"bad":true}`, sdk.Attempts[0]["raw"])
|
|
}
|
|
|
|
func TestChatDebugRunSummary_PreservesMalformedSummary(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
run := database.ChatDebugRun{
|
|
ID: uuid.New(),
|
|
ChatID: uuid.New(),
|
|
Kind: "chat_turn",
|
|
Status: "completed",
|
|
Summary: json.RawMessage(`not-an-object`),
|
|
StartedAt: time.Now().UTC(),
|
|
UpdatedAt: time.Now().UTC(),
|
|
}
|
|
|
|
sdk := db2sdk.ChatDebugRunSummary(run)
|
|
require.Equal(t, "malformed debug payload", sdk.Summary["error"])
|
|
require.NotEmpty(t, sdk.Summary["parse_error"], "parse_error should contain the unmarshal error")
|
|
require.Equal(t, "not-an-object", sdk.Summary["raw"])
|
|
}
|
|
|
|
func TestChatDebugStep_PreservesMalformedRequest(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
step := database.ChatDebugStep{
|
|
ID: uuid.New(),
|
|
RunID: uuid.New(),
|
|
ChatID: uuid.New(),
|
|
StepNumber: 1,
|
|
Operation: "stream",
|
|
Status: "completed",
|
|
NormalizedRequest: json.RawMessage(`[1,2,3]`),
|
|
Attempts: json.RawMessage(`[]`),
|
|
Metadata: json.RawMessage(`"just-a-string"`),
|
|
StartedAt: time.Now().UTC(),
|
|
UpdatedAt: time.Now().UTC(),
|
|
}
|
|
|
|
sdk := db2sdk.ChatDebugStep(step)
|
|
require.Equal(t, "malformed debug payload", sdk.NormalizedRequest["error"])
|
|
require.NotEmpty(t, sdk.NormalizedRequest["parse_error"], "parse_error should contain the unmarshal error")
|
|
require.Equal(t, "[1,2,3]", sdk.NormalizedRequest["raw"])
|
|
require.Equal(t, "malformed debug payload", sdk.Metadata["error"])
|
|
require.NotEmpty(t, sdk.Metadata["parse_error"], "parse_error should contain the unmarshal error")
|
|
require.Equal(t, `"just-a-string"`, sdk.Metadata["raw"])
|
|
}
|
|
|
|
func TestChatDebugRunSummary_JSONNullYieldsEmptyMap(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
run := database.ChatDebugRun{
|
|
ID: uuid.New(),
|
|
ChatID: uuid.New(),
|
|
Kind: "chat_turn",
|
|
Status: "completed",
|
|
Summary: json.RawMessage(`null`),
|
|
StartedAt: time.Now().UTC(),
|
|
UpdatedAt: time.Now().UTC(),
|
|
}
|
|
|
|
sdk := db2sdk.ChatDebugRunSummary(run)
|
|
require.NotNil(t, sdk.Summary, "JSON literal null must produce non-nil map")
|
|
require.Empty(t, sdk.Summary, "JSON literal null must produce empty map")
|
|
}
|
|
|
|
func TestChatDebugStep_JSONNullYieldsEmptyStructures(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
step := database.ChatDebugStep{
|
|
ID: uuid.New(),
|
|
RunID: uuid.New(),
|
|
ChatID: uuid.New(),
|
|
StepNumber: 1,
|
|
Operation: "stream",
|
|
Status: "completed",
|
|
NormalizedRequest: json.RawMessage(`null`),
|
|
Attempts: json.RawMessage(`null`),
|
|
Metadata: json.RawMessage(`null`),
|
|
StartedAt: time.Now().UTC(),
|
|
UpdatedAt: time.Now().UTC(),
|
|
}
|
|
|
|
sdk := db2sdk.ChatDebugStep(step)
|
|
require.NotNil(t, sdk.NormalizedRequest, "JSON literal null must produce non-nil map")
|
|
require.Empty(t, sdk.NormalizedRequest, "JSON literal null must produce empty map")
|
|
require.NotNil(t, sdk.Attempts, "JSON literal null must produce non-nil slice")
|
|
require.Empty(t, sdk.Attempts, "JSON literal null must produce empty slice")
|
|
require.NotNil(t, sdk.Metadata, "JSON literal null must produce non-nil map")
|
|
require.Empty(t, sdk.Metadata, "JSON literal null must produce empty map")
|
|
}
|
|
|
|
func TestChatDebugRunDetail(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
startedAt := time.Now().UTC().Round(time.Second)
|
|
finishedAt := startedAt.Add(5 * time.Second)
|
|
rootChatID := uuid.New()
|
|
parentChatID := uuid.New()
|
|
modelConfigID := uuid.New()
|
|
triggerMessageID := int64(7)
|
|
historyTipMessageID := int64(11)
|
|
|
|
run := database.ChatDebugRun{
|
|
ID: uuid.New(),
|
|
ChatID: uuid.New(),
|
|
RootChatID: uuid.NullUUID{UUID: rootChatID, Valid: true},
|
|
ParentChatID: uuid.NullUUID{UUID: parentChatID, Valid: true},
|
|
ModelConfigID: uuid.NullUUID{UUID: modelConfigID, Valid: true},
|
|
TriggerMessageID: sql.NullInt64{Int64: triggerMessageID, Valid: true},
|
|
HistoryTipMessageID: sql.NullInt64{Int64: historyTipMessageID, Valid: true},
|
|
Kind: "chat_turn",
|
|
Status: "completed",
|
|
Provider: sql.NullString{String: "openai", Valid: true},
|
|
Model: sql.NullString{String: "gpt-4o", Valid: true},
|
|
Summary: json.RawMessage(`{"step_count":2}`),
|
|
StartedAt: startedAt,
|
|
UpdatedAt: finishedAt,
|
|
FinishedAt: sql.NullTime{Time: finishedAt, Valid: true},
|
|
}
|
|
steps := []database.ChatDebugStep{
|
|
{
|
|
ID: uuid.New(),
|
|
RunID: run.ID,
|
|
ChatID: run.ChatID,
|
|
StepNumber: 1,
|
|
Operation: "stream",
|
|
Status: "completed",
|
|
NormalizedRequest: json.RawMessage(`{"messages":[]}`),
|
|
Attempts: json.RawMessage(`[]`),
|
|
Metadata: json.RawMessage(`{}`),
|
|
StartedAt: startedAt,
|
|
UpdatedAt: finishedAt,
|
|
},
|
|
{
|
|
ID: uuid.New(),
|
|
RunID: run.ID,
|
|
ChatID: run.ChatID,
|
|
StepNumber: 2,
|
|
Operation: "generate",
|
|
Status: "completed",
|
|
NormalizedRequest: json.RawMessage(`{"messages":[]}`),
|
|
Attempts: json.RawMessage(`[]`),
|
|
Metadata: json.RawMessage(`{}`),
|
|
StartedAt: startedAt,
|
|
UpdatedAt: finishedAt,
|
|
},
|
|
}
|
|
|
|
sdk := db2sdk.ChatDebugRunDetail(run, steps)
|
|
|
|
require.Equal(t, run.ID, sdk.ID)
|
|
require.Equal(t, run.ChatID, sdk.ChatID)
|
|
require.NotNil(t, sdk.RootChatID)
|
|
require.Equal(t, rootChatID, *sdk.RootChatID)
|
|
require.NotNil(t, sdk.ParentChatID)
|
|
require.Equal(t, parentChatID, *sdk.ParentChatID)
|
|
require.NotNil(t, sdk.ModelConfigID)
|
|
require.Equal(t, modelConfigID, *sdk.ModelConfigID)
|
|
require.NotNil(t, sdk.TriggerMessageID)
|
|
require.Equal(t, triggerMessageID, *sdk.TriggerMessageID)
|
|
require.NotNil(t, sdk.HistoryTipMessageID)
|
|
require.Equal(t, historyTipMessageID, *sdk.HistoryTipMessageID)
|
|
require.Equal(t, codersdk.ChatDebugRunKindChatTurn, sdk.Kind)
|
|
require.Equal(t, codersdk.ChatDebugStatusCompleted, sdk.Status)
|
|
require.NotNil(t, sdk.Provider)
|
|
require.Equal(t, "openai", *sdk.Provider)
|
|
require.NotNil(t, sdk.Model)
|
|
require.Equal(t, "gpt-4o", *sdk.Model)
|
|
require.Equal(t, map[string]any{"step_count": float64(2)}, sdk.Summary)
|
|
require.Equal(t, startedAt, sdk.StartedAt)
|
|
require.Equal(t, finishedAt, sdk.UpdatedAt)
|
|
require.NotNil(t, sdk.FinishedAt)
|
|
require.Equal(t, finishedAt, *sdk.FinishedAt)
|
|
require.Len(t, sdk.Steps, 2)
|
|
require.Equal(t, steps[0].ID, sdk.Steps[0].ID)
|
|
require.Equal(t, codersdk.ChatDebugStepOperationStream, sdk.Steps[0].Operation)
|
|
require.Equal(t, steps[1].ID, sdk.Steps[1].ID)
|
|
require.Equal(t, codersdk.ChatDebugStepOperationGenerate, sdk.Steps[1].Operation)
|
|
}
|
|
|
|
func TestChatDebugRunDetail_NullableFieldsNil(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
run := database.ChatDebugRun{
|
|
ID: uuid.New(),
|
|
ChatID: uuid.New(),
|
|
Kind: "chat_turn",
|
|
Status: "in_progress",
|
|
Summary: json.RawMessage(`{}`),
|
|
StartedAt: time.Now().UTC(),
|
|
UpdatedAt: time.Now().UTC(),
|
|
}
|
|
|
|
sdk := db2sdk.ChatDebugRunDetail(run, nil)
|
|
|
|
require.Nil(t, sdk.RootChatID, "NULL RootChatID should map to nil")
|
|
require.Nil(t, sdk.ParentChatID, "NULL ParentChatID should map to nil")
|
|
require.Nil(t, sdk.ModelConfigID, "NULL ModelConfigID should map to nil")
|
|
require.Nil(t, sdk.TriggerMessageID, "NULL TriggerMessageID should map to nil")
|
|
require.Nil(t, sdk.HistoryTipMessageID, "NULL HistoryTipMessageID should map to nil")
|
|
require.Nil(t, sdk.Provider, "NULL Provider should map to nil")
|
|
require.Nil(t, sdk.Model, "NULL Model should map to nil")
|
|
require.Nil(t, sdk.FinishedAt, "NULL FinishedAt should map to nil")
|
|
require.NotNil(t, sdk.Steps, "nil steps slice should serialize as empty array")
|
|
require.Empty(t, sdk.Steps)
|
|
}
|
|
|
|
func TestChatMessage_PreservesProviderExecutedOnToolResults(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
toolCallID := uuid.New().String()
|
|
toolName := "web_search"
|
|
|
|
// Build assistant content blocks with ProviderExecuted set.
|
|
toolCall := fantasy.ToolCallContent{
|
|
ToolCallID: toolCallID,
|
|
ToolName: toolName,
|
|
Input: `{"query":"test"}`,
|
|
ProviderExecuted: true,
|
|
}
|
|
toolResult := fantasy.ToolResultContent{
|
|
ToolCallID: toolCallID,
|
|
ToolName: toolName,
|
|
Result: fantasy.ToolResultOutputContentText{Text: `{"results":[]}`},
|
|
ProviderExecuted: true,
|
|
}
|
|
|
|
tcJSON, err := json.Marshal(toolCall)
|
|
require.NoError(t, err)
|
|
trJSON, err := json.Marshal(toolResult)
|
|
require.NoError(t, err)
|
|
|
|
rawContent := json.RawMessage("[" + string(tcJSON) + "," + string(trJSON) + "]")
|
|
|
|
dbMsg := database.ChatMessage{
|
|
ID: 1,
|
|
ChatID: uuid.New(),
|
|
Role: database.ChatMessageRoleAssistant,
|
|
Content: pqtype.NullRawMessage{
|
|
RawMessage: rawContent,
|
|
Valid: true,
|
|
},
|
|
CreatedAt: time.Now(),
|
|
}
|
|
|
|
result := db2sdk.ChatMessage(dbMsg)
|
|
|
|
require.Len(t, result.Content, 2)
|
|
|
|
// First part: tool call.
|
|
require.Equal(t, codersdk.ChatMessagePartTypeToolCall, result.Content[0].Type)
|
|
require.Equal(t, toolCallID, result.Content[0].ToolCallID)
|
|
require.Equal(t, toolName, result.Content[0].ToolName)
|
|
require.True(t, result.Content[0].ProviderExecuted, "tool call should preserve ProviderExecuted")
|
|
|
|
// Second part: tool result.
|
|
require.Equal(t, codersdk.ChatMessagePartTypeToolResult, result.Content[1].Type)
|
|
require.Equal(t, toolCallID, result.Content[1].ToolCallID)
|
|
require.Equal(t, toolName, result.Content[1].ToolName)
|
|
require.True(t, result.Content[1].ProviderExecuted, "tool result should preserve ProviderExecuted")
|
|
}
|
|
|
|
func TestChatQueuedMessage_ParsesUserContentParts(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
// Queued messages are always written via MarshalParts (SDK format).
|
|
rawContent, err := json.Marshal([]codersdk.ChatMessagePart{
|
|
codersdk.ChatMessageText("queued text"),
|
|
})
|
|
require.NoError(t, err)
|
|
|
|
queued := db2sdk.ChatQueuedMessage(database.ChatQueuedMessage{
|
|
ID: 1,
|
|
ChatID: uuid.New(),
|
|
Content: rawContent,
|
|
CreatedAt: time.Now(),
|
|
})
|
|
|
|
require.Len(t, queued.Content, 1)
|
|
require.Equal(t, codersdk.ChatMessagePartTypeText, queued.Content[0].Type)
|
|
require.Equal(t, "queued text", queued.Content[0].Text)
|
|
}
|
|
|
|
func TestChat_AllFieldsPopulated(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
// Every field of database.Chat is set to a non-zero value so
|
|
// that the reflection check below catches any field that
|
|
// db2sdk.Chat forgets to populate. When someone adds a new
|
|
// field to codersdk.Chat, this test will fail until the
|
|
// converter is updated.
|
|
now := dbtime.Now()
|
|
lastErrorPayload := codersdk.ChatError{
|
|
Message: "boom",
|
|
Detail: "provider detail",
|
|
Kind: codersdk.ChatErrorKindGeneric,
|
|
Provider: "openai",
|
|
Retryable: true,
|
|
StatusCode: 503,
|
|
}
|
|
lastErrorRaw, err := json.Marshal(lastErrorPayload)
|
|
require.NoError(t, err)
|
|
|
|
input := database.Chat{
|
|
ID: uuid.New(),
|
|
OwnerID: uuid.New(),
|
|
OwnerUsername: "owner-username",
|
|
OwnerName: "Owner Name",
|
|
OrganizationID: uuid.New(),
|
|
WorkspaceID: uuid.NullUUID{UUID: uuid.New(), Valid: true},
|
|
BuildID: uuid.NullUUID{UUID: uuid.New(), Valid: true},
|
|
AgentID: uuid.NullUUID{UUID: uuid.New(), Valid: true},
|
|
ParentChatID: uuid.NullUUID{UUID: uuid.New(), Valid: true},
|
|
RootChatID: uuid.NullUUID{UUID: uuid.New(), Valid: true},
|
|
LastModelConfigID: uuid.New(),
|
|
LastReasoningEffort: database.NullChatReasoningEffort{ChatReasoningEffort: database.ChatReasoningEffortHigh, Valid: true},
|
|
Title: "all-fields-test",
|
|
Status: database.ChatStatusRunning,
|
|
ClientType: database.ChatClientTypeUi,
|
|
LastError: pqtype.NullRawMessage{RawMessage: lastErrorRaw, Valid: true},
|
|
LastTurnSummary: sql.NullString{String: "turn completed", Valid: true},
|
|
Summary: sql.NullString{String: "summarized the whole chat", Valid: true},
|
|
CreatedAt: now,
|
|
UpdatedAt: now,
|
|
Archived: true,
|
|
UserACL: database.ChatACL{uuid.NewString(): database.ChatACLEntry{}},
|
|
PinOrder: 1,
|
|
PlanMode: database.NullChatPlanMode{ChatPlanMode: database.ChatPlanModePlan, Valid: true},
|
|
MCPServerIDs: []uuid.UUID{uuid.New()},
|
|
Labels: database.StringMap{"env": "prod"},
|
|
DynamicTools: pqtype.NullRawMessage{
|
|
RawMessage: json.RawMessage(`[{"name":"tool1","description":"test tool","inputSchema":{"type":"object"}}]`),
|
|
Valid: true,
|
|
},
|
|
// Pinned-context columns drive codersdk.Chat.Context. Set all of
|
|
// them so the converted sub-struct's fields are non-zero too.
|
|
ContextAggregateHash: []byte{0x01, 0x02, 0x03},
|
|
ContextDirtySince: sql.NullTime{Time: now, Valid: true},
|
|
ContextError: "context boom",
|
|
}
|
|
// Only ChatID is needed here. This test checks that
|
|
// Chat.DiffStatus is non-nil, not that every DiffStatus
|
|
// field is populated — that would be a separate test for
|
|
// the ChatDiffStatus converter.
|
|
diffStatus := &database.ChatDiffStatus{
|
|
ChatID: input.ID,
|
|
}
|
|
|
|
fileRows := []database.GetChatFileMetadataByChatIDRow{
|
|
{
|
|
ID: uuid.New(),
|
|
OwnerID: input.OwnerID,
|
|
OrganizationID: uuid.New(),
|
|
Name: "test.png",
|
|
Mimetype: "image/png",
|
|
CreatedAt: now,
|
|
},
|
|
}
|
|
|
|
got := db2sdk.Chat(input, diffStatus, fileRows)
|
|
|
|
require.Equal(t, &lastErrorPayload, got.LastError)
|
|
|
|
v := reflect.ValueOf(got)
|
|
typ := v.Type()
|
|
// These fields are set outside db2sdk.Chat and intentionally remain zero.
|
|
skip := map[string]bool{"HasUnread": true, "Warnings": true, "QueuedForCapacity": true}
|
|
for i := range typ.NumField() {
|
|
field := typ.Field(i)
|
|
if skip[field.Name] {
|
|
continue
|
|
}
|
|
require.False(t, v.Field(i).IsZero(),
|
|
"codersdk.Chat field %q is zero-valued — db2sdk.Chat may not be populating it",
|
|
field.Name,
|
|
)
|
|
}
|
|
}
|
|
|
|
func TestChat_Shared(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
testCases := []struct {
|
|
name string
|
|
userACL database.ChatACL
|
|
groupACL database.ChatACL
|
|
expected bool
|
|
}{
|
|
{
|
|
name: "not shared",
|
|
},
|
|
{
|
|
name: "user ACL",
|
|
userACL: database.ChatACL{uuid.NewString(): database.ChatACLEntry{}},
|
|
expected: true,
|
|
},
|
|
{
|
|
name: "group ACL",
|
|
groupACL: database.ChatACL{uuid.NewString(): database.ChatACLEntry{}},
|
|
expected: true,
|
|
},
|
|
{
|
|
name: "user and group ACLs",
|
|
userACL: database.ChatACL{uuid.NewString(): database.ChatACLEntry{}},
|
|
groupACL: database.ChatACL{uuid.NewString(): database.ChatACLEntry{}},
|
|
expected: true,
|
|
},
|
|
}
|
|
|
|
for _, tc := range testCases {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
chat := database.Chat{
|
|
ID: uuid.New(),
|
|
OwnerID: uuid.New(),
|
|
LastModelConfigID: uuid.New(),
|
|
Title: tc.name,
|
|
Status: database.ChatStatusWaiting,
|
|
CreatedAt: dbtime.Now(),
|
|
UpdatedAt: dbtime.Now(),
|
|
UserACL: tc.userACL,
|
|
GroupACL: tc.groupACL,
|
|
}
|
|
|
|
got := db2sdk.Chat(chat, nil, nil)
|
|
require.Equal(t, tc.expected, got.Shared)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestChat_FileMetadataConversion(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
ownerID := uuid.New()
|
|
orgID := uuid.New()
|
|
fileID := uuid.New()
|
|
now := dbtime.Now()
|
|
|
|
chat := database.Chat{
|
|
ID: uuid.New(),
|
|
OwnerID: ownerID,
|
|
LastModelConfigID: uuid.New(),
|
|
Title: "file metadata test",
|
|
Status: database.ChatStatusWaiting,
|
|
CreatedAt: now,
|
|
UpdatedAt: now,
|
|
}
|
|
|
|
rows := []database.GetChatFileMetadataByChatIDRow{
|
|
{
|
|
ID: fileID,
|
|
OwnerID: ownerID,
|
|
OrganizationID: orgID,
|
|
Name: "screenshot.png",
|
|
Mimetype: "image/png",
|
|
SizeBytes: 1234,
|
|
CreatedAt: now,
|
|
},
|
|
}
|
|
|
|
result := db2sdk.Chat(chat, nil, rows)
|
|
|
|
require.Len(t, result.Files, 1)
|
|
f := result.Files[0]
|
|
require.Equal(t, fileID, f.ID)
|
|
require.Equal(t, ownerID, f.OwnerID, "OwnerID must be mapped from DB row")
|
|
require.Equal(t, orgID, f.OrganizationID, "OrganizationID must be mapped from DB row")
|
|
require.Equal(t, "screenshot.png", f.Name)
|
|
require.Equal(t, "image/png", f.MimeType)
|
|
require.Equal(t, int64(1234), f.SizeBytes)
|
|
require.Equal(t, now, f.CreatedAt)
|
|
|
|
// Verify JSON serialization uses snake_case for mime_type.
|
|
data, err := json.Marshal(f)
|
|
require.NoError(t, err)
|
|
require.Contains(t, string(data), `"mime_type"`)
|
|
require.NotContains(t, string(data), `"mimetype"`)
|
|
}
|
|
|
|
func TestChat_NilFilesOmitted(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
chat := database.Chat{
|
|
ID: uuid.New(),
|
|
OwnerID: uuid.New(),
|
|
LastModelConfigID: uuid.New(),
|
|
Title: "no files",
|
|
Status: database.ChatStatusWaiting,
|
|
CreatedAt: dbtime.Now(),
|
|
UpdatedAt: dbtime.Now(),
|
|
}
|
|
|
|
result := db2sdk.Chat(chat, nil, nil)
|
|
require.Empty(t, result.Files)
|
|
}
|
|
|
|
func TestChat_LastErrorFallback(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
const fallbackMessage = "The chat request failed unexpectedly."
|
|
|
|
tests := []struct {
|
|
name string
|
|
raw json.RawMessage
|
|
expectPayload *codersdk.ChatError
|
|
}{
|
|
{
|
|
name: "MalformedJSON",
|
|
raw: json.RawMessage(`{`),
|
|
expectPayload: &codersdk.ChatError{
|
|
Message: fallbackMessage,
|
|
Kind: codersdk.ChatErrorKindGeneric,
|
|
Retryable: false,
|
|
},
|
|
},
|
|
{
|
|
name: "MessageMissingPreservesMetadata",
|
|
raw: json.RawMessage(`{"kind":"timeout","provider":"openai","status_code":504}`),
|
|
expectPayload: &codersdk.ChatError{
|
|
Message: fallbackMessage,
|
|
Kind: codersdk.ChatErrorKindTimeout,
|
|
Provider: "openai",
|
|
Retryable: false,
|
|
StatusCode: 504,
|
|
},
|
|
},
|
|
{
|
|
name: "WhitespaceMessageDefaultsKind",
|
|
raw: json.RawMessage(`{"message":" ","provider":"openai"}`),
|
|
expectPayload: &codersdk.ChatError{
|
|
Message: fallbackMessage,
|
|
Kind: codersdk.ChatErrorKindGeneric,
|
|
Provider: "openai",
|
|
Retryable: false,
|
|
},
|
|
},
|
|
{
|
|
name: "KindMissingDefaultsGeneric",
|
|
raw: json.RawMessage(`{"message":"OpenAI returned an unexpected error.","provider":"openai","status_code":502}`),
|
|
expectPayload: &codersdk.ChatError{
|
|
Message: "OpenAI returned an unexpected error.",
|
|
Kind: codersdk.ChatErrorKindGeneric,
|
|
Provider: "openai",
|
|
Retryable: false,
|
|
StatusCode: 502,
|
|
},
|
|
},
|
|
{
|
|
name: "UsageLimitKindRoundTrips",
|
|
raw: json.RawMessage(`{"message":"Usage limit reached.","kind":"usage_limit"}`),
|
|
expectPayload: &codersdk.ChatError{
|
|
Message: "Usage limit reached.",
|
|
Kind: codersdk.ChatErrorKindUsageLimit,
|
|
Retryable: false,
|
|
},
|
|
},
|
|
}
|
|
|
|
for _, tc := range tests {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
chat := database.Chat{
|
|
ID: uuid.New(),
|
|
OwnerID: uuid.New(),
|
|
LastModelConfigID: uuid.New(),
|
|
Title: "fallback payload",
|
|
Status: database.ChatStatusError,
|
|
CreatedAt: dbtime.Now(),
|
|
UpdatedAt: dbtime.Now(),
|
|
LastError: pqtype.NullRawMessage{
|
|
RawMessage: tc.raw,
|
|
Valid: true,
|
|
},
|
|
}
|
|
|
|
result := db2sdk.Chat(chat, nil, nil)
|
|
require.Equal(t, tc.expectPayload, result.LastError)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestChat_MultipleFiles(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
now := dbtime.Now()
|
|
file1 := uuid.New()
|
|
file2 := uuid.New()
|
|
|
|
chat := database.Chat{
|
|
ID: uuid.New(),
|
|
OwnerID: uuid.New(),
|
|
LastModelConfigID: uuid.New(),
|
|
Title: "multi file test",
|
|
Status: database.ChatStatusWaiting,
|
|
CreatedAt: now,
|
|
UpdatedAt: now,
|
|
}
|
|
|
|
rows := []database.GetChatFileMetadataByChatIDRow{
|
|
{
|
|
ID: file1,
|
|
OwnerID: chat.OwnerID,
|
|
OrganizationID: uuid.New(),
|
|
Name: "a.png",
|
|
Mimetype: "image/png",
|
|
CreatedAt: now,
|
|
},
|
|
{
|
|
ID: file2,
|
|
OwnerID: chat.OwnerID,
|
|
OrganizationID: uuid.New(),
|
|
Name: "b.txt",
|
|
Mimetype: "text/plain",
|
|
CreatedAt: now,
|
|
},
|
|
}
|
|
|
|
result := db2sdk.Chat(chat, nil, rows)
|
|
require.Len(t, result.Files, 2)
|
|
require.Equal(t, "a.png", result.Files[0].Name)
|
|
require.Equal(t, "b.txt", result.Files[1].Name)
|
|
}
|
|
|
|
func TestChatQueuedMessage_MalformedContent(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
queued := db2sdk.ChatQueuedMessage(database.ChatQueuedMessage{
|
|
ID: 1,
|
|
ChatID: uuid.New(),
|
|
Content: json.RawMessage(`{"unexpected":"shape"}`),
|
|
CreatedAt: time.Now(),
|
|
})
|
|
|
|
require.Empty(t, queued.Content)
|
|
}
|