fix(agent): start devcontainers through agentcontainers package #18471
Conversation
Fixes coder/internal#706 Context for the implementation here coder/internal#706 (comment) Synchronously starts dev containers defined in terraform with our `DevcontainerCLI` abstraction, instead of piggybacking off of our `agentscripts` package. This gives us more control over logs, instead of being reliant on packages which may or may not exist in the user-provided image.
There was a problem hiding this comment.
Pull Request Overview
This PR refactors how devcontainers are started by splitting out the devcontainer CLI functionality from the agentscripts package. Key changes include removing post start scripts from agentscripts, updating tests to reference new expected outputs and behavior, and updating the API to synchronously trigger devcontainer creation via a new CreateDevcontainer method.
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/agentscripts/agentscripts_test.go | Removed tests for post-start scripts and updated expectations. |
| agent/agentscripts/agentscripts.go | Refactored to remove runnerScript and post start script logic. |
| agent/agentcontainers/testdata/devcontainercli/parse/up.expected | Updated expected log output for devcontainer CLI. |
| agent/agentcontainers/devcontainercli_test.go | Updated test file references to expected log output file. |
| agent/agentcontainers/devcontainercli.go | Updated option defaults and logging writer behavior. |
| agent/agentcontainers/devcontainer_test.go | Entire file removed, reflecting changes in devcontainer handling. |
| agent/agentcontainers/devcontainer.go | Removed devcontainer script extraction helper functions. |
| agent/agentcontainers/api.go | Modified recreateDevcontainer to return errors and added CreateDevcontainer. |
| agent/agent.go | Removed legacy handling of experimental devcontainers and added calls to containerAPI.CreateDevcontainer. |
Comments suppressed due to low confidence (1)
| @@ -401,6 +408,7 @@ func (l *devcontainerCLILogWriter) Write(p []byte) (n int, err error) { | |||
| } | |||
| if logLine.Level >= 3 { | |||
| l.logger.Info(l.ctx, "@devcontainer/cli", slog.F("line", string(line))) | |||
| _, _ = l.writer.Write([]byte(logLine.Text + "\n")) | |||
There was a problem hiding this comment.
It might be beneficial to check the error returned by l.writer.Write rather than ignoring it. Handling any potential write failure could improve the reliability of the logging.
| _, _ = l.writer.Write([]byte(logLine.Text + "\n")) | |
| if _, err := l.writer.Write([]byte(logLine.Text + "\n")); err != nil { | |
| l.logger.Error(l.ctx, "failed to write to log writer", slog.Error(err), slog.F("text", logLine.Text)) | |
| } |
Copilot uses AI. Check for mistakes.
There was a problem hiding this comment.
Cursory glance looks good! 👍🏻
Couple of notes (in addition to inline comments):
- Testing, this could be done in
agent_test.gofor e.g. autostart integration test - A
api_test.goto testCreateDevcontainerbehavior - (Re-introduce agent script timing for autostart of devcontainer, not critical for GA, but perhaps track via ticket or if simple a follow-up PR.)
agent/agent.go
Outdated
|
|
||
| if cAPI := a.containerAPI.Load(); cAPI != nil { | ||
| for _, dc := range manifest.Devcontainers { | ||
| err = errors.Join(err, cAPI.CreateDevcontainer(dc)) |
There was a problem hiding this comment.
I think it's a good idea to do these sync so we avoid potential Docker concurrency races, it'd be nice if it was asynchronous but let's go with this!
| // have not been enabled, a warning will be surfaced in the agent logs. | ||
| script.RunOnStart = false | ||
| return script | ||
| } |
| }) | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
Good bye my beautiful hack! 👋🏻
agent/agentcontainers/api.go
Outdated
| dc, found := api.knownDevcontainers[workspaceFolder] | ||
| if !found { | ||
| api.mu.Unlock() | ||
| return xerrors.Errorf("no devcontainer found") |
There was a problem hiding this comment.
| return xerrors.Errorf("no devcontainer found") | |
| return xerrors.Errorf("devcontainer not found") |
Minor: Just a slightly different signal to not suggest there isn't a single devcontainer.
Fixes coder/internal#706
Context for the implementation here
coder/internal#706 (comment)
Synchronously starts dev containers defined in terraform with our
DevcontainerCLIabstraction, instead of piggybacking off of ouragentscriptspackage. This gives us more control over logs, instead of being reliant on packages which may or may not exist in the user-provided image.