@gitpod/gitpod-protocol 0.1.5-pd-gen47-patch-test.0 → 0.1.5-pd-ide-metrics.33

package/src/attribution.ts

@@ -0,0 +1,48 @@
+/**
+ * Copyright (c) 2022 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.
+ */
+
+export type AttributionId = UserAttributionId | TeamAttributionId;
+export type AttributionTarget = "user" | "team";
+
+export interface UserAttributionId {
+    kind: "user";
+    userId: string;
+}
+export interface TeamAttributionId {
+    kind: "team";
+    teamId: string;
+}
+
+export namespace AttributionId {
+    const SEPARATOR = ":";
+
+    export function parse(s: string): UserAttributionId | TeamAttributionId | undefined {
+        if (!s) {
+            return undefined;
+        }
+        const parts = s.split(":");
+        if (parts.length !== 2) {
+            return undefined;
+        }
+        switch (parts[0]) {
+            case "user":
+                return { kind: "user", userId: parts[1] };
+            case "team":
+                return { kind: "team", teamId: parts[1] };
+            default:
+                return undefined;
+        }
+    }
+
+    export function render(id: AttributionId): string {
+        switch (id.kind) {
+            case "user":
+                return `user${SEPARATOR}${id.userId}`;
+            case "team":
+                return `team${SEPARATOR}${id.teamId}`;
+        }
+    }
+}

package/src/blocked-repositories-protocol.ts

@@ -0,0 +1,13 @@
+/**
+ * Copyright (c) 2022 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.
+ */
+
+export interface BlockedRepository {
+    id: number;
+    urlRegexp: string;
+    blockUser: boolean;
+    createdAt: string;
+    updatedAt: string;
+}

package/src/context-url.ts

@@ -38,7 +38,7 @@ export namespace ContextURL {
         try {
             return new URL(normalized);
         } catch (err) {
-            console.error(`unable to parse URL from normalized contextURL: '${normalized}'`, err);
+            console.debug(`unable to parse URL from normalized contextURL: '${normalized}'`);
         }
         return undefined;
     }

package/src/experiments/always-default.ts

