update agentcontainers API file watch init

mafredri · mafredri · commit fd6922147e8f · 2025-04-29T12:07:26.000Z
diff --git a/agent/agent.go b/agent/agent.go
@@ -272,8 +272,9 @@ type agent struct {
 	metrics *agentMetrics
 	execer  agentexec.Execer
 
-	containerAPIOptions              []agentcontainers.Option
 	experimentalDevcontainersEnabled bool
+	containerAPIOptions              []agentcontainers.Option
+	containerAPI                     *agentcontainers.API
 }
 
 func (a *agent) TailnetConn() *tailnet.Conn {
@@ -1167,6 +1168,11 @@ func (a *agent) handleManifest(manifestOK *checkpoint) func(ctx context.Context,
 				}
 				a.metrics.startupScriptSeconds.WithLabelValues(label).Set(dur)
 				a.scriptRunner.StartCron()
+				if a.containerAPI != nil {
+					// Start the containerAPI service after
+					// devcontainers have been started.
+					a.containerAPI.Start()
+				}
 			})
 			if err != nil {
 				return xerrors.Errorf("track conn goroutine: %w", err)
diff --git a/agent/agentcontainers/api.go b/agent/agentcontainers/api.go
@@ -146,21 +146,30 @@ func NewAPI(logger slog.Logger, options ...Option) *API {
 		}
 	}
 
+	go api.loop()
+
+	return api
+}
+
+// Start watching for devcontainer config file changes and prime the
+// cache with the current list of containers.
+func (api *API) Start() {
+	// Prime the cache with the current list of containers.
+	_, _ = api.cl.List(api.ctx)
+
 	// Make sure we watch the devcontainer config files for changes.
 	for _, devcontainer := range api.knownDevcontainers {
-		if devcontainer.ConfigPath != "" {
-			if err := api.watcher.Add(devcontainer.ConfigPath); err != nil {
-				api.logger.Error(ctx, "watch devcontainer config file failed", slog.Error(err), slog.F("file", devcontainer.ConfigPath))
-			}
+		if devcontainer.ConfigPath == "" {
+			continue
 		}
-	}
-
-	go api.start()
 
-	return api
+		if err := api.watcher.Add(devcontainer.ConfigPath); err != nil {
+			api.logger.Error(api.ctx, "watch devcontainer config file failed", slog.Error(err), slog.F("file", devcontainer.ConfigPath))
+		}
+	}
 }
 
-func (api *API) start() {
+func (api *API) loop() {
 	defer close(api.done)
 
 	for {
diff --git a/agent/agentcontainers/api_test.go b/agent/agentcontainers/api_test.go
@@ -18,6 +18,7 @@ import (
 	"cdr.dev/slog"
 	"cdr.dev/slog/sloggers/slogtest"
 	"github.com/coder/coder/v2/agent/agentcontainers"
+	"github.com/coder/coder/v2/agent/agentcontainers/watcher"
 	"github.com/coder/coder/v2/codersdk"
 	"github.com/coder/coder/v2/testutil"
 	"github.com/coder/quartz"
@@ -253,6 +254,7 @@ func TestAPI(t *testing.T) {
 					logger,
 					agentcontainers.WithLister(tt.lister),
 					agentcontainers.WithDevcontainerCLI(tt.devcontainerCLI),
+					agentcontainers.WithWatcher(watcher.NewNoop()),
 				)
 				defer api.Close()
 				r.Mount("/", api.Routes())
@@ -558,6 +560,7 @@ func TestAPI(t *testing.T) {
 				r := chi.NewRouter()
 				apiOptions := []agentcontainers.Option{
 					agentcontainers.WithLister(tt.lister),
+					agentcontainers.WithWatcher(watcher.NewNoop()),
 				}
 
 				if len(tt.knownDevcontainers) > 0 {
@@ -631,6 +634,8 @@ func TestAPI(t *testing.T) {
 		)
 		defer api.Close()
 
+		api.Start()
+
 		r := chi.NewRouter()
 		r.Mount("/", api.Routes())
 
diff --git a/agent/api.go b/agent/api.go
@@ -37,7 +37,6 @@ func (a *agent) apiHandler() (http.Handler, func() error) {
 		cacheDuration: cacheDuration,
 	}
 
-	var containerAPI *agentcontainers.API
 	if a.experimentalDevcontainersEnabled {
 		containerAPIOpts := []agentcontainers.Option{
 			agentcontainers.WithExecer(a.execer),
@@ -53,9 +52,8 @@ func (a *agent) apiHandler() (http.Handler, func() error) {
 		// Append after to allow the agent options to override the default options.
 		containerAPIOpts = append(containerAPIOpts, a.containerAPIOptions...)
 
-		containerAPI = agentcontainers.NewAPI(a.logger.Named("containers"), containerAPIOpts...)
-
-		r.Mount("/api/v0/containers", containerAPI.Routes())
+		a.containerAPI = agentcontainers.NewAPI(a.logger.Named("containers"), containerAPIOpts...)
+		r.Mount("/api/v0/containers", a.containerAPI.Routes())
 	} else {
 		r.HandleFunc("/api/v0/containers", func(w http.ResponseWriter, r *http.Request) {
 			httpapi.Write(r.Context(), w, http.StatusNotFound, codersdk.Response{
@@ -77,8 +75,8 @@ func (a *agent) apiHandler() (http.Handler, func() error) {
 	r.Get("/debug/prometheus", promHandler.ServeHTTP)
 
 	return r, func() error {
-		if containerAPI != nil {
-			return containerAPI.Close()
+		if a.containerAPI != nil {
+			return a.containerAPI.Close()
 		}
 		return nil
 	}
