chore: change build audit log string to be clearer #6093
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| import { FC } from "react" | ||
| import { AuditLog } from "api/typesGenerated" | ||
| import { Link as RouterLink } from "react-router-dom" | ||
| import Link from "@material-ui/core/Link" | ||
| import { Trans, useTranslation } from "react-i18next" | ||
| import { BuildAuditDescription } from "./BuildAuditDescription" | ||
|
|
||
| export const AuditLogDescription: FC<{ auditLog: AuditLog }> = ({ | ||
| auditLog, | ||
| }): JSX.Element => { | ||
| const { t } = useTranslation("auditLog") | ||
|
|
||
| let target = auditLog.resource_target.trim() | ||
| const user = auditLog.user ? auditLog.user.username.trim() : "an unknown user" | ||
|
|
||
| if (auditLog.resource_type === "workspace_build") { | ||
| return <BuildAuditDescription auditLog={auditLog} /> | ||
| } | ||
|
|
||
| // SSH key entries have no links | ||
| if (auditLog.resource_type === "git_ssh_key") { | ||
| target = "" | ||
| } | ||
|
|
||
| const truncatedDescription = auditLog.description | ||
| .replace("{user}", `${user}`) | ||
| .replace("{target}", "") | ||
|
|
||
| // logs for workspaces created on behalf of other users indicate ownership in the description | ||
| const onBehalfOf = | ||
| auditLog.additional_fields.workspace_owner && | ||
| auditLog.additional_fields.workspace_owner !== "unknown" && | ||
| auditLog.additional_fields.workspace_owner !== auditLog.user?.username | ||
| ? `on behalf of ${auditLog.additional_fields.workspace_owner}` | ||
| : "" | ||
|
|
||
| if (auditLog.resource_link) { | ||
| return ( | ||
| <span> | ||
| <Trans | ||
| t={t} | ||
| i18nKey="table.logRow.description.linkedAuditDescription" | ||
| values={{ truncatedDescription, target, onBehalfOf }} | ||
| > | ||
| {"{{truncatedDescription}}"} | ||
| <Link component={RouterLink} to={auditLog.resource_link}> | ||
| <strong>{"{{target}}"}</strong> | ||
| </Link> | ||
| {"{{onBehalfOf}}"} | ||
| </Trans> | ||
| </span> | ||
| ) | ||
| } | ||
|
|
||
| return ( | ||
| <span> | ||
| <Trans | ||
| t={t} | ||
| i18nKey="table.logRow.description.unlinkedAuditDescription" | ||
| values={{ truncatedDescription, target, onBehalfOf }} | ||
| > | ||
| {"{{truncatedDescription}}"} | ||
| <strong>{"{{target}}"}</strong> | ||
| {"{{onBehalfOf}}"} | ||
| </Trans> | ||
| </span> | ||
| ) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| 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") | ||
|
|
||
| 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" | ||
|
|
||
| if (auditLog.resource_link) { | ||
| return ( | ||
| <span> | ||
| <Trans | ||
| t={t} | ||
| i18nKey="table.logRow.description.linkedWorkspaceBuild" | ||
| values={{ user, action, workspaceName }} | ||
| > | ||
| {"{{user}}"} | ||
| <Link component={RouterLink} to={auditLog.resource_link}> | ||
| {"{{action}}"} | ||
| </Link> | ||
| workspace{"{{workspaceName}}"} | ||
| </Trans> | ||
| </span> | ||
| ) | ||
| } | ||
|
|
||
| return ( | ||
| <span> | ||
| <Trans | ||
| t={t} | ||
| i18nKey="table.logRow.description.unlinkedWorkspaceBuild" | ||
| values={{ user, action, workspaceName }} | ||
| > | ||
| {"{{user}}"} | ||
| {"{{action}}"}workspace{"{{workspaceName}}"} | ||
| </Trans> | ||
| </span> | ||
| ) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| export { AuditLogDescription } from "./AuditLogDescription" |
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| export { AuditLogDiff } from "./AuditLogDiff" | ||
| export { determineGroupDiff } from "./auditUtils" |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We're getting changes here because I ran into this issue and had to re-add canvas.