@gitpod/gitpod-protocol 0.1.5-pd-workspacekit.3 → 0.1.5-pd-proto-ide.0

package/src/gitpod-service.ts

@@ -128,7 +128,6 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     deleteWorkspace(id: string): Promise<void>;
     setWorkspaceDescription(id: string, desc: string): Promise<void>;
     controlAdmission(id: string, level: GitpodServer.AdmissionLevel): Promise<void>;
-    restartRing1(workspaceId: string, type: number): Promise<void>;
 
     updateWorkspaceUserPin(id: string, action: GitpodServer.PinAction): Promise<void>;
     sendHeartBeat(options: GitpodServer.SendHeartBeatOptions): Promise<void>;
@@ -166,6 +165,7 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
 
     // Teams
     getTeam(teamId: string): Promise<Team>;
+    updateTeam(teamId: string, team: Pick<Team, "name">): Promise<Team>;
     getTeams(): Promise<Team[]>;
     getTeamMembers(teamId: string): Promise<TeamMemberInfo[]>;
     createTeam(name: string): Promise<Team>;
@@ -175,6 +175,10 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     getGenericInvite(teamId: string): Promise<TeamMembershipInvite>;
     resetGenericInvite(inviteId: string): Promise<TeamMembershipInvite>;
     deleteTeam(teamId: string): Promise<void>;
+    createOrgAuthProvider(params: GitpodServer.CreateOrgAuthProviderParams): Promise<AuthProviderEntry>;
+    updateOrgAuthProvider(params: GitpodServer.UpdateOrgAuthProviderParams): Promise<AuthProviderEntry>;
+    getOrgAuthProviders(params: GitpodServer.GetOrgAuthProviderParams): Promise<AuthProviderEntry[]>;
+    deleteOrgAuthProvider(params: GitpodServer.DeleteOrgAuthProviderParams): Promise<void>;
 
     // Projects
     getProviderRepositoriesForUser(params: GetProviderRepositoriesParams): Promise<ProviderRepository[]>;
@@ -273,6 +277,7 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     getStripePublishableKey(): Promise<string>;
     getStripeSetupIntentClientSecret(): Promise<string>;
     findStripeSubscriptionId(attributionId: string): Promise<string | undefined>;
+    getPriceInformation(attributionId: string): Promise<string | undefined>;
     createStripeCustomerIfNeeded(attributionId: string, currency: string): Promise<void>;
     subscribeToStripe(attributionId: string, setupIntentId: string, usageLimit: number): Promise<number | undefined>;
     getStripePortalUrl(attributionId: string): Promise<string>;
@@ -353,16 +358,33 @@ export interface ClientHeaderFields {
     clientRegion?: string;
 }
 
-export const WORKSPACE_TIMEOUT_DEFAULT_SHORT = "short";
-export const WORKSPACE_TIMEOUT_DEFAULT_LONG = "long";
-export const WORKSPACE_TIMEOUT_EXTENDED = "extended";
-export const WORKSPACE_TIMEOUT_EXTENDED_ALT = "180m"; // for backwards compatibility since the IDE uses this
-export const WorkspaceTimeoutValues = [
-    WORKSPACE_TIMEOUT_DEFAULT_SHORT,
-    WORKSPACE_TIMEOUT_DEFAULT_LONG,
-    WORKSPACE_TIMEOUT_EXTENDED,
-    WORKSPACE_TIMEOUT_EXTENDED_ALT,
-] as const;
+const WORKSPACE_MAXIMUM_TIMEOUT_HOURS = 24;
+
+export type WorkspaceTimeoutDuration = string;
+export namespace WorkspaceTimeoutDuration {
+    export function validate(duration: string): WorkspaceTimeoutDuration {
+        duration = duration.toLowerCase();
+        const unit = duration.slice(-1);
+        if (!["m", "h"].includes(unit)) {
+            throw new Error(`Invalid timeout unit: ${unit}`);
+        }
+        const value = parseInt(duration.slice(0, -1), 10);
+        if (isNaN(value) || value <= 0) {
+            throw new Error(`Invalid timeout value: ${duration}`);
+        }
+        if (
+            (unit === "h" && value > WORKSPACE_MAXIMUM_TIMEOUT_HOURS) ||
+            (unit === "m" && value > WORKSPACE_MAXIMUM_TIMEOUT_HOURS * 60)
+        ) {
+            throw new Error("Workspace inactivity timeout cannot exceed 24h");
+        }
+        return duration;
+    }
+}
+
+export const WORKSPACE_TIMEOUT_DEFAULT_SHORT: WorkspaceTimeoutDuration = "30m";
+export const WORKSPACE_TIMEOUT_DEFAULT_LONG: WorkspaceTimeoutDuration = "60m";
+export const WORKSPACE_TIMEOUT_EXTENDED: WorkspaceTimeoutDuration = "180m";
 
 export const createServiceMock = function <C extends GitpodClient, S extends GitpodServer>(
     methods: Partial<JsonRpcProxy<S>>,
@@ -387,17 +409,15 @@ export const createServerMock = function <C extends GitpodClient, S extends Gitp
     });
 };
 
