fix(agent): fix script filtering for devcontainers (#18635)

mafredri · web-flow · commit 8ee2668b392c · 2025-06-27T16:59:31.000+03:00
diff --git a/agent/agent.go b/agent/agent.go
@@ -1158,15 +1158,13 @@ func (a *agent) handleManifest(manifestOK *checkpoint) func(ctx context.Context,
 				}
 			}
 
-			var (
-				scripts             = manifest.Scripts
-				scriptRunnerOpts    []agentscripts.InitOption
-				devcontainerScripts map[uuid.UUID]codersdk.WorkspaceAgentScript
-			)
+			scripts := manifest.Scripts
 			if a.containerAPI != nil {
-				scripts, devcontainerScripts = agentcontainers.ExtractDevcontainerScripts(manifest.Devcontainers, scripts)
+				// Since devcontainer are enabled, remove devcontainer scripts
+				// from the main scripts list to avoid showing an error.
+				scripts, _ = agentcontainers.ExtractDevcontainerScripts(manifest.Devcontainers, manifest.Scripts)
 			}
-			err = a.scriptRunner.Init(scripts, aAPI.ScriptCompleted, scriptRunnerOpts...)
+			err = a.scriptRunner.Init(scripts, aAPI.ScriptCompleted)
 			if err != nil {
 				return xerrors.Errorf("init script runner: %w", err)
 			}
@@ -1187,10 +1185,11 @@ func (a *agent) handleManifest(manifestOK *checkpoint) func(ctx context.Context,
 				if a.containerAPI != nil {
 					a.containerAPI.Init(
 						agentcontainers.WithManifestInfo(manifest.OwnerName, manifest.WorkspaceName, manifest.AgentName),
-						agentcontainers.WithDevcontainers(manifest.Devcontainers, scripts),
+						agentcontainers.WithDevcontainers(manifest.Devcontainers, manifest.Scripts),
 						agentcontainers.WithSubAgentClient(agentcontainers.NewSubAgentClientFromAPI(a.logger, aAPI)),
 					)
 
+					_, devcontainerScripts := agentcontainers.ExtractDevcontainerScripts(manifest.Devcontainers, manifest.Scripts)
 					for _, dc := range manifest.Devcontainers {
 						cErr := a.createDevcontainer(ctx, aAPI, dc, devcontainerScripts[dc.ID])
 						err = errors.Join(err, cErr)
diff --git a/agent/agentcontainers/api.go b/agent/agentcontainers/api.go
@@ -79,15 +79,14 @@ type API struct {
 	containersErr            error                                          // Error from the last list operation.
 	devcontainerNames        map[string]bool                                // By devcontainer name.
 	knownDevcontainers       map[string]codersdk.WorkspaceAgentDevcontainer // By workspace folder.
+	devcontainerLogSourceIDs map[string]uuid.UUID                           // By workspace folder.
 	configFileModifiedTimes  map[string]time.Time                           // By config file path.
 	recreateSuccessTimes     map[string]time.Time                           // By workspace folder.
 	recreateErrorTimes       map[string]time.Time                           // By workspace folder.
 	injectedSubAgentProcs    map[string]subAgentProcess                     // By workspace folder.
 	usingWorkspaceFolderName map[string]bool                                // By workspace folder.
 	ignoredDevcontainers     map[string]bool                                // By workspace folder. Tracks three states (true, false and not checked).
 	asyncWg                  sync.WaitGroup
-
-	devcontainerLogSourceIDs map[string]uuid.UUID // By workspace folder.
 }
 
 type subAgentProcess struct {
@@ -935,12 +934,7 @@ func (api *API) CreateDevcontainer(workspaceFolder, configPath string, opts ...D
 		return xerrors.Errorf("devcontainer not found")
 	}
 
-	api.asyncWg.Add(1)
-	defer api.asyncWg.Done()
-	api.mu.Unlock()
-
 	var (
-		err    error
 		ctx    = api.ctx
 		logger = api.logger.With(
 			slog.F("devcontainer_id", dc.ID),
@@ -950,19 +944,23 @@ func (api *API) CreateDevcontainer(workspaceFolder, configPath string, opts ...D
 		)
 	)
 
-	if dc.ConfigPath != configPath {
-		logger.Warn(ctx, "devcontainer config path mismatch",
-			slog.F("config_path_param", configPath),
-		)
-	}
-
 	// Send logs via agent logging facilities.
 	logSourceID := api.devcontainerLogSourceIDs[dc.WorkspaceFolder]
 	if logSourceID == uuid.Nil {
-		// Fallback to the external log source ID if not found.
+		api.logger.Debug(api.ctx, "devcontainer log source ID not found, falling back to external log source ID")
 		logSourceID = agentsdk.ExternalLogSourceID
 	}
 
+	api.asyncWg.Add(1)
+	defer api.asyncWg.Done()
+	api.mu.Unlock()
+
+	if dc.ConfigPath != configPath {
+		logger.Warn(ctx, "devcontainer config path mismatch",
+			slog.F("config_path_param", configPath),
+		)
+	}
+
 	scriptLogger := api.scriptLogger(logSourceID)
 	defer func() {
 		flushCtx, cancel := context.WithTimeout(api.ctx, 5*time.Second)
@@ -981,7 +979,7 @@ func (api *API) CreateDevcontainer(workspaceFolder, configPath string, opts ...D
 	upOptions := []DevcontainerCLIUpOptions{WithUpOutput(infoW, errW)}
 	upOptions = append(upOptions, opts...)
 
-	_, err = api.dccli.Up(ctx, dc.WorkspaceFolder, configPath, upOptions...)
+	_, err := api.dccli.Up(ctx, dc.WorkspaceFolder, configPath, upOptions...)
 	if err != nil {
 		// No need to log if the API is closing (context canceled), as this
 		// is expected behavior when the API is shutting down.
