Skip to content

feat: indicate when workspace builds are stopped/started by Coder #5813

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 23, 2023
Merged

feat: indicate when workspace builds are stopped/started by Coder #5813

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a610150
feat: indicate when workspace_builds are stopped/started by Coder
Kira-Pilot Jan 20, 2023
d6da9ec
added translattion
Kira-Pilot Jan 20, 2023
d2a1b02
Merge remote-tracking branch 'origin/main' into label-build-events/ki…
Kira-Pilot Jan 23, 2023
bcd460f
added json tags and adjust type
Kira-Pilot Jan 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions coderd/audit.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,8 +180,9 @@ func (api *API) convertAuditLogs(ctx context.Context, dblogs []database.GetAudit
}

type AdditionalFields struct {
WorkspaceName string
BuildNumber string
WorkspaceName string `json:"workspace_name"`
BuildNumber string `json:"build_number"`
BuildReason database.BuildReason `json:"build_reason"`
}

func (api *API) convertAuditLog(ctx context.Context, dblog database.GetAuditLogsOffsetRow) codersdk.AuditLog {
Expand Down Expand Up @@ -219,6 +220,7 @@ func (api *API) convertAuditLog(ctx context.Context, dblog database.GetAuditLogs
resourceInfo := map[string]string{
"workspaceName": "unknown",
"buildNumber": "unknown",
"buildReason": "unknown",
}
dblog.AdditionalFields, err = json.Marshal(resourceInfo)
api.Logger.Error(ctx, "marshal additional fields", slog.Error(err))
Expand Down Expand Up @@ -262,8 +264,8 @@ func auditLogDescription(alog database.GetAuditLogsOffsetRow, additionalFields A
)

// Strings for starting/stopping workspace builds follow the below format:
// "{user} started build #{build_number} for workspace {target}"
// where target is a workspace instead of a workspace build
// "{user | 'Coder automatically'} started build #{build_number} for workspace {target}"
// where target is a workspace (name) instead of a workspace build
// passed in on the FE via AuditLog.AdditionalFields rather than derived in request.go:35
if alog.ResourceType == database.ResourceTypeWorkspaceBuild && alog.Action != database.AuditActionDelete {
if len(additionalFields.BuildNumber) == 0 {
Expand Down
2 changes: 2 additions & 0 deletions coderd/provisionerdserver/provisionerdserver.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -550,6 +550,7 @@ func (server *Server) FailJob(ctx context.Context, failJob *proto.FailedJob) (*p
buildResourceInfo := map[string]string{
"workspaceName": workspace.Name,
"buildNumber": strconv.FormatInt(int64(build.BuildNumber), 10),
"buildReason": fmt.Sprintf("%v", build.Reason),
}

wriBytes, err := json.Marshal(buildResourceInfo)
Expand Down Expand Up @@ -799,6 +800,7 @@ func (server *Server) CompleteJob(ctx context.Context, completed *proto.Complete
buildResourceInfo := map[string]string{
"workspaceName": workspace.Name,
"buildNumber": strconv.FormatInt(int64(workspaceBuild.BuildNumber), 10),
"buildReason": fmt.Sprintf("%v", workspaceBuild.Reason),
}

wriBytes, err := json.Marshal(buildResourceInfo)
Expand Down
11 changes: 9 additions & 2 deletions site/src/components/AuditLogRow/AuditLogDescription.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,17 @@ export const AuditLogDescription: FC<{ auditLog: AuditLog }> = ({
const { t } = i18next

let target = auditLog.resource_target.trim()
let user = auditLog.user?.username.trim()

// audit logs with a resource_type of workspace build use workspace name as a target
if (auditLog.resource_type === "workspace_build") {
// audit logs with a resource_type of workspace build use workspace name as a target
target = auditLog.additional_fields.workspaceName.trim()
// workspaces can be started/stopped by a user, or kicked off automatically by Coder
user =
auditLog.additional_fields.buildReason &&
auditLog.additional_fields.buildReason !== "initiator"
? t("auditLog:table.logRow.buildReason")
: auditLog.user?.username.trim()
}

// SSH key entries have no links
Expand All @@ -30,7 +37,7 @@ export const AuditLogDescription: FC<{ auditLog: AuditLog }> = ({
}

const truncatedDescription = auditLog.description
.replace("{user}", `${auditLog.user?.username.trim()}`)
.replace("{user}", `${user}`)
.replace("{target}", "")

return (
Expand Down
3 changes: 2 additions & 1 deletion site/src/i18n/en/auditLog.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@
"os": "OS: ",
"browser": "Browser: ",
"notAvailable": "Not available",
"onBehalfOf": " on behalf of {{owner}}"
"onBehalfOf": " on behalf of {{owner}}",
"buildReason": "Coder automatically"
}
},
"paywall": {
Expand Down