Skip to content

feat(site): Add source code tab on template page, group buttons and add edit file option #6681

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 9 commits into from
Mar 21, 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 edit file button
  • Loading branch information
BrunoQuaresma committed Mar 20, 2023
commit fc494389e02e437ebc81770ff8ae2a348e0922dd
26 changes: 10 additions & 16 deletions site/src/components/TemplateLayout/TemplateLayout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,10 @@ import { AlertBanner } from "components/AlertBanner/AlertBanner"
import {
checkAuthorization,
getTemplateByName,
getTemplateDAUs,
getTemplateVersion,
getTemplateVersionResources,
getTemplateVersions,
} from "api/api"
import { useQuery } from "@tanstack/react-query"
import { useDashboard } from "components/Dashboard/DashboardProvider"

const templatePermissions = (templateId: string) => ({
canUpdateTemplate: {
Expand All @@ -30,23 +28,16 @@ const templatePermissions = (templateId: string) => ({

const fetchTemplate = async (orgId: string, templateName: string) => {
const template = await getTemplateByName(orgId, templateName)
const [activeVersion, resources, versions, daus, permissions] =
await Promise.all([
getTemplateVersion(template.active_version_id),
getTemplateVersionResources(template.active_version_id),
getTemplateVersions(template.id),
getTemplateDAUs(template.id),
checkAuthorization({
checks: templatePermissions(template.id),
}),
])
const [activeVersion, permissions] = await Promise.all([
getTemplateVersion(template.active_version_id),
checkAuthorization({
checks: templatePermissions(template.id),
}),
])

return {
template,
activeVersion,
resources,
versions,
daus,
permissions,
}
}
Expand Down Expand Up @@ -82,6 +73,7 @@ export const TemplateLayout: FC<{ children?: JSX.Element }> = ({
const orgId = useOrganizationId()
const { template } = useParams() as { template: string }
const templateData = useTemplateData(orgId, template)
const dashboard = useDashboard()

if (templateData.error) {
return (
Expand All @@ -104,7 +96,9 @@ export const TemplateLayout: FC<{ children?: JSX.Element }> = ({
<>
<TemplatePageHeader
template={templateData.data.template}
activeVersion={templateData.data.activeVersion}
permissions={templateData.data.permissions}
canEditFiles={dashboard.experiments.includes("template_editor")}
onDeleteTemplate={() => {
navigate("/templates")
}}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { ComponentMeta, Story } from "@storybook/react"
import { MockTemplate } from "testHelpers/entities"
import { MockTemplate, MockTemplateVersion } from "testHelpers/entities"
import {
TemplatePageHeader,
TemplatePageHeaderProps,
Expand All @@ -12,6 +12,9 @@ export default {
template: {
defaultValue: MockTemplate,
},
activeVersion: {
defaultValue: MockTemplateVersion,
},
permissions: {
defaultValue: {
canUpdateTemplate: true,
Expand Down
33 changes: 27 additions & 6 deletions site/src/components/TemplateLayout/TemplatePageHeader.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
import Button from "@material-ui/core/Button"
import AddCircleOutline from "@material-ui/icons/AddCircleOutline"
import { AuthorizationResponse, Template } from "api/typesGenerated"
import {
AuthorizationResponse,
Template,
TemplateVersion,
} from "api/typesGenerated"
import { Avatar } from "components/Avatar/Avatar"
import { Maybe } from "components/Conditionals/Maybe"
import { DeleteDialog } from "components/Dialogs/DeleteDialog/DeleteDialog"
Expand All @@ -19,17 +23,19 @@ import Menu from "@material-ui/core/Menu"
import MenuItem from "@material-ui/core/MenuItem"

const Language = {
editButton: "Edit",
variablesButton: "Variables",
settingsButton: "Settings",
createButton: "Create workspace",
deleteButton: "Delete",
editFilesButton: "Edit files",
}

const TemplateMenu: FC<{ templateName: string; onDelete: () => void }> = ({
templateName,
onDelete,
}) => {
const TemplateMenu: FC<{
templateName: string
templateVersion: string
canEditFiles: boolean
onDelete: () => void
}> = ({ templateName, templateVersion, canEditFiles, onDelete }) => {
const [anchorEl, setAnchorEl] = useState<HTMLButtonElement | null>(null)

const handleClose = () => {
Expand Down Expand Up @@ -68,6 +74,15 @@ const TemplateMenu: FC<{ templateName: string; onDelete: () => void }> = ({
>
{Language.variablesButton}
</MenuItem>
{canEditFiles && (
<MenuItem
component={RouterLink}
to={`/templates/${templateName}/versions/${templateVersion}/edit`}
onClick={handleClose}
>
{Language.editFilesButton}
</MenuItem>
)}
<MenuItem
onClick={() => {
onDelete()
Expand Down Expand Up @@ -96,13 +111,17 @@ const CreateWorkspaceButton: FC<{

export type TemplatePageHeaderProps = {
template: Template
activeVersion: TemplateVersion
permissions: AuthorizationResponse
canEditFiles: boolean
onDeleteTemplate: () => void
}

export const TemplatePageHeader: FC<TemplatePageHeaderProps> = ({
template,
activeVersion,
permissions,
canEditFiles,
onDeleteTemplate,
}) => {
const hasIcon = template.icon && template.icon !== ""
Expand All @@ -116,8 +135,10 @@ export const TemplatePageHeader: FC<TemplatePageHeaderProps> = ({
<CreateWorkspaceButton templateName={template.name} />
<Maybe condition={permissions.canUpdateTemplate}>
<TemplateMenu
templateVersion={activeVersion.name}
templateName={template.name}
onDelete={deleteTemplate.openDeleteConfirmation}
canEditFiles={canEditFiles}
/>
</Maybe>
</>
Expand Down