fix(coderd/agentapi): set ReadyAt for start timeout

mafredri · mafredri · commit c85aa4473786 · 2024-07-09T11:00:36.000+03:00
diff --git a/cli/cliui/agent.go b/cli/cliui/agent.go
@@ -206,7 +206,13 @@ func Agent(ctx context.Context, writer io.Writer, agentID uuid.UUID, opts AgentO
 			case codersdk.WorkspaceAgentLifecycleReady:
 				sw.Complete(stage, safeDuration(sw, agent.ReadyAt, agent.StartedAt))
 			case codersdk.WorkspaceAgentLifecycleStartTimeout:
-				sw.Fail(stage, 0)
+				// Backwards compatibility: Avoid printing warning if
+				// coderd is old and doesn't set ReadyAt for timeouts.
+				if agent.ReadyAt == nil {
+					sw.Fail(stage, 0)
+				} else {
+					sw.Fail(stage, safeDuration(sw, agent.ReadyAt, agent.StartedAt))
+				}
 				sw.Log(time.Time{}, codersdk.LogLevelWarn, "Warning: A startup script timed out and your workspace may be incomplete.")
 			case codersdk.WorkspaceAgentLifecycleStartError:
 				sw.Fail(stage, safeDuration(sw, agent.ReadyAt, agent.StartedAt))
diff --git a/coderd/agentapi/lifecycle.go b/coderd/agentapi/lifecycle.go
@@ -98,7 +98,9 @@ func (a *LifecycleAPI) UpdateLifecycle(ctx context.Context, req *agentproto.Upda
 		// This agent is (re)starting, so it's not ready yet.
 		readyAt.Time = time.Time{}
 		readyAt.Valid = false
-	case database.WorkspaceAgentLifecycleStateReady, database.WorkspaceAgentLifecycleStateStartError:
+	case database.WorkspaceAgentLifecycleStateReady,
+		database.WorkspaceAgentLifecycleStateStartTimeout,
+		database.WorkspaceAgentLifecycleStateStartError:
 		if !startedAt.Valid {
 			startedAt = dbChangedAt
 		}
diff --git a/coderd/agentapi/lifecycle_test.go b/coderd/agentapi/lifecycle_test.go
@@ -275,7 +275,7 @@ func TestUpdateLifecycle(t *testing.T) {
 			if state == agentproto.Lifecycle_STARTING {
 				expectedStartedAt = sql.NullTime{Valid: true, Time: stateNow}
 			}
-			if state == agentproto.Lifecycle_READY || state == agentproto.Lifecycle_START_ERROR {
+			if state == agentproto.Lifecycle_READY || state == agentproto.Lifecycle_START_TIMEOUT || state == agentproto.Lifecycle_START_ERROR {
 				expectedReadyAt = sql.NullTime{Valid: true, Time: stateNow}
 			}
 

Original file line number	Diff line number	Diff line change
`@@ -275,7 +275,7 @@ func TestUpdateLifecycle(t *testing.T) {`
`275`	`275`	`if state == agentproto.Lifecycle_STARTING {`
`276`	`276`	`expectedStartedAt = sql.NullTime{Valid: true, Time: stateNow}`
`277`	`277`	`}`
`278`		`- if state == agentproto.Lifecycle_READY \|\| state == agentproto.Lifecycle_START_ERROR {`
	`278`	`+ if state == agentproto.Lifecycle_READY \|\| state == agentproto.Lifecycle_START_TIMEOUT \|\| state == agentproto.Lifecycle_START_ERROR {`
`279`	`279`	`expectedReadyAt = sql.NullTime{Valid: true, Time: stateNow}`
`280`	`280`	`}`
`281`	`281`