Thanks to visit codestin.com
Credit goes to github.com

Skip to content

chore: change build audit log string to be clearer #6093

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 10 commits into from
Feb 8, 2023
Merged

chore: change build audit log string to be clearer #6093

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
f9d28b0
changed bbuild string
Kira-Pilot Feb 7, 2023
7f71c2a
clean up friendly string
Kira-Pilot Feb 7, 2023
0125d4f
using Trans component
Kira-Pilot Feb 7, 2023
c182357
general cleanup
Kira-Pilot Feb 7, 2023
7ca2a8b
fixed tests
Kira-Pilot Feb 7, 2023
57c1529
fix lint
Kira-Pilot Feb 7, 2023
ec75fb7
Merge remote-tracking branch 'origin/main' into fix-build-string/kira…
Kira-Pilot Feb 7, 2023
d0ba8eb
fixing bolding
Kira-Pilot Feb 7, 2023
3a34e5e
removing dead strings in auditLogRow
Kira-Pilot Feb 7, 2023
a2b461e
fix tests
Kira-Pilot Feb 7, 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
Prev Previous commit
Next Next commit
using Trans component
  • Loading branch information
@Kira-Pilot
Kira-Pilot committed Feb 7, 2023
commit 0125d4f457f2bd8813eaa673cedadeebe570eedd
63 changes: 21 additions & 42 deletions site/src/components/AuditLogRow/AuditLogDescription.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,55 +3,19 @@ import { AuditLog } from "api/typesGenerated"
import { Link as RouterLink } from "react-router-dom"
import Link from "@material-ui/core/Link"
import { makeStyles } from "@material-ui/core/styles"
import i18next from "i18next"

const BuildAuditDescription: FC<{ auditLog: AuditLog }> = ({
auditLog,
}): JSX.Element => {
const { t } = i18next

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

const actionVerb =
auditLog.action === "start"
? t("auditLog:table.logRow.started")
: t("auditLog:table.logRow.stopped")

return (
<span>
<>
{user}{" "}
{auditLog.resource_link ? (
<Link component={RouterLink} to={auditLog.resource_link}>
<strong>{actionVerb}</strong>
</Link>
) : (
{ actionVerb }
)}{" "}
{t("auditLog:table.logRow.workspace")}
<strong>{target}</strong>
</>
</span>
)
}
import { useTranslation } from "react-i18next"
import { BuildAuditDescription } from "./BuildAuditDescription"

export const AuditLogDescription: FC<{ auditLog: AuditLog }> = ({
auditLog,
}): JSX.Element => {
const classes = useStyles()
const { t } = i18next
const { t } = useTranslation("auditLog")

const target = auditLog.resource_target.trim()
const user = auditLog.user
? auditLog.user.username.trim()
: t("auditLog:table.logRow.unknownUser")
: t("table.logRow.unknownUser")

if (auditLog.resource_type === "workspace_build") {
return <BuildAuditDescription auditLog={auditLog} />
Expand All @@ -72,6 +36,21 @@ export const AuditLogDescription: FC<{ auditLog: AuditLog }> = ({
.replace("{user}", `${user}`)
.replace("{target}", "")

// return (
// <span>
// <Trans
// t={t}
// i18nKey="table.logRow.auditDescription"
// values={{ truncatedDescription, target }}
// >
// {"{{truncatedDescription}}"}
// <Link component={RouterLink} to={auditLog.resource_link}>
// <strong>{"{{target}}"}</strong>
// </Link>
// </Trans>
// </span>
// )

return (
<span>
{truncatedDescription}
Expand All @@ -84,7 +63,7 @@ export const AuditLogDescription: FC<{ auditLog: AuditLog }> = ({
)}
{auditLog.is_deleted && (
<span className={classes.deletedLabel}>
<>{t("auditLog:table.logRow.deletedLabel")}</>
<>{t("table.logRow.deletedLabel")}</>
</span>
)}
{/* logs for workspaces created on behalf of other users indicate ownership in the description */}
Expand All @@ -94,7 +73,7 @@ export const AuditLogDescription: FC<{ auditLog: AuditLog }> = ({
auditLog.user?.username && (
<span>
<>
{t("auditLog:table.logRow.onBehalfOf", {
{t("table.logRow.onBehalfOf", {
owner: auditLog.additional_fields.workspace_owner,
})}
</>
Expand Down
38 changes: 38 additions & 0 deletions site/src/components/AuditLogRow/BuildAuditDescription.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
import { Trans, useTranslation } from "react-i18next"
import { AuditLog } from "api/typesGenerated"
import { FC } from "react"
import { Link as RouterLink } from "react-router-dom"
import Link from "@material-ui/core/Link"

export const BuildAuditDescription: FC<{ auditLog: AuditLog }> = ({
auditLog,
}): JSX.Element => {
const { t } = useTranslation("auditLog")

// audit logs with a resource_type of workspace build use workspace name as a target
const workspaceName = auditLog.additional_fields?.workspace_name?.trim()
// workspaces can be started/stopped by a user, or kicked off automatically by Coder
const user =
auditLog.additional_fields?.build_reason &&
auditLog.additional_fields?.build_reason !== "initiator"
? "Coder automatically"
: auditLog.user?.username.trim()

const action = auditLog.action === "start" ? "started" : "stopped"

return (
<span>
<Trans
t={t}
i18nKey="table.logRow.workspaceBuild"
values={{ user, action, workspaceName }}
>
{"{{user}}"}
<Link component={RouterLink} to={auditLog.resource_link}>
{"{{action}}"}
</Link>
workspace{"{{workspaceName}}"}
</Trans>
</span>
)
}
6 changes: 2 additions & 4 deletions site/src/i18n/en/auditLog.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,9 @@
"os": "OS: ",
"browser": "Browser: ",
"onBehalfOf": " on behalf of {{owner}}",
"buildReason": "Coder automatically",
"unknownUser": "an unknown user",
"started": "started",
"stopped": "stopped",
"workspace": " workspace "
"workspaceBuild": "{{user}} <1>{{action}}</1> workspace <strong>{{workspaceName}}</strong>",
"auditDescription": "{{truncatedDescription}} <1>{{target}}</1>"
}
},
"paywall": {
Expand Down