fix(agent): delay containerAPI init to ensure startup scripts run before (#18630)

mafredri · web-flow · commit 7e99fb7d7e9f · 2025-06-27T14:10:35.000+03:00
diff --git a/agent/agent.go b/agent/agent.go
@@ -1163,13 +1163,7 @@ func (a *agent) handleManifest(manifestOK *checkpoint) func(ctx context.Context,
 				scriptRunnerOpts    []agentscripts.InitOption
 				devcontainerScripts map[uuid.UUID]codersdk.WorkspaceAgentScript
 			)
-			if a.devcontainers {
-				a.containerAPI.Init(
-					agentcontainers.WithManifestInfo(manifest.OwnerName, manifest.WorkspaceName, manifest.AgentName),
-					agentcontainers.WithDevcontainers(manifest.Devcontainers, scripts),
-					agentcontainers.WithSubAgentClient(agentcontainers.NewSubAgentClientFromAPI(a.logger, aAPI)),
-				)
-
+			if a.containerAPI != nil {
 				scripts, devcontainerScripts = agentcontainers.ExtractDevcontainerScripts(manifest.Devcontainers, scripts)
 			}
 			err = a.scriptRunner.Init(scripts, aAPI.ScriptCompleted, scriptRunnerOpts...)
@@ -1190,9 +1184,17 @@ func (a *agent) handleManifest(manifestOK *checkpoint) func(ctx context.Context,
 				// autostarted devcontainer will be included in this time.
 				err := a.scriptRunner.Execute(a.gracefulCtx, agentscripts.ExecuteStartScripts)
 
-				for _, dc := range manifest.Devcontainers {
-					cErr := a.createDevcontainer(ctx, aAPI, dc, devcontainerScripts[dc.ID])
-					err = errors.Join(err, cErr)
+				if a.containerAPI != nil {
+					a.containerAPI.Init(
+						agentcontainers.WithManifestInfo(manifest.OwnerName, manifest.WorkspaceName, manifest.AgentName),
+						agentcontainers.WithDevcontainers(manifest.Devcontainers, scripts),
+						agentcontainers.WithSubAgentClient(agentcontainers.NewSubAgentClientFromAPI(a.logger, aAPI)),
+					)
+
+					for _, dc := range manifest.Devcontainers {
+						cErr := a.createDevcontainer(ctx, aAPI, dc, devcontainerScripts[dc.ID])
+						err = errors.Join(err, cErr)
+					}
 				}
 
 				dur := time.Since(start).Seconds()
diff --git a/agent/agentcontainers/api.go b/agent/agentcontainers/api.go
@@ -530,7 +530,6 @@ func (api *API) updateContainers(ctx context.Context) error {
 		// will clear up on the next update.
 		if !errors.Is(err, context.Canceled) {
 			api.mu.Lock()
-			api.containers = codersdk.WorkspaceAgentListContainersResponse{}
 			api.containersErr = err
 			api.mu.Unlock()
 		}
@@ -947,7 +946,7 @@ func (api *API) CreateDevcontainer(workspaceFolder, configPath string, opts ...D
 			slog.F("devcontainer_id", dc.ID),
 			slog.F("devcontainer_name", dc.Name),
 			slog.F("workspace_folder", dc.WorkspaceFolder),
-			slog.F("config_path", configPath),
+			slog.F("config_path", dc.ConfigPath),
 		)
 	)
 
diff --git a/agent/api.go b/agent/api.go
@@ -36,7 +36,7 @@ func (a *agent) apiHandler() http.Handler {
 		cacheDuration: cacheDuration,
 	}
 
-	if a.devcontainers {
+	if a.containerAPI != nil {
 		r.Mount("/api/v0/containers", a.containerAPI.Routes())
 	} else {
 		r.HandleFunc("/api/v0/containers", func(w http.ResponseWriter, r *http.Request) {

Original file line number	Diff line number	Diff line change
`@@ -530,7 +530,6 @@ func (api *API) updateContainers(ctx context.Context) error {`
`530`	`530`	`// will clear up on the next update.`
`531`	`531`	`if !errors.Is(err, context.Canceled) {`
`532`	`532`	`api.mu.Lock()`
`533`		`- api.containers = codersdk.WorkspaceAgentListContainersResponse{}`
`534`	`533`	`api.containersErr = err`
`535`	`534`	`api.mu.Unlock()`
`536`	`535`	`}`
`@@ -947,7 +946,7 @@ func (api *API) CreateDevcontainer(workspaceFolder, configPath string, opts ...D`
`947`	`946`	`slog.F("devcontainer_id", dc.ID),`
`948`	`947`	`slog.F("devcontainer_name", dc.Name),`
`949`	`948`	`slog.F("workspace_folder", dc.WorkspaceFolder),`
`950`		`- slog.F("config_path", configPath),`
	`949`	`+ slog.F("config_path", dc.ConfigPath),`
`951`	`950`	`)`
`952`	`951`	`)`
`953`	`952`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ func (a *agent) apiHandler() http.Handler {`
`36`	`36`	`cacheDuration: cacheDuration,`
`37`	`37`	`}`
`38`	`38`
`39`		`- if a.devcontainers {`
	`39`	`+ if a.containerAPI != nil {`
`40`	`40`	`r.Mount("/api/v0/containers", a.containerAPI.Routes())`
`41`	`41`	`} else {`
`42`	`42`	`r.HandleFunc("/api/v0/containers", func(w http.ResponseWriter, r *http.Request) {`