Skip to content

Add build number to workspace_build audit logs #5267

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 15 commits into from
Dec 6, 2022
Merged

Add build number to workspace_build audit logs #5267

Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
a630982
got links working
Kira-Pilot Nov 23, 2022
c988b1a
added translations
Kira-Pilot Nov 23, 2022
34a527f
fixed translation
Kira-Pilot Nov 23, 2022
b101417
added translation for unavailable ip
Kira-Pilot Nov 28, 2022
ddc0dc0
added support for group, template, user links
Kira-Pilot Nov 28, 2022
709e42e
cleaned up string
Kira-Pilot Nov 30, 2022
d5eb06a
added deleted label
Kira-Pilot Nov 30, 2022
221f089
querying for workspace id
Kira-Pilot Nov 30, 2022
8177557
remove prints
Kira-Pilot Nov 30, 2022
d1ba2b9
fix/write tests
Kira-Pilot Nov 30, 2022
3406ca7
added build number
Kira-Pilot Dec 2, 2022
3235f0f
Merge remote-tracking branch 'origin/main' into add-build-number-to-a…
Kira-Pilot Dec 2, 2022
500572b
checking for existence of additional fields
Kira-Pilot Dec 2, 2022
b62e554
adjust documentation
Kira-Pilot Dec 2, 2022
7ebb11d
PR feedback
Kira-Pilot Dec 6, 2022
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
Prev Previous commit
Next Next commit
added build number
  • Loading branch information
@Kira-Pilot
Kira-Pilot committed Dec 2, 2022
commit 3406ca738da66594bfd2a7d6dfa85529bc09178e
36 changes: 19 additions & 17 deletions coderd/audit.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,11 @@ func (api *API) convertAuditLogs(ctx context.Context, dblogs []database.GetAudit
return alogs
}

type AdditionalFields struct {
WorkspaceName string
BuildNumber string
}

func (api *API) convertAuditLog(ctx context.Context, dblog database.GetAuditLogsOffsetRow) codersdk.AuditLog {
ip, _ := netip.AddrFromSlice(dblog.Ip.IPNet.IP)

Expand All @@ -184,6 +189,13 @@ func (api *API) convertAuditLog(ctx context.Context, dblog database.GetAuditLogs
}
}

additionalFieldsBytes := []byte(dblog.AdditionalFields)
var additionalFields AdditionalFields
err := json.Unmarshal(additionalFieldsBytes, &additionalFields)
if err != nil {
api.Logger.Error(ctx, "unmarshal additional fields", slog.Error(err))
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this happens, should we try to populate additionalFields with something to show it failed, maybe like unknown.


return codersdk.AuditLog{
ID: dblog.ID,
RequestID: dblog.RequestID,
Expand All @@ -200,23 +212,24 @@ func (api *API) convertAuditLog(ctx context.Context, dblog database.GetAuditLogs
StatusCode: dblog.StatusCode,
AdditionalFields: dblog.AdditionalFields,
User: user,
Description: auditLogDescription(dblog),
ResourceLink: api.auditLogResourceLink(ctx, dblog),
Description: auditLogDescription(dblog, additionalFields),
ResourceLink: api.auditLogResourceLink(ctx, dblog, additionalFields),
IsDeleted: api.auditLogIsResourceDeleted(ctx, dblog),
}
}

func auditLogDescription(alog database.GetAuditLogsOffsetRow) string {
func auditLogDescription(alog database.GetAuditLogsOffsetRow, additionalFields AdditionalFields) string {
str := fmt.Sprintf("{user} %s",
codersdk.AuditAction(alog.Action).FriendlyString(),
)

// Strings for starting/stopping workspace builds follow the below format:
// "{user} started build for workspace {target}"
// "{user} started build #{build_number} for workspace {target}"
// where target is a workspace 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 {
str += " build for"
str += fmt.Sprintf(" build #%s for",
additionalFields.BuildNumber)
}

// We don't display the name (target) for git ssh keys. It's fairly long and doesn't
Expand Down Expand Up @@ -271,12 +284,7 @@ func (api *API) auditLogIsResourceDeleted(ctx context.Context, alog database.Get
}
}

type AdditionalFields struct {
WorkspaceName string
BuildNumber string
}

func (api *API) auditLogResourceLink(ctx context.Context, alog database.GetAuditLogsOffsetRow) string {
func (api *API) auditLogResourceLink(ctx context.Context, alog database.GetAuditLogsOffsetRow, additionalFields AdditionalFields) string {
if api.auditLogIsResourceDeleted(ctx, alog) {
return ""
}
Expand All @@ -292,12 +300,6 @@ func (api *API) auditLogResourceLink(ctx context.Context, alog database.GetAudit
return fmt.Sprintf("/@%s/%s",
alog.UserUsername.String, alog.ResourceTarget)
case database.ResourceTypeWorkspaceBuild:
additionalFieldsBytes := []byte(alog.AdditionalFields)
var additionalFields AdditionalFields
err := json.Unmarshal(additionalFieldsBytes, &additionalFields)
if err != nil {
api.Logger.Error(ctx, "could not unmarshal workspace name", slog.Error(err))
}
return fmt.Sprintf("/@%s/%s/builds/%s",
alog.UserUsername.String, additionalFields.WorkspaceName, additionalFields.BuildNumber)
default:
Expand Down