Skip to content

fix(site): exclude workspace schedule settings for prebuilt workspaces #18826

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 11 commits into from
Jul 15, 2025
Merged

fix(site): exclude workspace schedule settings for prebuilt workspaces #18826

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
95ca5f7
fix(site): exclude workspace schedule settings for prebuilt workspaces
ssncferreira Jul 10, 2025
207c80f
feat: add is_prebuild flag to workspace API response
ssncferreira Jul 10, 2025
450b3e1
fix: fmt
ssncferreira Jul 10, 2025
0bde254
chore: add comment to IsPrebuild parameter on codersdk.Workspaces
ssncferreira Jul 14, 2025
73f5476
chore: add story to WorkspaceSchedulePage
ssncferreira Jul 14, 2025
f306854
Merge remote-tracking branch 'origin/main' into ssncferreira/exclude-…
ssncferreira Jul 14, 2025
d5e45bb
fix: run make gen
ssncferreira Jul 14, 2025
0120c5b
chore: use workspace.IsPrebuild() on convertWorkspace
ssncferreira Jul 14, 2025
ad475cf
simplify story
BrunoQuaresma Jul 14, 2025
02c0ff5
fix: run make fmt
ssncferreira Jul 15, 2025
1260e49
Merge remote-tracking branch 'origin/main' into ssncferreira/exclude-…
ssncferreira Jul 15, 2025
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
7 changes: 7 additions & 0 deletions site/src/modules/workspaces/prebuilds.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import type { Workspace } from "api/typesGenerated";

// Returns true if the workspace is a prebuilt workspace (owned by the prebuilds system user),
// otherwise returns false.
export const isPrebuiltWorkspace = (workspace: Workspace): boolean => {
return workspace.owner_id === "c42fdf75-3097-471c-8c33-fb52454d81c0";
};
98 changes: 62 additions & 36 deletions site/src/pages/WorkspaceSettingsPage/WorkspaceSchedulePage/WorkspaceSchedulePage.tsx
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd suggest adding a story here to showcase the new behaviour.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed in 73f5476

Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@ import { Alert } from "components/Alert/Alert";
import { ErrorAlert } from "components/Alert/ErrorAlert";
import { ConfirmDialog } from "components/Dialogs/ConfirmDialog/ConfirmDialog";
import { displayError, displaySuccess } from "components/GlobalSnackbar/utils";
import { Link } from "components/Link/Link";
import { Loader } from "components/Loader/Loader";
import { PageHeader, PageHeaderTitle } from "components/PageHeader/PageHeader";
import dayjs from "dayjs";
import { isPrebuiltWorkspace } from "modules/workspaces/prebuilds";
import {
scheduleChanged,
scheduleToAutostart,
Expand All @@ -20,6 +22,7 @@ import { type FC, useState } from "react";
import { Helmet } from "react-helmet-async";
import { useMutation, useQuery, useQueryClient } from "react-query";
import { useNavigate, useParams } from "react-router-dom";
import { docs } from "utils/docs";
import { pageTitle } from "utils/page";
import { WorkspaceScheduleForm } from "./WorkspaceScheduleForm";
import {
Expand Down Expand Up @@ -94,42 +97,65 @@ const WorkspaceSchedulePage: FC = () => {
</Alert>
)}

{template && (
<WorkspaceScheduleForm
template={template}
error={submitScheduleMutation.error}
initialValues={{
...getAutostart(workspace),
...getAutostop(workspace),
}}
isLoading={submitScheduleMutation.isPending}
defaultTTL={dayjs.duration(template.default_ttl_ms, "ms").asHours()}
onCancel={() => {
navigate(`/@${username}/${workspaceName}`);
}}
onSubmit={async (values) => {
const data = {
workspace,
autostart: formValuesToAutostartRequest(values),
ttl: formValuesToTTLRequest(values),
autostartChanged: scheduleChanged(
getAutostart(workspace),
values,
),
autostopChanged: scheduleChanged(getAutostop(workspace), values),
};

await submitScheduleMutation.mutateAsync(data);

if (
data.autostopChanged &&
getAutostop(workspace).autostopEnabled
) {
setIsConfirmingApply(true);
}
}}
/>
)}
{template &&
// Prebuilt workspaces have their own scheduling system,
// so we avoid showing the workspace-level schedule settings form.
// Instead, show an informational message with a link to the relevant docs.
(isPrebuiltWorkspace(workspace) ? (
<Alert severity="info">
Prebuilt workspaces do not support workspace-level scheduling. For
prebuilt workspace specific scheduling refer to the{" "}
<Link
title="Prebuilt Workspaces Scheduling"
href={docs(
"/admin/templates/extending-templates/prebuilt-workspaces#scheduling",
)}
target="_blank"
rel="noreferrer"
>
Prebuilt Workspaces Scheduling
</Link>
documentation page.
</Alert>
) : (
<WorkspaceScheduleForm
template={template}
error={submitScheduleMutation.error}
initialValues={{
...getAutostart(workspace),
...getAutostop(workspace),
}}
isLoading={submitScheduleMutation.isPending}
defaultTTL={dayjs.duration(template.default_ttl_ms, "ms").asHours()}
onCancel={() => {
navigate(`/@${username}/${workspaceName}`);
}}
onSubmit={async (values) => {
const data = {
workspace,
autostart: formValuesToAutostartRequest(values),
ttl: formValuesToTTLRequest(values),
autostartChanged: scheduleChanged(
getAutostart(workspace),
values,
),
autostopChanged: scheduleChanged(
getAutostop(workspace),
values,
),
};

await submitScheduleMutation.mutateAsync(data);

if (
data.autostopChanged &&
getAutostop(workspace).autostopEnabled
) {
setIsConfirmingApply(true);
}
}}
/>
))}

<ConfirmDialog
open={isConfirmingApply}
Expand Down
Loading