Skip to content

fix: Audit log human parse message and nullable diffs #3978

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 2 commits into from
Sep 9, 2022
Merged

fix: Audit log human parse message and nullable diffs #3978

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
53db53d
fix: Audit log human parse message and nullable diffs
BrunoQuaresma Sep 9, 2022
9e41869
Fix diff values
BrunoQuaresma Sep 9, 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
11 changes: 10 additions & 1 deletion site/src/components/AuditLogRow/AuditLogDiff.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,20 @@ import { colors } from "theme/colors"
import { MONOSPACE_FONT_FAMILY } from "theme/constants"
import { combineClasses } from "util/combineClasses"

const getDiffValue = (value: number | string | boolean) => {
const getDiffValue = (value: unknown): string => {
if (typeof value === "string") {
return `"${value}"`
}

if (Array.isArray(value)) {
const values = value.map((v) => getDiffValue(v))
return `[${values.join(", ")}]`
}

if (value === null || value === undefined) {
return "null"
}

return value.toString()
}

Expand Down
31 changes: 7 additions & 24 deletions site/src/components/AuditLogRow/AuditLogRow.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ import { CloseDropdown, OpenDropdown } from "components/DropdownArrows/DropdownA
import { Pill } from "components/Pill/Pill"
import { Stack } from "components/Stack/Stack"
import { UserAvatar } from "components/UserAvatar/UserAvatar"
import { t } from "i18next"
import { ComponentProps, useState } from "react"
import { MONOSPACE_FONT_FAMILY } from "theme/constants"
import userAgentParser from "ua-parser-js"
Expand All @@ -26,26 +25,10 @@ const pillTypeByHttpStatus = (httpStatus: number): ComponentProps<typeof Pill>["
return "success"
}

const actionLabelByAction: Record<AuditLog["action"], string> = {
create: t("actions.create", { ns: "auditLog" }),
write: t("actions.write", { ns: "auditLog" }),
delete: t("actions.delete", { ns: "auditLog" }),
}

const resourceLabelByResourceType: Record<AuditLog["resource_type"], string> = {
organization: "organization",
template: "template",
template_version: "template version",
user: "user",
workspace: "workspace",
git_ssh_key: "git ssh key",
api_key: "api key",
}

const readableActionMessage = (auditLog: AuditLog) => {
return `${actionLabelByAction[auditLog.action]} ${
resourceLabelByResourceType[auditLog.resource_type]
}`
return auditLog.description
.replace("{user}", `<strong>${auditLog.user?.username}</strong>`)
.replace("{target}", `<strong>${auditLog.resource_target}</strong>`)
}

export interface AuditLogRowProps {
Expand Down Expand Up @@ -98,10 +81,10 @@ export const AuditLogRow: React.FC<AuditLogRowProps> = ({
avatarURL={auditLog.user?.avatar_url}
/>
<div>
<span className={styles.auditLogResume}>
<strong>{auditLog.user?.username}</strong> {readableActionMessage(auditLog)}{" "}
<strong>{auditLog.resource_target}</strong>
</span>
<span
className={styles.auditLogResume}
dangerouslySetInnerHTML={{ __html: readableActionMessage(auditLog) }}
/>
<span className={styles.auditLogTime}>{createDayString(auditLog.time)}</span>
</div>
</Stack>
Expand Down
7 changes: 6 additions & 1 deletion site/src/testHelpers/entities.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -775,7 +775,7 @@ export const MockAuditLog: TypesGen.AuditLog = {
diff: {},
status_code: 200,
additional_fields: "",
description: "Colin Adler updated the workspace bruno-dev",
description: "{user} updated workspace {target}",
user: MockUser,
}

Expand All @@ -799,5 +799,10 @@ export const MockAuditLog2: TypesGen.AuditLog = {
new: "53bded77-7b9d-4e82-8771-991a34d759f9",
secret: false,
},
roles: {
old: null,
new: ["admin", "auditor"],
secret: false,
},
},
}