feat(agent/agentcontainers): support apps for dev container agents #18346

DanielleMaywood · 2025-06-12T16:28:58Z

Add apps to the sub agent based on the dev container customization.

{
  "name": "Development Container",
  "image": "mcr.microsoft.com/devcontainers/typescript-node:18",
  "customizations": {
    "coder": {
      "apps": [
        {
          "slug": "web-app",
          "displayName": "Web Application",
          "url": "http://localhost:8080/${localEnv:CODER_USER_NAME}/${localEnv:CODER_WORKSPACE_NAME}/${localEnv:CODER_AGENT_NAME}",
          "openIn": "tab",
          "share": "owner",
          "icon": "${localEnv:CODER_URL}/icons/web.svg",
          "order": 1,
          "group": "Web Editors"
        }
      ]
    }
  }
}

The implementation also provides the following env variables for use in the devcontainer json

CODER_WORKSPACE_AGENT_NAME
CODER_WORKSPACE_USER_NAME
CODER_WORKSPACE_NAME
CODER_URL

Copilot

Pull Request Overview

This PR adds support for passing app definitions to sub agents based on dev container customizations and updates related tests and API integrations.

Extends the API to accept new app-related configuration options.
Adds new tests for sub-agent apps functionality and updates environment variable handling in the devcontainer CLI.
Updates various components (API, client, tests, and mocks) to support the new apps configuration.

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
agent/api.go	Appends options for user and workspace names and devcontainer apps; injects environment variables.
agent/agenttest/client.go	Introduces GetSubAgentApps for retrieving app definitions.
agent/agentcontainers/subagent_test.go	Adds tests for sub-agent creation with app configurations.
agent/agentcontainers/subagent.go	Extends the SubAgent struct and converts app configuration for API calls.
agent/agentcontainers/devcontainercli_test.go	Updates devcontainer CLI test to include an explicit env argument.
agent/agentcontainers/devcontainercli.go	Adds environment variables to CLI commands.
agent/agentcontainers/api_test.go	Updates tests to include env validations for sub-agent app settings.
agent/agentcontainers/acmock/acmock.go	Adjusts mock method signatures to include the new env arg.

Comments suppressed due to low confidence (1)

agent/api.go

mafredri

I still need to take a closer look at the tests, but I identified some things that may require some refactoring.

agent/agentcontainers/subagent.go

mafredri · 2025-06-18T11:01:07Z

agent/agentcontainers/api.go

+				fmt.Sprintf("CODER_WORKSPACE_AGENT_NAME=%s", dc.Name),
+				fmt.Sprintf("CODER_WORKSPACE_OWNER_NAME=%s", api.userName),
+				fmt.Sprintf("CODER_WORKSPACE_NAME=%s", api.workspaceName),
+				fmt.Sprintf("CODER_DEPLOYMENT_URL=%s", api.subAgentURL),


Suggested change

fmt.Sprintf("CODER_DEPLOYMENT_URL=%s", api.subAgentURL),

fmt.Sprintf("CODER_AGENT_URL=%s", api.subAgentURL),

The naming is slightly unfortunate but we currently have both CODER_URL and CODER_AGENT_URL in the product, and a third one seems like too much.

