Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit670fa4a

Browse files
authored
feat: add the /aitasks/prompts endpoint (#18464)
Add an endpoint to fetch AI task prompts for multiple workspace buildsat the same time. A prompt is the value of the "AI Prompt" workspacebuild parameter. On main, the only way our API allows fetching workspacebuild parameters is by using the `/workspacebuilds/$build_id/parameters`endpoint, requiring a separate API call for every build.The Tasks dashboard fetches Task workspaces in order to show them in alist, and then needs to fetch the value of the `AI Prompt` parameter forevery task workspace (using its latest build id), requiring anadditional API call for each list item. This endpoint will allow thedashboard to make just 2 calls to render the list: one to fetch taskworkspaces, the other to fetch prompts.<img width="1512" alt="Screenshot 2025-06-20 at 11 33 11"src="https://github.com/user-attachments/assets/92899999-e922-44c5-8325-b4b23a0d2bff"/>Related tocoder/internal#660.
1 parent0238f29 commit670fa4a

File tree

16 files changed

+493
-1
lines changed

16 files changed

+493
-1
lines changed

‎coderd/aitasks.go

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
package coderd
2+
3+
import (
4+
"fmt"
5+
"net/http"
6+
"strings"
7+
8+
"github.com/google/uuid"
9+
10+
"github.com/coder/coder/v2/coderd/httpapi"
11+
"github.com/coder/coder/v2/codersdk"
12+
)
13+
14+
// This endpoint is experimental and not guaranteed to be stable, so we're not
15+
// generating public-facing documentation for it.
16+
func (api*API)aiTasksPrompts(rw http.ResponseWriter,r*http.Request) {
17+
ctx:=r.Context()
18+
19+
buildIDsParam:=r.URL.Query().Get("build_ids")
20+
ifbuildIDsParam=="" {
21+
httpapi.Write(ctx,rw,http.StatusBadRequest, codersdk.Response{
22+
Message:"build_ids query parameter is required",
23+
})
24+
return
25+
}
26+
27+
// Parse build IDs
28+
buildIDStrings:=strings.Split(buildIDsParam,",")
29+
buildIDs:=make([]uuid.UUID,0,len(buildIDStrings))
30+
for_,idStr:=rangebuildIDStrings {
31+
id,err:=uuid.Parse(strings.TrimSpace(idStr))
32+
iferr!=nil {
33+
httpapi.Write(ctx,rw,http.StatusBadRequest, codersdk.Response{
34+
Message:fmt.Sprintf("Invalid build ID format: %s",idStr),
35+
Detail:err.Error(),
36+
})
37+
return
38+
}
39+
buildIDs=append(buildIDs,id)
40+
}
41+
42+
parameters,err:=api.Database.GetWorkspaceBuildParametersByBuildIDs(ctx,buildIDs)
43+
iferr!=nil {
44+
httpapi.Write(ctx,rw,http.StatusInternalServerError, codersdk.Response{
45+
Message:"Internal error fetching workspace build parameters.",
46+
Detail:err.Error(),
47+
})
48+
return
49+
}
50+
51+
promptsByBuildID:=make(map[string]string,len(parameters))
52+
for_,param:=rangeparameters {
53+
ifparam.Name!=codersdk.AITaskPromptParameterName {
54+
continue
55+
}
56+
buildID:=param.WorkspaceBuildID.String()
57+
promptsByBuildID[buildID]=param.Value
58+
}
59+
60+
httpapi.Write(ctx,rw,http.StatusOK, codersdk.AITasksPromptsResponse{
61+
Prompts:promptsByBuildID,
62+
})
63+
}

‎coderd/aitasks_test.go

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
package coderd_test
2+
3+
import (
4+
"testing"
5+
6+
"github.com/google/uuid"
7+
"github.com/stretchr/testify/require"
8+
9+
"github.com/coder/coder/v2/coderd/coderdtest"
10+
"github.com/coder/coder/v2/coderd/database/dbtestutil"
11+
"github.com/coder/coder/v2/codersdk"
12+
"github.com/coder/coder/v2/provisioner/echo"
13+
"github.com/coder/coder/v2/provisionersdk/proto"
14+
"github.com/coder/coder/v2/testutil"
15+
)
16+
17+
funcTestAITasksPrompts(t*testing.T) {
18+
t.Parallel()
19+
20+
t.Run("EmptyBuildIDs",func(t*testing.T) {
21+
t.Parallel()
22+
client:=coderdtest.New(t,&coderdtest.Options{})
23+
_=coderdtest.CreateFirstUser(t,client)
24+
experimentalClient:=codersdk.NewExperimentalClient(client)
25+
26+
ctx:=testutil.Context(t,testutil.WaitShort)
27+
28+
// Test with empty build IDs
29+
prompts,err:=experimentalClient.AITaskPrompts(ctx, []uuid.UUID{})
30+
require.NoError(t,err)
31+
require.Empty(t,prompts.Prompts)
32+
})
33+
34+
t.Run("MultipleBuilds",func(t*testing.T) {
35+
t.Parallel()
36+
37+
if!dbtestutil.WillUsePostgres() {
38+
t.Skip("This test checks RBAC, which is not supported in the in-memory database")
39+
}
40+
41+
adminClient:=coderdtest.New(t,&coderdtest.Options{IncludeProvisionerDaemon:true})
42+
first:=coderdtest.CreateFirstUser(t,adminClient)
43+
memberClient,_:=coderdtest.CreateAnotherUser(t,adminClient,first.OrganizationID)
44+
45+
ctx:=testutil.Context(t,testutil.WaitLong)
46+
47+
// Create a template with parameters
48+
version:=coderdtest.CreateTemplateVersion(t,adminClient,first.OrganizationID,&echo.Responses{
49+
Parse:echo.ParseComplete,
50+
ProvisionPlan: []*proto.Response{{
51+
Type:&proto.Response_Plan{
52+
Plan:&proto.PlanComplete{
53+
Parameters: []*proto.RichParameter{
54+
{
55+
Name:"param1",
56+
Type:"string",
57+
DefaultValue:"default1",
58+
},
59+
{
60+
Name:codersdk.AITaskPromptParameterName,
61+
Type:"string",
62+
DefaultValue:"default2",
63+
},
64+
},
65+
},
66+
},
67+
}},
68+
ProvisionApply:echo.ApplyComplete,
69+
})
70+
template:=coderdtest.CreateTemplate(t,adminClient,first.OrganizationID,version.ID)
71+
coderdtest.AwaitTemplateVersionJobCompleted(t,adminClient,version.ID)
72+
73+
// Create two workspaces with different parameters
74+
workspace1:=coderdtest.CreateWorkspace(t,memberClient,template.ID,func(request*codersdk.CreateWorkspaceRequest) {
75+
request.RichParameterValues= []codersdk.WorkspaceBuildParameter{
76+
{Name:"param1",Value:"value1a"},
77+
{Name:codersdk.AITaskPromptParameterName,Value:"value2a"},
78+
}
79+
})
80+
coderdtest.AwaitWorkspaceBuildJobCompleted(t,memberClient,workspace1.LatestBuild.ID)
81+
82+
workspace2:=coderdtest.CreateWorkspace(t,memberClient,template.ID,func(request*codersdk.CreateWorkspaceRequest) {
83+
request.RichParameterValues= []codersdk.WorkspaceBuildParameter{
84+
{Name:"param1",Value:"value1b"},
85+
{Name:codersdk.AITaskPromptParameterName,Value:"value2b"},
86+
}
87+
})
88+
coderdtest.AwaitWorkspaceBuildJobCompleted(t,memberClient,workspace2.LatestBuild.ID)
89+
90+
workspace3:=coderdtest.CreateWorkspace(t,adminClient,template.ID,func(request*codersdk.CreateWorkspaceRequest) {
91+
request.RichParameterValues= []codersdk.WorkspaceBuildParameter{
92+
{Name:"param1",Value:"value1c"},
93+
{Name:codersdk.AITaskPromptParameterName,Value:"value2c"},
94+
}
95+
})
96+
coderdtest.AwaitWorkspaceBuildJobCompleted(t,adminClient,workspace3.LatestBuild.ID)
97+
allBuildIDs:= []uuid.UUID{workspace1.LatestBuild.ID,workspace2.LatestBuild.ID,workspace3.LatestBuild.ID}
98+
99+
experimentalMemberClient:=codersdk.NewExperimentalClient(memberClient)
100+
// Test parameters endpoint as member
101+
prompts,err:=experimentalMemberClient.AITaskPrompts(ctx,allBuildIDs)
102+
require.NoError(t,err)
103+
// we expect 2 prompts because the member client does not have access to workspace3
104+
// since it was created by the admin client
105+
require.Len(t,prompts.Prompts,2)
106+
107+
// Check workspace1 parameters
108+
build1Prompt:=prompts.Prompts[workspace1.LatestBuild.ID.String()]
109+
require.Equal(t,"value2a",build1Prompt)
110+
111+
// Check workspace2 parameters
112+
build2Prompt:=prompts.Prompts[workspace2.LatestBuild.ID.String()]
113+
require.Equal(t,"value2b",build2Prompt)
114+
115+
experimentalAdminClient:=codersdk.NewExperimentalClient(adminClient)
116+
// Test parameters endpoint as admin
117+
// we expect 3 prompts because the admin client has access to all workspaces
118+
prompts,err=experimentalAdminClient.AITaskPrompts(ctx,allBuildIDs)
119+
require.NoError(t,err)
120+
require.Len(t,prompts.Prompts,3)
121+
122+
// Check workspace3 parameters
123+
build3Prompt:=prompts.Prompts[workspace3.LatestBuild.ID.String()]
124+
require.Equal(t,"value2c",build3Prompt)
125+
})
126+
127+
t.Run("NonExistentBuildIDs",func(t*testing.T) {
128+
t.Parallel()
129+
client:=coderdtest.New(t,&coderdtest.Options{})
130+
_=coderdtest.CreateFirstUser(t,client)
131+
132+
ctx:=testutil.Context(t,testutil.WaitShort)
133+
134+
// Test with non-existent build IDs
135+
nonExistentID:=uuid.New()
136+
experimentalClient:=codersdk.NewExperimentalClient(client)
137+
prompts,err:=experimentalClient.AITaskPrompts(ctx, []uuid.UUID{nonExistentID})
138+
require.NoError(t,err)
139+
require.Empty(t,prompts.Prompts)
140+
})
141+
}

‎coderd/coderd.go

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -939,6 +939,14 @@ func New(options *Options) *API {
939939
})
940940
})
941941