@@ -0,0 +1,24 @@
+/**
+ * Copyright (c) 2022 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 { Attributes, Client } from "./types";
+
+// AlwaysReturningDefaultValueClient is an implemention of an experiments.Client which performs no lookup/network operation
+// and always returns the default value for a given experimentName.
+// This client is used for non-SaaS version of Gitpod, in particular for self-hosted installations where external
+// network connections are not desirable or even possible.
+class AlwaysReturningDefaultValueClient implements Client {
+    getValueAsync<T>(experimentName: string, defaultValue: T, attributes: Attributes): Promise<T> {
+        return Promise.resolve(defaultValue);
+    }
+
+    dispose(): void {
+        // there is nothing to dispose, no-op.
+    }
+}
+
+export function newAlwaysReturningDefaultValueClient(): Client {
+    return new AlwaysReturningDefaultValueClient();
+}

package/src/experiments/configcat-server.ts

@@ -0,0 +1,38 @@
+/**
+ * Copyright (c) 2022 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 { Client } from "./types";
+import * as configcat from "configcat-node";
+import { LogLevel } from "configcat-common";
+import { ConfigCatClient } from "./configcat";
+import { newAlwaysReturningDefaultValueClient } from "./always-default";
+
+let client: Client | undefined;
+
+export function getExperimentsClientForBackend(): Client {
+    // We have already instantiated a client, we can just re-use it.
+    if (client !== undefined) {
+        return client;
+    }
+
+    // Retrieve SDK key from ENV Variable
+    const sdkKey = process.env.CONFIGCAT_SDK_KEY;
+
+    // Self-hosted installations do not set the ConfigCat SDK key, so always use a client which returns the default value.
+    if (sdkKey === undefined || sdkKey === "") {
+        client = newAlwaysReturningDefaultValueClient();
+        return client;
+    }
+
+    const configCatClient = configcat.createClient(sdkKey, {
+        pollIntervalSeconds: 3 * 60, // 3 minutes
+        logger: configcat.createConsoleLogger(LogLevel.Error),
+        maxInitWaitTimeSeconds: 0,
+    });
+
+    client = new ConfigCatClient(configCatClient);
+    return client;
+}

package/src/experiments/configcat.ts

@@ -0,0 +1,58 @@
+/**
+ * Copyright (c) 2022 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 { Attributes, Client } from "./types";
+import { User as ConfigCatUser } from "configcat-common/lib/RolloutEvaluator";
+import { IConfigCatClient } from "configcat-common/lib/ConfigCatClient";
+import { User } from "../protocol";
+
+export const USER_ID_ATTRIBUTE = "user_id";
+export const PROJECT_ID_ATTRIBUTE = "project_id";
+export const TEAM_ID_ATTRIBUTE = "team_id";
+export const TEAM_IDS_ATTRIBUTE = "team_ids";
+export const TEAM_NAME_ATTRIBUTE = "team_name";
+export const TEAM_NAMES_ATTRIBUTE = "team_names";
+
+export class ConfigCatClient implements Client {
+    private client: IConfigCatClient;
+
+    constructor(cc: IConfigCatClient) {
+        this.client = cc;
+    }
+
+    getValueAsync<T>(experimentName: string, defaultValue: T, attributes: Attributes): Promise<T> {
+        return this.client.getValueAsync(experimentName, defaultValue, attributesToUser(attributes));
+    }
+
+    dispose(): void {
+        return this.client.dispose();
+    }
+}
+
+export function attributesToUser(attributes: Attributes): ConfigCatUser {
+    const userId = attributes.user?.id || "";
+    const email = User.is(attributes.user) ? User.getPrimaryEmail(attributes.user) : attributes.user?.email || "";
+
+    const custom: { [key: string]: string } = {};
+    if (userId) {
+        custom[USER_ID_ATTRIBUTE] = userId;
+    }
+    if (attributes.projectId) {
+        custom[PROJECT_ID_ATTRIBUTE] = attributes.projectId;
+    }
+    if (attributes.teamId) {
+        custom[TEAM_ID_ATTRIBUTE] = attributes.teamId;
+    }
+    if (attributes.teamName) {
+        custom[TEAM_NAME_ATTRIBUTE] = attributes.teamName;
+    }
+    if (attributes.teams) {
+        custom[TEAM_NAMES_ATTRIBUTE] = attributes.teams.map((t) => t.name).join(",");
+        custom[TEAM_IDS_ATTRIBUTE] = attributes.teams.map((t) => t.id).join(",");
+    }
+
+    return new ConfigCatUser(userId, email, "", custom);
+}

package/src/experiments/types.ts

@@ -0,0 +1,35 @@
+/**
+ * Copyright (c) 2022 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 { User } from "../protocol";
+import { Team } from "../teams-projects-protocol";
+
+export const Client = Symbol("Client");
+
+// Attributes define attributes which can be used to segment audiences.
+// Set the attributes which you want to use to group audiences into.
+export interface Attributes {
+    // user.id is mapped to ConfigCat's "identifier" + "custom.user_id"
+    user?: User | { id: string; email?: string };
+
+    // Currently selected Gitpod Project ID (mapped to "custom.project_id")
+    projectId?: string;
+
+    // Currently selected Gitpod Team ID (mapped to "custom.team_id")
+    teamId?: string;
+    // Currently selected Gitpod Team Name (mapped to "custom.team_name")
+    teamName?: string;
+
+    // All the Gitpod Teams that the user is a member (or owner) of (mapped to "custom.team_names" and "custom.team_ids")
+    teams?: Team[];
+}
+
+export interface Client {
+    getValueAsync<T>(experimentName: string, defaultValue: T, attributes: Attributes): Promise<T>;
+
+    // dispose will dispose of the client, no longer retrieving flags
+    dispose(): void;
+}

package/src/gitpod-service.ts

@@ -24,6 +24,7 @@ import {
     GuessGitTokenScopesParams,
     GuessedGitTokenScopes,
     ProjectEnvVar,
+    PrebuiltWorkspace,
     UserSSHPublicKeyValue,
     SSHPublicKeyValue,
 } from "./protocol";
@@ -36,6 +37,7 @@ import {
     PrebuildWithStatus,
     StartPrebuildResult,
     PartialProject,
+    PrebuildEvent,
 } from "./teams-projects-protocol";
 import { JsonRpcProxy, JsonRpcServer } from "./messaging/proxy-factory";
 import { Disposable, CancellationTokenSource } from "vscode-jsonrpc";
@@ -58,6 +60,9 @@ import {
 import { RemotePageMessage, RemoteTrackMessage, RemoteIdentifyMessage } from "./analytics";
 import { IDEServer } from "./ide-protocol";
 import { InstallationAdminSettings, TelemetryData } from "./installation-admin-protocol";
+import { Currency } from "./plans";
+import { BillableSession, BillableSessionRequest } from "./usage";
+import { SupportedWorkspaceClass } from "./workspace-class";
 
 export interface GitpodClient {
     onInstanceUpdate(instance: WorkspaceInstance): void;
@@ -178,7 +183,10 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     getTeamProjects(teamId: string): Promise<Project[]>;
     getUserProjects(): Promise<Project[]>;
     getProjectOverview(projectId: string): Promise<Project.Overview | undefined>;
+    getPrebuildEvents(projectId: string): Promise<PrebuildEvent[]>;
     findPrebuilds(params: FindPrebuildsParams): Promise<PrebuildWithStatus[]>;
+    findPrebuildByWorkspaceID(workspaceId: string): Promise<PrebuiltWorkspace | undefined>;
+    getPrebuild(prebuildId: string): Promise<PrebuildWithStatus | undefined>;
     triggerPrebuild(projectId: string, branchName: string | null): Promise<StartPrebuildResult>;
     cancelPrebuild(projectId: string, prebuildId: string): Promise<void>;
     fetchProjectRepositoryConfiguration(projectId: string): Promise<string | undefined>;
@@ -278,12 +286,31 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
 
     getGithubUpgradeUrls(): Promise<GithubUpgradeURL[]>;
 
+    getStripePublishableKey(): Promise<string>;
+    getStripeSetupIntentClientSecret(): Promise<string>;
+    findStripeSubscriptionIdForTeam(teamId: string): Promise<string | undefined>;
+    subscribeTeamToStripe(teamId: string, setupIntentId: string, currency: Currency): Promise<void>;
+    getStripePortalUrlForTeam(teamId: string): Promise<string>;
+    getSpendingLimitForTeam(teamId: string): Promise<number | undefined>;
+    setSpendingLimitForTeam(teamId: string, spendingLimit: number): Promise<void>;
+
+    listBilledUsage(req: BillableSessionRequest): Promise<BillableSession[]>;
+
+    setUsageAttribution(usageAttribution: string): Promise<void>;
+
     /**
      * Analytics
      */
     trackEvent(event: RemoteTrackMessage): Promise<void>;
     trackLocation(event: RemotePageMessage): Promise<void>;
     identifyUser(event: RemoteIdentifyMessage): Promise<void>;
