10000 feat: Add workspace build logs page by BrunoQuaresma · Pull Request #1598 · coder/coder · GitHub
[go: up one dir, main page]

Skip to content

feat: Add workspace build logs page #1598

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 14 commits into from
May 19, 2022
Merged
Show file tree
Hide file tree
Changes from 7 commits
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
6 changes: 4 additions & 2 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"cSpell.words": [
"buildname",
"circbuf",
"cliflag",
"cliui",
Expand Down Expand Up @@ -55,6 +56,7 @@
"TCGETS",
"tcpip",
"TCSETS",
"testid",
"tfexec",
"tfjson",
"tfstate",
Expand All @@ -76,7 +78,7 @@
},
{
"match": "provisionerd/proto/provis 10000 ionerd.proto",
"cmd": "make provisionerd/proto/provisionerd.pb.go",
"cmd": "make provisionerd/proto/provisionerd.pb.go"
}
]
},
Expand Down Expand Up @@ -104,5 +106,5 @@
},
// We often use a version of TypeScript that's ahead of the version shipped
// with VS Code.
"typescript.tsdk": "./site/node_modules/typescript/lib",
"typescript.tsdk": "./site/node_modules/typescript/lib"
}
10 changes: 10 additions & 0 deletions site/src/AppRouter.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import { SSHKeysPage } from "./pages/SettingsPages/SSHKeysPage/SSHKeysPage"
import TemplatesPage from "./pages/TemplatesPage/TemplatesPage"
import { CreateUserPage } from "./pages/UsersPage/CreateUserPage/CreateUserPage"
import { UsersPage } from "./pages/UsersPage/UsersPage"
import { WorkspaceBuildPage } from "./pages/WorkspaceBuildPage/WorkspaceBuildPage"
import { WorkspacePage } from "./pages/WorkspacePage/WorkspacePage"
import { WorkspaceSettingsPage } from "./pages/WorkspaceSettingsPage/WorkspaceSettingsPage"

