feat: Add connection_timeout and troubleshooting_url to agent

mafredri · mafredri · commit 2bf20be8f778 · 2022-11-09T13:18:48.000Z
This commit adds the connection timeout and troubleshooting url fields to coder agents. If an initial connection cannot be established within connection timeout seconds, then the agent status will be marked as `"timeout"`. The troubleshooting URL will be present, if configured in the Terraform template, it can be presented to the user when the agent state is either `"timeout"` or `"disconnected"`. Fixes #4678
diff --git a/cli/cliui/agent.go b/cli/cliui/agent.go
@@ -35,10 +35,10 @@ func Agent(ctx context.Context, writer io.Writer, opts AgentOptions) error {
 	if err != nil {
 		return xerrors.Errorf("fetch: %w", err)
 	}
-	if agent.Status == codersdk.WorkspaceAgentConnected {
+	switch agent.Status {
+	case codersdk.WorkspaceAgentConnected:
 		return nil
-	}
-	if agent.Status == codersdk.WorkspaceAgentDisconnected {
+	case codersdk.WorkspaceAgentTimeout, codersdk.WorkspaceAgentDisconnected:
 		opts.WarnInterval = 0
 	}
 	spin := spinner.New(spinner.CharSets[78], 100*time.Millisecond, spinner.WithColor("fgHiGreen"))
@@ -77,10 +77,8 @@ func Agent(ctx context.Context, writer io.Writer, opts AgentOptions) error {
 		}
 		resourceMutex.Lock()
 		defer resourceMutex.Unlock()
-		message := "Don't panic, your workspace is booting up!"
-		if agent.Status == codersdk.WorkspaceAgentDisconnected {
-			message = "The workspace agent lost connection! Wait for it to reconnect or restart your workspace."
-		}
+
+		message := waitingMessage(agent)
 		// This saves the cursor position, then defers clearing from the cursor
 		// position to the end of the screen.
 		_, _ = fmt.Fprintf(writer, "\033[s\r\033[2K%s\n\n", Styles.Paragraph.Render(Styles.Prompt.String()+message))
@@ -105,3 +103,20 @@ func Agent(ctx context.Context, writer io.Writer, opts AgentOptions) error {
 		return nil
 	}
 }
+
+func waitingMessage(agent codersdk.WorkspaceAgent) string {
+	var m string
+	switch agent.Status {
+	case codersdk.WorkspaceAgentTimeout:
+		m = "The workspace agent is having trouble connecting."
+	case codersdk.WorkspaceAgentDisconnected:
+		m = "The workspace agent lost connection!"
+	default:
+		// Not a failure state, no troubleshooting necessary.
+		return "Don't panic, your workspace is booting up!"
+	}
+	if agent.TroubleshootingURL != "" {
+		return fmt.Sprintf("%s See troubleshooting instructions at: %s", m, agent.TroubleshootingURL)
+	}
+	return fmt.Sprintf("%s Wait for it to (re)connect or restart your workspace.", m)
+}
diff --git a/cli/cliui/resources.go b/cli/cliui/resources.go
@@ -127,6 +127,13 @@ func renderAgentStatus(agent codersdk.WorkspaceAgent) string {
 		since := database.Now().Sub(*agent.DisconnectedAt)
 		return Styles.Error.Render("⦾ disconnected") + " " +
 			Styles.Placeholder.Render("["+strconv.Itoa(int(since.Seconds()))+"s]")
+	case codersdk.WorkspaceAgentTimeout:
+		since := database.Now().Sub(agent.CreatedAt)
+		return fmt.Sprintf(
+			"%s %s",
+			Styles.Warn.Render("⦾ timeout"),
+			Styles.Placeholder.Render("["+strconv.Itoa(int(since.Seconds()))+"s]"),
+		)
 	case codersdk.WorkspaceAgentConnected:
 		return Styles.Keyword.Render("⦿ connected")
 	default:
diff --git a/coderd/database/databasefake/databasefake.go b/coderd/database/databasefake/databasefake.go
@@ -154,6 +154,7 @@ func (q *fakeQuerier) AcquireProvisionerJob(_ context.Context, arg database.Acqu
 	}
 	return database.ProvisionerJob{}, sql.ErrNoRows
 }
+
 func (*fakeQuerier) DeleteOldAgentStats(_ context.Context) error {
 	// no-op
 	return nil
@@ -2376,6 +2377,8 @@ func (q *fakeQuerier) InsertWorkspaceAgent(_ context.Context, arg database.Inser
 		StartupScript:        arg.StartupScript,
 		InstanceMetadata:     arg.InstanceMetadata,
 		ResourceMetadata:     arg.ResourceMetadata,
+		ConnectionTimeout:    arg.ConnectionTimeout,
+		TroubleshootingUrl:   arg.TroubleshootingUrl,
 	}
 
 	q.provisionerJobAgents = append(q.provisionerJobAgents, agent)
diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000072_add_agent_connection_timeout_and_troubleshooting_url.down.sql b/coderd/database/migrations/000072_add_agent_connection_timeout_and_troubleshooting_url.down.sql
@@ -0,0 +1,9 @@
+BEGIN;
+
+ALTER TABLE workspace_agents
+	DROP COLUMN connection_timeout;
+
+ALTER TABLE workspace_agents
+	DROP COLUMN troubleshooting_url;
+
+COMMIT;
diff --git a/coderd/database/migrations/000072_add_agent_connection_timeout_and_troubleshooting_url.up.sql b/coderd/database/migrations/000072_add_agent_connection_timeout_and_troubleshooting_url.up.sql
@@ -0,0 +1,10 @@
+BEGIN;
+
+-- Default value same as in terraform-provider-coder.
+ALTER TABLE workspace_agents
+	ADD COLUMN connection_timeout integer NOT NULL DEFAULT 120;
+
+ALTER TABLE workspace_agents
+	ADD COLUMN troubleshooting_url text NOT NULL DEFAULT '';
+
+COMMIT;
diff --git a/coderd/database/models.go b/coderd/database/models.go
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/workspaceagents.sql b/coderd/database/queries/workspaceagents.sql
@@ -53,10 +53,12 @@ INSERT INTO
 		startup_script,
 		directory,
 		instance_metadata,
-		resource_metadata
+		resource_metadata,
+		connection_timeout,
+		troubleshooting_url
 	)
 VALUES
-	($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13, $14) RETURNING *;
+	($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13, $14, $15, $16) RETURNING *;
 
 -- name: UpdateWorkspaceAgentConnectionByID :exec
 UPDATE
diff --git a/coderd/provisionerdserver/provisionerdserver.go b/coderd/provisionerdserver/provisionerdserver.go
@@ -678,7 +678,7 @@ func InsertWorkspaceResource(ctx context.Context, db database.Store, jobID uuid.
 	}
 	snapshot.WorkspaceResources = append(snapshot.WorkspaceResources, telemetry.ConvertWorkspaceResource(resource))
 
-	var appSlugs = make(map[string]struct{})
+	appSlugs := make(map[string]struct{})
 	for _, prAgent := range protoResource.Agents {
 		var instanceID sql.NullString
 		if prAgent.GetInstanceId() != "" {
@@ -723,6 +723,8 @@ func InsertWorkspaceResource(ctx context.Context, db database.Store, jobID uuid.
 				String: prAgent.StartupScript,
 				Valid:  prAgent.StartupScript != "",
 			},
+			ConnectionTimeout:  prAgent.GetConnectionTimeout(),
+			TroubleshootingUrl: prAgent.GetTroubleshootingUrl(),
 		})
 		if err != nil {
 			return xerrors.Errorf("insert agent: %w", err)
diff --git a/coderd/workspaceagents.go b/coderd/workspaceagents.go
@@ -682,6 +682,8 @@ func convertWorkspaceAgent(derpMap *tailcfg.DERPMap, coordinator tailnet.Coordin
 		EnvironmentVariables: envs,
 		Directory:            dbAgent.Directory,
 		Apps:                 apps,
+		ConnectionTimeout:    dbAgent.ConnectionTimeout,
+		TroubleshootingURL:   dbAgent.TroubleshootingUrl,
 	}
 	node := coordinator.Node(dbAgent.ID)
 	if node != nil {
@@ -718,11 +720,21 @@ func convertWorkspaceAgent(derpMap *tailcfg.DERPMap, coordinator tailnet.Coordin
 	if dbAgent.DisconnectedAt.Valid {
 		workspaceAgent.DisconnectedAt = &dbAgent.DisconnectedAt.Time
 	}
+
+	connectionTimeout := time.Duration(dbAgent.ConnectionTimeout) * time.Second
+
 	switch {
 	case !dbAgent.FirstConnectedAt.Valid:
-		// If the agent never connected, it's waiting for the compute
-		// to start up.
-		workspaceAgent.Status = codersdk.WorkspaceAgentConnecting
+		switch {
+		case database.Now().Sub(dbAgent.CreatedAt) > connectionTimeout:
+			// If the agent took too long to connect the first time,
+			// mark it as timed out.
+			workspaceAgent.Status = codersdk.WorkspaceAgentTimeout
+		default:
+			// If the agent never connected, it's waiting for the compute
+			// to start up.
+			workspaceAgent.Status = codersdk.WorkspaceAgentConnecting
+		}
 	case dbAgent.DisconnectedAt.Time.After(dbAgent.LastConnectedAt.Time):
 		// If we've disconnected after our last connection, we know the
 		// agent is no longer connected.
diff --git a/codersdk/workspaceagents.go b/codersdk/workspaceagents.go
@@ -32,6 +32,7 @@ const (
 	WorkspaceAgentConnecting   WorkspaceAgentStatus = "connecting"
 	WorkspaceAgentConnected    WorkspaceAgentStatus = "connected"
 	WorkspaceAgentDisconnected WorkspaceAgentStatus = "disconnected"
+	WorkspaceAgentTimeout      WorkspaceAgentStatus = "timeout"
 )
 
 type WorkspaceAgent struct {
@@ -53,7 +54,9 @@ type WorkspaceAgent struct {
 	Version              string               `json:"version"`
 	Apps                 []WorkspaceApp       `json:"apps"`
 	// DERPLatency is mapped by region name (e.g. "New York City", "Seattle").
-	DERPLatency map[string]DERPRegion `json:"latency,omitempty"`
+	DERPLatency        map[string]DERPRegion `json:"latency,omitempty"`
+	ConnectionTimeout  int32                 `json:"connection_timeout"`
+	TroubleshootingURL string                `json:"troubleshooting_url,omitempty"`
 }
 
 type WorkspaceAgentResourceMetadata struct {
diff --git a/provisionersdk/proto/provisioner.pb.go b/provisionersdk/proto/provisioner.pb.go
diff --git a/provisionersdk/proto/provisioner.proto b/provisionersdk/proto/provisioner.proto
@@ -85,6 +85,8 @@ message Agent {
         string token = 9;
         string instance_id = 10;
     }
+	int32 connection_timeout = 11;
+	string troubleshooting_url = 12;
 }
 
 enum AppSharingLevel {
diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts

Original file line number	Diff line number	Diff line change
`@@ -154,6 +154,7 @@ func (q *fakeQuerier) AcquireProvisionerJob(_ context.Context, arg database.Acqu`
`154`	`154`	`}`
`155`	`155`	`return database.ProvisionerJob{}, sql.ErrNoRows`
`156`	`156`	`}`
	`157`	`+`
`157`	`158`	`func (*fakeQuerier) DeleteOldAgentStats(_ context.Context) error {`
`158`	`159`	`// no-op`
`159`	`160`	`return nil`
`@@ -2376,6 +2377,8 @@ func (q *fakeQuerier) InsertWorkspaceAgent(_ context.Context, arg database.Inser`
`2376`	`2377`	`StartupScript: arg.StartupScript,`
`2377`	`2378`	`InstanceMetadata: arg.InstanceMetadata,`
`2378`	`2379`	`ResourceMetadata: arg.ResourceMetadata,`
	`2380`	`+ ConnectionTimeout: arg.ConnectionTimeout,`
	`2381`	`+ TroubleshootingUrl: arg.TroubleshootingUrl,`
`2379`	`2382`	`}`
`2380`	`2383`
`2381`	`2384`	`q.provisionerJobAgents = append(q.provisionerJobAgents, agent)`