Skip to content

feat: Redesign build logs #4734

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 9 commits into from
Oct 25, 2022
Merged

feat: Redesign build logs #4734

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
41b79d0
feat: Redesign build logs
BrunoQuaresma Oct 24, 2022
7e97461
Fix tests
BrunoQuaresma Oct 24, 2022
24ccec4
Fix tests
BrunoQuaresma Oct 24, 2022
6dc9cd2
Fix test
BrunoQuaresma Oct 24, 2022
19eb0cb
Update site/src/components/BuildsTable/BuildDateRow.tsx
BrunoQuaresma Oct 25, 2022
ef080c3
Apply suggestions from code review
BrunoQuaresma Oct 25, 2022
a9a7baf
Fix navigable build log
BrunoQuaresma Oct 25, 2022
6cd9659
Improve translation and table row focus
BrunoQuaresma Oct 25, 2022
b947be1
Fix show more resources button
BrunoQuaresma Oct 25, 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
71 changes: 71 additions & 0 deletions site/src/components/BuildsTable/BuildAvatar.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
import Avatar from "@material-ui/core/Avatar"
import Badge from "@material-ui/core/Badge"
import { Theme, useTheme, withStyles } from "@material-ui/core/styles"
import { FC } from "react"
import PlayArrowOutlined from "@material-ui/icons/PlayArrowOutlined"
import PauseOutlined from "@material-ui/icons/PauseOutlined"
import DeleteOutlined from "@material-ui/icons/DeleteOutlined"
import { WorkspaceBuild, WorkspaceTransition } from "api/typesGenerated"
import { getDisplayWorkspaceBuildStatus } from "util/workspace"
import { PaletteIndex } from "theme/palettes"

interface StylesBadgeProps {
type: PaletteIndex
}

const StyledBadge = withStyles((theme) => ({
badge: {
backgroundColor: ({ type }: StylesBadgeProps) => theme.palette[type].light,
borderRadius: "100%",
width: 8,
minWidth: 8,
height: 8,
display: "block",
padding: 0,
},
}))(Badge)

const StyledAvatar = withStyles((theme) => ({
root: {
background: theme.palette.background.paperLight,
color: theme.palette.text.primary,
border: `2px solid ${theme.palette.divider}`,

"& svg": {
width: 24,
height: 24,
},
},
}))(Avatar)

export type BuildAvatarProps = {
build: WorkspaceBuild
}

const iconByTransition: Record<WorkspaceTransition, JSX.Element> = {
start: <PlayArrowOutlined />,
stop: <PauseOutlined />,
delete: <DeleteOutlined />,
}

export const BuildAvatar: FC<BuildAvatarProps> = ({ build }) => {
const theme = useTheme<Theme>()
const displayBuildStatus = getDisplayWorkspaceBuildStatus(theme, build)

return (
<StyledBadge
role="status"
type={displayBuildStatus.type}
arial-label={displayBuildStatus.status}
title={displayBuildStatus.status}
overlap="circular"
anchorOrigin={{
vertical: "bottom",
horizontal: "right",
}}
badgeContent={<div></div>}
>
<StyledAvatar>{iconByTransition[build.transition]}</StyledAvatar>
</StyledBadge>
)
}
45 changes: 45 additions & 0 deletions site/src/components/BuildsTable/BuildDateRow.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
import { makeStyles } from "@material-ui/core/styles"
import TableCell from "@material-ui/core/TableCell"
import TableRow from "@material-ui/core/TableRow"
import formatRelative from "date-fns/formatRelative"

export interface BuildDateRow {
date: Date
}

export const BuildDateRow: React.FC<BuildDateRow> = ({ date }) => {
const styles = useStyles()
// We only want the message related to the date since the time is displayed
// inside of the build row
const displayDate = formatRelative(date, new Date()).split("at")[0]

return (
<TableRow className={styles.buildDateRow}>
<TableCell
className={styles.buildDateCell}
title={date.toLocaleDateString()}
>
{displayDate}
</TableCell>
</TableRow>
)
}

