[dashboard] Measure workspace cluster region RTT

[server] Test RTT for available workspace cluster only

[dashboard] Improve RTT measurement

[dashboard] enable RTT measurement

Author: csweichel

components/dashboard/src/start/CreateWorkspace.tsx

@@ -17,6 +17,7 @@ import { openAuthorizeWindow } from "../provider-utils";
 import { SelectAccountPayload } from "@gitpod/gitpod-protocol/lib/auth";
 import { SelectAccountModal } from "../settings/SelectAccountModal";
 import { watchHeadlessLogs } from "../components/PrebuildLogs";
+import { measureAndPickWorkspaceClusterRegion } from "./choose-region";
 
 const WorkspaceLogs = React.lazy(() => import('../components/WorkspaceLogs'));
 
@@ -46,6 +47,9 @@ export default class CreateWorkspace extends React.Component<CreateWorkspaceProp
     // Invalidate any previous result.
     this.setState({ result: undefined, stillParsing: true });
 
+    // Ensure we'll land on a good workspace custer
+    await measureAndPickWorkspaceClusterRegion();
+
     // We assume anything longer than 3 seconds is no longer just parsing the context URL (i.e. it's now creating a workspace).
     let timeout = setTimeout(() => this.setState({ stillParsing: false }), 3000);
 

components/dashboard/src/start/StartWorkspace.tsx

@@ -15,6 +15,7 @@ import PendingChangesDropdown from "../components/PendingChangesDropdown";
 import { watchHeadlessLogs } from "../components/PrebuildLogs";
 import { getGitpodService, gitpodHostUrl } from "../service/service";
 import { StartPage, StartPhase, StartWorkspaceError } from "./StartPage";
+import { measureAndPickWorkspaceClusterRegion } from "./choose-region";
 const sessionId = v4();
 
 const WorkspaceLogs = React.lazy(() => import('../components/WorkspaceLogs'));
@@ -117,6 +118,9 @@ export default class StartWorkspace extends React.Component<StartWorkspaceProps,
       }
     }
 
