Skip to content

feat: persist AI task state in template imports & workspace builds #18449

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 22 commits into from
Jun 24, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
9fa7a93
chore: go.mod
dannykopping Jun 18, 2025
d01a050
feat: proto & db changes to persist coder_ai_task state
dannykopping Jun 18, 2025
4383350
feat: store coder_ai_task resource state
dannykopping Jun 18, 2025
957fb08
chore: rename ai_tasks_sidebar_app_id to ai_task_sidebar_app_id
dannykopping Jun 19, 2025
91c8f0c
chore: update to d9b0f892f9c2b3768b9647b089900b0628cb7828, prompt nam…
dannykopping Jun 19, 2025
efe5da9
chore: update provisioner API version comments
dannykopping Jun 19, 2025
5e0d28a
chore: move prompt param validation to ConvertState with other valida…
dannykopping Jun 19, 2025
57da39f
chore: unify tf testdata versions & fix tests
dannykopping Jun 20, 2025
c6c7b5c
chore: dbauthz
dannykopping Jun 20, 2025
4816ed5
chore: fix TestWorkspaceAgentAppHealth test after agent ID field now …
dannykopping Jun 20, 2025
e48df2e
chore: add tests
dannykopping Jun 20, 2025
0b2b732
chore: correct bad rebase
dannykopping Jun 23, 2025
5edee05
chore: undo changes to terraform testdata, so as to not complicate th…
dannykopping Jun 23, 2025
3614a5b
chore: fixing tests
dannykopping Jun 23, 2025
d7e47f9
chore: ensure sidebar app ID must be set when has_ai_task is set
dannykopping Jun 23, 2025
f4111df
chore: test multiple coder_ai_tasks cannot be configured
dannykopping Jun 23, 2025
cc0e290
chore: fix CI
dannykopping Jun 23, 2025
138d865
chore: minor refactor
dannykopping Jun 23, 2025
1aba76b
chore: add clarifying/defensive parentheses
dannykopping Jun 23, 2025
6454ffe
chore: fix conflict
dannykopping Jun 23, 2025
bce4a88
chore: review comments
dannykopping Jun 24, 2025
9a453e8
Merge branch 'main' of github.com:/coder/coder into dk/coder-ai-task-res
dannykopping Jun 24, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
chore: add tests
Signed-off-by: Danny Kopping <dannykopping@gmail.com>

# Conflicts:
#	go.sum
  • Loading branch information
dannykopping committed Jun 23, 2025
commit e48df2ebad8df16623ddd4f6833ba8728f2b310a
1 change: 1 addition & 0 deletions coderd/database/dbmem/dbmem.go
Original file line number Diff line number Diff line change
Expand Up @@ -12075,6 +12075,7 @@ func (q *FakeQuerier) UpdateWorkspaceBuildAITaskByID(_ context.Context, arg data
continue
}
workspaceBuild.HasAITask = arg.HasAITask
workspaceBuild.AITaskSidebarAppID = arg.SidebarAppID
workspaceBuild.UpdatedAt = dbtime.Now()
q.workspaceBuilds[index] = workspaceBuild
return nil
Expand Down
290 changes: 290 additions & 0 deletions coderd/provisionerdserver/provisionerdserver_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1564,6 +1564,69 @@ func TestCompleteJob(t *testing.T) {
require.Contains(t, job.Error.String, `external auth provider "github" is not configured`)
})

