Add agent ID and name on agent script timing response

coder · BrunoQuaresma · Nov 1, 2024 · Oct 25, 2024 · Oct 25, 2024 · Oct 29, 2024
commit 8f15ca13e1c0df38202425a3cb5dc4d9a92e138d
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/dbauthz/dbauthz_test.go b/coderd/database/dbauthz/dbauthz_test.go
@@ -2873,13 +2873,15 @@ func (s *MethodTestSuite) TestSystemFunctions() {
 		})
 		rows := []database.GetWorkspaceAgentScriptTimingsByBuildIDRow{
 			{
-				StartedAt:   timing.StartedAt,
-				EndedAt:     timing.EndedAt,
-				Stage:       timing.Stage,
-				ScriptID:    timing.ScriptID,
-				ExitCode:    timing.ExitCode,
-				Status:      timing.Status,
-				DisplayName: script.DisplayName,
+				StartedAt:          timing.StartedAt,
+				EndedAt:            timing.EndedAt,
+				Stage:              timing.Stage,
+				ScriptID:           timing.ScriptID,
+				ExitCode:           timing.ExitCode,
+				Status:             timing.Status,
+				DisplayName:        script.DisplayName,
+				WorkspaceAgentID:   agent.ID,
+				WorkspaceAgentName: agent.Name,
 			},
 		}
 		check.Args(build.ID).Asserts(rbac.ResourceSystem, policy.ActionRead).Returns(rows)

diff --git a/coderd/database/dbmem/dbmem.go b/coderd/database/dbmem/dbmem.go
@@ -5893,14 +5893,24 @@ func (q *FakeQuerier) GetWorkspaceAgentScriptTimingsByBuildID(ctx context.Contex
 			}
 		}
 
+		var agent database.WorkspaceAgent
+		for _, a := range agents {
+			if a.ID == script.WorkspaceAgentID {
+				agent = a
+				break
+			}
+		}
+
 		rows = append(rows, database.GetWorkspaceAgentScriptTimingsByBuildIDRow{
-			ScriptID:    t.ScriptID,
-			StartedAt:   t.StartedAt,
-			EndedAt:     t.EndedAt,
-			ExitCode:    t.ExitCode,
-			Stage:       t.Stage,
-			Status:      t.Status,
-			DisplayName: script.DisplayName,
+			ScriptID:           t.ScriptID,
+			StartedAt:          t.StartedAt,
+			EndedAt:            t.EndedAt,
+			ExitCode:           t.ExitCode,
+			Stage:              t.Stage,
+			Status:             t.Status,
+			DisplayName:        script.DisplayName,
+			WorkspaceAgentID:   agent.ID,
+			WorkspaceAgentName: agent.Name,
 		})
 	}
 	return rows, nil

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
@@ -303,7 +303,11 @@ VALUES
 RETURNING workspace_agent_script_timings.*;
 
 -- name: GetWorkspaceAgentScriptTimingsByBuildID :many
-SELECT workspace_agent_script_timings.*, workspace_agent_scripts.display_name
+SELECT
+	workspace_agent_script_timings.*,
+	workspace_agent_scripts.display_name,
+	workspace_agents.id as workspace_agent_id,
+	workspace_agents.name as workspace_agent_name
 FROM workspace_agent_script_timings
 INNER JOIN workspace_agent_scripts ON workspace_agent_scripts.id = workspace_agent_script_timings.script_id
 INNER JOIN workspace_agents ON workspace_agents.id = workspace_agent_scripts.workspace_agent_id

diff --git a/coderd/workspacebuilds.go b/coderd/workspacebuilds.go
@@ -1002,12 +1002,14 @@ func (api *API) buildTimings(ctx context.Context, build database.WorkspaceBuild)
 	}
 	for _, t := range agentScriptTimings {
 		res.AgentScriptTimings = append(res.AgentScriptTimings, codersdk.AgentScriptTiming{
-			StartedAt:   t.StartedAt,
-			EndedAt:     t.EndedAt,
-			ExitCode:    t.ExitCode,
-			Stage:       string(t.Stage),
-			Status:      string(t.Status),
-			DisplayName: t.DisplayName,
+			StartedAt:          t.StartedAt,
+			EndedAt:            t.EndedAt,
+			ExitCode:           t.ExitCode,
+			Stage:              string(t.Stage),
+			Status:             string(t.Status),
+			DisplayName:        t.DisplayName,
+			WorkspaceAgentID:   t.WorkspaceAgentID.String(),
+			WorkspaceAgentName: t.WorkspaceAgentName,
 		})
 	}
 

diff --git a/coderd/workspacebuilds_test.go b/coderd/workspacebuilds_test.go
@@ -1320,6 +1320,8 @@ func TestWorkspaceBuildTimings(t *testing.T) {
 			require.Equal(t, string(genTiming.Stage), timingRes.Stage)
 			require.Equal(t, genTiming.StartedAt.UnixMilli(), timingRes.StartedAt.UnixMilli())
 			require.Equal(t, genTiming.EndedAt.UnixMilli(), timingRes.EndedAt.UnixMilli())
+			require.Equal(t, agent.ID.String(), timingRes.WorkspaceAgentID)
+			require.Equal(t, agent.Name, timingRes.WorkspaceAgentName)
 		}
 	})
 

diff --git a/codersdk/workspacebuilds.go b/codersdk/workspacebuilds.go
@@ -186,12 +186,14 @@ type ProvisionerTiming struct {
 }
 
 type AgentScriptTiming struct {
-	StartedAt   time.Time `json:"started_at" format:"date-time"`
-	EndedAt     time.Time `json:"ended_at" format:"date-time"`
-	ExitCode    int32     `json:"exit_code"`
-	Stage       string    `json:"stage"`
-	Status      string    `json:"status"`
-	DisplayName string    `json:"display_name"`
+	StartedAt          time.Time `json:"started_at" format:"date-time"`
+	EndedAt            time.Time `json:"ended_at" format:"date-time"`
+	ExitCode           int32     `json:"exit_code"`
+	Stage              string    `json:"stage"`
+	Status             string    `json:"status"`
+	DisplayName        string    `json:"display_name"`
+	WorkspaceAgentID   string    `json:"workspace_agent_id"`
+	WorkspaceAgentName string    `json:"workspace_agent_name"`
 }
 
 type WorkspaceBuildTimings struct {

diff --git a/docs/reference/api/builds.md b/docs/reference/api/builds.md
diff --git a/docs/reference/api/schemas.md b/docs/reference/api/schemas.md
diff --git a/docs/reference/api/workspaces.md b/docs/reference/api/workspaces.md
diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts