feat: support devcontainer agents in ui and unify backend #18332

mafredri · 2025-06-11T17:41:39Z

This PR adds consolidates two container endpoints on the backend and improves the frontend devcontainer support by showing names and displaying apps as appropriate.

With this change, the frontend now has knowledge of the subagent and we can also display things like port forwards.

The frontend was updated to show dev container labels on the border as well as subagent connection status. The recreation flow was also adjusted a bit to show placeholder app icons when relevant.

Support for apps was also added, although these are still WIP on the backend. And the port forwarding utility was added in since the sub agents now provide the necessary info.

Fixes coder/internal#666

DanielleMaywood

haven't managed to read all the Go yet but will read it by Monday

site/src/modules/resources/SubAgentOutdatedTooltip.tsx

site/src/modules/resources/AgentDevcontainerCard.tsx

codersdk/workspaceagents.go

johnstcn · 2025-06-16T08:45:54Z

agent/agentcontainers/api.go

+	for _, id := range subAgentIDs {
+		err := api.subAgentClient.Delete(deleteCtx, id)
+		if err != nil {
+			api.logger.Error(api.ctx, "delete subagent record during shutdown failed",
+				slog.Error(err),
+				slog.F("agent_id", id),
+			)
+		}
+	}


Suggestion: should we do this in parallel instead?

What's the argument for doing it in parallel? My gut feeling is I want to avoid spamming coderd. If this is something we want, we should allow deleting multiple agents in one request instead. // cc @DanielleMaywood

Main argument is to reduce time to shutdown. Currently it is worst case maximum len(subAgentIDs) * deleteCtx timeout. Not a blocker though.

Gotcha 👍🏻. It's btw just 1 * deleteCtx timeout, we give up on deleting the rest if it takes too long.

Gotcha. That may be another argument for doing multiple at once - I'd pefer it to be all or nothing.

agent/agentcontainers/api.go

BrunoQuaresma · 2025-06-16T12:13:53Z

site/src/api/typesGenerated.ts