t.Run("TemplateImport_WithAITasks", func(t *testing.T) {
t.Parallel()

t.Run("WithoutPromptParam", func(t *testing.T) {
t.Parallel()

srv, db, _, pd := setup(t, false, &overrides{})
jobID := uuid.New()
versionID := uuid.New()
err := db.InsertTemplateVersion(ctx, database.InsertTemplateVersionParams{
ID: versionID,
JobID: jobID,
OrganizationID: pd.OrganizationID,
})
require.NoError(t, err)
job, err := db.InsertProvisionerJob(ctx, database.InsertProvisionerJobParams{
ID: jobID,
Provisioner: database.ProvisionerTypeEcho,
Input: []byte(`{"template_version_id": "` + versionID.String() + `"}`),
StorageMethod: database.ProvisionerStorageMethodFile,
Type: database.ProvisionerJobTypeWorkspaceBuild,
OrganizationID: pd.OrganizationID,
Tags: pd.Tags,
})
require.NoError(t, err)
_, err = db.AcquireProvisionerJob(ctx, database.AcquireProvisionerJobParams{
OrganizationID: pd.OrganizationID,
WorkerID: uuid.NullUUID{
UUID: pd.ID,
Valid: true,
},
Types: []database.ProvisionerType{database.ProvisionerTypeEcho},
StartedAt: sql.NullTime{
Time: dbtime.Now(),
Valid: true,
},
ProvisionerTags: must(json.Marshal(job.Tags)),
})
require.NoError(t, err)
completeJob := func() {
_, err = srv.CompleteJob(ctx, &proto.CompletedJob{
JobId: job.ID.String(),
Type: &proto.CompletedJob_TemplateImport_{
TemplateImport: &proto.CompletedJob_TemplateImport{
StartResources: []*sdkproto.Resource{{
Name: "my_task",
Type: "coder_ai_task",
}},
StopResources: []*sdkproto.Resource{},
HasAiTasks: true,
Plan: []byte("{}"),
},
},
})
require.NoError(t, err)
}
completeJob()
job, err = db.GetProvisionerJobByID(ctx, job.ID)
require.NoError(t, err)
require.Contains(t, job.Error.String, `external auth provider "github" is not configured`)
})
})