Expand Down Expand Up @@ -138,6 +139,15 @@ export const AppRouter: React.FC = () => (
</Route>
</Route>

<Route
path="builds/:buildId"
element={
<AuthAndFrame>
<WorkspaceBuildPage />
</AuthAndFrame>
}
/>

{/* Using path="*"" means "match anything", so this route
acts like a catch-all for URLs that we don't have explicit
routes for. */}
Expand Down
12 changes: 11 additions & 1 deletion site/src/api/api.ts
D7AE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import axios, { AxiosRequestHeaders } from "axios"
import { mutate } from "swr"
import { WorkspaceBuildTransition } from "./types"
import { ProvisionerJobLog, WorkspaceBuildTransition } from "./types"
import * as TypesGen from "./typesGenerated"

const CONTENT_TYPE_JSON: AxiosRequestHeaders = {
Expand Down Expand Up @@ -248,3 +248,13 @@ export const getWorkspaceBuilds = async (workspaceId: string): Promise<TypesGen.
const response = await axios.get<TypesGen.WorkspaceBuild[]>(`/api/v2/workspaces/${workspaceId}/builds`)
return response.data
}

export const getWorkspaceBuild = async (workspaceId: string): Promise<TypesGen.WorkspaceBuild> => {
const response = await axios.get<TypesGen.WorkspaceBuild>(`/api/v2/workspacebuilds/${workspaceId}`)
return response.data
}

export const getWorkspaceBuildLogs = async (buildname: string): Promise<ProvisionerJobLog[]> => {
const response = await axios.get<ProvisionerJobLog[]>(`/api/v2/workspacebuilds/${buildname}/logs`)
return response.data
}
9 changes: 9 additions & 0 deletions site/src/api/types.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import * as TypesGen from "./typesGenerated"

export interface UserAgent {
readonly browser: string
readonly device: string
Expand All @@ -12,3 +14,10 @@ export interface ReconnectingPTYRequest {
}

export type WorkspaceBuildTransition = "start" | "stop" | "delete"

// The generated type for ProvisionerJobLog is different than the one returned
// by the API.
export interface ProvisionerJobLog extends TypesGen.ProvisionerJobLog {
readonly source: string
readonly level: string
}
61 changes: 37 additions & 24 deletions site/src/components/BuildsTable/BuildsTable.tsx
< 341A /thead>
Original file line number Diff line number Diff line change
@@ -1,23 +1,18 @@
import Box from "@material-ui/core/Box"
import { Theme } from "@material-ui/core/styles"
import { makeStyles, Theme } from "@material-ui/core/styles"
import Table from "@material-ui/core/Table"
import TableBody from "@material-ui/core/TableBody"
import TableCell from "@material-ui/core/TableCell"
import TableHead from "@material-ui/core/TableHead"
import TableRow from "@material-ui/core/TableRow"
import useTheme from "@material-ui/styles/useTheme"
import dayjs from "dayjs"
import duration from "dayjs/plugin/duration"
import relativeTime from "dayjs/plugin/relativeTime"
import React from "react"
import { useNavigate } from "react-router-dom"
import * as TypesGen from "../../api/typesGenerated"
import { getDisplayStatus } from "../../util/workspace"
import { displayWorkspaceBuildDuration, getDisplayStatus } from "../../util/workspace"
import { EmptyState } from "../EmptyState/EmptyState"
import { TableLoader } from "../TableLoader/TableLoader"
F438
dayjs.extend(relativeTime)
dayjs.extend(duration)

export const Language = {
emptyMessage: "No builds found",
inProgressLabel: "In progress",
Expand All @@ -27,19 +22,6 @@ export const Language = {
statusLabel: "Status",
}

const getDurationInSeconds = (build: TypesGen.WorkspaceBuild) => {
let display = Language.inProgressLabel

if (build.job.started_at && build.job.completed_at) {
const startedAt = dayjs(build.job.started_at)
const completedAt = dayjs(build.job.completed_at)
const diff = completedAt.diff(startedAt, "seconds")
display = `${diff} seconds`
}

return display
}

export interface BuildsTableProps {
builds?: TypesGen.WorkspaceBuild[]
className?: string
Expand All @@ -48,6 +30,8 @@ export interface BuildsTableProps {
export const BuildsTable: React.FC<BuildsTableProps> = ({ builds, className }) => {
const isLoading = !builds
const theme: Theme = useTheme()
const navigate = useNavigate()
const styles = useStyles()

return (
<Table className={className}>
Expand All @@ -64,13 +48,28 @@ export const BuildsTable: React.FC<BuildsTableProps> = ({ builds, className }) =
{builds &&
builds.map((b) => {
const status = getDisplayStatus(theme, b)
const duration = getDurationInSeconds(b)

const navigateToBuildPage = () => {
navigate(`/builds/${b.id}`)
}

return (
<TableRow key={b.id} data-testid={`build-${b.id}`}>
<TableRow
hover
key={b.id}
data-testid={`build-${b.id}`}
tabIndex={0}
onClick={navigateToBuildPage}
onKeyDown={(event) => {
if (event.key === "Enter") {
navigateToBuildPage()
}
}}
className={styles.clickableTableRow}
>
<TableCell>{b.transition}</TableCell>
<TableCell>
<span style={{ color: theme.palette.text.secondary }}>{duration}</span>
<span style={{ color: theme.palette.text.secondary }}>{displayWorkspaceBuildDuration(b)}</span>
</TableCell>
<TableCell>
<span style={{ color: theme.palette.text.secondary }}>{new Date(b.created_at).toLocaleString()}</span>
Expand All @@ -95,3 +94,17 @@ export const BuildsTable: React.FC<BuildsTableProps> = ({ builds, className }) =
</Table>
)
}

const useStyles = makeStyles((theme) => ({
clickableTableRow: {
cursor: "pointer",

"&:hover td": {
backgroundColor: theme.palette.background.default,
},

"&:focus": {
outline: `1px solid ${theme.palette.primary.dark}`,
},
},
}))
11 changes: 11 additions & 0 deletions site/src/components/Loader/Loader.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import Box from "@material-ui/core/Box"
import CircularProgress from "@material-ui/core/CircularProgress"
import React from "react"

export const Loader: React.FC<{ size?: number }> = ({ size = 26 }) => {
return (
<Box p={4} width="100%" display="flex" alignItems="center" justifyContent="center">
<CircularProgress size={size} />
</Box>
)
}
20 changes: 20 additions & 0 deletions site/src/components/Logs/Logs.stories.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import { ComponentMeta, Story } from "@storybook/react"
import React from "react"
import { MockWorkspaceBuildLogs } from "../../testHelpers/entities"
import { Logs, LogsProps } from "./Logs"

export default {
title: "components/Logs",
component: Logs,
} as ComponentMeta<typeof Logs>

const Template: Story<LogsProps> = (args) => <Logs {...args} />

const lines = MockWorkspaceBuildLogs.map((l) => ({
time: l.created_at,
output: l.output,
}))
export const Example = Template.bind({})
Example.args = {
lines,
}
53 changes: 53 additions & 0 deletions site/src/components/Logs/Logs.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
import { makeStyles } from "@material-ui/core/styles"
import dayjs from "dayjs"
import React from "react"
import { MONOSPACE_FONT_FAMILY } from "../../theme/constants"
import { combineClasses } from "../../util/combineClasses"

interface Line {
time: string
output: string
}

export interface LogsProps {
lines: Line[]
className?: string
}

export const Logs: React.FC<LogsProps> = ({ lines, className = "" }) => {
const styles = useStyles()

return (
<div className={combineClasses([className, styles.root])}>
{lines.map((line, idx) => (
<div className={styles.line} key={idx}>
<div className={styles.time}>{dayjs(line.time).format(`HH:mm:ss.SSS`)}</div>
<div>{line.output}</div>
</div>
))}
</div>
)
}

const useStyles = makeStyles((theme) => ({
root: {
minHeight: 156,
background: theme.palette.background.default,
color: theme.palette.text.primary,
fontFamily: MONOSPACE_FONT_FAMILY,
fontSize: 13,
wordBreak: "break-all",
padding: theme.spacing(2),
borderRadius: theme.shape.borderRadius,
overflowX: "auto",
},
line: {
display: "flex",
alignItems: "baseline",
},
time: {
width: theme.spacing(12.5),
marginRight: theme.spacing(3),
flexShrink: 0,
},
}))
7 changes: 2 additions & 5 deletions site/src/components/TableLoader/TableLoader.tsx
Original file line number Diff line number Diff line change
@@ -1,19 +1,16 @@
import Box from "@material-ui/core/Box"
import CircularProgress from "@material-ui/core/CircularProgress"
import { makeStyles } from "@material-ui/core/styles"
import TableCell from "@material-ui/core/TableCell"
import TableRow from "@material-ui/core/TableRow"
import React from "react"
import { Loader } from "../Loader/Loader"

export const TableLoader: React.FC = () => {
const styles = useStyles()

return (
<TableRow>
<TableCell colSpan={999} className={styles.cell}>
<Box p={4}>
<CircularProgress size={26} />
</Box>
<Loader />
</TableCell>
</TableRow>
)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import { ComponentMeta, Story } from "@storybook/react"
import React from "react"
import { MockWorkspaceBuildLogs } from "../../testHelpers/entities"
import { WorkspaceBuildLogs, WorkspaceBuildLogsProps } from "./WorkspaceBuildLogs"

export default {
title: "components/WorkspaceBuildLogs",
component: WorkspaceBuildLogs,
} as ComponentMeta<typeof WorkspaceBuildLogs>

const Template: Story<WorkspaceBuildLogsProps> = (args) => <WorkspaceBuildLogs {...args} />

export const Example = Template.bind({})
Example.args = {
logs: MockWorkspaceBuildLogs,
}
Loading
0