+}
+
+// From codersdk/workspaceagents.go
+export interface WorkspaceAgentDevcontainerAgent {


This name sounds confusing to me 🤔. From my understanding, we have two agents, WorkspaceAgent, and Devcontainer Agent, is that correct? If yes, why not call DevcontainerAgent to simplify the naming?

I think prefixing the resource names, when not necessary, a bad practice, but I see we do that in a lot of places in coderd, so it is not a blocker, but I would like to bring attention to it.

I do see your point. Technically I suppose "Workspace" in "WorkspaceAgent" is also somehwhat useless. The main idea with this is to follow existing naming conventions but also to symbolize the dependency tree. A devcontainer agent (a workspace agents subagent) cannot exist without a (parent) workspace agent. Hence it is nested in the naming. Another existing type like WorkspaceAgentContainer also already exists so I don't think it's worth diverging right now without a plan for how to tackle existing names.

site/src/modules/resources/AgentApps/AgentApps.tsx

site/src/modules/resources/AgentDevcontainerCard.tsx

BrunoQuaresma · 2025-06-16T12:31:43Z

site/src/modules/resources/AgentDevcontainerCard.tsx

+	const handleRebuildDevcontainer = async () => {
+		setIsRebuilding(true);
+		setSubAgentRemoved(true);
+		let rebuildSucceeded = false;
 		try {
 			const response = await fetch(


In the FE, we handle requests in two ways: queries or mutations. In this case, you should wrap this request into a mutation. Here is the docs.

When using a mutation, you can invalidate other queries or update their data to reflect the most recent status, instead of doing it manually, so you wouldn't need the isRebuilding or subAgentRemoved statuses. Here is how you can do it. If you need more examples, you can search in the codebase for "invalidateQueries".

Thanks for the tip! This was superb, actually solved a couple of issues I wanted to address but didn't know how!

f150bad (#18332)

BrunoQuaresma

Left a few comments related to the FE codebase.

johnstcn · 2025-06-16T13:34:04Z

I don't have any blocking comments, but deferring final approval to @DanielleMaywood

mafredri · 2025-06-16T16:05:18Z

site/src/modules/resources/AgentDevcontainerCard.tsx

+		onMutate: async () => {
+			await queryClient.cancelQueries({
+				queryKey: ["agents", parentAgent.id, "containers"],
+			});
+
+			// Snapshot the previous data for rollback in case of error.
+			const previousData = queryClient.getQueryData([
+				"agents",
+				parentAgent.id,
+				"containers",
+			]);
+
+			// Optimistically update the devcontainer status to
+			// "starting" and zero the agent and container to mimic what
+			// the API does.
+			queryClient.setQueryData(
+				["agents", parentAgent.id, "containers"],
+				(oldData?: WorkspaceAgentListContainersResponse) => {
+					if (!oldData?.devcontainers) return oldData;
+					return {
+						...oldData,
+						devcontainers: oldData.devcontainers.map((dc) => {
+							if (dc.id === devcontainer.id) {
+								return {
+									...dc,
+									agent: null,
+									container: null,
+									status: "starting",
+								};
+							}
+							return dc;
+						}),
+					};
+				},
+			);
+
+			return { previousData };
+		},


@BrunoQuaresma should I keep or remove this? It essentially just leads to a slightly faster UI response.

It is up to you! If you think this faster UI experience, worth the amount of code/complexity, go for it.

Ok, I think it's a bit better and without it's dependent on ping between user <-> coderd <-> agent, so let's keep for now. Pretty easy to eliminate if it becomes a burden. 👍🏻

johnstcn

Reviewed the backend changes, nothing blocking 👍 Nice work!

agent/agentcontainers/api.go

johnstcn · 2025-06-17T09:45:58Z

agent/agentcontainers/api.go

-// handleDevcontainersList handles the HTTP request to list known devcontainers.
-func (api *API) handleDevcontainersList(w http.ResponseWriter, r *http.Request) {
-	ctx := r.Context()
-
-	api.mu.RLock()
-	err := api.containersErr
-	devcontainers := make([]codersdk.WorkspaceAgentDevcontainer, 0, len(api.knownDevcontainers))
-	for _, dc := range api.knownDevcontainers {
-		devcontainers = append(devcontainers, dc)
-	}
-	api.mu.RUnlock()
-	if err != nil {
-		httpapi.Write(ctx, w, http.StatusInternalServerError, codersdk.Response{
-			Message: "Could not list containers",
-			Detail:  err.Error(),
-		})
-		return
-	}
-
-	slices.SortFunc(devcontainers, func(a, b codersdk.WorkspaceAgentDevcontainer) int {
-		if cmp := strings.Compare(a.WorkspaceFolder, b.WorkspaceFolder); cmp != 0 {
-			return cmp
-		}
-		return strings.Compare(a.ConfigPath, b.ConfigPath)
-	})
-
-	response := codersdk.WorkspaceAgentDevcontainersResponse{
-		Devcontainers: devcontainers,
-	}
-
-	httpapi.Write(ctx, w, http.StatusOK, response)
-}
-


This is replaced by api.handleList now?

Yes 👍🏻

johnstcn · 2025-06-17T09:46:47Z

agent/agentcontainers/api.go

+		err = api.subAgentClient.Delete(ctx, proc.agent.ID)
+		if err != nil {
+			return xerrors.Errorf("delete existing subagent failed: %w", err)
+		}


as discussed: this maybe becomes a soft-delete or a conditional re-use if the apps match

codersdk/workspaceagents.go

Co-authored-by: Cian Johnston <cian@coder.com>

Updates #18332

github-actions bot assigned mafredri Jun 11, 2025

mafredri added 10 commits June 13, 2025 16:47

backend

765c2cf

ui-1

4019358

backend-2

452dbc9

ui-2

6a23998

backend-3

ee3ed36

ui-3

fc1a90a

ui-wip

88ce78f

ui-wip2

b1431a3

backend fix test after rebase

2c2bf28

ui-final?

18e1593

mafredri force-pushed the mafredri/feat-agent-devcontainer-injection-6 branch from c9f4ca4 to 18e1593 Compare June 13, 2025 17:35

mafredri changed the title ~~feat: expand devcontainer subagent support in ui and improve backend~~ feat: support devcontainer agents in ui and unify backend Jun 13, 2025

mafredri force-pushed the mafredri/feat-agent-devcontainer-injection-6 branch 2 times, most recently from fc1a236 to 414b6f4 Compare June 13, 2025 18:44

mafredri added 3 commits June 13, 2025 19:05

oh no I accidentally the coercion

df28ff9

site: remove circ dependency

9f69f69

site: add tests

ecfe483

mafredri force-pushed the mafredri/feat-agent-devcontainer-injection-6 branch from 414b6f4 to ecfe483 Compare June 13, 2025 19:06

mafredri added 3 commits June 13, 2025 19:12

whelp

71c61b6

tweak app display

2e1c31f

add port forward test

7e41c15

mafredri requested review from BrunoQuaresma, johnstcn and DanielleMaywood June 13, 2025 20:00

mafredri marked this pull request as ready for review June 13, 2025 20:00

cleanup

79e1844

mafredri force-pushed the mafredri/feat-agent-devcontainer-injection-6 branch from 8f12d26 to 79e1844 Compare June 13, 2025 20:08

DanielleMaywood requested changes Jun 13, 2025

View reviewed changes

site/src/modules/resources/SubAgentOutdatedTooltip.tsx Outdated Show resolved Hide resolved

site/src/modules/resources/SubAgentOutdatedTooltip.tsx Outdated Show resolved Hide resolved

site/src/modules/resources/AgentDevcontainerCard.tsx Outdated Show resolved Hide resolved

dont show content (due to margin) when there are no apps

8ce0aec

mafredri force-pushed the mafredri/feat-agent-devcontainer-injection-6 branch from abc9999 to d4f208b Compare June 16, 2025 08:48

mafredri requested a review from DanielleMaywood June 16, 2025 08:49

johnstcn reviewed Jun 16, 2025

View reviewed changes

mafredri added 2 commits June 16, 2025 09:36

review comments

7e5ede0

add comment about idempotency

7a3674a

BrunoQuaresma reviewed Jun 16, 2025

View reviewed changes

site/src/modules/resources/AgentApps/AgentApps.tsx Outdated Show resolved Hide resolved

BrunoQuaresma reviewed Jun 16, 2025

View reviewed changes

site/src/modules/resources/AgentDevcontainerCard.tsx Outdated Show resolved Hide resolved

BrunoQuaresma reviewed Jun 16, 2025

View reviewed changes

switch -> if

c0607b1

mafredri added 2 commits June 16, 2025 13:39

rename apps to agentapps

e1ea4bf

refactor to use mutation

f150bad

mafredri force-pushed the mafredri/feat-agent-devcontainer-injection-6 branch from 4032530 to f150bad Compare June 16, 2025 15:59

mafredri commented Jun 16, 2025

View reviewed changes

adjust refetch trigger

2b22ee2

johnstcn approved these changes Jun 17, 2025

View reviewed changes

mafredri and others added 3 commits June 17, 2025 09:58

fix linter

4b9d218

Update agent/agentcontainers/api.go

e021c8d

Co-authored-by: Cian Johnston <cian@coder.com>

clarify todo

0c44de8

DanielleMaywood approved these changes Jun 17, 2025

View reviewed changes

mafredri added a commit that referenced this pull request Jun 17, 2025

fix(agent/agentcontainers): reduce need to recreate sub agents

d496771

Updates #18332

mafredri mentioned this pull request Jun 17, 2025

fix(agent/agentcontainers): reduce need to recreate sub agents #18402

Open

mafredri added a commit that referenced this pull request Jun 17, 2025

fix(agent/agentcontainers): reduce need to recreate sub agents

bea0596

Updates #18332

mafredri added a commit that referenced this pull request Jun 17, 2025

fix(agent/agentcontainers): reduce need to recreate sub agents

2391dae

Updates #18332

mafredri added a commit that referenced this pull request Jun 17, 2025

fix(agent/agentcontainers): reduce need to recreate sub agents

2ec5a58

Updates #18332

mafredri merged commit 97474bb into main Jun 17, 2025
39 checks passed

mafredri deleted the mafredri/feat-agent-devcontainer-injection-6 branch June 17, 2025 13:06

github-actions bot locked and limited conversation to collaborators Jun 17, 2025

feat: support devcontainer agents in ui and unify backend #18332

feat: support devcontainer agents in ui and unify backend #18332

Conversation

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

Uh oh!

Uh oh!

DanielleMaywood left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

johnstcn Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BrunoQuaresma Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

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!

BrunoQuaresma left a comment

Choose a reason for hiding this comment

Uh oh!

johnstcn commented Jun 16, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Choose a reason for hiding this comment

Uh oh!

johnstcn left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

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!

Uh oh!

Uh oh!

Uh oh!

mafredri commented Jun 11, 2025 •

edited

Loading

johnstcn Jun 16, 2025 •

edited

Loading

mafredri Jun 16, 2025 •

edited

Loading

BrunoQuaresma Jun 16, 2025 •

edited

Loading

mafredri Jun 16, 2025 •

edited

Loading