Add region admission preference

Author: csweichel

components/gitpod-protocol/src/gitpod-service.ts

@@ -9,7 +9,7 @@ import {
     WhitelistedRepository, WorkspaceImageBuild, AuthProviderInfo, Branding, CreateWorkspaceMode,
     Token, UserEnvVarValue, ResolvePluginsParams, PreparePluginUploadParams, Terms,
     ResolvedPlugins, Configuration, InstallPluginsParams, UninstallPluginParams, UserInfo, GitpodTokenType,
-    GitpodToken, AuthProviderEntry, GuessGitTokenScopesParams, GuessedGitTokenScopes
+    GitpodToken, AuthProviderEntry, GuessGitTokenScopesParams, GuessedGitTokenScopes, WorkspaceClusterPreference
 } from './protocol';
 import {
     Team, TeamMemberInfo,
@@ -237,6 +237,9 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     trackEvent(event: RemoteTrackMessage): Promise<void>;
     trackLocation(event: RemotePageMessage): Promise<void>;
     identifyUser(event: RemoteIdentifyMessage): Promise<void>;
+
+    listWorkspaceClusterRTTEndpoints(): Promise<{ endpoint: string; region: string }[]>;
+    setWorkspaceClusterPreferences(pref: WorkspaceClusterPreference): Promise<void>;
 }
 
 export interface CreateProjectParams {

components/gitpod-protocol/src/protocol.ts

@@ -107,6 +107,9 @@ export interface AdditionalUserData {
 
     // Git clone URL pointing to the user's dotfile repo
     dotfileRepo?: string;
+
+    // cluster preferences collect data useful for workspace cluster selection
+    clusterPreferences?: WorkspaceClusterPreference;
 }
 
 export interface EmailNotificationSettings {
@@ -1248,3 +1251,7 @@ export interface Terms {
     readonly content: string;
     readonly formElements?: object;
 }
+
+export interface WorkspaceClusterPreference {
+    region?: string;
+}

components/gitpod-protocol/src/workspace-cluster.ts

@@ -60,9 +60,13 @@ export type AdmissionConstraintFeaturePreview = { type: "has-feature-preview" };
 export type AdmissionConstraintHasRole = { type: "has-permission", permission: PermissionName };
 export type AdmissionConstraintHasUserLevel = { type: "has-user-level", level: string };
 
-export type AdmissionPreference = AdmissionPreferenceUserLevel;
+export type AdmissionPreference = AdmissionPreferenceUserLevel | AdmissionPreferenceRegion;
 export type AdmissionPreferenceUserLevel = { type: 'user-level', level: string };
+export type AdmissionPreferenceRegion = { type: 'region', rttEndpoint: string, name: string };
 
+export function isAdmissionPreferenceRegion(arg: any): arg is AdmissionPreferenceRegion {
+    return "type" in arg && arg.type === "region" && "rttEndpoint" in arg && "region" in arg;
+}
 
 export const WorkspaceClusterDB = Symbol("WorkspaceClusterDB");
 export interface WorkspaceClusterDB {

components/server/src/auth/rate-limiter.ts

@@ -174,6 +174,9 @@ function getConfig(config: RateLimiterConfig): RateLimiterConfig {
         "trackLocation": { group: "default", points: 1},
         "identifyUser": { group: "default", points: 1},
         "getIDEOptions": { group: "default", points: 1 },
+
+        "listWorkspaceClusterRTTEndpoints": { group: "default", points: 1 },
+        "setWorkspaceClusterPreferences": { group: "default", points: 1 },
     };
 
     return {

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

@@ -6,7 +6,7 @@
 
 import { DownloadUrlRequest, DownloadUrlResponse, UploadUrlRequest, UploadUrlResponse } from '@gitpod/content-service/lib/blobs_pb';
 import { AppInstallationDB, UserDB, UserMessageViewsDB, WorkspaceDB, DBWithTracing, TracedWorkspaceDB, DBGitpodToken, DBUser, UserStorageResourcesDB, TeamDB } from '@gitpod/gitpod-db/lib';
-import { AuthProviderEntry, AuthProviderInfo, Branding, CommitContext, Configuration, CreateWorkspaceMode, DisposableCollection, GetWorkspaceTimeoutResult, GitpodClient as GitpodApiClient, GitpodServer, GitpodToken, GitpodTokenType, InstallPluginsParams, PermissionName, PortVisibility, PrebuiltWorkspace, PrebuiltWorkspaceContext, PreparePluginUploadParams, ResolvedPlugins, ResolvePluginsParams, SetWorkspaceTimeoutResult, StartPrebuildContext, StartWorkspaceResult, Terms, Token, UninstallPluginParams, User, UserEnvVar, UserEnvVarValue, UserInfo, WhitelistedRepository, Workspace, WorkspaceContext, WorkspaceCreationResult, WorkspaceImageBuild, WorkspaceInfo, WorkspaceInstance, WorkspaceInstancePort, WorkspaceInstanceUser, WorkspaceTimeoutDuration, GuessGitTokenScopesParams, GuessedGitTokenScopes, Team, TeamMemberInfo, TeamMembershipInvite, CreateProjectParams, Project, ProviderRepository, TeamMemberRole, WithDefaultConfig, FindPrebuildsParams, PrebuildWithStatus, StartPrebuildResult, ClientHeaderFields } from '@gitpod/gitpod-protocol';
+import { AuthProviderEntry, AuthProviderInfo, Branding, CommitContext, Configuration, CreateWorkspaceMode, DisposableCollection, GetWorkspaceTimeoutResult, GitpodClient as GitpodApiClient, GitpodServer, GitpodToken, GitpodTokenType, InstallPluginsParams, PermissionName, PortVisibility, PrebuiltWorkspace, PrebuiltWorkspaceContext, PreparePluginUploadParams, ResolvedPlugins, ResolvePluginsParams, SetWorkspaceTimeoutResult, StartPrebuildContext, StartWorkspaceResult, Terms, Token, UninstallPluginParams, User, UserEnvVar, UserEnvVarValue, UserInfo, WhitelistedRepository, Workspace, WorkspaceContext, WorkspaceCreationResult, WorkspaceImageBuild, WorkspaceInfo, WorkspaceInstance, WorkspaceInstancePort, WorkspaceInstanceUser, WorkspaceTimeoutDuration, GuessGitTokenScopesParams, GuessedGitTokenScopes, Team, TeamMemberInfo, TeamMembershipInvite, CreateProjectParams, Project, ProviderRepository, TeamMemberRole, WithDefaultConfig, FindPrebuildsParams, PrebuildWithStatus, StartPrebuildResult, ClientHeaderFields, WorkspaceClusterPreference } from '@gitpod/gitpod-protocol';
 import { AccountStatement } from "@gitpod/gitpod-protocol/lib/accounting-protocol";
 import { AdminBlockUserRequest, AdminGetListRequest, AdminGetListResult, AdminGetWorkspacesRequest, AdminModifyPermanentWorkspaceFeatureFlagRequest, AdminModifyRoleOrPermissionRequest, WorkspaceAndInstance } from '@gitpod/gitpod-protocol/lib/admin-protocol';
 import { GetLicenseInfoResult, LicenseFeature, LicenseValidationResult } from '@gitpod/gitpod-protocol/lib/license-protocol';
@@ -56,6 +56,7 @@ import { IDEConfigService } from '../ide-config';
 import { PartialProject } from '@gitpod/gitpod-protocol/src/teams-projects-protocol';
 import { ClientMetadata } from '../websocket/websocket-connection-manager';
 import { ConfigurationService } from '../config/configuration-service';
+import { AdmissionPreferenceRegion, WorkspaceClusterDB } from '@gitpod/gitpod-protocol/lib/workspace-cluster';
 
 // shortcut
 export const traceWI = (ctx: TraceContext, wi: Omit<LogContext, "userId">) => TraceContext.setOWI(ctx, wi);    // userId is already taken care of in WebsocketConnectionManager
@@ -113,6 +114,8 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
 
     @inject(IDEConfigService) protected readonly ideConfigService: IDEConfigService;
 
+    @inject(WorkspaceClusterDB) protected readonly workspaceClusterDB: WorkspaceClusterDB;
+
     /** Id the uniquely identifies this server instance */
     public readonly uuid: string = uuidv4();
     public readonly clientMetadata: ClientMetadata;
@@ -2182,6 +2185,34 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
         return ideConfig.ideOptions;
     }
 
+    async listWorkspaceClusterRTTEndpoints(ctx: TraceContext): Promise<{ region: string; endpoint: string; }[]> {
+        const candidates = await this.workspaceClusterDB.findFiltered({state: 'available'});
+        const allEndpoints = candidates.flatMap(c => (c.admissionPreferences || []).filter(ap => ap.type === 'region')).map(ap => {
+            const rap = ap as AdmissionPreferenceRegion;
+            return {
+                region: rap.name,
+                endpoint: rap.rttEndpoint,
+            };
+        });
+
+        return [...new Set(allEndpoints)];
+    }
+
+    async setWorkspaceClusterPreferences(ctx: TraceContext, pref: WorkspaceClusterPreference): Promise<void> {
+        const user = this.checkUser("setWorkspaceClusterPreferences");
+
+        const data = user.additionalData || {};
+        const clusterPref = data.clusterPreferences || {};
+
+        // don't just dump `pref` in here, we have no idea what it contains.
+        clusterPref.region = pref.region;
+
+        data.clusterPreferences = clusterPref;
+        user.additionalData = data;
+
+        await this.userDB.updateUserPartial(user);
+    }
+
     //#region gitpod.io concerns
     //
     async adminGetAccountStatement(ctx: TraceContext, userId: string): Promise<AccountStatement> {

components/ws-manager-api/typescript/src/client-provider.ts

@@ -199,6 +199,8 @@ function admissionPreferencesFilter(user: ExtendedUser): (c: WorkspaceClusterWoT
             switch (pref.type) {
                 case "user-level":
                     return pref.level === user.level;
+                case "region":
+                    return pref.name === user.additionalData?.clusterPreferences?.region;
                 default:
                     return false;
             }

components/ws-manager-bridge-api/cluster-service.proto

@@ -52,8 +52,14 @@ message AdmissionConstraint {
 }
 
 message AdmissionPreference {
+  message Region {
+    string name =  1;
+    string rtt_endpoint = 2;
+  }
+
   oneof preference {
     string user_level = 1;
+    Region region = 2;
   }
 }