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

Commit7ae3fdc

Browse files
authored
refactor: use task data model for notifications (#20590)
Updatescoder/internal#973Updatescoder/internal#974
1 parent7b6e724 commit7ae3fdc

File tree

6 files changed

+92
-90
lines changed

6 files changed

+92
-90
lines changed

‎coderd/aitasks_test.go‎

Lines changed: 23 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,12 @@ package coderd_test
22

33
import (
44
"context"
5-
"database/sql"
65
"encoding/json"
76
"io"
87
"net/http"
98
"net/http/httptest"
10-
"strings"
119
"testing"
1210
"time"
13-
"unicode/utf8"
1411

1512
"github.com/google/uuid"
1613
"github.com/stretchr/testify/assert"
@@ -1325,31 +1322,31 @@ func TestTasksNotification(t *testing.T) {
13251322
// Given: a workspace build with an agent containing an App
13261323
workspaceAgentAppID:=uuid.New()
13271324
workspaceBuildID:=uuid.New()
1328-
workspaceBuildSeed:= database.WorkspaceBuild{
1325+
workspaceBuilder:=dbfake.WorkspaceBuild(t,db, database.WorkspaceTable{
1326+
OrganizationID:ownerUser.OrganizationID,
1327+
OwnerID:memberUser.ID,
1328+
}).Seed(database.WorkspaceBuild{
13291329
ID:workspaceBuildID,
1330-
}
1330+
})
13311331
iftc.isAITask {
1332-
workspaceBuildSeed= database.WorkspaceBuild{
1333-
ID:workspaceBuildID,
1334-
// AI Task configuration
1335-
HasAITask: sql.NullBool{Bool:true,Valid:true},
1336-
AITaskSidebarAppID: uuid.NullUUID{UUID:workspaceAgentAppID,Valid:true},
1337-
}
1332+
workspaceBuilder=workspaceBuilder.
1333+
WithTask(database.TaskTable{
1334+
Prompt:tc.taskPrompt,
1335+
},&proto.App{
1336+
Id:workspaceAgentAppID.String(),
1337+
Slug:"ccw",
1338+
})
1339+
}else {
1340+
workspaceBuilder=workspaceBuilder.
1341+
WithAgent(func(agent []*proto.Agent) []*proto.Agent {
1342+
agent[0].Apps= []*proto.App{{
1343+
Id:workspaceAgentAppID.String(),
1344+
Slug:"ccw",
1345+
}}
1346+
returnagent
1347+
})
13381348
}
1339-
workspaceBuild:=dbfake.WorkspaceBuild(t,db, database.WorkspaceTable{
1340-
OrganizationID:ownerUser.OrganizationID,
1341-
OwnerID:memberUser.ID,
1342-
}).Seed(workspaceBuildSeed).Params(database.WorkspaceBuildParameter{
1343-
WorkspaceBuildID:workspaceBuildID,
1344-
Name:codersdk.AITaskPromptParameterName,
1345-
Value:tc.taskPrompt,
1346-
}).WithAgent(func(agent []*proto.Agent) []*proto.Agent {
1347-
agent[0].Apps= []*proto.App{{
1348-
Id:workspaceAgentAppID.String(),
1349-
Slug:"ccw",
1350-
}}
1351-
returnagent
1352-
}).Do()
1349+
workspaceBuild:=workspaceBuilder.Do()
13531350

13541351
// Given: the workspace agent app has previous statuses
13551352
agentClient:=agentsdk.New(client.URL,agentsdk.WithFixedToken(workspaceBuild.AgentToken))
@@ -1390,13 +1387,7 @@ func TestTasksNotification(t *testing.T) {
13901387
require.Len(t,sent,1)
13911388
require.Equal(t,memberUser.ID,sent[0].UserID)
13921389
require.Len(t,sent[0].Labels,2)
1393-
// NOTE: len(string) is the number of bytes in the string, not the number of runes.
1394-
require.LessOrEqual(t,utf8.RuneCountInString(sent[0].Labels["task"]),160)
1395-
iflen(tc.taskPrompt)>160 {
1396-
require.Contains(t,tc.taskPrompt,strings.TrimSuffix(sent[0].Labels["task"],"…"))
1397-
}else {
1398-
require.Equal(t,tc.taskPrompt,sent[0].Labels["task"])
1399-
}
1390+
require.Equal(t,workspaceBuild.Task.Name,sent[0].Labels["task"])
14001391
require.Equal(t,workspace.Name,sent[0].Labels["workspace"])
14011392
}else {
14021393
// Then: No notification is sent

‎coderd/database/queries.sql.go‎

Lines changed: 8 additions & 1 deletion
Some generated files are not rendered by default. Learn more aboutcustomizing how changed files appear on GitHub.

‎coderd/database/queries/workspaceagents.sql‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,8 @@ WHERE
285285
SELECT
286286
sqlc.embed(workspaces),
287287
sqlc.embed(workspace_agents),
288-
sqlc.embed(workspace_build_with_user)
288+
sqlc.embed(workspace_build_with_user),
289+
tasks.idAS task_id
289290
FROM
290291
workspace_agents
291292
JOIN
@@ -300,6 +301,10 @@ JOIN
300301
workspaces
301302
ON
302303
workspace_build_with_user.workspace_id=workspaces.id
304+
LEFT JOIN
305+
tasks
306+
ON
307+
tasks.workspace_id=workspaces.id
303308
WHERE
304309
-- This should only match 1 agent, so 1 returned row or 0.
305310
workspace_agents.auth_token= @auth_token::uuid

‎coderd/httpmw/workspaceagent.go‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,7 @@ func ExtractWorkspaceAgentAndLatestBuild(opts ExtractWorkspaceAgentAndLatestBuil
118118
OwnerID:row.WorkspaceTable.OwnerID,
119119
TemplateID:row.WorkspaceTable.TemplateID,
120120
VersionID:row.WorkspaceBuild.TemplateVersionID,
121+
TaskID:row.TaskID,
121122
BlockUserData:row.WorkspaceAgent.APIKeyScope==database.AgentKeyScopeEnumNoUserData,
122123
}),
123124
)

‎coderd/rbac/scopes.go‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ type WorkspaceAgentScopeParams struct {
1818
OwnerID uuid.UUID
1919
TemplateID uuid.UUID
2020
VersionID uuid.UUID
21+
TaskID uuid.NullUUID
2122
BlockUserDatabool
2223
}
2324

@@ -42,6 +43,15 @@ func WorkspaceAgentScope(params WorkspaceAgentScopeParams) Scope {
4243
panic("failed to expand scope, this should never happen")
4344
}
4445

46+
// Include task in the allow list if the workspace has an associated task.
47+
varextraAllowList []AllowListElement
48+
ifparams.TaskID.Valid {
49+
extraAllowList=append(extraAllowList,AllowListElement{
50+
Type:ResourceTask.Type,
51+
ID:params.TaskID.UUID.String(),
52+
})
53+
}
54+
4555
returnScope{
4656
// TODO: We want to limit the role too to be extra safe.
4757
// Even though the allowlist blocks anything else, it is still good
@@ -52,12 +62,12 @@ func WorkspaceAgentScope(params WorkspaceAgentScopeParams) Scope {
5262
// Limit the agent to only be able to access the singular workspace and
5363
// the template/version it was created from. Add additional resources here
5464
// as needed, but do not add more workspace or template resource ids.
55-
AllowIDList: []AllowListElement{
65+
AllowIDList:append([]AllowListElement{
5666
{Type:ResourceWorkspace.Type,ID:params.WorkspaceID.String()},
5767
{Type:ResourceTemplate.Type,ID:params.TemplateID.String()},
5868
{Type:ResourceTemplate.Type,ID:params.VersionID.String()},
5969
{Type:ResourceUser.Type,ID:params.OwnerID.String()},
60-
},
70+
},extraAllowList...),
6171
}
6272
}
6373

‎coderd/workspaceagents.go‎

Lines changed: 42 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -461,67 +461,55 @@ func (api *API) enqueueAITaskStateNotification(
461461
return
462462
}
463463

464-
workspaceBuild,err:=api.Database.GetLatestWorkspaceBuildByWorkspaceID(ctx,workspace.ID)
465-
iferr!=nil {
466-
api.Logger.Warn(ctx,"failed to get workspace build",slog.Error(err))
464+
if!workspace.TaskID.Valid {
465+
// Workspace has no task ID, do nothing.
467466
return
468467
}
469468

470-
// Confirm Workspace Agent App is an AI Task
471-
ifworkspaceBuild.HasAITask.Valid&&workspaceBuild.HasAITask.Bool&&
472-
workspaceBuild.AITaskSidebarAppID.Valid&&workspaceBuild.AITaskSidebarAppID.UUID==appID {
473-
// Skip if the latest persisted state equals the new state (no new transition)
474-
iflen(latestAppStatus)>0&&latestAppStatus[0].State==database.WorkspaceAppStatusState(newAppStatus) {
475-
return
476-
}
469+
task,err:=api.Database.GetTaskByID(ctx,workspace.TaskID.UUID)
470+
iferr!=nil {
471+
api.Logger.Warn(ctx,"failed to get task",slog.Error(err))
472+
return
473+
}
477474

478-
// Skip the initial "Working" notification when task first starts.
479-
// This is obvious to the user since they just created the task.
480-
// We still notify on first "Idle" status and all subsequent transitions.
481-
iflen(latestAppStatus)==0&&newAppStatus==codersdk.WorkspaceAppStatusStateWorking {
482-
return
483-
}
475+
if!task.WorkspaceAppID.Valid||task.WorkspaceAppID.UUID!=appID {
476+
// Non-task app, do nothing.
477+
return
478+
}
484479

485-
// Use the task prompt as the "task" label, fallback to workspace name
486-
parameters,err:=api.Database.GetWorkspaceBuildParameters(ctx,workspaceBuild.ID)
487-
iferr!=nil {
488-
api.Logger.Warn(ctx,"failed to get workspace build parameters",slog.Error(err))
489-
return
490-
}
491-
taskName:=workspace.Name
492-
for_,param:=rangeparameters {
493-
ifparam.Name==codersdk.AITaskPromptParameterName {
494-
taskName=param.Value
495-
}
496-
}
480+
// Skip if the latest persisted state equals the new state (no new transition)
481+
iflen(latestAppStatus)>0&&latestAppStatus[0].State==database.WorkspaceAppStatusState(newAppStatus) {
482+
return
483+
}
497484

498-
// As task prompt may be particularly long, truncate it to 160 characters for notifications.
499-
iflen(taskName)>160 {
500-
taskName=strutil.Truncate(taskName,160,strutil.TruncateWithEllipsis,strutil.TruncateWithFullWords)
501-
}
485+
// Skip the initial "Working" notification when task first starts.
486+
// This is obvious to the user since they just created the task.
487+
// We still notify on first "Idle" status and all subsequent transitions.
488+
iflen(latestAppStatus)==0&&newAppStatus==codersdk.WorkspaceAppStatusStateWorking {
489+
return
490+
}
502491

503-
if_,err:=api.NotificationsEnqueuer.EnqueueWithData(
504-
// nolint:gocritic // Need notifier actor to enqueue notifications
505-
dbauthz.AsNotifier(ctx),
506-
workspace.OwnerID,
507-
notificationTemplate,
508-
map[string]string{
509-
"task":taskName,
510-
"workspace":workspace.Name,
511-
},
512-
map[string]any{
513-
// Use a 1-minute bucketed timestamp to bypass per-day dedupe,
514-
// allowing identical content to resend within the same day
515-
// (but not more than once every 10s).
516-
"dedupe_bypass_ts":api.Clock.Now().UTC().Truncate(time.Minute),
517-
},
518-
"api-workspace-agent-app-status",
519-
// Associate this notification with related entities
520-
workspace.ID,workspace.OwnerID,workspace.OrganizationID,appID,
521-
);err!=nil {
522-
api.Logger.Warn(ctx,"failed to notify of task state",slog.Error(err))
523-
return
524-
}
492+
if_,err:=api.NotificationsEnqueuer.EnqueueWithData(
493+
// nolint:gocritic // Need notifier actor to enqueue notifications
494+
dbauthz.AsNotifier(ctx),
495+
workspace.OwnerID,
496+
notificationTemplate,
497+
map[string]string{
498+
"task":task.Name,
499+
"workspace":workspace.Name,
500+
},
501+
map[string]any{
502+
// Use a 1-minute bucketed timestamp to bypass per-day dedupe,
503+
// allowing identical content to resend within the same day
504+
// (but not more than once every 10s).
505+
"dedupe_bypass_ts":api.Clock.Now().UTC().Truncate(time.Minute),
506+
},
507+
"api-workspace-agent-app-status",
508+
// Associate this notification with related entities
509+
workspace.ID,workspace.OwnerID,workspace.OrganizationID,appID,
510+
);err!=nil {
511+
api.Logger.Warn(ctx,"failed to notify of task state",slog.Error(err))
512+
return
525513
}
526514
}
527515

0 commit comments

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