-
Notifications
You must be signed in to change notification settings - Fork 894
feat: add orphan
option to workspace delete in UI
#10654
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
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
19e7341
added workspace delete dialog
Kira-Pilot 16271f1
added stories and tests
Kira-Pilot 3cea330
Merge remote-tracking branch 'origin/main' into delete-orphan-ui/kira…
Kira-Pilot fd4fabc
Merge remote-tracking branch 'origin/main' into delete-orphan-ui/kira…
Kira-Pilot e94d7ae
PR review
Kira-Pilot 03c5082
fix flake
Kira-Pilot 176125a
fixed stories
Kira-Pilot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
30 changes: 30 additions & 0 deletions
30
site/src/pages/WorkspacePage/WorkspaceDeleteDialog/WorkspaceDeleteDialog.stories.tsx
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,30 @@ | ||
import { Meta, StoryObj } from "@storybook/react"; | ||
import { WorkspaceDeleteDialog } from "./WorkspaceDeleteDialog"; | ||
import { MockWorkspace } from "testHelpers/entities"; | ||
|
||
const meta: Meta<typeof WorkspaceDeleteDialog> = { | ||
title: "pages/WorkspacePage/WorkspaceDeleteDialog", | ||
component: WorkspaceDeleteDialog, | ||
}; | ||
|
||
export default meta; | ||
type Story = StoryObj<typeof WorkspaceDeleteDialog>; | ||
|
||
const args = { | ||
Kira-Pilot marked this conversation as resolved.
Show resolved
Hide resolved
|
||
workspace: MockWorkspace, | ||
canUpdateTemplate: false, | ||
isOpen: true, | ||
onCancel: () => {}, | ||
onConfirm: () => {}, | ||
}; | ||
|
||
export const NotTemplateAdmin: Story = { | ||
args, | ||
}; | ||
|
||
export const TemplateAdmin: Story = { | ||
args: { | ||
...args, | ||
canUpdateTemplate: true, | ||
}, | ||
}; |
182 changes: 182 additions & 0 deletions
182
site/src/pages/WorkspacePage/WorkspaceDeleteDialog/WorkspaceDeleteDialog.tsx
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,182 @@ | ||
import { Workspace, CreateWorkspaceBuildRequest } from "api/typesGenerated"; | ||
import { useId, useState, FormEvent } from "react"; | ||
import { ConfirmDialog } from "components/Dialogs/ConfirmDialog/ConfirmDialog"; | ||
import { type Interpolation, type Theme } from "@emotion/react"; | ||
import { colors } from "theme/colors"; | ||
import dayjs from "dayjs"; | ||
import TextField from "@mui/material/TextField"; | ||
import { docs } from "utils/docs"; | ||
import Link from "@mui/material/Link"; | ||
import Checkbox from "@mui/material/Checkbox"; | ||
|
||
const styles = { | ||
workspaceInfo: (theme) => ({ | ||
display: "flex", | ||
justifyContent: "space-between", | ||
backgroundColor: colors.gray[14], | ||
border: `1px solid ${theme.palette.divider}`, | ||
borderRadius: 8, | ||
padding: 12, | ||
marginBottom: 20, | ||
lineHeight: "18px", | ||
Kira-Pilot marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
"& .name": { | ||
fontSize: 18, | ||
fontWeight: 800, | ||
color: theme.palette.text.primary, | ||
}, | ||
|
||
"& .label": { | ||
fontSize: 11, | ||
color: theme.palette.text.secondary, | ||
}, | ||
|
||
"& .info": { | ||
fontSize: 14, | ||
fontWeight: 500, | ||
color: theme.palette.text.primary, | ||
}, | ||
}), | ||
orphanContainer: () => ({ | ||
marginTop: 24, | ||
display: "flex", | ||
backgroundColor: colors.orange[15], | ||
justifyContent: "space-between", | ||
border: `1px solid ${colors.orange[11]}`, | ||
borderRadius: 8, | ||
padding: 12, | ||
lineHeight: "18px", | ||
|
||
"& .option": { | ||
color: colors.orange[11], | ||
"&.Mui-checked": { | ||
color: colors.orange[11], | ||
}, | ||
}, | ||
|
||
"& .info": { | ||
fontSize: "14px", | ||
color: colors.orange[10], | ||
fontWeight: 500, | ||
}, | ||
}), | ||
} satisfies Record<string, Interpolation<Theme>>; | ||
|
||
interface WorkspaceDeleteDialogProps { | ||
workspace: Workspace; | ||
canUpdateTemplate: boolean; | ||
isOpen: boolean; | ||
onCancel: () => void; | ||
onConfirm: (arg: CreateWorkspaceBuildRequest["orphan"]) => void; | ||
} | ||
export const WorkspaceDeleteDialog = (props: WorkspaceDeleteDialogProps) => { | ||
const { workspace, canUpdateTemplate, isOpen, onCancel, onConfirm } = props; | ||
|
||
const hookId = useId(); | ||
const [userConfirmationText, setUserConfirmationText] = useState(""); | ||
const [orphanWorkspace, setOrphanWorkspace] = | ||
useState<CreateWorkspaceBuildRequest["orphan"]>(false); | ||
const [isFocused, setIsFocused] = useState(false); | ||
|
||
const deletionConfirmed = workspace.name === userConfirmationText; | ||
const onSubmit = (event: FormEvent) => { | ||
event.preventDefault(); | ||
if (deletionConfirmed) { | ||
onConfirm(orphanWorkspace); | ||
} | ||
}; | ||
|
||
const hasError = !deletionConfirmed && userConfirmationText.length > 0; | ||
const displayErrorMessage = hasError && !isFocused; | ||
const inputColor = hasError ? "error" : "primary"; | ||
|
||
return ( | ||
<ConfirmDialog | ||
type="delete" | ||
hideCancel={false} | ||
open={isOpen} | ||
title="Delete Workspace" | ||
onConfirm={() => onConfirm(orphanWorkspace)} | ||
onClose={onCancel} | ||
disabled={!deletionConfirmed} | ||
description={ | ||
<> | ||
<div css={styles.workspaceInfo}> | ||
<div css={{ flexDirection: "column" }}> | ||
<p className="name">{workspace.name}</p> | ||
<p className="label">workspace</p> | ||
</div> | ||
<div css={{ flexDirection: "column" }}> | ||
<p className="info">{dayjs(workspace.created_at).fromNow()}</p> | ||
<p className="label">created</p> | ||
</div> | ||
</div> | ||
|
||
<p>Deleting this workspace is irreversible!</p> | ||
<p> | ||
Type “<strong>{workspace.name}</strong>“ below to | ||
confirm: | ||
</p> | ||
|
||
<form onSubmit={onSubmit}> | ||
<TextField | ||
fullWidth | ||
autoFocus | ||
css={{ marginTop: 32 }} | ||
name="confirmation" | ||
autoComplete="off" | ||
id={`${hookId}-confirm`} | ||
placeholder={workspace.name} | ||
value={userConfirmationText} | ||
onChange={(event) => setUserConfirmationText(event.target.value)} | ||
onFocus={() => setIsFocused(true)} | ||
onBlur={() => setIsFocused(false)} | ||
label="Workspace name" | ||
color={inputColor} | ||
error={displayErrorMessage} | ||
helperText={ | ||
displayErrorMessage && | ||
`${userConfirmationText} does not match the name of this workspace` | ||
} | ||
InputProps={{ color: inputColor }} | ||
inputProps={{ | ||
"data-testid": "delete-dialog-name-confirmation", | ||
}} | ||
/> | ||
{canUpdateTemplate && ( | ||
<div css={styles.orphanContainer}> | ||
<div css={{ flexDirection: "column" }}> | ||
Kira-Pilot marked this conversation as resolved.
Show resolved
Hide resolved
|
||
<Checkbox | ||
id="orphan_resources" | ||
size="small" | ||
color="warning" | ||
onChange={async () => { | ||
Kira-Pilot marked this conversation as resolved.
Show resolved
Hide resolved
|
||
setOrphanWorkspace(!orphanWorkspace); | ||
}} | ||
className="option" | ||
name="orphan_resources" | ||
checked={orphanWorkspace} | ||
/> | ||
</div> | ||
<div css={{ flexDirection: "column" }}> | ||
<p className="info">Orphan resources</p> | ||
<span css={{ fontSize: "11px" }}> | ||
Skip resource cleanup. Resources such as volumes and virtual | ||
machines will not be destroyed. | ||
<Link | ||
href={docs("/workspaces#workspace-resources")} | ||
target="_blank" | ||
rel="noreferrer" | ||
> | ||
Learn more... | ||
</Link> | ||
</span> | ||
</div> | ||
</div> | ||
)} | ||
</form> | ||
</> | ||
} | ||
/> | ||
); | ||
}; |
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 * from "./WorkspaceDeleteDialog"; |
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
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.
Uh oh!
There was an error while loading. Please reload this page.