Fix plumbing

coder · mafredri · Jan 24, 2023 · Jan 19, 2023 · Jan 19, 2023 · Jan 19, 2023
commit 60f414fbd2847532dd3e742029fe9b26375a28b6
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/database/migrations/000091_add_workspace_agent_state.down.sql b/coderd/database/migrations/000091_add_workspace_agent_state.down.sql
@@ -1,4 +1,4 @@
-ALTER TABLE workspace_agents DROP COLUMN startup_script_timeout;
+ALTER TABLE workspace_agents DROP COLUMN startup_script_timeout_seconds;
 ALTER TABLE workspace_agents DROP COLUMN delay_login_until_ready;
 
 ALTER TABLE workspace_agents DROP COLUMN lifecycle_state;

diff --git a/coderd/workspaceagents.go b/coderd/workspaceagents.go
@@ -150,6 +150,7 @@ func (api *API) workspaceAgentMetadata(rw http.ResponseWriter, r *http.Request)
 		Directory:            apiAgent.Directory,
 		VSCodePortProxyURI:   vscodeProxyURI,
 		MOTDFile:             workspaceAgent.MOTDFile,
+		StartupScriptTimeout: time.Duration(apiAgent.StartupScriptTimeoutSeconds) * time.Second,
 	})
 }
 
@@ -739,22 +740,24 @@ func convertWorkspaceAgent(derpMap *tailcfg.DERPMap, coordinator tailnet.Coordin
 		troubleshootingURL = dbAgent.TroubleshootingURL
 	}
 	workspaceAgent := codersdk.WorkspaceAgent{
-		ID:                       dbAgent.ID,
-		CreatedAt:                dbAgent.CreatedAt,
-		UpdatedAt:                dbAgent.UpdatedAt,
-		ResourceID:               dbAgent.ResourceID,
-		InstanceID:               dbAgent.AuthInstanceID.String,
-		Name:                     dbAgent.Name,
-		Architecture:             dbAgent.Architecture,
-		OperatingSystem:          dbAgent.OperatingSystem,
-		StartupScript:            dbAgent.StartupScript.String,
-		Version:                  dbAgent.Version,
-		EnvironmentVariables:     envs,
-		Directory:                dbAgent.Directory,
-		Apps:                     apps,
-		ConnectionTimeoutSeconds: dbAgent.ConnectionTimeoutSeconds,
-		TroubleshootingURL:       troubleshootingURL,
-		LifecycleState:           codersdk.WorkspaceAgentLifecycle(dbAgent.LifecycleState),
+		ID:                          dbAgent.ID,
+		CreatedAt:                   dbAgent.CreatedAt,
+		UpdatedAt:                   dbAgent.UpdatedAt,
+		ResourceID:                  dbAgent.ResourceID,
+		InstanceID:                  dbAgent.AuthInstanceID.String,
+		Name:                        dbAgent.Name,
+		Architecture:                dbAgent.Architecture,
+		OperatingSystem:             dbAgent.OperatingSystem,
+		StartupScript:               dbAgent.StartupScript.String,
+		Version:                     dbAgent.Version,
+		EnvironmentVariables:        envs,
+		Directory:                   dbAgent.Directory,
+		Apps:                        apps,
+		ConnectionTimeoutSeconds:    dbAgent.ConnectionTimeoutSeconds,
+		TroubleshootingURL:          troubleshootingURL,
+		LifecycleState:              codersdk.WorkspaceAgentLifecycle(dbAgent.LifecycleState),
+		DelayLoginUntilReady:        dbAgent.DelayLoginUntilReady,
+		StartupScriptTimeoutSeconds: dbAgent.StartupScriptTimeoutSeconds,
 	}
 	node := coordinator.Node(dbAgent.ID)
 	if node != nil {

diff --git a/codersdk/workspaceagents.go b/codersdk/workspaceagents.go
@@ -77,6 +77,10 @@ type WorkspaceAgent struct {
 	DERPLatency              map[string]DERPRegion `json:"latency,omitempty"`
 	ConnectionTimeoutSeconds int32                 `json:"connection_timeout_seconds"`
 	TroubleshootingURL       string                `json:"troubleshooting_url"`
+	// DelayLoginUntilReady if true, the agent will delay logins until it is ready (e.g. executing startup script has ended).
+	DelayLoginUntilReady bool `db:"delay_login_until_ready" json:"delay_login_until_ready"`
+	// StartupScriptTimeoutSeconds is the number of seconds to wait for the startup script to complete. If the script does not complete within this time, the agent lifecycle will be marked as start_timeout.
+	StartupScriptTimeoutSeconds int32 `db:"startup_script_timeout_seconds" json:"startup_script_timeout_seconds"`
 }
 
 type WorkspaceAgentResourceMetadata struct {

diff --git a/docs/api/agents.md b/docs/api/agents.md
@@ -519,6 +519,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent} \
   "architecture": "string",
   "connection_timeout_seconds": 0,
   "created_at": "2019-08-24T14:15:22Z",
+  "delay_login_until_ready": true,
   "directory": "string",
   "disconnected_at": "2019-08-24T14:15:22Z",
   "environment_variables": {
@@ -544,6 +545,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent} \
   "operating_system": "string",
   "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
   "startup_script": "string",
+  "startup_script_timeout_seconds": 0,
   "status": "connecting",
   "troubleshooting_url": "string",
   "updated_at": "2019-08-24T14:15:22Z",