[server] Allow setting ws-class on project level

Author: svenefftinge

components/dashboard/src/projects/ProjectSettings.tsx

@@ -4,7 +4,7 @@
  * See License-AGPL.txt in the project root for license information.
  */
 
-import { useContext } from "react";
+import { useContext, useEffect, useState } from "react";
 import { useLocation } from "react-router";
 import { Project, ProjectSettings, Team } from "@gitpod/gitpod-protocol";
 import CheckBox from "../components/CheckBox";
@@ -14,6 +14,8 @@ import { PageWithSubMenu } from "../components/PageWithSubMenu";
 import PillLabel from "../components/PillLabel";
 import { ProjectContext } from "./project-context";
 import { FeatureFlagContext } from "../contexts/FeatureFlagContext";
+import SelectWorkspaceClass from "../settings/selectClass";
+import { BillingMode } from "@gitpod/gitpod-protocol/lib/billing-mode";
 
 export function getProjectSettingsMenu(project?: Project, team?: Team) {
     const teamOrUserSlug = !!team ? "t/" + team.slug : "projects";
@@ -48,6 +50,14 @@ export function ProjectSettingsPage(props: { project?: Project; children?: React
 export default function () {
     const { showPersistentVolumeClaimUI } = useContext(FeatureFlagContext);
     const { project, setProject } = useContext(ProjectContext);
+    const [teamBillingMode, setTeamBillingMode] = useState<BillingMode | undefined>(undefined);
+    const { teams } = useContext(TeamsContext);
+    const team = getCurrentTeam(useLocation(), teams);
+    useEffect(() => {
+        if (team) {
+            getGitpodService().server.getBillingModeForTeam(team.id).then(setTeamBillingMode);
+        }
+    }, [team]);
 
     if (!project) return null;
 
@@ -59,6 +69,15 @@ export default function () {
         setProject({ ...project, settings: newSettings });
     };
 
+    const setWorkspaceClass = async (value: string) => {
+        if (!project) {
+            return value;
+        }
+        const before = project.settings?.workspaceClasses?.regular;
+        updateProjectSettings({ workspaceClasses: { prebuild: value, regular: value } });
+        return before;
+    };
+
     return (
         <ProjectSettingsPage project={project}>
             <h3>Prebuilds</h3>
@@ -144,6 +163,10 @@ export default function () {
                 <>
                     <br></br>
                     <h3 className="mt-12">Workspaces</h3>
+                    <SelectWorkspaceClass
+                        enabled={BillingMode.canSetWorkspaceClass(teamBillingMode)}
+                        setWorkspaceClass={setWorkspaceClass}
+                    />
                     <CheckBox
                         title={
                             <span>

components/dashboard/src/settings/Preferences.tsx

@@ -14,6 +14,7 @@ import SelectIDE from "./SelectIDE";
 import SelectWorkspaceClass from "./selectClass";
 import { PageWithSettingsSubMenu } from "./PageWithSettingsSubMenu";
 import { BillingMode } from "@gitpod/gitpod-protocol/lib/billing-mode";
+import { WorkspaceClasses } from "@gitpod/gitpod-protocol";
 
 type Theme = "light" | "dark" | "system";
 
@@ -49,13 +50,29 @@ export default function Preferences() {
         }
     };
 
+    const setWorkspaceClass = async (value: string) => {
+        const additionalData = user?.additionalData || {};
+        const prevWorkspaceClass = additionalData?.workspaceClasses?.regular;
+        const workspaceClasses = (additionalData?.workspaceClasses || {}) as WorkspaceClasses;
+        workspaceClasses.regular = value;
+        workspaceClasses.prebuild = value;
+        additionalData.workspaceClasses = workspaceClasses;
+        if (value !== prevWorkspaceClass) {
+            await getGitpodService().server.updateLoggedInUser({ additionalData });
+        }
+        return prevWorkspaceClass;
+    };
+
     return (
         <div>
             <PageWithSettingsSubMenu title="Preferences" subtitle="Configure user preferences.">
                 <h3>Editor</h3>
                 <p className="text-base text-gray-500 dark:text-gray-400">Choose the editor for opening workspaces.</p>
                 <SelectIDE location="preferences" />
-                <SelectWorkspaceClass enabled={BillingMode.canSetWorkspaceClass(userBillingMode)} />
+                <SelectWorkspaceClass
+                    enabled={BillingMode.canSetWorkspaceClass(userBillingMode)}
+                    setWorkspaceClass={setWorkspaceClass}
+                />
                 <h3 className="mt-12">Theme</h3>
                 <p className="text-base text-gray-500 dark:text-gray-400">Early bird or night owl? Choose your side.</p>
                 <div className="mt-4 space-x-3 flex">

components/dashboard/src/settings/selectClass.tsx

@@ -8,29 +8,23 @@ import { useContext, useEffect, useState } from "react";
 import { getGitpodService } from "../service/service";
 import { UserContext } from "../user-context";
 import { trackEvent } from "../Analytics";
-import { WorkspaceClasses } from "@gitpod/gitpod-protocol";
 import WorkspaceClass from "../components/WorkspaceClass";
 import { SupportedWorkspaceClass } from "@gitpod/gitpod-protocol/lib/workspace-class";
 
 interface SelectWorkspaceClassProps {
     enabled: boolean;
+    setWorkspaceClass: (value: string) => Promise<string | undefined>;
 }
 
 export default function SelectWorkspaceClass(props: SelectWorkspaceClassProps) {
     const { user } = useContext(UserContext);
 
     const [workspaceClass, setWorkspaceClass] = useState<string>(user?.additionalData?.workspaceClasses?.regular || "");
     const actuallySetWorkspaceClass = async (value: string) => {
-        const additionalData = user?.additionalData || {};
-        const prevWorkspaceClass = additionalData?.workspaceClasses?.regular || "";
-        const workspaceClasses = (additionalData?.workspaceClasses || {}) as WorkspaceClasses;
-        workspaceClasses.regular = value;
-        workspaceClasses.prebuild = value;
-        additionalData.workspaceClasses = workspaceClasses;
-        if (value !== prevWorkspaceClass) {
-            await getGitpodService().server.updateLoggedInUser({ additionalData });
+        const previousValue = await props.setWorkspaceClass(value);
+        if (previousValue !== value) {
             trackEvent("workspace_class_changed", {
-                previous: prevWorkspaceClass,
+                previous: previousValue,
                 current: value,
             });
             setWorkspaceClass(value);

components/gitpod-protocol/src/teams-projects-protocol.ts

@@ -4,7 +4,7 @@
  * See License-AGPL.txt in the project root for license information.
  */
 
-import { PrebuiltWorkspaceState } from "./protocol";
+import { PrebuiltWorkspaceState, WorkspaceClasses } from "./protocol";
 import { v4 as uuidv4 } from "uuid";
 import { DeepPartial } from "./util/deep-partial";
 import { WebhookEvent } from "./webhook-event";
@@ -21,6 +21,8 @@ export interface ProjectSettings {
     allowUsingPreviousPrebuilds?: boolean;
     // how many commits in the commit history a prebuild is good (undefined and 0 means every commit is prebuilt)
     prebuildEveryNthCommit?: number;
+    // preferred workspace classes
+    workspaceClasses?: WorkspaceClasses;
 }
 
 export interface Project {

components/server/src/workspace/gitpod-server-impl.ts

@@ -2980,6 +2980,7 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
         let user = this.checkAndBlockUser("getSupportedWorkspaceClasses");
         let selectedClass = await WorkspaceClasses.getConfiguredOrUpgradeFromLegacy(
             user,
+            undefined,
             this.config.workspaceClasses,
             this.entitlementService,
         );

components/server/src/workspace/workspace-classes.ts

@@ -5,7 +5,7 @@
  */
 
 import { WorkspaceDB } from "@gitpod/gitpod-db/lib";
-import { User, Workspace } from "@gitpod/gitpod-protocol";
+import { Project, User, Workspace } from "@gitpod/gitpod-protocol";
 import { log } from "@gitpod/gitpod-protocol/lib/util/logging";
 import { TraceContext } from "@gitpod/gitpod-protocol/lib/util/tracing";
 import { EntitlementService } from "../billing/entitlement-service";
@@ -159,9 +159,13 @@ export namespace WorkspaceClasses {
      */
     export async function getConfiguredOrUpgradeFromLegacy(
         user: User,
+        project: Project | undefined,
         classes: WorkspaceClassesConfig,
         entitlementService: EntitlementService,
     ): Promise<string> {
+        if (project?.settings?.workspaceClasses?.regular) {
+            return project?.settings?.workspaceClasses?.regular;
+        }
         if (user.additionalData?.workspaceClasses?.regular) {
             return user.additionalData?.workspaceClasses?.regular;
         }

components/server/src/workspace/workspace-starter.ts

@@ -60,6 +60,7 @@ import {
     WithReferrerContext,
     EnvVarWithValue,
     BillingTier,
+    Project,
 } from "@gitpod/gitpod-protocol";
 import { IAnalyticsWriter } from "@gitpod/gitpod-protocol/lib/analytics";
 import { log } from "@gitpod/gitpod-protocol/lib/util/logging";
@@ -204,6 +205,7 @@ export async function getWorkspaceClassForInstance(
     workspace: Workspace,
     previousInstance: WorkspaceInstance | undefined,
     user: User,
+    project: Project | undefined,
     entitlementService: EntitlementService,
     config: WorkspaceClassesConfig,
     workspaceDb: DBWithTracing<WorkspaceDB>,
@@ -217,17 +219,22 @@ export async function getWorkspaceClassForInstance(
                 if (prebuildClass) {
                     const userClass = await WorkspaceClasses.getConfiguredOrUpgradeFromLegacy(
                         user,
+                        project,
                         config,
                         entitlementService,
                     );
                     workspaceClass = WorkspaceClasses.selectClassForRegular(prebuildClass, userClass, config);
+                } else if (project?.settings?.workspaceClasses?.regular) {
+                    workspaceClass = project?.settings?.workspaceClasses?.regular;
                 } else if (user.additionalData?.workspaceClasses?.regular) {
                     workspaceClass = user.additionalData?.workspaceClasses?.regular;
                 }
             }
 
             if (workspace.type == "prebuild") {
-                if (user.additionalData?.workspaceClasses?.prebuild) {
+                if (project?.settings?.workspaceClasses?.prebuild) {
+                    workspaceClass = project?.settings?.workspaceClasses?.prebuild;
+                } else if (user.additionalData?.workspaceClasses?.prebuild) {
                     workspaceClass = user.additionalData?.workspaceClasses?.prebuild;
                 }
             }