feat(agent/agentcontainers): support agent name in customization

DanielleMaywood · DanielleMaywood · commit a5278c905a99 · 2025-06-19T10:56:53.000Z
This PR supports specifying a name that will be used for the
devcontainer agent in the customizations section of the
devcontainer.json configuration file.
diff --git a/agent/agentcontainers/api.go b/agent/agentcontainers/api.go
@@ -1146,6 +1146,7 @@ func (api *API) maybeInjectSubAgentIntoContainerLocked(ctx context.Context, dc c
 		}
 
 		var appsWithPossibleDuplicates []SubAgentApp
+		var possibleAgentName string
 
 		if config, err := api.dccli.ReadConfig(ctx, dc.WorkspaceFolder, dc.ConfigPath,
 			[]string{
@@ -1173,6 +1174,14 @@ func (api *API) maybeInjectSubAgentIntoContainerLocked(ctx context.Context, dc c
 
 				appsWithPossibleDuplicates = append(appsWithPossibleDuplicates, customization.Apps...)
 			}
+
+			// NOTE(DanielleMaywood):
+			// We only want to take an agent name specified in the very last customization layer.
+			// This restricts the ability for a feature to specify the agent name. We may revisit
+			// this in the future, but for now we want to restrict this behavior.
+			if len(coderCustomization) > 0 {
+				possibleAgentName = coderCustomization[len(coderCustomization)-1].Name
+			}
 		}
 
 		displayApps := make([]codersdk.DisplayApp, 0, len(displayAppsMap))
@@ -1204,6 +1213,10 @@ func (api *API) maybeInjectSubAgentIntoContainerLocked(ctx context.Context, dc c
 
 		subAgentConfig.DisplayApps = displayApps
 		subAgentConfig.Apps = apps
+
+		if possibleAgentName != "" {
+			subAgentConfig.Name = possibleAgentName
+		}
 	}
 
 	deleteSubAgent := proc.agent.ID != uuid.Nil && maybeRecreateSubAgent && !proc.agent.EqualConfig(subAgentConfig)
diff --git a/agent/agentcontainers/api_test.go b/agent/agentcontainers/api_test.go
@@ -1739,6 +1739,32 @@ func TestAPI(t *testing.T) {
 					assert.Equal(t, int32(2), subAgent.Apps[1].Order)
 				},
 			},
+			{
+				name: "Name",
+				customization: []agentcontainers.CoderCustomization{
+					{
+						Name: "not-this-name",
+					},
+					{
+						Name: "custom-name",
+					},
+				},
+				afterCreate: func(t *testing.T, subAgent agentcontainers.SubAgent) {
+					require.Equal(t, "custom-name", subAgent.Name)
+				},
+			},
+			{
+				name: "NameIsOnlyUsedWhenInLastLayer",
+				customization: []agentcontainers.CoderCustomization{
+					{
+						Name: "custom-name",
+					},
+					{},
+				},
+				afterCreate: func(t *testing.T, subAgent agentcontainers.SubAgent) {
+					require.NotEqual(t, "custom-name", subAgent.Name)
+				},
+			},
 		}
 
 		for _, tt := range tests {
@@ -1825,7 +1851,6 @@ func TestAPI(t *testing.T) {
 
 				// Then: We expected it to succeed
 				require.Len(t, fSAC.created, 1)
-				assert.Equal(t, testContainer.FriendlyName, fSAC.created[0].Name)
 
 				if tt.afterCreate != nil {
 					tt.afterCreate(t, fSAC.created[0])
diff --git a/agent/agentcontainers/devcontainercli.go b/agent/agentcontainers/devcontainercli.go
@@ -34,6 +34,7 @@ type DevcontainerCustomizations struct {
 type CoderCustomization struct {
 	DisplayApps map[codersdk.DisplayApp]bool `json:"displayApps,omitempty"`
 	Apps        []SubAgentApp                `json:"apps,omitempty"`
+	Name        string                       `json:"name,omitempty"`
 }
 
 // DevcontainerCLI is an interface for the devcontainer CLI.

Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,7 @@ type DevcontainerCustomizations struct {`
`34`	`34`	`type CoderCustomization struct {`
`35`	`35`	DisplayApps map[codersdk.DisplayApp]bool `json:"displayApps,omitempty"`
`36`	`36`	Apps []SubAgentApp `json:"apps,omitempty"`
	`37`	+ Name string `json:"name,omitempty"`
`37`	`38`	`}`
`38`	`39`
`39`	`40`	`// DevcontainerCLI is an interface for the devcontainer CLI.`