942+
// Experimental routes are not guaranteed to be stable and may change at any time.
943+
r.Route("/api/experimental",func(r chi.Router) {
944+
r.Use(apiKeyMiddleware)
945+
r.Route("/aitasks",func(r chi.Router) {
946+
r.Get("/prompts",api.aiTasksPrompts)
947+
})
948+
})
949+
942950
r.Route("/api/v2",func(r chi.Router) {
943951
api.APIHandler=r
944952

‎coderd/database/dbauthz/dbauthz.go

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3281,6 +3281,15 @@ func (q *querier) GetWorkspaceBuildParameters(ctx context.Context, workspaceBuil
32813281
returnq.db.GetWorkspaceBuildParameters(ctx,workspaceBuildID)
32823282
}
32833283

3284+
func (q*querier)GetWorkspaceBuildParametersByBuildIDs(ctx context.Context,workspaceBuildIDs []uuid.UUID) ([]database.WorkspaceBuildParameter,error) {
3285+
prep,err:=prepareSQLFilter(ctx,q.auth,policy.ActionRead,rbac.ResourceWorkspace.Type)
3286+
iferr!=nil {
3287+
returnnil,xerrors.Errorf("(dev error) prepare sql filter: %w",err)
3288+
}
3289+
3290+
returnq.db.GetAuthorizedWorkspaceBuildParametersByBuildIDs(ctx,workspaceBuildIDs,prep)
3291+
}
3292+
32843293
func (q*querier)GetWorkspaceBuildStatsByTemplates(ctx context.Context,since time.Time) ([]database.GetWorkspaceBuildStatsByTemplatesRow,error) {
32853294
iferr:=q.authorizeContext(ctx,policy.ActionRead,rbac.ResourceSystem);err!=nil {
32863295
returnnil,err
@@ -5266,6 +5275,10 @@ func (q *querier) GetAuthorizedWorkspacesAndAgentsByOwnerID(ctx context.Context,
52665275
returnq.GetWorkspacesAndAgentsByOwnerID(ctx,ownerID)
52675276
}
52685277

5278+
func (q*querier)GetAuthorizedWorkspaceBuildParametersByBuildIDs(ctx context.Context,workspaceBuildIDs []uuid.UUID,_ rbac.PreparedAuthorized) ([]database.WorkspaceBuildParameter,error) {
5279+
returnq.GetWorkspaceBuildParametersByBuildIDs(ctx,workspaceBuildIDs)
5280+
}
5281+
52695282
// GetAuthorizedUsers is not required for dbauthz since GetUsers is already
52705283
// authenticated.
52715284
func (q*querier)GetAuthorizedUsers(ctx context.Context,arg database.GetUsersParams,_ rbac.PreparedAuthorized) ([]database.GetUsersRow,error) {

‎coderd/database/dbauthz/dbauthz_test.go

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2012,6 +2012,14 @@ func (s *MethodTestSuite) TestWorkspace() {
20122012
// No asserts here because SQLFilter.
20132013
check.Args(ws.OwnerID,emptyPreparedAuthorized{}).Asserts()
20142014
}))
2015+
s.Run("GetWorkspaceBuildParametersByBuildIDs",s.Subtest(func(db database.Store,check*expects) {
2016+
// no asserts here because SQLFilter
2017+
check.Args([]uuid.UUID{}).Asserts()
2018+
}))
2019+
s.Run("GetAuthorizedWorkspaceBuildParametersByBuildIDs",s.Subtest(func(db database.Store,check*expects) {
2020+
// no asserts here because SQLFilter
2021+
check.Args([]uuid.UUID{},emptyPreparedAuthorized{}).Asserts()
2022+
}))
20152023
s.Run("GetLatestWorkspaceBuildByWorkspaceID",s.Subtest(func(db database.Store,check*expects) {
20162024
u:=dbgen.User(s.T(),db, database.User{})
20172025
o:=dbgen.Organization(s.T(),db, database.Organization{})

‎coderd/database/dbmem/dbmem.go

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7960,6 +7960,11 @@ func (q *FakeQuerier) GetWorkspaceBuildParameters(_ context.Context, workspaceBu
79607960
returnq.getWorkspaceBuildParametersNoLock(workspaceBuildID)
79617961
}
79627962

7963+
func (q*FakeQuerier)GetWorkspaceBuildParametersByBuildIDs(ctx context.Context,workspaceBuildIDs []uuid.UUID) ([]database.WorkspaceBuildParameter,error) {
7964+
// No auth filter.
7965+
returnq.GetAuthorizedWorkspaceBuildParametersByBuildIDs(ctx,workspaceBuildIDs,nil)
7966+
}
7967+
79637968
func (q*FakeQuerier)GetWorkspaceBuildStatsByTemplates(ctx context.Context,since time.Time) ([]database.GetWorkspaceBuildStatsByTemplatesRow,error) {
79647969
q.mutex.RLock()
79657970
deferq.mutex.RUnlock()
@@ -13901,6 +13906,30 @@ func (q *FakeQuerier) GetAuthorizedWorkspacesAndAgentsByOwnerID(ctx context.Cont
1390113906
returnout,nil
1390213907
}
1390313908

13909+
func (q*FakeQuerier)GetAuthorizedWorkspaceBuildParametersByBuildIDs(ctx context.Context,workspaceBuildIDs []uuid.UUID,prepared rbac.PreparedAuthorized) ([]database.WorkspaceBuildParameter,error) {
13910+
q.mutex.RLock()
13911+
deferq.mutex.RUnlock()
13912+
13913+
ifprepared!=nil {
13914+
// Call this to match the same function calls as the SQL implementation.
13915+
_,err:=prepared.CompileToSQL(ctx,rbac.ConfigWithoutACL())
13916+
iferr!=nil {
13917+
returnnil,err
13918+
}
13919+
}
13920+
13921+
filteredParameters:=make([]database.WorkspaceBuildParameter,0)
13922+
for_,buildID:=rangeworkspaceBuildIDs {
13923+
parameters,err:=q.GetWorkspaceBuildParameters(ctx,buildID)
13924+
iferr!=nil {
13925+
returnnil,err
13926+
}
13927+
filteredParameters=append(filteredParameters,parameters...)
13928+
}
13929+
13930+
returnfilteredParameters,nil
13931+
}
13932+
1390413933
func (q*FakeQuerier)GetAuthorizedUsers(ctx context.Context,arg database.GetUsersParams,prepared rbac.PreparedAuthorized) ([]database.GetUsersRow,error) {
1390513934
iferr:=validateDatabaseType(arg);err!=nil {
1390613935
returnnil,err

‎coderd/database/dbmetrics/querymetrics.go

Lines changed: 14 additions & 0 deletions
Some generated files are not rendered by default. Learn more aboutcustomizing how changed files appear on GitHub.

‎coderd/database/dbmock/dbmock.go

Lines changed: 30 additions & 0 deletions
Some generated files are not rendered by default. Learn more aboutcustomizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp