8000 feat(agent/agentcontainers): support apps for dev container agents by DanielleMaywood · Pull Request #18346 · coder/coder · GitHub
[go: up one dir, main page]
Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 16 commits into from
Jun 18, 2025
+526 −20
Merged

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

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
eb8a469
feat(agent/agentcontainers): support apps for dev container agents
DanielleMaywood Jun 12, 2025
0dc5bb2
chore: copilot feedback
DanielleMaywood Jun 12, 2025
bcd6689
chore: more changes
DanielleMaywood Jun 13, 2025
91fd4e7
chore: pass env variables + remove accidental commit
DanielleMaywood Jun 13, 2025
c273b23
chore: fix some tests
DanielleMaywood Jun 13, 2025
8698100
chore: fix issues
DanielleMaywood Jun 17, 2025
8ec61b6
chore: fix and update test
DanielleMaywood Jun 17, 2025
ab2e82e
chore: fix oopsie
DanielleMaywood Jun 18, 2025
4db77af
test: add organization sharing level
DanielleMaywood Jun 18, 2025
d3a2583
chore: CODER_DEPLOYMENT_URL -> CODER_URL
DanielleMaywood Jun 18, 2025
20e832a
chore: remove all the pointers
DanielleMaywood Jun 18, 2025
336997b
chore: handle in CloneConfig as wel 8000 l
DanielleMaywood Jun 18, 2025
0ae2616
chore: rename WithUserName and WithWorkspaceName to WithManifestInfo
DanielleMaywood Jun 18, 2025
e17b228
chore: just use PATH
DanielleMaywood Jun 18, 2025
d1da3a1
chore: app deduplication
DanielleMaywood Jun 18, 2025
c6652a1
chore: appease linter
DanielleMaywood Jun 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
chore: fix some tests
  • Loading branch information
