[dashboard] Measure workspace cluster region RTT

Author: csweichel

components/dashboard/src/Login.tsx

@@ -22,6 +22,7 @@ import fresh from "./images/welcome/fresh.svg";
 import prebuild from "./images/welcome/prebuild.svg";
 import exclamation from "./images/exclamation.svg";
 import { getURLHash } from "./App";
+import { measureAndPickWorkspaceClusterRegion } from "./start/choose-region";
 
 
 function Item(props: { icon: string, iconSize?: string, text: string }) {
@@ -84,6 +85,8 @@ export function Login() {
     const authorizeSuccessful = async (payload?: string) => {
         updateUser().catch(console.error);
 
+        await measureAndPickWorkspaceClusterRegion();
+
         // Check for a valid returnTo in payload
         const safeReturnTo = getSafeURLRedirect(payload);
         if (safeReturnTo) {

components/dashboard/src/start/StartPage.tsx

@@ -6,6 +6,7 @@
 
 import { useEffect } from 'react';
 import gitpodIcon from '../icons/gitpod.svg';
+import { measureAndPickWorkspaceClusterRegion } from './choose-region';
 
 export enum StartPhase {
   Checking = 0,
@@ -84,6 +85,7 @@ export function StartPage(props: StartPageProps) {
   const { phase, error } = props;
   let title = props.title || getPhaseTitle(phase, error);
   useEffect(() => { document.title = 'Starting — Gitpod' }, []);
+  measureAndPickWorkspaceClusterRegion();
   return <div className="w-screen h-screen align-middle">
     <div className="flex flex-col mx-auto items-center text-center h-screen">
       <div className="h-1/3"></div>

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

@@ -0,0 +1,65 @@
+/**
+ * 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 eps = await getGitpodService().server.listWorkspaceClusterRTTEndpoints();
+
+    if (!!eps.lastMeasurement) {
+        const lrm = Date.parse(eps.lastMeasurement);
+        if (Date.now() - lrm < 6*60*60*1000) {
+            // we checked within the last six hours. Nothing to do here.
+            return;
+        }
+    }
+
+    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;
+    }
+
+    await getGitpodService().server.setWorkspaceClusterPreferences({ region });
+}
+
+async function measureRTT(endpoint: string, region: string): Promise<string | undefined> {
+    const laps = 5;
+    let count = 0;
+    for (let i = 0; i < laps; i++) {
+        const controller = new AbortController();
+        const abort = setTimeout(() => controller.abort(), 1000);
+
+        try {
+            await fetch(endpoint, {
+                cache: "no-cache",
+                signal: controller.signal,
+            });
+            count++;
+        } catch (err) {
+            console.debug(`failed to fetch RTT endpoint ${endpoint}: ${err}`);
+        } finally {
+            clearTimeout(abort);
+        }
+    }
+
+    if (count < 5) {
+        // we haven't completed all RTT measurements, hence take a penalty lap.
+        await new Promise(resolve => setTimeout(resolve, laps * 1000));
+        return;
+    }
+
+    return region;
+}
+
+export { measureAndPickWorkspaceClusterRegion };

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

@@ -9,7 +9,8 @@ import {
     WhitelistedRepository, WorkspaceImageBuild, AuthProviderInfo, Branding, CreateWorkspaceMode,
     Token, UserEnvVarValue, ResolvePluginsParams, PreparePluginUploadParams, Terms,
     ResolvedPlugins, Configuration, InstallPluginsParams, UninstallPluginParams, UserInfo, GitpodTokenType,
-    GitpodToken, AuthProviderEntry, GuessGitTokenScopesParams, GuessedGitTokenScopes, WorkspaceClusterPreference
+    GitpodToken, AuthProviderEntry, GuessGitTokenScopesParams, GuessedGitTokenScopes, WorkspaceClusterPreference,
+    WorkspaceClusterRTTEndpoints
 } from './protocol';
 import {
     Team, TeamMemberInfo,
@@ -238,7 +239,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

@@ -1254,4 +1254,15 @@ export interface Terms {
 
 export interface WorkspaceClusterPreference {
     region?: string;
-}
+    // lrm == lastRegionMeasurement. Not writing the full name to save
+    // a few 100mb in the database.
+    lrm?: string;
+}
+
+export interface WorkspaceClusterRTTEndpoints {
+    lastMeasurement?: string;
+    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, 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 { 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, 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';
@@ -2185,7 +2185,9 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
         return ideConfig.ideOptions;
     }
 
-    async listWorkspaceClusterRTTEndpoints(ctx: TraceContext): Promise<{ region: string; endpoint: string; }[]> {
+    async listWorkspaceClusterRTTEndpoints(ctx: TraceContext): Promise<WorkspaceClusterRTTEndpoints> {
+        const user = this.checkUser("listWorkspaceClusterRTTEndpoints");
+
         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;
@@ -2195,7 +2197,10 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
             };
         });
 
-        return [...new Set(allEndpoints)];
+        return {
+            lastMeasurement: user.additionalData?.clusterPreferences?.lrm,
+            candidates: [...new Set(allEndpoints)]
+        };
     }
 
     async setWorkspaceClusterPreferences(ctx: TraceContext, pref: WorkspaceClusterPreference): Promise<void> {
@@ -2206,6 +2211,7 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
 
         // don't just dump `pref` in here, we have no idea what it contains.
         clusterPref.region = pref.region;
+        clusterPref.lrm = new Date().toISOString();
 
         data.clusterPreferences = clusterPref;
         user.additionalData = data;