fix(agent/agentcontainers): ensure agent name env var is correct #18457
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
Previously, `CODER_WORKSPACE_AGENT_NAME` would always be passed as the dev container name. This is invalid for the following scenarios: - The dev container is specified in terraform - The dev container has a name customization This change now runs `ReadConfig` twice. The first read is to extract a name (if present), from the `devcontainer.json`. The second read will then use the name we have stored for the dev container (so this could be either the customization, terraform resource name, or container name).
There was a problem hiding this comment.
Pull Request Overview
This PR ensures the agent’s custom name from devcontainer.json is correctly applied to the CODER_WORKSPACE_AGENT_NAME environment variable by reading the config twice and updated tests to verify both reads.
- Changed
readConfigErrCchannel capacity and added assertions for the first “empty” read. - Added a new subtest (
CreateReadsConfigTwice) to cover custom-name override. - Updated
api.goto runReadConfigonce to extract the name and again to pass the proper env var.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| agent/agentcontainers/api_test.go | Increase readConfigErrC capacity; assert empty vs. populated envs on two reads; new custom-name subtest |
| agent/agentcontainers/api.go | Call ReadConfig twice: first to pick up Coder.Name, second to inject it into the env |
Comments suppressed due to low confidence (4)
agent/agentcontainers/api.go:1172
- [nitpick] If
subAgentConfig.Nameis empty (no customization), this injects an emptyCODER_WORKSPACE_AGENT_NAME; consider defaulting explicitly to the container’s name (dc.Name) to avoid passing a blank value.
fmt.Sprintf("CODER_WORKSPACE_AGENT_NAME=%s", subAgentConfig.Name),
agent/agentcontainers/api_test.go:1896
- There is no test covering the branch where the customization name is invalid; add a case that supplies an invalid
Coder.Nameand asserts that the warning path is triggered.
t.Run("CreateReadsConfigTwice", func(t *testing.T) {
agent/agentcontainers/api_test.go:1264
- [nitpick] The variable name
fakeDCCLIdiffers fromfDCCLIused in the new subtest; consider unifying the naming for clarity and consistency across tests.
fakeDCCLI = &fakeDevcontainerCLI{
agent/agentcontainers/api.go:1163
- The local variable
loggeris undefined here; useapi.logger.Warnto correctly reference the API’s logger instance.
logger.Warn(ctx, "invalid agent name in devcontainer customization, ignoring", slog.F("name", name))
mafredri
approved these changes
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.
Previously,
CODER_WORKSPACE_AGENT_NAMEwould always be passed as the dev container name.This is invalid for the following scenarios:
This change now runs
ReadConfigtwice. The first read is to extract a name (if present), from thedevcontainer.json. The second read will then use the name we have stored for the dev container (so this could be either the customization, terraform resource name, or container name).