enhance workspace build data and audit log with build reason display

kacpersaw · kacpersaw · commit 6803acebadb3 · 2025-07-15T12:51:03.000Z
diff --git a/site/src/api/api.ts b/site/src/api/api.ts
@@ -1255,6 +1255,7 @@ class ApiMethods {
 			template_version_id: templateVersionId,
 			log_level: logLevel,
 			rich_parameter_values: buildParameters,
+			reason: "dashboard",
 		});
 	};
 
diff --git a/site/src/modules/workspaces/WorkspaceBuildData/WorkspaceBuildData.tsx b/site/src/modules/workspaces/WorkspaceBuildData/WorkspaceBuildData.tsx
@@ -1,12 +1,15 @@
 import { type Interpolation, type Theme, useTheme } from "@emotion/react";
+import Tooltip from "@mui/material/Tooltip";
 import Skeleton from "@mui/material/Skeleton";
 import type { WorkspaceBuild } from "api/typesGenerated";
 import { BuildIcon } from "components/BuildIcon/BuildIcon";
 import { createDayString } from "utils/createDayString";
 import {
+	getDisplayInitiatorBuildReason,
 	getDisplayWorkspaceBuildInitiatedBy,
 	getDisplayWorkspaceBuildStatus,
 } from "utils/workspace";
+import { InfoIcon } from "lucide-react";
 
 export const WorkspaceBuildData = ({ build }: { build: WorkspaceBuild }) => {
 	const theme = useTheme();
@@ -29,13 +32,26 @@ export const WorkspaceBuildData = ({ build }: { build: WorkspaceBuild }) => {
 						textOverflow: "ellipsis",
 						overflow: "hidden",
 						whiteSpace: "nowrap",
+						display: "flex",
+						alignItems: "center",
+						gap: 4,
 					}}
 				>
 					<span css={{ textTransform: "capitalize" }}>{build.transition}</span>{" "}
 					by{" "}
 					<span css={{ fontWeight: 500 }}>
 						{getDisplayWorkspaceBuildInitiatedBy(build)}
 					</span>
+					{getDisplayInitiatorBuildReason(build.reason) && build.transition === 'start' && (
+						<Tooltip title={getDisplayInitiatorBuildReason(build.reason)}>
+							<InfoIcon
+								css={(theme) => ({
+									color: theme.palette.info.light,
+								})}
+								className="size-icon-xs -mt-px"
+							/>
+						</Tooltip>
+					)}
 				</div>
 				<div
 					css={{
diff --git a/site/src/pages/AuditPage/AuditLogRow/AuditLogDescription/BuildAuditDescription.tsx b/site/src/pages/AuditPage/AuditLogRow/AuditLogDescription/BuildAuditDescription.tsx
@@ -12,9 +12,10 @@ export const BuildAuditDescription: FC<BuildAuditDescriptionProps> = ({
 }) => {
 	const workspaceName = auditLog.additional_fields?.workspace_name?.trim();
 	// workspaces can be started/stopped/deleted by a user, or kicked off automatically by Coder
+	const systemReasons = ["autostart", "autostop", "dormancy"];
 	const user =
 		auditLog.additional_fields?.build_reason &&
-		auditLog.additional_fields?.build_reason !== "initiator"
+		systemReasons.includes(auditLog.additional_fields?.build_reason)
 			? "Coder automatically"
 			: auditLog.user
 				? auditLog.user.username.trim()
diff --git a/site/src/pages/AuditPage/AuditLogRow/AuditLogRow.tsx b/site/src/pages/AuditPage/AuditLogRow/AuditLogRow.tsx
@@ -21,6 +21,7 @@ import {
 	determineGroupDiff,
 	determineIdPSyncMappingDiff,
 } from "./AuditLogDiff/auditUtils";
+import { getDisplayInitiatorBuildReason } from "utils/workspace";
 
 const httpStatusColor = (httpStatus: number): ThemeRole => {
 	// Treat server errors (500) as errors
@@ -182,10 +183,10 @@ export const AuditLogRow: FC<AuditLogRowProps> = ({
 															</Link>
 														</div>
 													)}
-													{auditLog.additional_fields?.reason && (
+													{getDisplayInitiatorBuildReason(auditLog.additional_fields?.build_reason) && auditLog.action === 'start' && (
 														<div>
 															<h4 css={styles.auditLogInfoHeader}>Reason:</h4>
-															<div>{auditLog.additional_fields?.reason}</div>
+															<div>{getDisplayInitiatorBuildReason(auditLog.additional_fields?.build_reason)}</div>
 														</div>
 													)}
 												</div>
@@ -219,6 +220,12 @@ export const AuditLogRow: FC<AuditLogRowProps> = ({
 													</strong>
 												</span>
 											)}
+											{getDisplayInitiatorBuildReason(auditLog.additional_fields?.build_reason) && auditLog.action === 'start' && (
+												<span css={styles.auditLogInfo}>
+													<span>Reason: </span>
+													<strong>{getDisplayInitiatorBuildReason(auditLog.additional_fields?.build_reason)}</strong>
+												</span>
+											)}
 										</Stack>
 									)}
 								</Stack>
diff --git a/site/src/utils/workspace.tsx b/site/src/utils/workspace.tsx
@@ -78,11 +78,24 @@ export const getDisplayWorkspaceBuildInitiatedBy = (
 ): string | undefined => {
 	switch (build.reason) {
 		case "initiator":
+		case "dashboard":
+		case "cli":
+		case "ssh_connection":
+		case "vscode_connection":
+		case "jetbrains_connection":
 			return build.initiator_name;
 		case "autostart":
 		case "autostop":
 		case "dormancy":
 			return "Coder";
+	}
+	return undefined;
+};
+
+export const getDisplayInitiatorBuildReason = (buildReason: string): string | undefined => {
+	switch (buildReason) {
+		case "initiator":
+			return "API";
 		case "dashboard":
 			return "Dashboard";
 		case "cli":
