Organization timeout defaults (#20099)

* Organization timeout defaults proto

* Generated code

* Implement TimeoutSettings on the API layer

* Add timeout setting UI

* Actually change default workspace timeout based on org settings

workspace starter fixes

* Add alert for free plans

* denyUserTimeouts

* [dashboard] Fix check for "timeout config eligibility" by using BillingMode

* [server] Drop FF "disable_set_timeout"

* fix

* Move to team policies

* don't include `timeoutSettings` if not set

* [dashboard] TeamPolicies: Disable "save" if workspace timeouts are disabled

---------

Co-authored-by: Gero Posmyk-Leinemann <[email protected]>

Author: filiptronicek

components/dashboard/src/data/billing-mode/org-billing-mode-query.ts

@@ -12,17 +12,17 @@ import { useCurrentOrg } from "../organizations/orgs-query";
 type OrgBillingModeQueryResult = BillingMode;
 
 export const useOrgBillingMode = () => {
-    const team = useCurrentOrg().data;
+    const organization = useCurrentOrg().data;
 
     return useQuery<OrgBillingModeQueryResult>({
-        queryKey: getOrgBillingModeQueryKey(team?.id ?? ""),
+        queryKey: getOrgBillingModeQueryKey(organization?.id ?? ""),
         queryFn: async () => {
-            if (!team) {
+            if (!organization) {
                 throw new Error("No current organization selected");
             }
-            return await getGitpodService().server.getBillingModeForTeam(team.id);
+            return await getGitpodService().server.getBillingModeForTeam(organization.id);
         },
-        enabled: !!team,
+        enabled: !!organization,
     });
 };
 

components/dashboard/src/data/organizations/update-org-settings-mutation.ts

@@ -11,24 +11,26 @@ import { organizationClient } from "../../service/public-api";
 import { OrganizationSettings } from "@gitpod/public-api/lib/gitpod/v1/organization_pb";
 import { ErrorCode } from "@gitpod/gitpod-protocol/lib/messaging/error";
 import { useOrgWorkspaceClassesQueryInvalidator } from "./org-workspace-classes-query";
+import { PlainMessage } from "@bufbuild/protobuf";
 
 type UpdateOrganizationSettingsArgs = Partial<
     Pick<
-        OrganizationSettings,
+        PlainMessage<OrganizationSettings>,
         | "workspaceSharingDisabled"
         | "defaultWorkspaceImage"
         | "allowedWorkspaceClasses"
         | "pinnedEditorVersions"
         | "restrictedEditorNames"
         | "defaultRole"
+        | "timeoutSettings"
     >
 >;
 
 export const useUpdateOrgSettingsMutation = () => {
     const org = useCurrentOrg().data;
     const invalidateOrgSettings = useOrgSettingsQueryInvalidator();
     const invalidateWorkspaceClasses = useOrgWorkspaceClassesQueryInvalidator();
-    const teamId = org?.id || "";
+    const teamId = org?.id ?? "";
 
     return useMutation<OrganizationSettings, Error, UpdateOrganizationSettingsArgs>({
         mutationFn: async ({
@@ -38,6 +40,7 @@ export const useUpdateOrgSettingsMutation = () => {
             pinnedEditorVersions,
             restrictedEditorNames,
             defaultRole,
+            timeoutSettings,
         }) => {
             const settings = await organizationClient.updateOrganizationSettings({
                 organizationId: teamId,
@@ -49,6 +52,7 @@ export const useUpdateOrgSettingsMutation = () => {
                 restrictedEditorNames,
                 updateRestrictedEditorNames: !!restrictedEditorNames,
                 defaultRole,
+                timeoutSettings,
             });
             return settings.settings!;
         },

components/dashboard/src/service/json-rpc-organization-client.ts

@@ -254,6 +254,10 @@ export class JsonRpcOrganizationClient implements PromiseClient<typeof Organizat
         await getGitpodService().server.updateOrgSettings(request.organizationId, {
             ...update,
             defaultRole: request.defaultRole as OrgMemberRole,
+            timeoutSettings: {
+                inactivity: converter.toDurationString(request.timeoutSettings?.inactivity),
+                denyUserTimeouts: request.timeoutSettings?.denyUserTimeouts,
+            },
         });
         return new UpdateOrganizationSettingsResponse();
     }

components/dashboard/src/teams/TeamPolicies.tsx

@@ -6,7 +6,7 @@
 
 import { isGitpodIo } from "../utils";
 import { OrganizationSettings } from "@gitpod/public-api/lib/gitpod/v1/organization_pb";
-import React, { useCallback, useMemo, useState } from "react";
+import { FormEvent, useCallback, useEffect, useMemo, useState } from "react";
 import Alert from "../components/Alert";
 import { CheckboxInputField } from "../components/forms/CheckboxInputField";
 import { Heading2, Heading3, Subheading } from "../components/typography/headings";
@@ -29,17 +29,32 @@ import { IdeOptions, IdeOptionsModifyModal, IdeOptionsModifyModalProps } from ".
 import { useDocumentTitle } from "../hooks/use-document-title";
 import { LinkButton } from "@podkit/buttons/LinkButton";
 import PillLabel from "../components/PillLabel";
+import { useOrgBillingMode } from "../data/billing-mode/org-billing-mode-query";
+import { converter } from "../service/public-api";
+import { useToast } from "../components/toasts/Toasts";
+import type { PlainMessage } from "@bufbuild/protobuf";
+import { WorkspaceTimeoutDuration } from "@gitpod/gitpod-protocol";
+import { Link } from "react-router-dom";
+import { InputField } from "../components/forms/InputField";
+import { TextInput } from "../components/forms/TextInputField";
+import { LoadingButton } from "@podkit/buttons/LoadingButton";
 
 export default function TeamPoliciesPage() {
     useDocumentTitle("Organization Settings - Policies");
+    const { toast } = useToast();
     const org = useCurrentOrg().data;
     const isOwner = useIsOwner();
 
     const { data: settings, isLoading } = useOrgSettingsQuery();
     const updateTeamSettings = useUpdateOrgSettingsMutation();
 
+    const billingMode = useOrgBillingMode();
+    const [workspaceTimeout, setWorkspaceTimeout] = useState<string | undefined>(undefined);
+    const [allowTimeoutChangeByMembers, setAllowTimeoutChangeByMembers] = useState<boolean | undefined>(undefined);
+    const [workspaceTimeoutSettingError, setWorkspaceTimeoutSettingError] = useState<string | undefined>(undefined);
+
     const handleUpdateTeamSettings = useCallback(
-        async (newSettings: Partial<OrganizationSettings>, options?: { throwMutateError?: boolean }) => {
+        async (newSettings: Partial<PlainMessage<OrganizationSettings>>, options?: { throwMutateError?: boolean }) => {
             if (!org?.id) {
                 throw new Error("no organization selected");
             }
@@ -51,16 +66,58 @@ export default function TeamPoliciesPage() {
                     ...settings,
                     ...newSettings,
                 });
+                setWorkspaceTimeoutSettingError(undefined);
+                toast("Organization settings updated");
             } catch (error) {
                 if (options?.throwMutateError) {
                     throw error;
                 }
+                toast(`Failed to update organization settings: ${error.message}`);
                 console.error(error);
             }
         },
-        [updateTeamSettings, org?.id, isOwner, settings],
+        [updateTeamSettings, org?.id, isOwner, settings, toast],
+    );
+
+    useEffect(() => {
+        setWorkspaceTimeout(
+            settings?.timeoutSettings?.inactivity
+                ? converter.toDurationString(settings.timeoutSettings.inactivity)
+                : undefined,
+        );
+        setAllowTimeoutChangeByMembers(!settings?.timeoutSettings?.denyUserTimeouts);
+    }, [settings?.timeoutSettings]);
+
+    const handleUpdateOrganizationTimeoutSettings = useCallback(
+        (e: FormEvent<HTMLFormElement>) => {
+            e.preventDefault();
+            try {
+                if (workspaceTimeout) {
+                    WorkspaceTimeoutDuration.validate(workspaceTimeout);
+                }
+            } catch (error) {
+                setWorkspaceTimeoutSettingError(error.message);
+                return;
+            }
+
+            // Nothing has changed
+            if (workspaceTimeout === undefined && allowTimeoutChangeByMembers === undefined) {
+                return;
+            }
+
+            handleUpdateTeamSettings({
+                timeoutSettings: {
+                    inactivity: workspaceTimeout ? converter.toDuration(workspaceTimeout) : undefined,
+                    denyUserTimeouts: !allowTimeoutChangeByMembers,
+                },
+            });
+        },
+        [workspaceTimeout, allowTimeoutChangeByMembers, handleUpdateTeamSettings],
     );
 
+    const billingModeAllowsWorkspaceTimeouts =
+        billingMode.data?.mode === "none" || (billingMode.data?.mode === "usage-based" && billingMode.data?.paid);
+
     return (
         <>
             <OrgSettingsPage>
@@ -91,6 +148,64 @@ export default function TeamPoliciesPage() {
                         />
                     </ConfigurationSettingsField>
 
+                    <ConfigurationSettingsField>
+                        <Heading3>Workspace timeouts</Heading3>
+                        {!billingModeAllowsWorkspaceTimeouts && (
+                            <Alert type="info" className="my-3">
+                                Setting Workspace timeouts is only available for organizations on a paid plan. Visit{" "}
+                                <Link to={"/billing"} className="gp-link">
+                                    Billing
+                                </Link>{" "}
+                                to upgrade your plan.
+                            </Alert>
+                        )}
+                        <form onSubmit={handleUpdateOrganizationTimeoutSettings}>
+                            <InputField
+                                label="Default workspace timeout"
+                                error={workspaceTimeoutSettingError}
+                                hint={
+                                    <span>
+                                        Use minutes or hours, like <span className="font-semibold">30m</span> or{" "}
+                                        <span className="font-semibold">2h</span>
+                                    </span>
+                                }
+                            >
+                                <TextInput
+                                    value={workspaceTimeout ?? ""}
+                                    placeholder="e.g. 30m"
+                                    onChange={setWorkspaceTimeout}
+                                    disabled={
+                                        updateTeamSettings.isLoading || !isOwner || !billingModeAllowsWorkspaceTimeouts
+                                    }
+                                />
+                            </InputField>
+                            <CheckboxInputField
+                                label="Allow members to change workspace timeouts"
+                                hint="Allow users to change the timeout duration for their workspaces as well as setting a default one in their user settings."
+                                checked={!!allowTimeoutChangeByMembers}
+                                containerClassName="my-4"
+                                onChange={setAllowTimeoutChangeByMembers}
+                                disabled={
+                                    updateTeamSettings.isLoading || !isOwner || !billingModeAllowsWorkspaceTimeouts
+                                }
+                            />
+                            <LoadingButton
+                                type="submit"
+                                loading={updateTeamSettings.isLoading}
+                                disabled={
+                                    !isOwner ||
+                                    !billingModeAllowsWorkspaceTimeouts ||
+                                    ((workspaceTimeout ===
+                                        converter.toDurationString(settings?.timeoutSettings?.inactivity) ??
+                                        "") &&
+                                        allowTimeoutChangeByMembers === !settings?.timeoutSettings?.denyUserTimeouts)
+                                }
+                            >
+                                Save
+                            </LoadingButton>
+                        </form>
+                    </ConfigurationSettingsField>
+
                     <OrgWorkspaceClassesOptions
                         isOwner={isOwner}
                         settings={settings}

components/dashboard/src/teams/TeamSettings.tsx

@@ -30,17 +30,22 @@ import { useInstallationDefaultWorkspaceImageQuery } from "../data/installation/
 import { ConfigurationSettingsField } from "../repositories/detail/ConfigurationSettingsField";
 import { Select, SelectContent, SelectItem, SelectTrigger, SelectValue } from "@podkit/select/Select";
 import { useDocumentTitle } from "../hooks/use-document-title";
+import { PlainMessage } from "@bufbuild/protobuf";
+import { useToast } from "../components/toasts/Toasts";
 
 export default function TeamSettingsPage() {
     useDocumentTitle("Organization Settings - General");
+    const { toast } = useToast();
     const user = useCurrentUser();
     const org = useCurrentOrg().data;
     const isOwner = useIsOwner();
     const invalidateOrgs = useOrganizationsInvalidator();
+
     const [modal, setModal] = useState(false);
     const [teamNameToDelete, setTeamNameToDelete] = useState("");
     const [teamName, setTeamName] = useState(org?.name || "");
     const [updated, setUpdated] = useState(false);
+
     const updateOrg = useUpdateOrgMutation();
 
     const close = () => setModal(false);
@@ -93,7 +98,7 @@ export default function TeamSettingsPage() {
     const [showImageEditModal, setShowImageEditModal] = useState(false);
 
     const handleUpdateTeamSettings = useCallback(
-        async (newSettings: Partial<OrganizationSettings>, options?: { throwMutateError?: boolean }) => {
+        async (newSettings: Partial<PlainMessage<OrganizationSettings>>, options?: { throwMutateError?: boolean }) => {
             if (!org?.id) {
                 throw new Error("no organization selected");
             }
@@ -105,14 +110,16 @@ export default function TeamSettingsPage() {
                     ...settings,
                     ...newSettings,
                 });
+                toast("Organization settings updated");
             } catch (error) {
                 if (options?.throwMutateError) {
                     throw error;
                 }
+                toast(`Failed to update organization settings: ${error.message}`);
                 console.error(error);
             }
         },
-        [updateTeamSettings, org?.id, isOwner, settings],
+        [updateTeamSettings, org?.id, isOwner, settings, toast],
     );
 
     return (

components/dashboard/src/user-settings/Preferences.tsx

@@ -23,6 +23,8 @@ import {
 import { useOrgBillingMode } from "../data/billing-mode/org-billing-mode-query";
 import { converter, userClient } from "../service/public-api";
 import { LoadingButton } from "@podkit/buttons/LoadingButton";
+import { useOrgSettingsQuery } from "../data/organizations/org-settings-query";
+import Alert from "../components/Alert";
 
 export type IDEChangedTrackLocation = "workspace_list" | "workspace_start" | "preferences";
 
@@ -32,6 +34,7 @@ export default function Preferences() {
     const updateUser = useUpdateCurrentUserMutation();
     const billingMode = useOrgBillingMode();
     const updateDotfileRepo = useUpdateCurrentUserDotfileRepoMutation();
+    const { data: settings } = useOrgSettingsQuery();
 
     const [dotfileRepo, setDotfileRepo] = useState<string>(user?.dotfileRepo || "");
 
@@ -166,6 +169,14 @@ export default function Preferences() {
                 <Subheading>Workspaces will stop after a period of inactivity without any user input.</Subheading>
 
                 <div className="mt-4 max-w-xl">
+                    {!!settings?.timeoutSettings?.denyUserTimeouts && (
+                        <Alert type="warning" className="mb-4">
+                            The currently selected organization does not allow members to set custom workspace timeouts,
+                            so for workspaces created in it, its default timeout of{" "}
+                            {converter.toDurationString(settings?.timeoutSettings?.inactivity)} will be used.
+                        </Alert>
+                    )}
+
                     <form onSubmit={saveWorkspaceTimeout}>
                         <InputField
                             label="Default Workspace Timeout"
@@ -198,7 +209,7 @@ export default function Preferences() {
                                         Save
                                     </LoadingButton>
                                 </div>
-                                {!!creationError && (
+                                {creationError && (
                                     <p className="text-gitpod-red w-full max-w-lg">
                                         Cannot set custom workspace timeout: {creationError.message}
                                     </p>

components/gitpod-db/src/typeorm/entity/db-team-settings.ts

@@ -4,7 +4,7 @@
  * See License.AGPL.txt in the project root for license information.
  */
 
-import { OrgMemberRole, OrganizationSettings } from "@gitpod/gitpod-protocol";
+import { OrgMemberRole, OrganizationSettings, TimeoutSettings } from "@gitpod/gitpod-protocol";
 import { Entity, Column, PrimaryColumn } from "typeorm";
 import { TypeORM } from "../typeorm";
 
@@ -33,6 +33,9 @@ export class DBOrgSettings implements OrganizationSettings {
     @Column("varchar", { nullable: true })
     defaultRole?: OrgMemberRole | undefined;
 
+    @Column("json", { nullable: true })
+    timeoutSettings?: TimeoutSettings | undefined;
+
     @Column()
     deleted: boolean;
 }

components/gitpod-db/src/typeorm/migration/1723148483807-AddOrgTimeoutSettings.ts

@@ -0,0 +1,25 @@
+/**
+ * Copyright (c) 2024 Gitpod GmbH. All rights reserved.
+ * Licensed under the GNU Affero General Public License (AGPL).
+ * See License.AGPL.txt in the project root for license information.
+ */
+
+import { MigrationInterface, QueryRunner } from "typeorm";
+import { columnExists } from "./helper/helper";
+
+const table = "d_b_org_settings";
+const newColumn = "timeoutSettings";
+
+export class AddOrgTimeoutSettings1723148483807 implements MigrationInterface {
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        if (!(await columnExists(queryRunner, table, newColumn))) {
+            await queryRunner.query(`ALTER TABLE ${table} ADD COLUMN ${newColumn} JSON NULL`);
+        }
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        if (await columnExists(queryRunner, table, newColumn)) {
+            await queryRunner.query(`ALTER TABLE ${table} DROP COLUMN ${newColumn}`);
+        }
+    }
+}

components/gitpod-db/src/typeorm/team-db-impl.ts

@@ -368,6 +368,7 @@ export class TeamDBImpl extends TransactionalDBImpl<TeamDB> implements TeamDB {
                 "pinnedEditorVersions",
                 "restrictedEditorNames",
                 "defaultRole",
+                "timeoutSettings",
             ],
         });
     }