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.

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
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Next Next commit
got links working
  • Loading branch information
Kira-Pilot committed Nov 23, 2022
commit a6309822feb8ec1a016cf1809ba5c948631b3252
57 changes: 49 additions & 8 deletions coderd/audit.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package coderd

import (
"context"
"database/sql"
"encoding/json"
"fmt"
Expand All @@ -14,6 +15,7 @@ import (
"github.com/google/uuid"
"github.com/tabbed/pqtype"

"cdr.dev/slog"
"github.com/coder/coder/coderd/database"
"github.com/coder/coder/coderd/httpapi"
"github.com/coder/coder/coderd/httpmw"
Expand Down Expand Up @@ -69,7 +71,7 @@ func (api *API) auditLogs(rw http.ResponseWriter, r *http.Request) {
}

httpapi.Write(ctx, rw, http.StatusOK, codersdk.AuditLogResponse{
AuditLogs: convertAuditLogs(dblogs),
AuditLogs: api.convertAuditLogs(ctx, dblogs),
Count: dblogs[0].Count,
})
}
Expand Down Expand Up @@ -147,17 +149,17 @@ func (api *API) generateFakeAuditLog(rw http.ResponseWriter, r *http.Request) {
rw.WriteHeader(http.StatusNoContent)
}

func convertAuditLogs(dblogs []database.GetAuditLogsOffsetRow) []codersdk.AuditLog {
func (api *API) convertAuditLogs(ctx context.Context, dblogs []database.GetAuditLogsOffsetRow) []codersdk.AuditLog {
alogs := make([]codersdk.AuditLog, 0, len(dblogs))

for _, dblog := range dblogs {
alogs = append(alogs, convertAuditLog(dblog))
alogs = append(alogs, api.convertAuditLog(ctx, dblog))
}

return alogs
}

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

diff := codersdk.AuditDiff{}
Expand Down Expand Up @@ -199,21 +201,60 @@ func convertAuditLog(dblog database.GetAuditLogsOffsetRow) codersdk.AuditLog {
AdditionalFields: dblog.AdditionalFields,
Description: auditLogDescription(dblog),
User: user,
ResourceLink: api.auditLogResourceLink(ctx, dblog),
}
}

type AdditionalFields struct {
WorkspaceName string
BuildNumber string
}

func (api *API) auditLogResourceLink(ctx context.Context, alog database.GetAuditLogsOffsetRow) string {
switch alog.ResourceType {
case database.ResourceTypeOrganization:
return ""
case database.ResourceTypeTemplate:
return ""
case database.ResourceTypeTemplateVersion:
return ""
case database.ResourceTypeUser:
return ""
case database.ResourceTypeWorkspace:
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 for friendly string", slog.Error(err))
}
return fmt.Sprintf("/@%s/%s/builds/%s",
alog.UserUsername.String, additionalFields.WorkspaceName, additionalFields.BuildNumber)
case database.ResourceTypeGitSshKey:
return ""
case database.ResourceTypeApiKey:
return ""
case database.ResourceTypeGroup:
return ""
default:
return ""
}
}

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

