[dashboard] add custom global timeout user preference

Co-authored-by: George Tsiolis <[email protected]>
gitpod-io · Feb 24, 2023 · 6ab9dc4 · 6ab9dc4
1 parent ad26ca1
commit 6ab9dc4
Show file tree

Hide file tree

Showing 2 changed files with 67 additions and 0 deletions.
diff --git a/components/dashboard/src/user-settings/Preferences.tsx b/components/dashboard/src/user-settings/Preferences.tsx
@@ -11,6 +11,8 @@ import { trackEvent } from "../Analytics";
 import SelectIDE from "./SelectIDE";
 import { PageWithSettingsSubMenu } from "./PageWithSettingsSubMenu";
 import { ThemeSelector } from "../components/ThemeSelector";
+import CheckBox from "../components/CheckBox";
+import { WorkspaceTimeoutDuration } from "@gitpod/gitpod-protocol";
 
 export default function Preferences() {
     const { user } = useContext(UserContext);
@@ -29,6 +31,32 @@ export default function Preferences() {
         }
     };
 
+    const [disabledClosedTimeout, setDisabledClosedTimeout] = useState<boolean>(
+        user?.additionalData?.disabledClosedTimeout ?? false,
+    );
+    const actuallySetDisabledClosedTimeout = async (value: boolean) => {
+        try {
+            const additionalData = user?.additionalData || {};
+            additionalData.disabledClosedTimeout = value;
+            await getGitpodService().server.updateLoggedInUser({ additionalData });
+            setDisabledClosedTimeout(value);
+        } catch (e) {
+            alert("Cannot set custom workspace timeout: " + e.message);
+        }
+    };
+
+    const [workspaceTimeout, setWorkspaceTimeout] = useState<string>(user?.additionalData?.workspaceTimeout ?? "");
+    const actuallySetWorkspaceTimeout = async (value: string) => {
+        try {
+            const timeout = WorkspaceTimeoutDuration.validate(value);
+            const additionalData = user?.additionalData || {};
+            additionalData.workspaceTimeout = timeout;
+            await getGitpodService().server.updateLoggedInUser({ additionalData });
+        } catch (e) {
+            alert("Cannot set custom workspace timeout: " + e.message);
+        }
+    };
+
     return (
         <div>
             <PageWithSettingsSubMenu>
@@ -72,6 +100,42 @@ export default function Preferences() {
                         </p>
                     </div>
                 </div>
+
+                <h3 className="mt-12">Inactivity Timeout </h3>
+                <p className="text-base text-gray-500 dark:text-gray-400">
+                    By default, workspaces stop following 30 minutes without user input (e.g. keystrokes or terminal
+                    input commands). You can increase the workspace timeout up to a maximum of 24 hours.
+                </p>
+                <div className="mt-4 max-w-xl">
+                    <h4>Default Inactivity Timeout</h4>
+                    <span className="flex">
+                        <input
+                            type="text"
+                            className="w-96 h-9"
+                            value={workspaceTimeout}
+                            placeholder="timeout time, such as 30m, 1h, max 24h"
+                            onChange={(e) => setWorkspaceTimeout(e.target.value)}
+                        />
+                        <button
+                            className="secondary ml-2"
+                            onClick={() => actuallySetWorkspaceTimeout(workspaceTimeout)}
+                        >
+                            Save Changes
+                        </button>
+                    </span>
+                    <div className="mt-1">
+                        <p className="text-gray-500 dark:text-gray-400">
+                            Use minutes or hours, like <strong>30m</strong> or <strong>2h</strong>.
+                        </p>
+                    </div>
+
+                    <CheckBox
+                        title="Keep workspace running"
+                        desc={<span>Don't change workspace inactivity timeout when closing the editor.</span>}
+                        checked={disabledClosedTimeout}
+                        onChange={(e) => actuallySetDisabledClosedTimeout(e.target.checked)}
+                    />
+                </div>
             </PageWithSettingsSubMenu>
         </div>
     );

diff --git a/components/gitpod-protocol/src/protocol.ts b/components/gitpod-protocol/src/protocol.ts
@@ -254,6 +254,9 @@ export interface AdditionalUserData {
     // whether the user has been migrated to team attribution.
     // a corresponding feature flag (team_only_attribution) triggers the migration.
     isMigratedToTeamOnlyAttribution?: boolean;
+    // user globol workspace timeout
+    workspaceTimeout?: string;
+    disabledClosedTimeout?: boolean;
 }
 export namespace AdditionalUserData {
     export function set(user: User, partialData: Partial<AdditionalUserData>): User {