Skip to content

feat: add template editor to the ui #5963

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 23 commits into from
Feb 7, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
Prev Previous commit
Next Next commit
Add tabs
  • Loading branch information
kylecarbs committed Feb 1, 2023
commit 5a6f8711c8cb12edc7de5c43deb143eb4442cdef
133 changes: 84 additions & 49 deletions site/src/components/TemplateVersionEditor/TemplateVersionEditor.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import Tooltip from "@material-ui/core/Tooltip"
import Button from "@material-ui/core/Button"
import { makeStyles } from "@material-ui/core/styles"
import { makeStyles, Theme } from "@material-ui/core/styles"
import {
ProvisionerJobLog,
Template,
Expand All @@ -10,11 +11,13 @@ import { Avatar } from "components/Avatar/Avatar"
import { AvatarData } from "components/AvatarData/AvatarData"
import { TemplateResourcesTable } from "components/TemplateResourcesTable/TemplateResourcesTable"
import { WorkspaceBuildLogs } from "components/WorkspaceBuildLogs/WorkspaceBuildLogs"
import { FC, useEffect, useState } from "react"
import { FC, useCallback, useEffect, useState } from "react"
import { navHeight } from "theme/constants"
import { TemplateVersionFiles } from "util/templateVersion"
import { FileTree } from "./FileTree"
import { MonacoEditor } from "./MonacoEditor"
import Tab from "@material-ui/core/Tab"
import Tabs from "@material-ui/core/Tabs"

interface File {
path: string
Expand All @@ -30,13 +33,20 @@ export interface TemplateVersionEditorProps {
buildLogs?: ProvisionerJobLog[]
resources?: WorkspaceResource[]

disablePreview: boolean
disableUpdate: boolean

loading: boolean

onPreview: (files: TemplateVersionFiles) => void
onUpdate: () => void
}

const topbarHeight = navHeight

export const TemplateVersionEditor: FC<TemplateVersionEditorProps> = ({
disablePreview,
disableUpdate,
template,
templateVersion,
initialFiles,
Expand All @@ -45,7 +55,7 @@ export const TemplateVersionEditor: FC<TemplateVersionEditorProps> = ({
buildLogs,
resources,
}) => {
const styles = useStyles()
const [selectedTab, setSelectedTab] = useState(0)
const [files, setFiles] = useState(initialFiles)
const [activeFile, setActiveFile] = useState<File | undefined>(() => {
const fileKeys = Object.keys(initialFiles)
Expand All @@ -59,6 +69,11 @@ export const TemplateVersionEditor: FC<TemplateVersionEditorProps> = ({
}
}
})
const triggerPreview = useCallback(() => {
onPreview(files)
// Switch to the build log!
setSelectedTab(0)
}, [files, onPreview])
useEffect(() => {
const keyListener = (event: KeyboardEvent) => {
if (!(navigator.platform.match("Mac") ? event.metaKey : event.ctrlKey)) {
Expand All @@ -71,16 +86,20 @@ export const TemplateVersionEditor: FC<TemplateVersionEditorProps> = ({
break
case "Enter":
event.preventDefault()
onPreview(files)
triggerPreview()
break
}
}
document.addEventListener("keydown", keyListener)
return () => {
document.removeEventListener("keydown", keyListener)
}
}, [files, onPreview])
}, [files, triggerPreview])
const hasIcon = template.icon && template.icon !== ""
const templateVersionSucceeded = templateVersion.job.status === "succeeded"
const styles = useStyles({
templateVersionSucceeded,
})

return (
<div className={styles.root}>
Expand All @@ -100,27 +119,35 @@ export const TemplateVersionEditor: FC<TemplateVersionEditorProps> = ({
</div>

<div className={styles.topbarSides}>
<Button variant="text">Cancel Changes</Button>
<Button
size="small"
variant="outlined"
color="primary"
disabled={disablePreview}
onClick={() => {
onPreview(files)
triggerPreview()
}}
>
Preview (Ctrl + Enter)
</Button>

<Button
variant="contained"
color="primary"
disabled={templateVersion.job.status !== "succeeded"}
onClick={() => {
onUpdate()
}}
<Tooltip
title={
templateVersion.job.status !== "succeeded" ? "Something" : ""
}
>
Update
</Button>
<Button
size="small"
variant="contained"
color="primary"
disabled={disableUpdate}
onClick={() => {
onUpdate()
}}
>
Update Template
</Button>
</Tooltip>
</div>
</div>

Expand Down Expand Up @@ -152,41 +179,53 @@ export const TemplateVersionEditor: FC<TemplateVersionEditorProps> = ({
</div>

<div className={styles.panelWrapper}>
<div className={styles.panel}>
<div className={styles.tabBar}>Build Logs</div>
<Tabs
value={selectedTab}
onChange={(_, value) => {
setSelectedTab(value)
}}
>
<Tab label="Build Logs" />
<Tab disabled={disableUpdate} label="Resources" />
</Tabs>

<div className={styles.buildLogs}>
{buildLogs && <WorkspaceBuildLogs logs={buildLogs} />}
{templateVersion.job.error && (
<div className={styles.buildLogError}>
{templateVersion.job.error}
</div>
)}
</div>
<div className={`${styles.panel} ${styles.buildLogs} ${selectedTab === 0 ? "" : "hidden"}`}>
{buildLogs && <WorkspaceBuildLogs logs={buildLogs} />}
{templateVersion.job.error && (
<div className={styles.buildLogError}>
{templateVersion.job.error}
</div>
)}
</div>

<div className={styles.panelDivider} />

<div className={styles.panel}>
<div className={`${styles.tabBar} top`}>Resources</div>
<div className={styles.resources}>
{resources && (
<TemplateResourcesTable
resources={resources.filter(
(r) => r.workspace_transition === "start",
)}
/>
)}
</div>
<div className={`${styles.panel} ${styles.resources} ${selectedTab === 1 ? "" : "hidden"}`}>
{resources && (
<TemplateResourcesTable
resources={resources.filter(
(r) => r.workspace_transition === "start",
)}
/>
)}
</div>
</div>

{templateVersionSucceeded && (
<>
<div className={styles.panelDivider} />
</>
)}
</div>
</div>
</div>
)
}

const useStyles = makeStyles((theme) => ({
const useStyles = makeStyles<
Theme,
{
templateVersionSucceeded: boolean
}
>((theme) => ({
root: {
height: `calc(100vh - ${navHeight}px)`,
background: theme.palette.background.default,
Expand All @@ -207,10 +246,6 @@ const useStyles = makeStyles((theme) => ({
alignItems: "center",
gap: 16,
},
panelDivider: {
height: 1,
background: theme.palette.divider,
},
sidebarAndEditor: {
display: "flex",
flex: 1,
Expand Down Expand Up @@ -238,13 +273,13 @@ const useStyles = makeStyles((theme) => ({
flex: 1,
display: "flex",
flexDirection: "column",
borderLeft: `1px solid ${theme.palette.divider}`,
overflowY: "auto",
},
panel: {
height: "50%",
flex: 1,
display: "flex",
flexDirection: "column",
borderLeft: `1px solid ${theme.palette.divider}`,
"&.hidden": {
display: "none",
},
},
tabBar: {
padding: "8px 16px",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export const TemplateVersionEditorPage: FC = () => {
context: { templateName, versionName, orgId },
})
const [editorState, sendEvent] = useMachine(templateVersionEditorMachine, {
context: { orgId }
context: { orgId },
})
const { t } = useTranslation("templateVersionPage")

Expand All @@ -34,31 +34,39 @@ export const TemplateVersionEditorPage: FC = () => {
</title>
</Helmet>

{versionState.context.template && versionState.context.currentFiles && versionState.context.currentVersion && (
<TemplateVersionEditor
template={versionState.context.template}
templateVersion={editorState.context.version || versionState.context.currentVersion}
initialFiles={versionState.context.currentFiles}
onPreview={(files) => {
if (!versionState.context.template) {
throw new Error("no template")
{versionState.context.template &&
versionState.context.currentFiles &&
versionState.context.currentVersion && (
<TemplateVersionEditor
template={versionState.context.template}
templateVersion={
editorState.context.version || versionState.context.currentVersion
}
sendEvent({
type: "CREATE_BUILD",
files: files,
templateId: versionState.context.template.id,
})
}}
onUpdate={() => {
sendEvent({
type: "UPDATE_ACTIVE",
})
console.log("We made a new version active")
}}
resources={editorState.context.resources}
buildLogs={editorState.context.buildLogs}
/>
)}
initialFiles={versionState.context.currentFiles}
onPreview={(files) => {
if (!versionState.context.template) {
throw new Error("no template")
}
sendEvent({
type: "CREATE_BUILD",
files: files,
templateId: versionState.context.template.id,
})
}}
onUpdate={() => {
sendEvent({
type: "UPDATE_ACTIVE",
})
}}
disablePreview={editorState.hasTag("loading")}
disableUpdate={
editorState.hasTag("loading") ||
editorState.context.version?.job.status !== "succeeded"
}
resources={editorState.context.resources}
buildLogs={editorState.context.buildLogs}
/>
)}
</>
)
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ export const templateVersionEditorMachine = createMachine(
},
},
updatingActiveVersion: {
tags: "loading",
invoke: {
id: "updateActiveVersion",
src: "updateActiveVersion",
Expand All @@ -67,6 +68,7 @@ export const templateVersionEditorMachine = createMachine(
},
},
uploadTar: {
tags: "loading",
invoke: {
id: "uploadTar",
src: "uploadTar",
Expand All @@ -77,6 +79,7 @@ export const templateVersionEditorMachine = createMachine(
},
},
creatingBuild: {
tags: "loading",
invoke: {
id: "createBuild",
src: "createBuild",
Expand All @@ -87,6 +90,7 @@ export const templateVersionEditorMachine = createMachine(
},
},
watchingBuildLogs: {
tags: "loading",
invoke: {
id: "watchBuildLogs",
src: "watchBuildLogs",
Expand All @@ -109,6 +113,7 @@ export const templateVersionEditorMachine = createMachine(
},
},
fetchingVersion: {
tags: "loading",
invoke: {
id: "fetchVersion",
src: "fetchVersion",
Expand All @@ -119,6 +124,7 @@ export const templateVersionEditorMachine = createMachine(
},
},
fetchResources: {
tags: "loading",
invoke: {
id: "getResources",
src: "getResources",
Expand Down