Skip to content

refactor(site): handle edge cases for non-admin users with no workspaces and templates #10517

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 2 commits into from
Nov 6, 2023
Merged

refactor(site): handle edge cases for non-admin users with no workspaces and templates #10517

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e5c919
Improve a few edge cases when workspaces are empty but the user is no…
BrunoQuaresma Nov 3, 2023
518c5b4
Update WorkspacesEmpty.tsx
BrunoQuaresma Nov 3, 2023
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
64 changes: 61 additions & 3 deletions site/src/pages/WorkspacesPage/WorkspacesEmpty.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,76 @@ import { Link } from "react-router-dom";
export const WorkspacesEmpty = (props: {
isUsingFilter: boolean;
templates?: Template[];
canCreateTemplate: boolean;
}) => {
const { isUsingFilter, templates } = props;
const { isUsingFilter, templates, canCreateTemplate } = props;
const totalFeaturedTemplates = 6;
const featuredTemplates = templates?.slice(0, totalFeaturedTemplates);
const defaultTitle = "Create a workspace";
const defaultMessage =
"A workspace is your personal, customizable development environment.";
const defaultImage = (
<div
css={{
maxWidth: "50%",
height: 272,
overflow: "hidden",
marginTop: 48,
opacity: 0.85,

"& img": {
maxWidth: "100%",
},
}}
>
<img src="/featured/workspaces.webp" alt="" />
</div>
);

if (isUsingFilter) {
return <TableEmpty message="No results matched your search" />;
}

if (templates && templates.length === 0 && canCreateTemplate) {
return (
<TableEmpty
message={defaultTitle}
description={`${defaultMessage} To create a workspace, you first need to create a template.`}
cta={
<Button
component={Link}
to="/templates"
variant="contained"
startIcon={<ArrowForwardOutlined />}
>
Go to templates
</Button>
}
css={{
paddingBottom: 0,
}}
image={defaultImage}
/>
);
}

if (templates && templates.length === 0 && !canCreateTemplate) {
return (
<TableEmpty
message={defaultTitle}
description={`${defaultMessage} There are no templates available, but you will see them here once your admin adds them.`}
css={{
paddingBottom: 0,
}}
image={defaultImage}
/>
);
}

return (
<TableEmpty
message="Create a workspace"
description="A workspace is your personal, customizable development environment in the cloud. Select one template below to start."
message={defaultTitle}
description={`${defaultMessage} Select one template below to start.`}
cta={
<div>
<div
Expand Down Expand Up @@ -80,6 +137,7 @@ export const WorkspacesEmpty = (props: {
</Link>
))}
</div>

{templates && templates.length > totalFeaturedTemplates && (
<Button
component={Link}
Expand Down
2 changes: 2 additions & 0 deletions site/src/pages/WorkspacesPage/WorkspacesPage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ const WorkspacesPage: FC = () => {
const { entitlements } = useDashboard();
const canCheckWorkspaces =
entitlements.features["workspace_batch_actions"].enabled;
const permissions = usePermissions();

// We want to uncheck the selected workspaces always when the url changes
// because of filtering or pagination
Expand All @@ -111,6 +112,7 @@ const WorkspacesPage: FC = () => {
</Helmet>

<WorkspacesPageView
canCreateTemplate={permissions.createTemplates}
checkedWorkspaces={checkedWorkspaces}
onCheckChange={setCheckedWorkspaces}
canCheckWorkspaces={canCheckWorkspaces}
Expand Down
27 changes: 27 additions & 0 deletions site/src/pages/WorkspacesPage/WorkspacesPageView.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,33 @@ export const OwnerHasNoWorkspaces: Story = {
args: {
workspaces: [],
count: 0,
canCreateTemplate: true,
},
};

export const OwnerHasNoWorkspacesAndNoTemplates: Story = {
args: {
workspaces: [],
templates: [],
count: 0,
canCreateTemplate: true,
},
};

export const UserHasNoWorkspaces: Story = {
args: {
workspaces: [],
count: 0,
canCreateTemplate: false,
},
};

export const UserHasNoWorkspacesAndNoTemplates: Story = {
args: {
workspaces: [],
templates: [],
count: 0,
canCreateTemplate: false,
},
};

Expand Down
12 changes: 7 additions & 5 deletions site/src/pages/WorkspacesPage/WorkspacesPageView.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { Template, Workspace } from "api/typesGenerated";
import { PaginationWidgetBase } from "components/PaginationWidget/PaginationWidgetBase";
import { ComponentProps, FC } from "react";
import { ComponentProps } from "react";
import { Margins } from "components/Margins/Margins";
import { PageHeader, PageHeaderTitle } from "components/PageHeader/PageHeader";
import { Stack } from "components/Stack/Stack";
Expand Down Expand Up @@ -49,11 +49,10 @@ export interface WorkspacesPageViewProps {
canCheckWorkspaces: boolean;
templatesFetchStatus: TemplateQuery["status"];
templates: TemplateQuery["data"];
canCreateTemplate: boolean;
}

export const WorkspacesPageView: FC<
React.PropsWithChildren<WorkspacesPageViewProps>
> = ({
export const WorkspacesPageView = ({
workspaces,
dormantWorkspaces,
error,
Expand All @@ -69,7 +68,8 @@ export const WorkspacesPageView: FC<
canCheckWorkspaces,
templates,
templatesFetchStatus,
}) => {
canCreateTemplate,
}: WorkspacesPageViewProps) => {
const { saveLocal } = useLocalStorage();

const workspacesDeletionScheduled = dormantWorkspaces
Expand Down Expand Up @@ -149,6 +149,7 @@ export const WorkspacesPageView: FC<
</TableToolbar>

<WorkspacesTable
canCreateTemplate={canCreateTemplate}
workspaces={workspaces}
isUsingFilter={filterProps.filter.used}
onUpdateWorkspace={onUpdateWorkspace}
Expand All @@ -157,6 +158,7 @@ export const WorkspacesPageView: FC<
canCheckWorkspaces={canCheckWorkspaces}
templates={templates}
/>

{count !== undefined && (
<PaginationWidgetBase
count={count}
Expand Down
3 changes: 3 additions & 0 deletions site/src/pages/WorkspacesPage/WorkspacesTable.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ export interface WorkspacesTableProps {
onCheckChange: (checkedWorkspaces: Workspace[]) => void;
canCheckWorkspaces: boolean;
templates?: Template[];
canCreateTemplate: boolean;
}

export const WorkspacesTable: FC<WorkspacesTableProps> = ({
Expand All @@ -46,6 +47,7 @@ export const WorkspacesTable: FC<WorkspacesTableProps> = ({
onCheckChange,
canCheckWorkspaces,
templates,
canCreateTemplate,
}) => {
return (
<TableContainer>
Expand Down Expand Up @@ -92,6 +94,7 @@ export const WorkspacesTable: FC<WorkspacesTableProps> = ({
<WorkspacesEmpty
templates={templates}
isUsingFilter={isUsingFilter}
canCreateTemplate={canCreateTemplate}
/>
)}
{workspaces &&
Expand Down