-type WorkspaceTimeoutDurationTuple = typeof WorkspaceTimeoutValues;
-export type WorkspaceTimeoutDuration = WorkspaceTimeoutDurationTuple[number];
-
 export interface SetWorkspaceTimeoutResult {
     resetTimeoutOnWorkspaces: string[];
+    humanReadableDuration: string;
 }
 
 export interface GetWorkspaceTimeoutResult {
     duration: WorkspaceTimeoutDuration;
-    durationRaw: string;
     canChange: boolean;
+    humanReadableDuration: string;
 }
 
 export interface StartWorkspaceResult {
@@ -430,6 +450,7 @@ export namespace GitpodServer {
         forceDefaultImage?: boolean;
         workspaceClass?: string;
         ideSettings?: IDESettings;
+        region?: string;
     }
     export interface TakeSnapshotOptions {
         workspaceId: string;
@@ -457,6 +478,20 @@ export namespace GitpodServer {
     export interface DeleteOwnAuthProviderParams {
         readonly id: string;
     }
+    export interface CreateOrgAuthProviderParams {
+        // ownerId is automatically set to the authenticated user
+        readonly entry: Omit<AuthProviderEntry.NewOrgEntry, "ownerId">;
+    }
+    export interface UpdateOrgAuthProviderParams {
+        readonly entry: AuthProviderEntry.UpdateOrgEntry;
+    }
+    export interface GetOrgAuthProviderParams {
+        readonly organizationId: string;
+    }
+    export interface DeleteOrgAuthProviderParams {
+        readonly id: string;
+        readonly organizationId: string;
+    }
     export type AdmissionLevel = "owner" | "everyone";
     export type PinAction = "pin" | "unpin" | "toggle";
     export interface GenerateNewGitpodTokenOptions {

package/src/permission.ts

@@ -7,6 +7,7 @@
 // see below for explanation
 export const Permissions = {
     monitor: undefined,
+    developer: undefined,
     enforcement: undefined,
     "privileged-ws": undefined,
     "registry-access": undefined,
@@ -53,6 +54,9 @@ export namespace Permission {
     /** The permission to monitor the (live) state of a Gitpod installation */
     export const MONITOR: PermissionName = "monitor";
 
+    /** The permission to develop on this running Gitpod installation */
+    export const DEVELOPER: PermissionName = "developer";
+
     /** The permission for actions like block user, stop workspace, etc. */
     export const ENFORCEMENT: PermissionName = "enforcement";
 

package/src/protocol.ts

@@ -17,6 +17,9 @@ export interface User {
     /** The user id */
     id: string;
 
+    /** The ID of the Organization this user is owned by. If undefined, the user is owned by the installation */
+    organizationId?: string;
+
     /** The timestamp when the user entry was created */
     creationDate: string;
 
@@ -212,6 +215,9 @@ export interface AdditionalUserData {
     workspaceClasses?: WorkspaceClasses;
     // additional user profile data
     profile?: ProfileDetails;
+    // whether the user has been migrated to team attribution.
+    // a corresponding feature flag (team_only_attribution) triggers the migration.
+    isMigratedToTeamOnlyAttribution?: boolean;
 }
 export namespace AdditionalUserData {
     export function set(user: User, partialData: Partial<AdditionalUserData>): User {
@@ -652,6 +658,10 @@ export type SnapshotState = "pending" | "available" | "error";
 export interface Workspace {
     id: string;
     creationTime: string;
+    /**
+     * undefined means it is owned by the user (legacy mode, soon to be removed)
+     */
+    organizationId?: string;
     contextURL: string;
     description: string;
     ownerId: string;
@@ -1416,6 +1426,7 @@ export interface AuthProviderEntry {
     readonly type: AuthProviderEntry.Type;
     readonly host: string;
     readonly ownerId: string;
+    readonly organizationId?: string;
 
     readonly status: AuthProviderEntry.Status;
 
@@ -1447,6 +1458,14 @@ export namespace AuthProviderEntry {
     };
     export type UpdateEntry = Pick<AuthProviderEntry, "id" | "ownerId"> &
         Pick<OAuth2Config, "clientId" | "clientSecret">;
+    export type NewOrgEntry = NewEntry & {
+        organizationId: string;
+    };
+    export type UpdateOrgEntry = Pick<AuthProviderEntry, "id"> & {
+        clientId: string;
+        clientSecret: string;
+        organizationId: string;
+    };
     export function redact(entry: AuthProviderEntry): AuthProviderEntry {
         return {
             ...entry,

package/src/teams-projects-protocol.ts

@@ -48,6 +48,10 @@ export namespace Project {
         };
     };
 
+    export function slug(p: Project): string {
+        return p.slug || p.name || p.id;
+    }
+
     export interface Overview {
         branches: BranchDetails[];
         isConsideredInactive?: boolean;
@@ -128,7 +132,6 @@ export interface StartPrebuildResult {
 export interface Team {
     id: string;
     name: string;
-    slug: string;
     creationTime: string;
     markedDeleted?: boolean;
     /** This is a flag that triggers the HARD DELETION of this entity */
@@ -137,6 +140,12 @@ export interface Team {
 
 export type TeamMemberRole = "owner" | "member";
 
+export namespace TeamMemberRole {
+    export function isValid(role: any): role is TeamMemberRole {
+        return role === "owner" || role === "member";
+    }
+}
+
 export interface TeamMemberInfo {
     userId: string;
     fullName?: string;

package/src/typings/globals.ts

@@ -5,8 +5,11 @@
  */
 
 interface Window {
+    // gitpod is used by supervisor/frontend and vscode browser https://github.com/gitpod-io/openvscode-server/blob/dadd40deda5959c0efdaa0c7d02ab64b6f8b5ad0/src/vs/gitpod/browser/workbench/workbench.ts#L7
     gitpod: {
-        service: import("../gitpod-service").GitpodService;
         ideService?: import("../ide-frontend-service").IDEFrontendService;
+        loggedUserID?: string;
+
+        openDesktopIDE(url: string): void;
     };
 }

package/src/util/gitpod-host-url.ts

@@ -16,16 +16,10 @@ const baseWorkspaceIDRegex =
     "(([a-f][0-9a-f]{7}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})|([0-9a-z]{2,16}-[0-9a-z]{2,16}-[0-9a-z]{8,11}))";
 
 // this pattern matches v4 UUIDs as well as the new generated workspace ids (e.g. pink-panda-ns35kd21)
-const workspaceIDRegex = RegExp(`^${baseWorkspaceIDRegex}$`);
+const workspaceIDRegex = RegExp(`^(?:debug-)?${baseWorkspaceIDRegex}$`);
 
 // this pattern matches URL prefixes of workspaces
-const workspaceUrlPrefixRegex = RegExp(`^([0-9]{4,6}-)?${baseWorkspaceIDRegex}\\.`);
-
-export namespace StartOptions {
-    export const WORKSPACE_CLASS = "workspaceClass";
-    export const EDITOR = "editor";
-    export const USE_LATEST_EDITOR = "useLatestEditor";
-}
+const workspaceUrlPrefixRegex = RegExp(`^(([0-9]{4,6}|debug)-)?${baseWorkspaceIDRegex}\\.`);
 
 export class GitpodHostUrl {
     readonly url: URL;
@@ -83,8 +77,15 @@ export class GitpodHostUrl {
         return updated.with((url) => ({ pathname: `/api${url.pathname}` }));
     }
 
-    withContext(contextUrl: string) {
-        return this.with((url) => ({ hash: contextUrl }));
+    withContext(
+        contextUrl: string,
+        startOptions?: { showOptions?: boolean; editor?: string; workspaceClass?: string },
+    ) {
+        const searchParams = new URLSearchParams();
+        if (startOptions?.showOptions) {
+            searchParams.append("showOptions", "true");
+        }
+        return this.with((url) => ({ hash: contextUrl, search: searchParams.toString() }));
     }
 
     asWebsocket(): GitpodHostUrl {
@@ -100,27 +101,23 @@ export class GitpodHostUrl {
     }
 
     asBilling(): GitpodHostUrl {
-        return this.with((url) => ({ pathname: "/billing" }));
+        return this.with((url) => ({ pathname: "/user/billing" }));
     }
 
     asLogin(): GitpodHostUrl {
         return this.with((url) => ({ pathname: "/login" }));
     }
 
-    asUpgradeSubscription(): GitpodHostUrl {
-        return this.with((url) => ({ pathname: "/plans" }));
-    }
-
     asAccessControl(): GitpodHostUrl {
         return this.with((url) => ({ pathname: "/integrations" }));
     }
 
     asSettings(): GitpodHostUrl {
-        return this.with((url) => ({ pathname: "/settings" }));
+        return this.with((url) => ({ pathname: "/user/account" }));
     }
 
     asPreferences(): GitpodHostUrl {
-        return this.with((url) => ({ pathname: "/preferences" }));
+        return this.with((url) => ({ pathname: "/user/preferences" }));
     }
 
     asStart(workspaceId = this.workspaceId): GitpodHostUrl {
@@ -130,35 +127,9 @@ export class GitpodHostUrl {
         });
     }
 
-    asCreateWorkspace(
-        contextUrl: string,
-        o?: {
-            workspaceClass?: string;
-            editor?: string;
-            useLatestEditor?: boolean;
-        },
-    ): GitpodHostUrl {
-        const searchParams: URLSearchParams = new URLSearchParams();
-        if (o?.workspaceClass && o?.workspaceClass.length > 0) {
-            searchParams.append(StartOptions.WORKSPACE_CLASS, o.workspaceClass);
-        }
-        if (o?.editor && o?.editor?.length > 0) {
-            searchParams.append(StartOptions.EDITOR, o.editor);
-        }
-        if (o?.useLatestEditor !== undefined) {
-            searchParams.append(StartOptions.USE_LATEST_EDITOR, o.useLatestEditor.toString());
-        }
-        return this.withoutWorkspacePrefix().with({
-            pathname: "/",
-            search: searchParams.toString(),
-            hash: "#" + contextUrl,
-        });
-    }
-
-    asWorkspaceAuth(instanceID: string, redirect?: boolean): GitpodHostUrl {
+    asWorkspaceAuth(instanceID: string): GitpodHostUrl {
         return this.with((url) => ({
             pathname: `/api/auth/workspace-cookie/${instanceID}`,
-            search: redirect ? "redirect" : "",
         }));
     }
 
@@ -174,6 +145,10 @@ export class GitpodHostUrl {
         return result;
     }
 
+    get debugWorkspace(): boolean {
+        return this.url.host.match(workspaceUrlPrefixRegex)?.[2] === "debug";
+    }
+
     get workspaceId(): string | undefined {
         const hostSegs = this.url.host.split(".");
         if (hostSegs.length > 1) {
@@ -181,7 +156,7 @@ export class GitpodHostUrl {
             if (matchResults) {
                 // URL has a workspace prefix
                 // port prefixes are excluded
-                return matchResults[0];
+                return matchResults[1];
             }
         }
 
@@ -190,6 +165,11 @@ export class GitpodHostUrl {
             return pathSegs[2];
         }
 
+        const cleanHash = this.url.hash.replace(/^#/, "");
+        if (this.url.pathname == "/start/" && cleanHash.match(workspaceIDRegex)) {
+            return cleanHash;
+        }
+
         return undefined;
     }
 

package/src/util/tracing.ts

@@ -186,6 +186,15 @@ export namespace TraceContext {
             context: owi,
         });
     }
+
+    export function finishOnce(span: opentracing.Span): () => void {
+        let done = false;
+        return () => {
+            if (done) return;
+            span.finish();
+            done = true;
+        };
+    }
 }
 
 @injectable()

package/src/workspace-cluster.ts

@@ -19,6 +19,10 @@ export interface WorkspaceCluster {
     // The name can be at most 60 characters.
     applicationCluster: string;
 
+    // The name of the region this cluster belongs to. E.g. us-west1 or europe-west1
+    // The name can be at most 60 characters.
+    region: string;
+
     // URL of the cluster's ws-manager API
     url: string;