@DanielleMaywood
DanielleMaywood committed Jun 18, 2025
commit c273b2313810fcae6d5ecc412fbeb39ffcda709d
32 changes: 16 additions & 16 deletions agent/agentcontainers/api_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1319,9 +1319,9 @@ func TestAPI(t *testing.T) {
return nil
}) // Exec pwd.
testutil.RequireSend(ctx, t, fakeDCCLI.readConfigErrC, func(envs []string) (agentcontainers.DevcontainerConfig, error) {
assert.Contains(t, envs, "CODER_AGENT_NAME=test-container")
assert.Contains(t, envs, "CODER_WORKSPACE_AGENT_NAME=test-container")
assert.Contains(t, envs, "CODER_WORKSPACE_NAME=test-workspace")
assert.Contains(t, envs, "CODER_USER_NAME=test-user")
assert.Contains(t, envs, "CODER_WORKSPACE_OWNER_NAME=test-user")
assert.Contains(t, envs, "CODER_DEPLOYMENT_URL=test-subagent-url")
return agentcontainers.DevcontainerConfig{}, nil
})
Expand Down Expand Up @@ -1466,9 +1466,9 @@ func TestAPI(t *testing.T) {
return nil
}) // Exec pwd.
testutil.RequireSend(ctx, t, fakeDCCLI.readConfigErrC, func(envs []string) (agentcontainers.DevcontainerConfig, error) {
assert.Contains(t, envs, "CODER_AGENT_NAME=test-container")
assert.Contains(t, envs, "CODER_WORKSPACE_AGENT_NAME=test-container")
assert.Contains(t, envs, "CODER_WORKSPACE_NAME=test-workspace")
assert.Contains(t, envs, "CODER_USER_NAME=test-user")
assert.Contains(t, envs, "CODER_WORKSPACE_OWNER_NAME=test-user")
assert.Contains(t, envs, "CODER_DEPLOYMENT_URL=test-subagent-url")
return agentcontainers.DevcontainerConfig{}, nil
})
Expand Down Expand Up @@ -1631,17 +1631,17 @@ func TestAPI(t *testing.T) {
Slug: "web-app",
DisplayName: ptr.Ref("Web Application"),
URL: ptr.Ref("http://localhost:8080"),
OpenIn: codersdk.WorkspaceAppOpenInTab,
Share: codersdk.WorkspaceAppSharingLevelOwner,
OpenIn: ptr.Ref(codersdk.WorkspaceAppOpenInTab),
Share: ptr.Ref(codersdk.WorkspaceAppSharingLevelOwner),
Icon: ptr.Ref("/icons/web.svg"),
Order: ptr.Ref(int32(1)),
},
{
Slug: "api-server",
Display 8000 Name: ptr.Ref("API Server"),
URL: ptr.Ref("http://localhost:3000"),
OpenIn: codersdk.WorkspaceAppOpenInSlimWindow,
Share: codersdk.WorkspaceAppSharingLevelAuthenticated,
OpenIn: ptr.Ref(codersdk.WorkspaceAppOpenInSlimWindow),
Share: ptr.Ref(codersdk.WorkspaceAppSharingLevelAuthenticated),
Icon: ptr.Ref("/icons/api.svg"),
Order: ptr.Ref(int32(2)),
Hidden: ptr.Ref(true),
Expand All @@ -1650,8 +1650,8 @@ func TestAPI(t *testing.T) {
Slug: "docs",
DisplayName: ptr.Ref("Documentation"),
URL: ptr.Ref("http://localhost:4000"),
OpenIn: codersdk.WorkspaceAppOpenInTab,
Share: codersdk.WorkspaceAppSharingLevelPublic,
OpenIn: ptr.Ref(codersdk.WorkspaceAppOpenInTab),
Share: ptr.Ref(codersdk.WorkspaceAppSharingLevelPublic),
Icon: ptr.Ref("/icons/book.svg"),
Order: ptr.Ref(int32(3)),
},
Expand All @@ -1665,17 +1665,17 @@ func TestAPI(t *testing.T) {
assert.Equal(t, "web-app", subAgent.Apps[0].Slug)
assert.Equal(t, "Web Application", *subAgent.Apps[0].DisplayName)
assert.Equal(t, "http://localhost:8080", *subAgent.Apps[0].URL)
assert.Equal(t, codersdk.WorkspaceAppOpenInTab, subAgent.Apps[0].OpenIn)
assert.Equal(t, codersdk.WorkspaceAppSharingLevelOwner, subAgent.Apps[0].Share)
assert.Equal(t, codersdk.WorkspaceAppOpenInTab, *subAgent.Apps[0].OpenIn)
assert.Equal(t, codersdk.WorkspaceAppSharingLevelOwner, *subAgent.Apps[0].Share)
assert.Equal(t, "/icons/web.svg", *subAgent.Apps[0].Icon)
assert.Equal(t, int32(1), *subAgent.Apps[0].Order)

// Verify second app
assert.Equal(t, "api-server", subAgent.Apps[1].Slug)
assert.Equal(t, "API Server", *subAgent.Apps[1].DisplayName)
assert.Equal(t, "http://localhost:3000", *subAgent.Apps[1].URL)
assert.Equal(t, codersdk.WorkspaceAppOpenInSlimWindow, subAgent.Apps[1].OpenIn)
assert.Equal(t, codersdk.WorkspaceAppSharingLevelAuthenticated, subAgent.Apps[1].Share)
assert.Equal(t, codersdk.WorkspaceAppOpenInSlimWindow, *subAgent.Apps[1].OpenIn)
assert.Equal(t, codersdk.WorkspaceAppSharingLevelAuthenticated, *subAgent.Apps[1].Share)
assert.Equal(t, "/icons/api.svg", *subAgent.Apps[1].Icon)
assert.Equal(t, int32(2), *subAgent.Apps[1].Order)
assert.Equal(t, true, *subAgent.Apps[1].Hidden)
Expand All @@ -1684,8 +1684,8 @@ func TestAPI(t *testing.T) {
assert.Equal(t, "docs", subAgent.Apps[2].Slug)
assert.Equal(t, "Documentation", *subAgent.Apps[2].DisplayName)
assert.Equal(t, "http://localhost:4000", *subAgent.Apps[2].URL)
assert.Equal(t, codersdk.WorkspaceAppOpenInTab, subAgent.Apps[2].OpenIn)
assert.Equal(t, codersdk.WorkspaceAppSharingLevelPublic, subAgent.Apps[2].Share)
assert.Equal(t, codersdk.WorkspaceAppOpenInTab, *subAgent.Apps[2].OpenIn)
assert.Equal(t, codersdk.WorkspaceAppSharingLevelPublic, *subAgent.Apps[2].Share)
assert.Equal(t, "/icons/book.svg", *subAgent.Apps[2].Icon)
assert.Equal(t, int32(3), *subAgent.Apps[2].Order)
},
Expand Down
3 changes: 2 additions & 1 deletion agent/agentcontainers/devcontainercli.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,8 @@ func (d *devcontainerCLI) ReadConfig(ctx context.Context, workspaceFolder, confi
}

c := d.execer.CommandContext(ctx, "devcontainer", args...)
c.Env = append(os.Environ(), env...)
c.Env = append(c.Env, os.Environ()...)
c.Env = append(c.Env, env...)

var stdoutBuf bytes.Buffer
stdoutWriters := []io.Writer{&stdoutBuf, &devcontainerCLILogWriter{ctx: ctx, logger: logger.With(slog.F("stdout", true))}}
Expand Down
62 changes: 33 additions & 29 deletions agent/agentcontainers/subagent.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,19 +47,19 @@ func (s SubAgent) EqualConfig(other SubAgent) bool {
}

type SubAgentApp struct {
Slug string `json:"slug"`
Command *string `json:"command"`
DisplayName *string `json:"displayName"`
External *bool `json:"external"`
Group *string `json:"group"`
HealthCheck *SubAgentHealthCheck `json:"healthCheck"`
Hidden *bool `json:"hidden"`
Icon *string `json:"icon"`
OpenIn codersdk.WorkspaceAppOpenIn `json:"openIn"`
Order *int32 `json:"order"`
Share codersdk.WorkspaceAppSharingLevel `json:"share"`
Subdomain *bool `json:"subdomain"`
URL *string `json:"url"`
Slug string `json:"slug"`
Command *string `json:"command"`
DisplayName *string `json:"displayName"`
External *bool `json:"external"`
Group *string `json:"group"`
HealthCheck *SubAgentHealthCheck `json:"healthCheck"`
Hidden *bool `json:"hidden"`
Icon *string `json:"icon"`
OpenIn *codersdk.WorkspaceAppOpenIn `json:"openIn"`
Order *int32 `json:"order"`
Share *codersdk.WorkspaceAppSharingLevel `json:"share"`
Subdomain *bool `json:"subdomain"`
URL *string `json:"url"`
}

type SubAgentHealthCheck struct {
Expand Down Expand Up @@ -161,25 +161,29 @@ func (a *subAgentAPIClient) Create(ctx context.Context, agent SubAgent) (SubAgen
}

var openIn *agentproto.CreateSubAgentRequest_App_OpenIn
switch app.OpenIn {
case codersdk.WorkspaceAppOpenInSlimWindow:
openIn = agentproto.CreateSubAgentRequest_App_SLIM_WINDOW.Enum()
case codersdk.WorkspaceAppOpenInTab:
openIn = agentproto.CreateSubAgentRequest_App_TAB.Enum()
default:
return SubAgent{}, xerrors.Errorf("unexpected codersdk.WorkspaceAppOpenIn: %#v", app.OpenIn)
if app.OpenIn != nil {
switch *app.OpenIn {
case codersdk.WorkspaceAppOpenInSlimWindow:
openIn = agentproto.CreateSubAgentRequest_App_SLIM_WINDOW.Enum()
case codersdk.WorkspaceAppOpenInTab:
openIn = agentproto.CreateSubAgentRequest_App_TAB.Enum()
default:
return SubAgent{}, xerrors.Errorf("unexpected codersdk.WorkspaceAppOpenIn: %#v", app.OpenIn)
}
}

var share *agentproto.CreateSubAgentRequest_App_SharingLevel
switch app.Share {
case codersdk.WorkspaceAppSharingLevelAuthenticated:
share = agentproto.CreateSubAgentRequest_App_AUTHENTICATED.Enum()
case codersdk.WorkspaceAppSharingLevelOwner:
share = agentproto.CreateSubAgentRequest_App_OWNER.Enum()
case codersdk.WorkspaceAppSharingLevelPublic:
share = agentproto.CreateSubAgentRequest_App_PUBLIC.Enum()
default:
return SubAgent{}, xerrors.Errorf("unexpected codersdk.WorkspaceAppSharingLevel: %#v", app.Share)
if app.Share != nil {
switch *app.Share {
case codersdk.WorkspaceAppSharingLevelAuthenticated:
share = agentproto.CreateSubAgentRequest_App_AUTHENTICATED.Enum()
case codersdk.WorkspaceAppSharingLevelOwner:
share = agentproto.CreateSubAgentRequest_App_OWNER.Enum()
case codersdk.WorkspaceAppSharingLevelPublic:
share = agentproto.CreateSubAgentRequest_App_PUBLIC.Enum()
default:
return SubAgent{}, xerrors.Errorf("unexpected codersdk.WorkspaceAppSharingLevel: %#v", app.Share)
}
}

apps = append(apps, &agentproto.CreateSubAgentRequest_App{
Expand Down
75 changes: 20 additions & 55 deletions agent/agentcontainers/subagent_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,24 +114,20 @@ func TestSubAgentClient_CreateWithDisplayApps(t *testing.T) {
expectedApps []*agentproto.CreateSubAgentRequest_App
}{
{
name: "single app with minimal fields",
name: "SlugOnly",
apps: []agentcontainers.SubAgentApp{
{
Slug: "code-server",
OpenIn: codersdk.WorkspaceAppOpenInSlimWindow,
Share: codersdk.WorkspaceAppSharingLevelOwner,
Slug: "code-server",
},
},
expectedApps: []*agentproto.CreateSubAgentRequest_App{
{
Slug: "code-server",
OpenIn: agentproto.CreateSubAgentRequest_App_SLIM_WINDOW.Enum(),
Share: agentproto.CreateSubAgentRequest_App_OWNER.Enum(),
Slug: "code-server",
},
},
},
{
name: "single app with all fields",
name: "AllFields",
apps: []agentcontainers.SubAgentApp{
{
Slug: "jupyter",
Expand All @@ -146,9 +142,9 @@ func TestSubAgentClient_CreateWithDisplayApps(t *testing.T) {
},
Hidden: ptr.Ref(false),
Icon: ptr.Ref("/icon/jupyter.svg"),
OpenIn: codersdk.WorkspaceAppOpenInTab,
OpenIn: ptr.Ref(codersdk.WorkspaceAppOpenInTab),
Order: ptr.Ref(int32(1)),
Share: codersdk.WorkspaceAppSharingLevelAuthenticated,
Share: ptr.Ref(codersdk.WorkspaceAppSharingLevelAuthenticated),
Subdomain: ptr.Ref(true),
URL: ptr.Ref("http://localhost:8888"),
},
Expand Down Expand Up @@ -176,44 +172,38 @@ func TestSubAgentClient_CreateWithDisplayApps(t *testing.T) {
},
},
{
name: "multiple apps with different sharing levels",
name: "AllSharingLevels",
apps: []agentcontainers.SubAgentApp{
{
Slug: "owner-app",
OpenIn: codersdk.WorkspaceAppOpenInSlimWindow,
Share: codersdk.WorkspaceAppSharingLevelOwner,
Slug: "owner-app",
Share: ptr.Ref(codersdk.WorkspaceAppSharingLevelOwner),
},
{
Slug: "authenticated-app",
OpenIn: codersdk.WorkspaceAppOpenInTab,
Share: codersdk.WorkspaceAppSharingLevelAuthenticated,
Slug: "authenticated-app",
Share: ptr.Ref(codersdk.WorkspaceAppSharingLevelAuthenticated),
},
{
Slug: "public-app",
OpenIn: codersdk.WorkspaceAppOpenInSlimWindow,
Share: codersdk.WorkspaceAppSharingLevelPublic,
Slug: "public-app",
Share: ptr.Ref(codersdk.WorkspaceAppSharingLevelPublic),
},
},
expectedApps: []*agentproto.CreateSubAgentRequest_App{
{
Slug: "owner-app",
OpenIn: agentproto.CreateSubAgentRequest_App_SLIM_WINDOW.Enum(),
Share: agentproto.CreateSubAgentRequest_App_OWNER.Enum(),
Slug: "owner-app",
Share: agentproto.CreateSubAgentRequest_App_OWNER.Enum(),
},
{
Slug: "authenticated-app",
OpenIn: agentproto.CreateSubAgentRequest_App_TAB.Enum(),
Share: agentproto.CreateSubAgentRequest_App_AUTHENTICATED.Enum(),
Slug: "authenticated-app",
Share: agentproto.CreateSubAgentRequest_App_AUTHENTICATED.Enum(),
},
{
Slug: "public-app",
OpenIn: agentproto.CreateSubAgentRequest_App_SLIM_WINDOW.Enum(),
Share: agentproto.CreateSubAgentRequest_App_PUBLIC.Enum(),
Slug: "public-app",
Share: agentproto.CreateSubAgentRequest_App_PUBLIC.Enum(),
},
},
},
{
name: "app with health check",
name: "WithHealthCheck",
apps: []agentcontainers.SubAgentApp{
{
Slug: "health-app",
Expand All @@ -222,8 +212,6 @@ func TestSubAgentClient_CreateWithDisplayApps(t *testing.T) {
Threshold: 5,
URL: "http://localhost:3000/health",
},
OpenIn: codersdk.WorkspaceAppOpenInSlimWindow,
Share: codersdk.WorkspaceAppSharingLevelOwner,
},
},
expectedApps: []*agentproto.CreateSubAgentRequest_App{
Expand All @@ -234,32 +222,9 @@ func TestSubAgentClient_CreateWithDisplayApps(t *testing.T) {
Threshold: 5,
Url: "http://localhost:3000/health",
},
OpenIn: agentproto.CreateSubAgentRequest_App_SLIM_WINDOW.Enum(),
Share: agentproto.CreateSubAgentRequest_App_OWNER.Enum(),
},
},
},
{
name: "app without health check",
apps: []agentcontainers.SubAgentApp{
{
Slug: "no-health-app",
OpenIn: codersdk.WorkspaceAppOpenInTab,
Share: codersdk.WorkspaceAppSharingLevelOwner,
},
},
expectedApps: []*agentproto.CreateSubAgentRequest_App{
{
Slug: "no-health-app",
OpenIn: agentproto.CreateSubAgentRequest_App_TAB.Enum(),
Share: agentproto.CreateSubAgentRequest_App_OWNER.Enum(),
},
},
},
{
name: "no apps",
apps: []agentcontainers.SubAgentApp{},
},
}

for _, tt := range tests {
Expand Down
0