feat(site): use new task data model and endpoints #20431

mafredri · 2025-10-23T08:12:31Z

Updates the UI to use the new API endpoints for tasks and use its new data model.

Disclaimer: Since the base data model for tasks changed, we had to do a quite large refactor and I'm sorry for that 🙏, but you'll notice most of the changes are to adjust the types.

Closes coder/internal#976

mafredri · 2025-10-23T08:12:59Z

feat(site): use new task data model and endpoints #20431 👈 (View in Graphite)
chore(codersdk): document TaskStatus and TaskState #20441
chore(coderd/database/migrations): migrate tasks to new data model #20434 : 1 other dependent PR (#20334 )
main

This stack of pull requests is managed by Graphite. Learn more about stacking.

buenos-nachos

Nothing major stuck out to me for the frontend changes, but I did have a few questions.

The main thing that stuck out to me was whether we can stop polling every five seconds for some of the tasks, or if that's something we absolutely need for UX

buenos-nachos · 2025-10-23T16:33:50Z

site/src/api/api.ts

+	getTasks = async (
+		filter: TypesGen.TasksFilter,
+	): Promise<readonly TypesGen.Task[]> => {
+		const query = [];


Nit: can we type this as string[]?

buenos-nachos · 2025-10-23T16:41:36Z

site/src/modules/apps/apps.ts

+export type WorkspaceAppWithAgent = WorkspaceApp & {
+	agent: WorkspaceAgent;
+};


Nit: I know this is used in a few other files, but just because this is only used in one spot for this file, I'd move the type definition to be closer to where it's used, especially since it's more of a "kludge" type

Moved to modules/tasks/apps.ts

buenos-nachos · 2025-10-23T19:04:17Z

site/src/modules/apps/apps.ts

+	return workspace.latest_build.resources
+		.flatMap((r) => r.agents ?? [])
+		.flatMap((agent) =>
+			agent.apps.map((app) => ({
+				...app,
+				agent,
+			})),
+		);


I wish I knew a little bit more of Coder's backend implementations so I didn't have to ask this: are the same apps able to be shared across multiple agents? I'm wondering if we need any de-duplication

No, a workspace_app is linked to a single workspace_agent.

Yes. We can change this function to accept an agent ID, but the agent ID can be null depending on the state. Unfortunately, sice Go does not support uninon types, we need to update the code in a few places to handle that. Since we are quite out of time for this, I'm going to skip it for now.

buenos-nachos · 2025-10-23T19:09:41Z

site/src/modules/dashboard/Navbar/NavbarView.tsx

+	const filter: TypesGen.TasksFilter = {
+		owner: user.username,
 	};


We should be able to extract it outside of the component so it doesn't get recreated each render

Not sure if I go it... the filter needs to be mounted inside of the component, so we can access the user.username 🤔

buenos-nachos · 2025-10-23T19:13:17Z

site/src/modules/tasks/TasksSidebar/TasksSidebar.stories.tsx

+				path: `/tasks/${MockTasks[0].owner_name}/${MockTasks[0].id}`,
 				pathParams: {
-					workspace: MockTasks[0].workspace.name,
+					owner_name: MockTasks[0].owner_name,
+					task: MockTasks[0].id,


Not a huge deal, but I'm wondering if we can:

Split off the first mock task into a separate variable

Put the variable in the array at the first position still

Export the variable along with the array

It's not a big deal for a story, but in production, I would want to make sure that when we're dealing with empty arrays properly (and our tsconfig file isn't tuned tightly enough to catch potential mismatches at the type level)

buenos-nachos · 2025-10-23T19:42:05Z

site/src/pages/TaskPage/TaskPage.tsx

+		refetchInterval: ({ state }) => {
+			return state.error ? false : 5_000;
+		},


Do we want this to be constantly refetching? Because even if all tasks are settled, we'll still refetch every five seconds, as long as there is no error

Yes, because task has statuses and states that are updated during its lifecycle.

buenos-nachos · 2025-10-23T19:42:24Z

site/src/pages/TaskPage/TaskPage.tsx

+		refetchInterval: ({ state }) => {
+			return state.error ? false : 5_000;
+		},


Same question here

buenos-nachos · 2025-10-23T19:47:09Z

site/src/pages/TaskPage/TaskPage.tsx

+		queryKey: ["workspace", workspace.id, "parameters"],
+		queryFn: () => API.getWorkspaceParameters(workspace),


I feel like the API setup is a little bit off here. The API function only needs the workspace's latest build, but we're not putting it in the query key, and we're also putting in the workspace's ID, which isn't used by the function at all

Wondering if it might be worth changing what the API function accepts at input to minimize its dependencies

I do agree with you, but we are doing this in three other places in the codebase, so I'm not going to touch this right now, since it would be outside of the scope.

buenos-nachos · 2025-10-23T19:49:51Z

site/src/pages/TaskPage/TaskPage.tsx

-		if (
-			workspace.latest_build.job.completed_at &&
-			!workspace.latest_build.has_ai_task
-		) {
-			throw new WorkspaceDoesNotHaveAITaskError(workspace);
-		}


Do we need equivalent functionality still, or do we have guarantees that we'll never trigger it?

We've inverted the relationship, there is now a tasks table with a workspace_id column.

buenos-nachos · 2025-10-23T19:54:10Z

site/src/pages/TasksPage/TasksPage.stories.tsx

+				current_state: {
+					...(firstTask.current_state as TaskStateEntry),
+					state: "idle",


Instead of doing the type assertion, could we pass a function to mockResolvedValue, and have it throw an error if firstTask.current_state is null?

johnstcn

Backend changes LGTM

johnstcn · 2025-10-24T09:09:18Z

codersdk/aitasks.go

 	TemplateDisplayName     string                   `json:"template_display_name" table:"template display name"`
 	TemplateIcon            string                   `json:"template_icon" table:"template icon"`
 	WorkspaceID             uuid.NullUUID            `json:"workspace_id" format:"uuid" table:"workspace id"`
+	WorkspaceName           string                   `json:"workspace_name" table:"workspace name"`


Might be good to add some asserts for this in coderd/aitasks_test.go e.g. in TestTasks/{Get,List}.

mafredri

BE changes look good 👍🏻

mafredri · 2025-10-24T09:42:59Z

codersdk/aitasks.go

 	FilterQuery string `json:"filter_query,omitempty"`
 }

+// Experimental response shape for tasks list (server returns []Task).


Suggested change

// Experimental response shape for tasks list (server returns []Task).

// TaskListResponse is the response shape for tasks list.

//

// Experimental: This type is experimental and may change in the future.

…ite-use-new-tasks-data-model-and-endpoints

This was referenced Oct 23, 2025

feat(coderd): use task data model when creating a new task #20275

Merged

feat(coderd): use new data model for task delete #20334

Merged

github-actions bot assigned mafredri Oct 23, 2025

This was referenced Oct 23, 2025

feat(coderd): use task data model when fetching a task #20380

Merged

feat(coderd): use task data model for send/logs #20381

Merged

feat(coderd): use task data model for list #20394

Merged

mafredri mentioned this pull request Oct 23, 2025

chore(scripts/rules.go): ignore db imports in _test.go files #20406

Merged

mafredri force-pushed the refactor-site-use-new-tasks-data-model-and-endpoints branch from 5f883dd to 1e0548c Compare October 23, 2025 08:32

mafredri changed the base branch from mafredri/refactor-coderd-use-tasks-data-model-in-list to graphite-base/20431 October 23, 2025 08:37

This was referenced Oct 23, 2025

chore(coderd/database/migrations): migrate tasks to new data model #20434

Merged

chore(codersdk): document TaskStatus and TaskState #20441

Merged

mafredri force-pushed the refactor-site-use-new-tasks-data-model-and-endpoints branch from eea8ed5 to 6d13866 Compare October 23, 2025 15:34

mafredri force-pushed the graphite-base/20431 branch from 5fc4328 to 17fddfa Compare October 23, 2025 15:34

mafredri changed the base branch from graphite-base/20431 to mafredri/chore-codersdk-document-taskstatus-and-taskstate October 23, 2025 15:35

mafredri marked this pull request as ready for review October 23, 2025 15:51

mafredri requested review from aslilac and buenos-nachos as code owners October 23, 2025 15:51

mafredri force-pushed the mafredri/chore-codersdk-document-taskstatus-and-taskstate branch 3 times, most recently from e1f7b87 to 0554fd1 Compare October 23, 2025 16:32

mafredri force-pushed the refactor-site-use-new-tasks-data-model-and-endpoints branch from bd91d75 to d530c4d Compare October 23, 2025 16:41

mafredri changed the base branch from mafredri/chore-codersdk-document-taskstatus-and-taskstate to mafredri/refactor-coderd-use-tasks-data-model-in-list October 23, 2025 16:44

mafredri force-pushed the refactor-site-use-new-tasks-data-model-and-endpoints branch from d530c4d to c9f1efd Compare October 23, 2025 16:46

mafredri force-pushed the mafredri/refactor-coderd-use-tasks-data-model-in-list branch 3 times, most recently from 9220413 to e605686 Compare October 23, 2025 17:11

Base automatically changed from mafredri/refactor-coderd-use-tasks-data-model-in-list to main October 23, 2025 17:22

BrunoQuaresma added 2 commits October 23, 2025 17:23

Migrate task list

df19ab6

refactor tasks sidebar

3ca3149

BrunoQuaresma added 3 commits October 23, 2025 17:23

migrate task page

9253464

fix type errors

6f606e1

fix failed tests

aecddaf

mafredri force-pushed the refactor-site-use-new-tasks-data-model-and-endpoints branch from c9f1efd to aecddaf Compare October 23, 2025 17:23

BrunoQuaresma assigned BrunoQuaresma and unassigned mafredri Oct 23, 2025

BrunoQuaresma added 2 commits October 23, 2025 18:18

minor fixes

d8793de

minor fixes

208038f

BrunoQuaresma requested a review from a team October 23, 2025 18:48

fix storybook

88163b1

buenos-nachos reviewed Oct 23, 2025

View reviewed changes

johnstcn approved these changes Oct 24, 2025

View reviewed changes

mafredri commented Oct 24, 2025

View reviewed changes

mafredri mentioned this pull request Oct 24, 2025

chore: tasks: refactor existing API endpoints to use new data model coder/internal#976

Closed

6 tasks

BrunoQuaresma added 4 commits October 24, 2025 13:04

Apply code reviews

8dfac84

Merge branch 'main' of https://github.com/coder/coder into refactor-s…

c2ea700

…ite-use-new-tasks-data-model-and-endpoints

fix taskId

c7c605e

fix taskId

1973a7d

BrunoQuaresma merged commit 51d3abb into main Oct 24, 2025
31 checks passed

BrunoQuaresma deleted the refactor-site-use-new-tasks-data-model-and-endpoints branch October 24, 2025 13:45

github-actions bot locked and limited conversation to collaborators Oct 24, 2025

		queryKey: ["workspace", workspace.id, "parameters"],
		queryFn: () => API.getWorkspaceParameters(workspace),

-// Experimental response shape for tasks list (server returns []Task).
+// TaskListResponse is the response shape for tasks list.
+//
+// Experimental: This type is experimental and may change in the future.

feat(site): use new task data model and endpoints #20431

feat(site): use new task data model and endpoints #20431

Uh oh!

Conversation

mafredri commented Oct 23, 2025 • edited by BrunoQuaresma Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mafredri commented Oct 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

buenos-nachos left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

johnstcn left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mafredri left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

mafredri commented Oct 23, 2025 •

edited by BrunoQuaresma

Loading

mafredri commented Oct 23, 2025 •

edited

Loading