// Strings for workspace_builds follow the below format:
// "{user} started workspace build for {target}"
// where target is a workspace instead of the workspace build,
// passed in on the FE via AuditLog.AdditionalFields rather than derived in request.go:35
if alog.ResourceType == database.ResourceTypeWorkspaceBuild {
str += " for"
if alog.ResourceType != database.ResourceTypeWorkspaceBuild {
str += fmt.Sprintf(" %s",
codersdk.ResourceType(alog.ResourceType).FriendlyString())
}

// We don't display the name for git ssh keys. It's fairly long and doesn't
Expand Down
3 changes: 3 additions & 0 deletions coderd/provisionerdserver/provisionerdserver.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (
"net/http"
"net/url"
"reflect"
"strconv"
"sync"
"sync/atomic"
"time"
Expand Down Expand Up @@ -541,6 +542,7 @@ func (server *Server) FailJob(ctx context.Context, failJob *proto.FailedJob) (*p
// can form a friendly string for the user.
workspaceResourceInfo := map[string]string{
"workspaceName": workspace.Name,
"buildNumber": strconv.FormatInt(int64(build.BuildNumber), 10),
}

wriBytes, err := json.Marshal(workspaceResourceInfo)
Expand Down Expand Up @@ -756,6 +758,7 @@ func (server *Server) CompleteJob(ctx context.Context, completed *proto.Complete
// can form a friendly string for the user.
workspaceResourceInfo := map[string]string{
"workspaceName": workspace.Name,
"buildNumber": strconv.FormatInt(int64(workspaceBuild.BuildNumber), 10),
}

wriBytes, err := json.Marshal(workspaceResourceInfo)
Expand Down
1 change: 1 addition & 0 deletions codersdk/audit.go
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ type AuditLog struct {
StatusCode int32 `json:"status_code"`
AdditionalFields json.RawMessage `json:"additional_fields"`
Description string `json:"description"`
ResourceLink string `json:"resource_link"`

User *User `json:"user"`
}
Expand Down
1 change: 1 addition & 0 deletions site/src/api/typesGenerated.ts
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ export interface AuditLog {
readonly status_code: number
readonly additional_fields: Record<string, string>
readonly description: string
readonly resource_link: string
readonly user?: User
}

Expand Down
58 changes: 48 additions & 10 deletions site/src/components/AuditLogRow/AuditLogRow.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,45 @@ import { PaletteIndex } from "theme/palettes"
import userAgentParser from "ua-parser-js"
import { combineClasses } from "util/combineClasses"
import { AuditLogDiff } from "./AuditLogDiff"
import { Link } from "react-router-dom"

export const readableActionMessage = (auditLog: AuditLog): string => {
// const determineInitiator = (auditLog: AuditLog): string => {
// return auditLog.
// }

const determineResourceTarget = (auditLog: AuditLog): string => {
let target = auditLog.resource_target.trim()

// audit logs with a resource_type of workspace build use workspace name as a target
if (
auditLog.resource_type === "workspace_build" &&
auditLog.additional_fields.workspaceName
) {
target = auditLog.additional_fields.workspaceName.trim()
if (auditLog.resource_type === "workspace_build") {
// target = auditLog.additional_fields.workspaceName.trim()
target = "build"
}

return target
}

export const readableActionMessage = (auditLog: AuditLog): string => {
// let target = auditLog.resource_target.trim()

// audit logs with a resource_type of workspace build use workspace name as a target
// if (
// auditLog.resource_type === "workspace_build" &&
// auditLog.additional_fields.workspaceName
// ) {
// target = auditLog.additional_fields.workspaceName.trim()
// }

return auditLog.description
.replace("{user}", `<strong>${auditLog.user?.username.trim()}</strong>`)
.replace("{target}", `<strong>${target}</strong>`)
.replace("{user}", `${auditLog.user?.username.trim()}`)
.replace("{target}", "")

// return auditLog.description
// .replace("{user}", `<strong>${auditLog.user?.username.trim()}</strong>`)
// .replace(
// "{target}",
// `<Link to=/@${auditLog.user?.username.trim()}/${target}>${target}</Link>`,
// )
}

const httpStatusColor = (httpStatus: number): PaletteIndex => {
Expand Down Expand Up @@ -119,11 +143,25 @@ export const AuditLogRow: React.FC<AuditLogRowProps> = ({
alignItems="baseline"
spacing={1}
>
<span
<span>
{readableActionMessage(auditLog)}{" "}
<Link to={auditLog.resource_link}>
{determineResourceTarget(auditLog)}
</Link>
{auditLog.resource_type === "workspace_build" &&
auditLog.additional_fields.workspaceName && (
<span>
{" "}
for workspace{" "}
{auditLog.additional_fields.workspaceName}
</span>
)}
</span>
{/* <span
dangerouslySetInnerHTML={{
__html: readableActionMessage(auditLog),
}}
/>
/> */}
<span className={styles.auditLogTime}>
{new Date(auditLog.time).toLocaleTimeString()}
</span>
Expand Down