t.Run("TemplateImport_WithGitAuth", func(t *testing.T) {
t.Parallel()
srv, db, _, pd := setup(t, false, &overrides{
Expand Down Expand Up @@ -2435,6 +2498,233 @@ func TestCompleteJob(t *testing.T) {
testutil.RequireReceive(ctx, t, done)
require.Equal(t, replacements, orchestrator.replacements)
})

t.Run("AITasks", func(t *testing.T) {
t.Parallel()

// has_ai_task has a default value of nil, but once the template import completes it will have a value;
// it is set to "true" if the template has any coder_ai_task resources defined.
t.Run("TemplateImport", func(t *testing.T) {
type testcase struct {
name string
input *proto.CompletedJob_TemplateImport
expected bool
}

for _, tc := range []testcase{
{
name: "has_ai_task is false by default",
input: &proto.CompletedJob_TemplateImport{
// HasAiTasks is not set.
Plan: []byte("{}"),
},
expected: false,
},
{
name: "has_ai_task gets set to true",
input: &proto.CompletedJob_TemplateImport{
HasAiTasks: true,
Plan: []byte("{}"),
},
expected: true,
},
} {
t.Run(tc.name, func(t *testing.T) {
t.Parallel()

srv, db, _, pd := setup(t, false, &overrides{})

importJobID := uuid.New()
tvID := uuid.New()
template := dbgen.Template(t, db, database.Template{
Name: "template",
Provisioner: database.ProvisionerTypeEcho,
OrganizationID: pd.OrganizationID,
})
version := dbgen.TemplateVersion(t, db, database.TemplateVersion{
ID: tvID,
OrganizationID: pd.OrganizationID,
TemplateID: uuid.NullUUID{
UUID: template.ID,
Valid: true,
},
JobID: importJobID,
})
_ = version

ctx := testutil.Context(t, testutil.WaitShort)
job, err := db.InsertProvisionerJob(ctx, database.InsertProvisionerJobParams{
ID: importJobID,
CreatedAt: dbtime.Now(),
UpdatedAt: dbtime.Now(),
OrganizationID: pd.OrganizationID,
InitiatorID: uuid.New(),
Input: must(json.Marshal(provisionerdserver.TemplateVersionImportJob{
TemplateVersionID: tvID,
})),
Provisioner: database.ProvisionerTypeEcho,
StorageMethod: database.ProvisionerStorageMethodFile,
Type: database.ProvisionerJobTypeTemplateVersionImport,
Tags: pd.Tags,
})
require.NoError(t, err)

_, err = db.AcquireProvisionerJob(ctx, database.AcquireProvisionerJobParams{
OrganizationID: pd.OrganizationID,
WorkerID: uuid.NullUUID{
UUID: pd.ID,
Valid: true,
},
Types: []database.ProvisionerType{database.ProvisionerTypeEcho},
ProvisionerTags: must(json.Marshal(job.Tags)),
StartedAt: sql.NullTime{Time: job.CreatedAt, Valid: true},
})
require.NoError(t, err)

version, err = db.GetTemplateVersionByID(ctx, tvID)
require.NoError(t, err)
require.False(t, version.HasAITask.Valid) // Value should be nil (i.e. valid = false).

completedJob := proto.CompletedJob{
JobId: job.ID.String(),
Type: &proto.CompletedJob_TemplateImport_{
TemplateImport: tc.input,
},
}
_, err = srv.CompleteJob(ctx, &completedJob)
require.NoError(t, err)

version, err = db.GetTemplateVersionByID(ctx, tvID)
require.NoError(t, err)
require.True(t, version.HasAITask.Valid) // We ALWAYS expect a value to be set, therefore not nil, i.e. valid = true.
require.Equal(t, tc.expected, version.HasAITask.Bool)
})
}
})

// has_ai_task has a default value of nil, but once the workspace build completes it will have a value;
// it is set to "true" if the related template has any coder_ai_task resources defined, and its sidebar app ID
// will be set as well in that case.
t.Run("WorkspaceBuild", func(t *testing.T) {
type testcase struct {
name string
input *proto.CompletedJob_WorkspaceBuild
expected bool
}

sidebarAppID := uuid.NewString()
for _, tc := range []testcase{
{
name: "has_ai_task is false by default",
input: &proto.CompletedJob_WorkspaceBuild{
// No AiTasks defined.
},
expected: false,
},
{
name: "has_ai_task is set to true",
input: &proto.CompletedJob_WorkspaceBuild{
AiTasks: []*sdkproto.AITask{
{
Id: uuid.NewString(),
SidebarApp: &sdkproto.AITaskSidebarApp{
Id: sidebarAppID,
},
},
},
},
expected: true,
},
} {
t.Run(tc.name, func(t *testing.T) {
t.Parallel()

srv, db, _, pd := setup(t, false, &overrides{})

importJobID := uuid.New()
tvID := uuid.New()
template := dbgen.Template(t, db, database.Template{
Name: "template",
Provisioner: database.ProvisionerTypeEcho,
OrganizationID: pd.OrganizationID,
})
version := dbgen.TemplateVersion(t, db, database.TemplateVersion{
ID: tvID,
OrganizationID: pd.OrganizationID,
TemplateID: uuid.NullUUID{
UUID: template.ID,
Valid: true,
},
JobID: importJobID,
})
user := dbgen.User(t, db, database.User{})
workspaceTable := dbgen.Workspace(t, db, database.WorkspaceTable{
TemplateID: template.ID,
OwnerID: user.ID,
OrganizationID: pd.OrganizationID,
})
build := dbgen.WorkspaceBuild(t, db, database.WorkspaceBuild{
WorkspaceID: workspaceTable.ID,
TemplateVersionID: version.ID,
InitiatorID: user.ID,
Transition: database.WorkspaceTransitionStart,
})

ctx := testutil.Context(t, testutil.WaitShort)
job, err := db.InsertProvisionerJob(ctx, database.InsertProvisionerJobParams{
ID: importJobID,
CreatedAt: dbtime.Now(),
UpdatedAt: dbtime.Now(),
OrganizationID: pd.OrganizationID,
InitiatorID: uuid.New(),
Input: must(json.Marshal(provisionerdserver.WorkspaceProvisionJob{
WorkspaceBuildID: build.ID,
LogLevel: "DEBUG",
})),
Provisioner: database.ProvisionerTypeEcho,
StorageMethod: database.ProvisionerStorageMethodFile,
Type: database.ProvisionerJobTypeWorkspaceBuild,
Tags: pd.Tags,
})
require.NoError(t, err)

_, err = db.AcquireProvisionerJob(ctx, database.AcquireProvisionerJobParams{
OrganizationID: pd.OrganizationID,
WorkerID: uuid.NullUUID{
UUID: pd.ID,
Valid: true,
},
Types: []database.ProvisionerType{database.ProvisionerTypeEcho},
ProvisionerTags: must(json.Marshal(job.Tags)),
StartedAt: sql.NullTime{Time: job.CreatedAt, Valid: true},
})
require.NoError(t, err)

build, err = db.GetWorkspaceBuildByID(ctx, build.ID)
require.NoError(t, err)
require.False(t, build.HasAITask.Valid) // Value should be nil (i.e. valid = false).

completedJob := proto.CompletedJob{
JobId: job.ID.String(),
Type: &proto.CompletedJob_WorkspaceBuild_{
WorkspaceBuild: tc.input,
},
}
_, err = srv.CompleteJob(ctx, &completedJob)
require.NoError(t, err)

build, err = db.GetWorkspaceBuildByID(ctx, build.ID)
require.NoError(t, err)
require.True(t, build.HasAITask.Valid) // We ALWAYS expect a value to be set, therefore not nil, i.e. valid = true.
require.Equal(t, tc.expected, build.HasAITask.Bool)

if tc.expected {
require.Equal(t, sidebarAppID, build.AITaskSidebarAppID.UUID.String())
}
})
}
})
})
}

type mockPrebuildsOrchestrator struct {
Expand Down
5 changes: 1 addition & 4 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ require (
github.com/coder/quartz v0.2.1
github.com/coder/retry v1.5.1
github.com/coder/serpent v0.10.0
github.com/coder/terraform-provider-coder/v2 v2.6.0
github.com/coder/terraform-provider-coder/v2 v2.7.0
github.com/coder/websocket v1.8.13
github.com/coder/wgtunnel v0.1.13-0.20240522110300-ade90dfb2da0
github.com/coreos/go-oidc/v3 v3.14.1
Expand Down Expand Up @@ -535,6 +535,3 @@ require (
go.opentelemetry.io/otel/sdk/metric v1.35.0 // indirect
k8s.io/utils v0.0.0-20241210054802-24370beab758 // indirect
)

// TODO: replace once new version is cut.
replace github.com/coder/terraform-provider-coder/v2 => github.com/coder/terraform-provider-coder/v2 v2.5.4-0.20250619093524-d9b0f892f9c2
5 changes: 2 additions & 3 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -928,9 +928,8 @@ github.com/coder/tailscale v1.1.1-0.20250611020837-f14d20d23d8c h1:d/qBIi3Ez7Kko
github.com/coder/tailscale v1.1.1-0.20250611020837-f14d20d23d8c/go.mod h1:l7ml5uu7lFh5hY28lGYM4b/oFSmuPHYX6uk4RAu23Lc=
github.com/coder/terraform-config-inspect v0.0.0-20250107175719-6d06d90c630e h1:JNLPDi2P73laR1oAclY6jWzAbucf70ASAvf5mh2cME0=
github.com/coder/terraform-config-inspect v0.0.0-20250107175719-6d06d90c630e/go.mod h1:Gz/z9Hbn+4KSp8A2FBtNszfLSdT2Tn/uAKGuVqqWmDI=
github.com/coder/terraform-provider-coder/v2 v2.5.4-0.20250619093524-d9b0f892f9c2/go.mod h1:WrdLSbihuzH1RZhwrU+qmkqEhUbdZT/sjHHdarm5b5g=
github.com/coder/terraform-provider-coder/v2 v2.6.0 h1:ybSVxkblpFdanNX7hibex41yvwjswUlA3RPh4BAHjBI=
github.com/coder/terraform-provider-coder/v2 v2.6.0/go.mod h1:WrdLSbihuzH1RZhwrU+qmkqEhUbdZT/sjHHdarm5b5g=
github.com/coder/terraform-provider-coder/v2 v2.7.0 h1:0WV89TuboHnoy4J8MwNnCtNjF3Onx2Ny959FC2ClGQg=
github.com/coder/terraform-provider-coder/v2 v2.7.0/go.mod h1:WrdLSbihuzH1RZhwrU+qmkqEhUbdZT/sjHHdarm5b5g=
github.com/coder/trivy v0.0.0-20250527170238-9416a59d7019 h1:MHkv/W7l9eRAN9gOG0qZ1TLRGWIIfNi92273vPAQ8Fs=
github.com/coder/trivy v0.0.0-20250527170238-9416a59d7019/go.mod h1:eqk+w9RLBmbd/cB5XfPZFuVn77cf/A6fB7qmEVeSmXk=
github.com/coder/websocket v1.8.13 h1:f3QZdXy7uGVz+4uCJy2nTZyM0yTBj8yANEHhqlXZ9FE=
Expand Down
Loading