const useStyles = makeStyles((theme) => ({
buildDateRow: {
background: theme.palette.background.paper,

"&:not(:first-child) td": {
borderTop: `1px solid ${theme.palette.divider}`,
},
},

buildDateCell: {
padding: `${theme.spacing(1, 4)} !important`,
background: `${theme.palette.background.paperLight} !important`,
fontSize: 12,
position: "relative",
color: theme.palette.text.secondary,
textTransform: "capitalize",
},
}))
140 changes: 140 additions & 0 deletions site/src/components/BuildsTable/BuildRow.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,140 @@
import { makeStyles } from "@material-ui/core/styles"
import TableCell from "@material-ui/core/TableCell"
import TableRow from "@material-ui/core/TableRow"
import { WorkspaceBuild } from "api/typesGenerated"
import { Stack } from "components/Stack/Stack"
import { useTranslation } from "react-i18next"
import { MONOSPACE_FONT_FAMILY } from "theme/constants"
import {
displayWorkspaceBuildDuration,
getDisplayWorkspaceBuildInitiatedBy,
} from "util/workspace"
import { BuildAvatar } from "./BuildAvatar"

export interface BuildRowProps {
build: WorkspaceBuild
}

export const BuildRow: React.FC<BuildRowProps> = ({ build }) => {
const styles = useStyles()
const { t } = useTranslation("workspacePage")
const initiatedBy = getDisplayWorkspaceBuildInitiatedBy(build)

return (
<TableRow
hover
key={build.id}
data-testid={`build-${build.id}`}
className={styles.buildRow}
Copy link
Member

Choose a reason for hiding this comment

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

This is such a nice, tabbable table! I would love to be able to hit 'enter' and navigate to the log page without having to touch my mouse.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I was watching TV when I "remembered" that I forgot to add the link 😆 I'm glad you found it as well, really good review 🌮

>
<TableCell className={styles.buildCell}>
<Stack
direction="row"
alignItems="center"
className={styles.buildRow}
tabIndex={0}
>
<Stack
direction="row"
alignItems="center"
justifyContent="space-between"
className={styles.buildRowMain}
>
<Stack direction="row" alignItems="center">
<BuildAvatar build={build} />
<div>
<Stack
className={styles.buildResume}
direction="row"
alignItems="center"
spacing={1}
>
<span>
<strong>{initiatedBy}</strong>{" "}
Copy link
Member

Choose a reason for hiding this comment

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

We can add translations with formatting by using a Trans component.
Presley asked me to write out an example, so there's one in our how-tos.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I found it hard to use Trans here because of the conditionals but I moved the text to translation files.

{build.reason !== "initiator" ? "automatically " : " "}
<strong>
{t(`buildTransitionMessage.${build.transition}`)}
</strong>{" "}
the workspace
</span>

<span className={styles.buildTime}>
{new Date(build.created_at).toLocaleTimeString()}
</span>
</Stack>

<Stack direction="row" spacing={1}>
<span className={styles.buildInfo}>
Reason: <strong>{build.reason}</strong>
</span>

<span className={styles.buildInfo}>
Duration:{" "}
<strong>{displayWorkspaceBuildDuration(build)}</strong>
</span>
</Stack>
</div>
</Stack>
</Stack>
</Stack>
</TableCell>
</TableRow>
)
}

const useStyles = makeStyles((theme) => ({
buildRow: {
padding: theme.spacing(2, 4),
cursor: "pointer",

"&:not(:last-child) td:before": {
position: "absolute",
top: 20,
left: 50,
display: "block",
content: "''",
height: "100%",
width: 2,
background: theme.palette.divider,
},
},

buildCell: {
padding: "0 !important",
position: "relative",
borderBottom: 0,
},

buildRowMain: {
flex: 1,
},

buildResume: {
...theme.typography.body1,
fontFamily: "inherit",
},

buildInfo: {
...theme.typography.body2,
fontSize: 12,
fontFamily: "inherit",
color: theme.palette.text.secondary,
display: "block",
},

buildTime: {
color: theme.palette.text.secondary,
fontSize: 12,
},

buildRight: {
width: "auto",
},

buildExtraInfo: {
...theme.typography.body2,
fontFamily: MONOSPACE_FONT_FAMILY,
color: theme.palette.text.secondary,
whiteSpace: "nowrap",
},
}))
Loading