Skip to content

feat: add quiet hours settings page #9676

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 19 commits into from
Sep 15, 2023
Merged
Show file tree
Hide file tree
Changes from 17 commits
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
13 changes: 13 additions & 0 deletions coderd/schedule/cron/cron.go
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,19 @@ func (s Schedule) Min() time.Duration {
return durMin
}

// TimeParsed returns the parsed time.Time of the minute and hour fields. If the
// time cannot be represented in a valid time.Time, a zero time is returned.
func (s Schedule) TimeParsed() time.Time {
minute := strings.Fields(s.cronStr)[0]
hour := strings.Fields(s.cronStr)[1]
maybeTime := fmt.Sprintf("%s:%s", hour, minute)
t, err := time.ParseInLocation("15:4", maybeTime, s.sched.Location)
if err != nil {
return time.Time{}
}
return t
}

// Time returns a humanized form of the minute and hour fields.
func (s Schedule) Time() string {
minute := strings.Fields(s.cronStr)[0]
Expand Down
1 change: 1 addition & 0 deletions codersdk/deployment.go
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ var FeatureNames = []FeatureName{
FeatureExternalProvisionerDaemons,
FeatureAppearance,
FeatureAdvancedTemplateScheduling,
FeatureTemplateAutostopRequirement,
FeatureWorkspaceProxy,
FeatureUserRoleManagement,
FeatureExternalTokenEncryption,
Expand Down
2 changes: 1 addition & 1 deletion enterprise/coderd/coderd.go
Original file line number Diff line number Diff line change
Expand Up @@ -472,7 +472,7 @@ func (api *API) updateEntitlements(ctx context.Context) error {
codersdk.FeatureAdvancedTemplateScheduling: true,
// FeatureTemplateAutostopRequirement depends on
// FeatureAdvancedTemplateScheduling.
codersdk.FeatureTemplateAutostopRequirement: api.DefaultQuietHoursSchedule != "",
codersdk.FeatureTemplateAutostopRequirement: api.AGPL.Experiments.Enabled(codersdk.ExperimentTemplateAutostopRequirement) && api.DefaultQuietHoursSchedule != "",
codersdk.FeatureWorkspaceProxy: true,
codersdk.FeatureUserRoleManagement: true,
})
Expand Down
4 changes: 2 additions & 2 deletions enterprise/coderd/users.go
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ func (api *API) userQuietHoursSchedule(rw http.ResponseWriter, r *http.Request)
httpapi.Write(ctx, rw, http.StatusOK, codersdk.UserQuietHoursScheduleResponse{
RawSchedule: opts.Schedule.String(),
UserSet: opts.UserSet,
Time: opts.Schedule.Time(),
Time: opts.Schedule.TimeParsed().Format("15:40"),
Timezone: opts.Schedule.Location().String(),
Next: opts.Schedule.Next(time.Now().In(opts.Schedule.Location())),
})
Expand Down Expand Up @@ -114,7 +114,7 @@ func (api *API) putUserQuietHoursSchedule(rw http.ResponseWriter, r *http.Reques
httpapi.Write(ctx, rw, http.StatusOK, codersdk.UserQuietHoursScheduleResponse{
RawSchedule: opts.Schedule.String(),
UserSet: opts.UserSet,
Time: opts.Schedule.Time(),
Time: opts.Schedule.TimeParsed().Format("15:40"),
Timezone: opts.Schedule.Location().String(),
Next: opts.Schedule.Next(time.Now().In(opts.Schedule.Location())),
})
Expand Down
10 changes: 5 additions & 5 deletions enterprise/coderd/users_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ func TestUserQuietHours(t *testing.T) {
t.Run("OK", func(t *testing.T) {
t.Parallel()

defaultQuietHoursSchedule := "CRON_TZ=America/Chicago 0 0 * * *"
defaultQuietHoursSchedule := "CRON_TZ=America/Chicago 0 1 * * *"
defaultScheduleParsed, err := cron.Daily(defaultQuietHoursSchedule)
require.NoError(t, err)
nextTime := defaultScheduleParsed.Next(time.Now().In(defaultScheduleParsed.Location()))
if time.Until(nextTime) < time.Hour {
// Use a different default schedule instead, because we want to avoid
// the schedule "ticking over" during this test run.
defaultQuietHoursSchedule = "CRON_TZ=America/Chicago 0 12 * * *"
defaultQuietHoursSchedule = "CRON_TZ=America/Chicago 0 13 * * *"
defaultScheduleParsed, err = cron.Daily(defaultQuietHoursSchedule)
require.NoError(t, err)
}
Expand All @@ -55,7 +55,7 @@ func TestUserQuietHours(t *testing.T) {
require.NoError(t, err)
require.Equal(t, defaultScheduleParsed.String(), sched1.RawSchedule)
require.False(t, sched1.UserSet)
require.Equal(t, defaultScheduleParsed.Time(), sched1.Time)
require.Equal(t, defaultScheduleParsed.TimeParsed().Format("15:40"), sched1.Time)
require.Equal(t, defaultScheduleParsed.Location().String(), sched1.Timezone)
require.WithinDuration(t, defaultScheduleParsed.Next(time.Now()), sched1.Next, 15*time.Second)

Expand All @@ -78,7 +78,7 @@ func TestUserQuietHours(t *testing.T) {
require.NoError(t, err)
require.Equal(t, customScheduleParsed.String(), sched2.RawSchedule)
require.True(t, sched2.UserSet)
require.Equal(t, customScheduleParsed.Time(), sched2.Time)
require.Equal(t, customScheduleParsed.TimeParsed().Format("15:40"), sched2.Time)
require.Equal(t, customScheduleParsed.Location().String(), sched2.Timezone)
require.WithinDuration(t, customScheduleParsed.Next(time.Now()), sched2.Next, 15*time.Second)

Expand All @@ -87,7 +87,7 @@ func TestUserQuietHours(t *testing.T) {
require.NoError(t, err)
require.Equal(t, customScheduleParsed.String(), sched3.RawSchedule)
require.True(t, sched3.UserSet)
require.Equal(t, customScheduleParsed.Time(), sched3.Time)
require.Equal(t, customScheduleParsed.TimeParsed().Format("15:40"), sched3.Time)
require.Equal(t, customScheduleParsed.Location().String(), sched3.Timezone)
require.WithinDuration(t, customScheduleParsed.Next(time.Now()), sched3.Next, 15*time.Second)

Expand Down
4 changes: 4 additions & 0 deletions site/src/AppRouter.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ const CliAuthenticationPage = lazy(
const AccountPage = lazy(
() => import("./pages/UserSettingsPage/AccountPage/AccountPage"),
);
const SchedulePage = lazy(
() => import("./pages/UserSettingsPage/SchedulePage/SchedulePage"),
);
const SecurityPage = lazy(
() => import("./pages/UserSettingsPage/SecurityPage/SecurityPage"),
);
Expand Down Expand Up @@ -292,6 +295,7 @@ export const AppRouter: FC = () => {

<Route path="settings" element={<SettingsLayout />}>
<Route path="account" element={<AccountPage />} />
<Route path="schedule" element={<SchedulePage />} />
<Route path="security" element={<SecurityPage />} />
<Route path="ssh-keys" element={<SSHKeysPage />} />
<Route path="tokens">
Expand Down
15 changes: 15 additions & 0 deletions site/src/api/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -665,6 +665,21 @@ export const updateProfile = async (
return response.data;
};

export const getUserQuietHoursSchedule = async (
userId: TypesGen.User["id"],
): Promise<TypesGen.UserQuietHoursScheduleResponse> => {
const response = await axios.get(`/api/v2/users/${userId}/quiet-hours`);
return response.data;
};

export const updateUserQuietHoursSchedule = async (
userId: TypesGen.User["id"],
data: TypesGen.UpdateUserQuietHoursScheduleRequest,
): Promise<TypesGen.UserQuietHoursScheduleResponse> => {
const response = await axios.put(`/api/v2/users/${userId}/quiet-hours`, data);
return response.data;
};

export const activateUser = async (
userId: TypesGen.User["id"],
): Promise<TypesGen.User> => {
Expand Down
34 changes: 34 additions & 0 deletions site/src/api/queries/settings.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
import * as API from "api/api";
import {
type UserQuietHoursScheduleResponse,
type UpdateUserQuietHoursScheduleRequest,
} from "api/typesGenerated";
import { type QueryClient, type QueryOptions } from "@tanstack/react-query";

export const userQuietHoursScheduleKey = (userId: string) => [
"settings",
userId,
"quietHours",
];

export const userQuietHoursSchedule = (
userId: string,
): QueryOptions<UserQuietHoursScheduleResponse> => {
return {
queryKey: userQuietHoursScheduleKey(userId),
queryFn: () => API.getUserQuietHoursSchedule(userId),
};
};

export const updateUserQuietHoursSchedule = (
userId: string,
queryClient: QueryClient,
) => {
return {
mutationFn: (request: UpdateUserQuietHoursScheduleRequest) =>
API.updateUserQuietHoursSchedule(userId, request),
onSuccess: async () => {
await queryClient.invalidateQueries(userQuietHoursScheduleKey(userId));
},
};
};
13 changes: 13 additions & 0 deletions site/src/components/SettingsLayout/Sidebar.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ import { FC, ElementType, PropsWithChildren, ReactNode } from "react";
import { NavLink } from "react-router-dom";
import { combineClasses } from "utils/combineClasses";
import AccountIcon from "@mui/icons-material/Person";
import ScheduleIcon from "@mui/icons-material/EditCalendarOutlined";
import SecurityIcon from "@mui/icons-material/LockOutlined";
import { useDashboard } from "components/Dashboard/DashboardProvider";

const SidebarNavItem: FC<
PropsWithChildren<{ href: string; icon: ReactNode }>
Expand Down Expand Up @@ -41,6 +43,9 @@ const SidebarNavItemIcon: React.FC<{ icon: ElementType }> = ({

export const Sidebar: React.FC<{ user: User }> = ({ user }) => {
const styles = useStyles();
const { entitlements } = useDashboard();
const allowAutostopRequirement =
entitlements.features.template_autostop_requirement.enabled;

return (
<nav className={styles.sidebar}>
Expand All @@ -58,6 +63,14 @@ export const Sidebar: React.FC<{ user: User }> = ({ user }) => {
>
Account
</SidebarNavItem>
{allowAutostopRequirement && (
<SidebarNavItem
href="schedule"
icon={<SidebarNavItemIcon icon={ScheduleIcon} />}
>
Schedule
</SidebarNavItem>
)}
<SidebarNavItem
href="security"
icon={<SidebarNavItemIcon icon={SecurityIcon} />}
Expand Down
7 changes: 3 additions & 4 deletions site/src/pages/CreateTemplatePage/CreateTemplatePage.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,15 @@ const CreateTemplatePage: FC = () => {
const { starterTemplate, error, file, jobError, jobLogs, variables } =
state.context;
const shouldDisplayForm = !state.hasTag("loading");
const { entitlements, experiments } = useDashboard();
const { entitlements } = useDashboard();
const allowAdvancedScheduling =
entitlements.features["advanced_template_scheduling"].enabled;
// Requires the template RBAC feature, otherwise disabling everyone access
// means no one can access.
const allowDisableEveryoneAccess =
entitlements.features["template_rbac"].enabled;
const allowAutostopRequirement = experiments.includes(
"template_autostop_requirement",
);
const allowAutostopRequirement =
entitlements.features["template_autostop_requirement"].enabled;

const onCancel = () => {
navigate(-1);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,8 @@ const TemplateSchedulePage: FC = () => {
// This check can be removed when https://github.com/coder/coder/milestone/19
// is merged up
const allowWorkspaceActions = experiments.includes("workspace_actions");
const allowAutostopRequirement = experiments.includes(
"template_autostop_requirement",
);
const allowAutostopRequirement =
entitlements.features["template_autostop_requirement"].enabled;
const { clearLocal } = useLocalStorage();

const {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
import type { Meta, StoryObj } from "@storybook/react";
import { ScheduleForm } from "./ScheduleForm";
import { mockApiError } from "testHelpers/entities";
import { action } from "@storybook/addon-actions";

const defaultArgs = {
submitting: false,
initialValues: {
raw_schedule: "CRON_TZ=Australia/Sydney 0 2 * * *",
user_set: false,
time: "02:00",
timezone: "Australia/Sydney",
next: "2023-09-05T02:00:00+10:00",
},
updateErr: undefined,
now: new Date("2023-09-04T15:00:00+10:00"),
onSubmit: action("onSubmit"),
};

const meta: Meta<typeof ScheduleForm> = {
title: "pages/UserSettingsPage/ScheduleForm",
component: ScheduleForm,
args: defaultArgs,
};
export default meta;

type Story = StoryObj<typeof ScheduleForm>;

export const ExampleDefault: Story = {};

export const ExampleUserSet: Story = {
args: {
...defaultArgs,
initialValues: {
raw_schedule: "CRON_TZ=America/Chicago 0 2 * * *",
user_set: true,
time: "02:00",
timezone: "America/Chicago",
next: "2023-09-05T02:00:00-05:00",
},
now: new Date("2023-09-04T15:00:00-05:00"),
},
};

export const Submitting: Story = {
args: {
...defaultArgs,
isLoading: true,
},
};

export const WithError: Story = {
args: {
...defaultArgs,
mutationError: mockApiError({
message: "Invalid schedule",
validations: [
{
field: "schedule",
detail: "Could not validate cron schedule.",
},
],
}),
},
};
Loading