feat(agent/agentcontainers): support agent name in customization #18451
+99
−19
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This PR supports specifying a name that will be used for the devcontainer agent in the customizations section of the devcontainer.json configuration file.
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for specifying a custom agent name through the devcontainer.json configuration.
- Adds a new Name field to CoderCustomization in devcontainercli.go.
- Updates the API logic to use the agent name from the last customization layer.
- Enhances tests in api_test.go to verify that only the last customization layer's name is applied.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| agent/agentcontainers/devcontainercli.go | Adds a new Name field to the customization struct |
| agent/agentcontainers/api.go | Implements logic to select the agent name from the last layer |
| agent/agentcontainers/api_test.go | Introduces tests validating the correct agent name behavior |
Comments suppressed due to low confidence (1)
agent/agentcontainers/api_test.go:1765
- The test 'NameIsOnlyUsedWhenInLastLayer' currently verifies that the sub-agent name does not equal "custom-name" but does not assert the expected fallback name. Consider asserting an explicit default value to clarify the intended behavior.
require.NotEqual(t, "custom-name", subAgent.Name)
Technically this doesn't really test anything new but it is good to have an explicit test for anyways.
mafredri
reviewed
Jun 19, 2025
We want to be able to pick customizations that are only specified in the top-level customizations stanza. That is, we do not want to accidentally pick something specified in a feature (such as the agent name). This refactor picks the agent name from configuration instead of the merged configuration to ensure a feature cannot influence it.
mafredri
reviewed
Jun 19, 2025
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Relates to coder/internal#732
This PR supports specifying a name that will be used for the devcontainer agent in the customizations section of the devcontainer.json configuration file.
A follow up PR will introduce a fallback that names agents based on the folder name before falling back to the container name.