+    // Ensure we'll land on a good workspace custer - this call will take max 1 second
+    await measureAndPickWorkspaceClusterRegion();
+
     const { workspaceId } = this.props;
     try {
       const result = await getGitpodService().server.startWorkspace(workspaceId, { forceDefaultImage });

components/dashboard/src/start/choose-region.ts

@@ -0,0 +1,62 @@
+/**
+ * Copyright (c) 2021 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 { getGitpodService } from "../service/service";
+
+/**
+ *
+ * measureAndPickWorkspaceClusterRegion attempts multiple fetch calls on all available workspace cluster regions.
+ * The first region to return those fetch attempts is set as workspace cluster preference.
+ *
+ * @returns void
+ */
+async function measureAndPickWorkspaceClusterRegion(): Promise<void> {
+    const localStorageKey = "lastRTTMeasurement";
+
+    try {
+        let lastCheck = localStorage.getItem(localStorageKey);
+        if (!!lastCheck && (Date.now() - Date.parse(lastCheck)) < 6*60*60*1000) {
+            // we've recently done the check.
+            return;
+        }
+    } catch (err) {
+        // Date.parse can fail ... in which case we assume we haven't done the RTT measurement recently.
+        console.log("cannot determine last RTT measurement run", err);
+    }
+
+    const eps = await getGitpodService().server.listWorkspaceClusterRTTEndpoints();
+
+    const region = await Promise.race(eps.candidates.map(ep => measureRTT(ep.endpoint, ep.region)));
+    if (!region) {
+        console.warn("did not find a prefered workspace cluster region");
+        return;
+    }
+
+    localStorage.setItem(localStorageKey, new Date().toISOString())
+    await getGitpodService().server.setWorkspaceClusterPreferences({ region });
+}
+
+async function measureRTT(endpoint: string, region: string): Promise<string | undefined> {
+    const controller = new AbortController();
+    const abort = setTimeout(() => controller.abort(), 1000);
+
+    try {
+        await Promise.all(Array(5).map(async () => {
+            try {
+                await fetch(endpoint, { cache: "no-cache", signal: controller.signal, });
+            } catch (err) {
+                // we don't want a single error to abort the race. For example, it's ok
+                // if the RTT endpoints return 404.
+            }
+        }))
+    } finally {
+        clearTimeout(abort);
+    }
+
+    return region;
+}
+
+export { measureAndPickWorkspaceClusterRegion };

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

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

components/gitpod-protocol/src/protocol.ts

@@ -1237,3 +1237,10 @@ export interface Terms {
 export interface WorkspaceClusterPreference {
     region?: string;
 }
+
+export interface WorkspaceClusterRTTEndpoints {
+    candidates: {
+        region: string;
+        endpoint: string;
+    }[];
+}

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, 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 { AuthProviderEntry, AuthProviderInfo, 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, WorkspaceClusterRTTEndpoints } 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';
@@ -57,7 +57,7 @@ import { PartialProject } from '@gitpod/gitpod-protocol/src/teams-projects-proto
 import { ClientMetadata } from '../websocket/websocket-connection-manager';
 import { ConfigurationService } from '../config/configuration-service';
 import { ProjectEnvVar } from '@gitpod/gitpod-protocol/src/protocol';
-import { AdmissionPreferenceRegion, WorkspaceClusterDB } from '@gitpod/gitpod-protocol/lib/workspace-cluster';
+import { AdmissionPreferenceRegion } 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
@@ -115,8 +115,6 @@ 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;
@@ -2206,8 +2204,10 @@ 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'});
+    async listWorkspaceClusterRTTEndpoints(ctx: TraceContext): Promise<WorkspaceClusterRTTEndpoints> {
+        const user = this.checkUser("listWorkspaceClusterRTTEndpoints");
+
+        const candidates = await this.workspaceManagerClientProvider.getAvailableStartCluster(user);
         const allEndpoints = candidates.flatMap(c => (c.admissionPreferences || []).filter(ap => ap.type === 'region')).map(ap => {
             const rap = ap as AdmissionPreferenceRegion;
             return {
@@ -2216,7 +2216,9 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
             };
         });
 
-        return [...new Set(allEndpoints)];
+        return {
+            candidates: [...new Set(allEndpoints)]
+        };
     }
 
     async setWorkspaceClusterPreferences(ctx: TraceContext, pref: WorkspaceClusterPreference): Promise<void> {

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

@@ -54,13 +54,13 @@ class TestClientProvider {
 
     @test
     public async testGetStarterWorkspaceCluster() {
-        this.expectInstallations(["a1", "a2", "a3"], await this.provider.getAvailableStartCluster({} as User, {} as Workspace, {} as WorkspaceInstance));
+        this.expectInstallations(["a1", "a2", "a3"], await this.provider.getAvailableStartCluster({} as User));
         this.expectInstallations(["a1", "a2", "a3", "con1"], await this.provider.getAvailableStartCluster({
             additionalData: {featurePreview: true}
-        } as User, {} as Workspace, {} as WorkspaceInstance));
+        } as User));
         this.expectInstallations(["a1", "a2", "a3", "con2"], await this.provider.getAvailableStartCluster({
             rolesOrPermissions: ["new-workspace-cluster"]
-        } as User, {} as Workspace, {} as WorkspaceInstance));
+        } as User));
     }
 
     public async getStartManager() {

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

@@ -44,7 +44,7 @@ export class WorkspaceManagerClientProvider implements Disposable {
      * @returns The WorkspaceManagerClient that was chosen to start the next workspace with.
      */
     public async getStartManager(user: ExtendedUser, workspace: Workspace, instance: WorkspaceInstance, exceptInstallations?: string[]): Promise<{ manager: PromisifiedWorkspaceManagerClient, installation: string }> {
-        let availableCluster = await this.getAvailableStartCluster(user, workspace, instance);
+        let availableCluster = await this.getAvailableStartCluster(user);
         if (!!exceptInstallations) {
             availableCluster = availableCluster.filter(c => !exceptInstallations?.includes(c.name));
         }
@@ -70,9 +70,9 @@ export class WorkspaceManagerClientProvider implements Disposable {
         };
     }
 
-    public async getAvailableStartCluster(user: User, workspace: Workspace, instance: WorkspaceInstance): Promise<WorkspaceClusterWoTLS[]> {
+    public async getAvailableStartCluster(user: User): Promise<WorkspaceClusterWoTLS[]> {
         const allClusters = await this.source.getAllWorkspaceClusters();
-        const availableClusters = allClusters.filter(c => c.score >= 0 && c.state === "available").filter(admissionConstraintsFilter(user, workspace, instance));
+        const availableClusters = allClusters.filter(c => c.score >= 0 && c.state === "available").filter(admissionConstraintsFilter(user));
         return availableClusters;
     }
 
@@ -176,7 +176,7 @@ function chooseCluster(availableCluster: WorkspaceClusterWoTLS[]): WorkspaceClus
     return availableCluster[availableCluster.length - 1];
 }
 
-function admissionConstraintsFilter(user: User, workspace: Workspace, instance: WorkspaceInstance): (c: WorkspaceClusterWoTLS) => boolean {
+function admissionConstraintsFilter(user: User, workspace?: Workspace, instance?: WorkspaceInstance): (c: WorkspaceClusterWoTLS) => boolean {
     return (c: WorkspaceClusterWoTLS) => {
         if (!c.admissionConstraints) {
             return true;