+
+    /**
+     * Frontend notifications
+     */
+    getNotifications(): Promise<string[]>;
+
+    getSupportedWorkspaceClasses(): Promise<SupportedWorkspaceClass[]>;
 }
 
 export interface RateLimiterError {
@@ -365,7 +392,7 @@ export const createServerMock = function <C extends GitpodClient, S extends Gitp
         get: (target: S, property: keyof S) => {
             const result = target[property];
             if (!result) {
-                throw new Error(`Method ${property} not implemented`);
+                throw new Error(`Method ${String(property)} not implemented`);
             }
             return result;
         },
@@ -381,6 +408,7 @@ export interface SetWorkspaceTimeoutResult {
 
 export interface GetWorkspaceTimeoutResult {
     duration: WorkspaceTimeoutDuration;
+    durationRaw: string;
     canChange: boolean;
 }
 

package/src/index.ts

@@ -20,3 +20,4 @@ export * from "./teams-projects-protocol";
 export * from "./snapshot-url";
 export * from "./oss-allowlist";
 export * from "./installation-admin-protocol";
+export * from "./webhook-event";

package/src/installation-admin-protocol.ts

@@ -8,6 +8,7 @@ import { v4 as uuidv4 } from "uuid";
 
 const InstallationAdminSettingsPrototype = {
     sendTelemetry: true,
+    sendCustomerID: true,
 };
 
 export type InstallationAdminSettings = typeof InstallationAdminSettingsPrototype;
@@ -28,6 +29,8 @@ export interface TelemetryData {
     totalUsers: number;
     totalWorkspaces: number;
     totalInstances: number;
+    licenseType: string;
+    customerID?: string;
 }
 
 export namespace InstallationAdmin {

package/src/messaging/client-call-metrics.ts

@@ -6,26 +6,7 @@
 
 import { injectable } from "inversify";
 import * as prometheusClient from "prom-client";
-
-type GrpcMethodType = "unary" | "client_stream" | "server_stream" | "bidi_stream";
-export interface IGrpcCallMetricsLabels {
-    service: string;
-    method: string;
-    type: GrpcMethodType;
-}
-
-export interface IGrpcCallMetricsLabelsWithCode extends IGrpcCallMetricsLabels {
-    code: string;
-}
-
-export const IClientCallMetrics = Symbol("IClientCallMetrics");
-
-export interface IClientCallMetrics {
-    started(labels: IGrpcCallMetricsLabels): void;
-    sent(labels: IGrpcCallMetricsLabels): void;
-    received(labels: IGrpcCallMetricsLabels): void;
-    handled(labels: IGrpcCallMetricsLabelsWithCode): void;
-}
+import { IClientCallMetrics, IGrpcCallMetricsLabels, IGrpcCallMetricsLabelsWithCode } from "../util/grpc";
 
 @injectable()
 export class PrometheusClientCallMetrics implements IClientCallMetrics {

package/src/messaging/error.ts

@@ -62,6 +62,9 @@ export namespace ErrorCodes {
     // 490 Too Many Running Workspace
     export const TOO_MANY_RUNNING_WORKSPACES = 490;
 
+    // 500 Internal Server Error
+    export const INTERNAL_SERVER_ERROR = 500;
+
     // 501 EE Feature
     export const EE_FEATURE = 501;
 

package/src/protocol.ts

@@ -45,6 +45,9 @@ export interface User {
     markedDeleted?: boolean;
 
     additionalData?: AdditionalUserData;
+
+    // Identifies an explicit team or user ID to which all the user's workspace usage should be attributed to (e.g. for billing purposes)
+    usageAttributionId?: string;
 }
 
 export namespace User {
@@ -70,11 +73,14 @@ export namespace User {
     }
 
     /**
-     * Tries to return the primaryEmail of the first identity this user signed up with.
+     * Returns the stored email or if it doesn't exist returns the primaryEmail of the first identity this user signed up with.
      * @param user
      * @returns A primaryEmail, or undefined if there is none.
      */
     export function getPrimaryEmail(user: User): string | undefined {
+        if (user.additionalData?.profile?.emailAddress) {
+            return user.additionalData?.profile?.emailAddress;
+        }
         const identities = user.identities.filter((i) => !!i.primaryEmail);
         if (identities.length <= 0) {
             return undefined;
@@ -136,6 +142,50 @@ export namespace User {
         }
         user.additionalData.ideSettings = newIDESettings;
     }
+
+    export function getProfile(user: User): Profile {
+        return {
+            name: User.getName(user!) || "",
+            email: User.getPrimaryEmail(user!) || "",
+            company: user?.additionalData?.profile?.companyName,
+            avatarURL: user?.avatarUrl,
+        };
+    }
+
+    export function setProfile(user: User, profile: Profile): User {
+        user.fullName = profile.name;
+        user.avatarUrl = profile.avatarURL;
+
+        if (!user.additionalData) {
+            user.additionalData = {};
+        }
+        if (!user.additionalData.profile) {
+            user.additionalData.profile = {};
+        }
+        user.additionalData.profile.emailAddress = profile.email;
+        user.additionalData.profile.companyName = profile.company;
+        user.additionalData.profile.lastUpdatedDetailsNudge = new Date().toISOString();
+
+        return user;
+    }
+
+    // The actual Profile of a User
+    export interface Profile {
+        name: string;
+        email: string;
+        company?: string;
+        avatarURL?: string;
+    }
+    export namespace Profile {
+        export function hasChanges(before: Profile, after: Profile) {
+            return (
+                before.name !== after.name ||
+                before.email !== after.email ||
+                before.company !== after.company ||
+                before.avatarURL !== after.avatarURL
+            );
+        }
+    }
 }
 
 export interface AdditionalUserData {
@@ -150,9 +200,22 @@ export interface AdditionalUserData {
     oauthClientsApproved?: { [key: string]: string };
     // to remember GH Orgs the user installed/updated the GH App for
     knownGitHubOrgs?: string[];
-
     // Git clone URL pointing to the user's dotfile repo
     dotfileRepo?: string;
+    // preferred workspace classes
+    workspaceClasses?: WorkspaceClasses;
+    // additional user profile data
+    profile?: ProfileDetails;
+}
+
+// The format in which we store User Profiles in
+export interface ProfileDetails {
+    // when was the last time the user updated their profile information or has been nudged to do so.
+    lastUpdatedDetailsNudge?: string;
+    // the user's company name
+    companyName?: string;
+    // the user's email
+    emailAddress?: string;
 }
 
 export interface EmailNotificationSettings {
@@ -171,6 +234,11 @@ export type IDESettings = {
     useLatestVersion?: boolean;
 };
 
+export interface WorkspaceClasses {
+    regular: string;
+    prebuild: string;
+}
+
 export interface UserPlatform {
     uid: string;
     userAgent: string;
@@ -205,6 +273,7 @@ export const WorkspaceFeatureFlags = {
     full_workspace_backup: undefined,
     fixed_resources: undefined,
     persistent_volume_claim: undefined,
+    protected_secrets: undefined,
 };
 export type NamedWorkspaceFeatureFlag = keyof typeof WorkspaceFeatureFlags;
 
@@ -552,6 +621,7 @@ export interface Snapshot {
 
 export interface VolumeSnapshot {
     id: string;
+    workspaceId: string;
     creationTime: string;
     volumeHandle: string;
 }
@@ -625,7 +695,7 @@ export interface Workspace {
 
 export type WorkspaceSoftDeletion = "user" | "gc";
 
-export type WorkspaceType = "regular" | "prebuild" | "probe";
+export type WorkspaceType = "regular" | "prebuild" | "probe"; // TODO(gpl) Removed prove here
 
 export namespace Workspace {
     export function getFullRepositoryName(ws: Workspace): string | undefined {
@@ -701,6 +771,7 @@ export interface JetBrainsConfig {
 }
 export interface JetBrainsProductConfig {
     prebuilds?: JetBrainsPrebuilds;
+    vmoptions?: string;
 }
 export interface JetBrainsPrebuilds {
     version?: "stable" | "latest" | "both";
@@ -816,7 +887,9 @@ export interface PrebuiltWorkspace {
 
 export namespace PrebuiltWorkspace {
     export function isDone(pws: PrebuiltWorkspace) {
-        return pws.state === "available" || pws.state === "timeout" || pws.state === "aborted";
+        return (
+            pws.state === "available" || pws.state === "timeout" || pws.state === "aborted" || pws.state === "failed"
+        );
     }
 
     export function isAvailable(pws: PrebuiltWorkspace) {
@@ -1409,3 +1482,11 @@ export interface Terms {
     readonly content: string;
     readonly formElements?: object;
 }
+
+export interface CostCenter {
+    readonly id: string;
+    /**
+     * Unit: credits
+     */
+    spendingLimit: number;
+}

package/src/teams-projects-protocol.ts

@@ -7,6 +7,7 @@
 import { PrebuiltWorkspaceState } from "./protocol";
 import { v4 as uuidv4 } from "uuid";
 import { DeepPartial } from "./util/deep-partial";
+import { WebhookEvent } from "./webhook-event";
 
 export interface ProjectConfig {
     ".gitpod.yml": string;
@@ -14,6 +15,8 @@ export interface ProjectConfig {
 
 export interface ProjectSettings {
     useIncrementalPrebuilds?: boolean;
+    usePersistentVolumeClaim?: boolean;
+    keepOutdatedPrebuildsRunning?: boolean;
 }
 
 export interface Project {
@@ -150,3 +153,15 @@ export interface TeamMembershipInvite {
     /** This is a flag that triggers the HARD DELETION of this entity */
     deleted?: boolean;
 }
+
+export interface PrebuildEvent {
+    id: string;
+    creationTime: string;
+    status: WebhookEvent.Status | WebhookEvent.PrebuildStatus;
+    message?: string;
+    prebuildId?: string;
+    projectId?: string;
+    cloneUrl?: string;
+    branch?: string;
+    commit?: string;
+}

package/src/usage.ts

@@ -0,0 +1,50 @@
+/**
+ * Copyright (c) 2022 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 { WorkspaceType } from "./protocol";
+
+export interface BillableSession {
+    // The id of the one paying the bill
+    attributionId: string;
+
+    // Relevant for workspace type. When prebuild, shows "prebuild"
+    userId?: string;
+    teamId?: string;
+
+    instanceId: string;
+
+    workspaceId: string;
+
+    workspaceType: BillableWorkspaceType;
+
+    workspaceClass: string;
+
+    // When the workspace started
+    startTime: string;
+
+    // When the workspace ended. Not set when the workspace is still running.
+    endTime?: string;
+
+    // The credits used for this session
+    credits: number;
+
+    // TODO - maybe
+    projectId?: string;
+}
+
+export interface BillableSessionRequest {
+    attributionId: string;
+    startedTimeOrder: SortOrder;
+    from?: number;
+    to?: number;
+}
+
+export type BillableWorkspaceType = WorkspaceType;
+
+export enum SortOrder {
+    Descending = 0,
+    Ascending = 1,
+}