IMO CODER_URL would be more appropriate, however, it would be nice if these environment variables were also set on the parent workspace/agent (with CODER_AGENT_URL we're at 3/4). The reason is that if a user runs devcontainer up manually, these values are then serializable into the docker container label.

I've replaced it with CODER_URL. If you'd rather CODER_AGENT_URL I'm happy to update it again.

I don't think we can rely on anything serialized at the point of devcontainer up, as the CODER_WORKSPACE_AGENT_NAME will be the parents agent name, not the child. So I'm not sure there is too much benefit there.

Yeah, that's a good point about the conflicting env. Let's go with CODER_URL for now 👍🏻

agent/agentcontainers/api.go

mafredri · 2025-06-18T11:08:09Z

agent/api.go

+		if manifest != nil {
+			containerAPIOpts = append(containerAPIOpts,
+				agentcontainers.WithUserName(manifest.OwnerName),
+				agentcontainers.WithWorkspaceName(manifest.WorkspaceName),


It'd be nice to consolidate similar things rather than having too many knobs, perhaps a agentcontainers.WithManifestInfo(url, owner, workspace)? (I'm aware my naming suggestion could've been better 😅.)

johnstcn · 2025-06-18T11:36:47Z

agent/agentcontainers/api.go

@@ -153,6 +156,15 @@ func WithSubAgentEnv(env ...string) Option {
 	}
 }

+// WithManifestInfo sets the owner name, and workspace name
+// for the sub-agent.
+func WithManifestInfo(owner, workspace string) Option {


nit: the naming suggests you can pass in the entire manifest?

johnstcn · 2025-06-18T11:37:34Z

agent/agentcontainers/api.go

+				fmt.Sprintf("CODER_WORKSPACE_AGENT_NAME=%s", dc.Name),
+				fmt.Sprintf("CODER_WORKSPACE_OWNER_NAME=%s", api.ownerName),
+				fmt.Sprintf("CODER_WORKSPACE_NAME=%s", api.workspaceName),
+				fmt.Sprintf("CODER_URL=%s", api.subAgentURL),


Note for later: we'll need to document these environment variables somewhere.

agent/agentcontainers/devcontainercli.go

agent/agentcontainers/api.go

mafredri

A few more things but other than that, looks good, nice work!

mafredri · 2025-06-18T13:50:24Z

agent/agentcontainers/api.go

+		if config, err := api.dccli.ReadConfig(ctx, dc.WorkspaceFolder, dc.ConfigPath,
+			[]string{
+				fmt.Sprintf("CODER_WORKSPACE_AGENT_NAME=%s", dc.Name),
+				fmt.Sprintf("CODER_WORKSPACE_OWNER_NAME=%s", api.ownerName),


Can we modify agent/agent.go to set this on the parent as well?

Just to ensure I know what you're referring to:

In this stanza here?

coder/agent/agent.go

Lines 1293 to 1309 in 529fb50

// Define environment variables that should be set for all commands,

// and then merge them with the current environment.

envs := map[string]string{

// Set env vars indicating we're inside a Coder workspace.

"CODER": "true",

"CODER_WORKSPACE_NAME": manifest.WorkspaceName,

"CODER_WORKSPACE_AGENT_NAME": manifest.AgentName,

// Specific Coder subcommands require the agent token exposed!

"CODER_AGENT_TOKEN": *a.sessionToken.Load(),

// Git on Windows resolves with UNIX-style paths.

// If using backslashes, it's unable to find the executable.

"GIT_SSH_COMMAND": fmt.Sprintf("%s gitssh --", unixExecutablePath),

// Hide Coder message on code-server's "Getting Started" page

"CS_DISABLE_GETTING_STARTED_OVERRIDE": "true",

}

mafredri · 2025-06-18T13:52:46Z

agent/agentcontainers/api.go

 		subAgentConfig.DisplayApps = displayApps
+		subAgentConfig.Apps = apps


We should log app creation errors from the response after agent creation too.

mafredri · 2025-06-18T13:54:16Z

agent/agentcontainers/subagent.go

+		Hidden:    &app.Hidden,
+		Order:     &app.Order,
+		Subdomain: &app.Subdomain,
+	}


Did we check to see what the "defaults" when creating apps in terraform?

mafredri · 2025-06-18T13:56:14Z

agent/agentcontainers/subagent.go

+	URL         string                            `json:"url"`
+}
+
+func (app SubAgentApp) ToProtoApp() (*agentproto.CreateSubAgentRequest_App, error) {


Comment: Typically these methods exist in agentsdk/convert.go. Personally I think it makes sense to keep here though.

github-actions bot assigned DanielleMaywood Jun 12, 2025

DanielleMaywood force-pushed the dm-sub-agent-apps-configuration-2 branch from d06023f to 08f0f9c Compare June 12, 2025 19:47

Base automatically changed from dm-sub-agent-apps-configuration to main June 12, 2025 22:36

DanielleMaywood force-pushed the dm-sub-agent-apps-configuration-2 branch from 08f0f9c to 6270098 Compare June 12, 2025 22:42

DanielleMaywood requested a review from Copilot June 12, 2025 22:43

This comment was marked as outdated.

Sign in to view

DanielleMaywood force-pushed the dm-sub-agent-apps-configuration-2 branch 3 times, most recently from c3ba85a to c800571 Compare June 17, 2025 16:07

DanielleMaywood added 7 commits June 18, 2025 10:14

feat(agent/agentcontainers): support apps for dev container agents

eb8a469

chore: copilot feedback

0dc5bb2

chore: more changes

bcd6689

chore: pass env variables + remove accidental commit

91fd4e7

chore: fix some tests

c273b23

chore: fix issues

8698100

chore: fix and update test

8ec61b6

DanielleMaywood force-pushed the dm-sub-agent-apps-configuration-2 branch from 75709b9 to 8ec61b6 Compare June 18, 2025 10:14

DanielleMaywood requested a review from Copilot June 18, 2025 10:14

Copilot AI reviewed Jun 18, 2025

View reviewed changes

agent/api.go Show resolved Hide resolved

chore: fix oopsie

ab2e82e

DanielleMaywood marked this pull request as ready for review June 18, 2025 10:28

test: add organization sharing level

4db77af

DanielleMaywood requested review from mafredri and johnstcn June 18, 2025 10:39

mafredri reviewed Jun 18, 2025

View reviewed changes

DanielleMaywood added 4 commits June 18, 2025 11:31

chore: CODER_DEPLOYMENT_URL -> CODER_URL

d3a2583

chore: remove all the pointers

20e832a

chore: handle in CloneConfig as well

336997b

chore: rename WithUserName and WithWorkspaceName to WithManifestInfo

0ae2616

johnstcn reviewed Jun 18, 2025

View reviewed changes

DanielleMaywood added 3 commits June 18, 2025 11:50

chore: just use PATH

e17b228

chore: app deduplication

d1da3a1

chore: appease linter

c6652a1

johnstcn approved these changes Jun 18, 2025

View reviewed changes

agent/agentcontainers/api.go Show resolved Hide resolved

DanielleMaywood merged commit 529fb50 into main Jun 18, 2025
34 checks passed

DanielleMaywood deleted the dm-sub-agent-apps-configuration-2 branch June 18, 2025 13:55

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

mafredri reviewed Jun 18, 2025

View reviewed changes

	fmt.Sprintf("CODER_DEPLOYMENT_URL=%s", api.subAgentURL),
	fmt.Sprintf("CODER_AGENT_URL=%s", api.subAgentURL),

	// Define environment variables that should be set for all commands,
	// and then merge them with the current environment.
	envs := map[string]string{
	// Set env vars indicating we're inside a Coder workspace.
	"CODER": "true",
	"CODER_WORKSPACE_NAME": manifest.WorkspaceName,
	"CODER_WORKSPACE_AGENT_NAME": manifest.AgentName,

	// Specific Coder subcommands require the agent token exposed!
	"CODER_AGENT_TOKEN": *a.sessionToken.Load(),

	// Git on Windows resolves with UNIX-style paths.
	// If using backslashes, it's unable to find the executable.
	"GIT_SSH_COMMAND": fmt.Sprintf("%s gitssh --", unixExecutablePath),
	// Hide Coder message on code-server's "Getting Started" page
	"CS_DISABLE_GETTING_STARTED_OVERRIDE": "true",
	}

		subAgentConfig.DisplayApps = displayApps
		subAgentConfig.Apps = apps

feat(agent/agentcontainers): support apps for dev container agents #18346

feat(agent/agentcontainers): support apps for dev container agents #18346

Uh oh!

Conversation

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

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

mafredri 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!

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 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!

Uh oh!

DanielleMaywood commented Jun 12, 2025 •

edited by mafredri

Loading