rename start to ready

coder · mafredri · Apr 29, 2025 · Apr 29, 2025 · Apr 29, 2025 · Apr 29, 2025
commit 17fa155d64b54cbb6cefb474b078c60f23be9272
diff --git a/agent/agent.go b/agent/agent.go
@@ -1169,9 +1169,10 @@ 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()
+					// Inform the container API that the agent is ready.
+					// This allows us to start watching for changes to
+					// the devcontainer configuration files.
+					a.containerAPI.Ready()
 				}
 			})
 			if err != nil {

diff --git a/agent/agentcontainers/api.go b/agent/agentcontainers/api.go
@@ -151,9 +151,11 @@ func NewAPI(logger slog.Logger, options ...Option) *API {
 	return api
 }
 
-// Start watching for devcontainer config file changes and prime the
-// cache with the current list of containers.
-func (api *API) Start() {
+// Ready signals the API that we are ready to begin watching for file
+// changes. This is used to prime the cache with the current list of
+// containers and to start watching the devcontainer config files for
+// changes. It should be called after the agent ready.
+func (api *API) Ready() {
 	// Prime the cache with the current list of containers.
 	_, _ = api.cl.List(api.ctx)
 

diff --git a/agent/agentcontainers/api_test.go b/agent/agentcontainers/api_test.go
@@ -634,7 +634,7 @@ func TestAPI(t *testing.T) {
 		)
 		defer api.Close()
 
-		api.Start()
+		api.Ready()
 
 		r := chi.NewRouter()
 		r.Mount("/", api.Routes())