@gitpod/gitpod-protocol 0.1.5-release-2022.6.1.0 → 0.1.5-release-2022.6.1.1

package/src/protocol.spec.ts

@@ -0,0 +1,97 @@
+/**
+ * Copyright (c) 2020 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 { suite, test } from "mocha-typescript";
+import * as chai from "chai";
+import { SSHPublicKeyValue } from ".";
+
+const expect = chai.expect;
+
+@suite
+class TestSSHPublicKeyValue {
+    private key =
+        "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDCnrN9UdK1bNGPmZfenTWXLuYYDjlYvZE8S+WOfP08WpR1GETzX5ZvgYOEZGwEE8KUPHC9cge4Hvo/ydIS9aqbZ5MiVGJ8cAIq1Ic89SjlDWU6fl8TwIqOPCi2imAASlEDP4q8vMLK1N6UOW1EVbxyL3uybGd10ysC1t1FxFPveIGNsYE/MOQeuEWS16AplpXYXIfVRSlgAskeBft2w8Ud3B4gNe8ECLA/FXu96UpvZkdtOarA3JZ9Z27GveNJg9Mtmmw0+US0KXiO9x9NyH7G8+mqVDwDY+nNvaFA5gtQxkkl/uY2oz9k/B4Rjlj3jOiUXe5uQs3XUm5m8g9a9fh62DabLpA2fEvtfg+a/VqNe52dNa5YjupwvBd6Inb5uMW/TYjNl6bNHPlXFKw/nwLOVzukpkjxMZUKS6+4BGkpoasj6y2rTU/wkpbdD8J7yjI1p6J9aKkC6KksIWgN7xGmHkv2PCGDqMHTNbnQyowtNKMgA/667vAYJ0qW7HAHBFXJRs6uRi/DI3+c1QV2s4wPCpEHDIYApovQ0fbON4WDPoGMyHd7kPh9xB/bX7Dj0uMXImu1pdTd62fQ/1XXX64+vjAAXS/P9RSCD0RCRt/K3LPKl2m7GPI3y1niaE52XhxZw+ms9ays6NasNVMw/ZC+f02Ti+L5FBEVf8230RVVRQ== notfound@gitpod.io";
+
+    @test public testValidate() {
+        const key = this.key;
+        const [t, k, e] = key.split(" ");
+        expect(
+            SSHPublicKeyValue.getData({
+                key,
+                name: "NiceName",
+            }),
+        ).to.deep.equal({ type: t, key: k, email: e });
+    }
+
+    @test public testValidateWithDiffType() {
+        const key = this.key;
+        const [_, k, e] = key.split(" ");
+        expect(
+            SSHPublicKeyValue.getData({
+                key: key.replace("ssh-rsa", "sk-ecdsa-sha2-nistp256@openssh.com"),
+                name: "NiceName",
+            }),
+        ).to.deep.equal({ type: "sk-ecdsa-sha2-nistp256@openssh.com", key: k, email: e });
+    }
+
+    @test public testValidateWithoutEmail() {
+        const key = this.key;
+        const [t, k, _] = key.split(" ");
+        expect(
+            SSHPublicKeyValue.getData({
+                key: key.replace(" notfound@gitpod.io", ""),
+                name: "NiceName",
+            }),
+        ).to.deep.equal({ type: t, key: k, email: undefined });
+    }
+
+    @test public testValidateWithoutEmailButEndsWithSpaces() {
+        const key = this.key;
+        const [t, k, _] = key.split(" ");
+        expect(
+            SSHPublicKeyValue.getData({
+                key: key.replace("notfound@gitpod.io", "  "),
+                name: "NiceName",
+            }),
+        ).to.deep.equal({ type: t, key: k, email: undefined });
+    }
+
+    @test public testValidateWithError() {
+        expect(() =>
+            SSHPublicKeyValue.getData({
+                key: "Hello World",
+                name: "NiceName",
+            }),
+        ).throw("Key is invalid");
+
+        expect(() =>
+            SSHPublicKeyValue.getData({
+                key: "",
+                name: "NiceName",
+            }),
+        ).throw("Key is invalid");
+    }
+
+    @test public testGetFingerprint() {
+        const key = this.key;
+        expect(
+            SSHPublicKeyValue.getFingerprint({
+                key,
+                name: "NiceName",
+            }),
+        ).to.equal("ykjP/b5aqoa3envmXzWpPMCGgEFMu3QvubfSTNrJCMA=");
+    }
+
+    @test public testGetFingerprintWithIncorrectPublicKey() {
+        expect(() =>
+            SSHPublicKeyValue.getFingerprint({
+                key: "Hello World",
+                name: "NiceName",
+            }),
+        ).to.throw("Key is invalid");
+    }
+}
+module.exports = new TestSSHPublicKeyValue(); // Only to circumvent no usage warning :-/

package/src/protocol.ts

@@ -70,11 +70,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 +139,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 +197,24 @@ 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;
+    // 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;
+    // 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 +233,11 @@ export type IDESettings = {
     useLatestVersion?: boolean;
 };
 
+export interface WorkspaceClasses {
+    regular: string;
+    prebuild: string;
+}
+
 export interface UserPlatform {
     uid: string;
     userAgent: string;
@@ -205,6 +272,7 @@ export const WorkspaceFeatureFlags = {
     full_workspace_backup: undefined,
     fixed_resources: undefined,
     persistent_volume_claim: undefined,
+    protected_secrets: undefined,
 };
 export type NamedWorkspaceFeatureFlag = keyof typeof WorkspaceFeatureFlags;
 
@@ -356,6 +424,68 @@ export namespace UserEnvVar {
     }
 }
 
+export interface SSHPublicKeyValue {
+    name: string;
+    key: string;
+}
+export interface UserSSHPublicKey extends SSHPublicKeyValue {
+    id: string;
+    key: string;
+    userId: string;
+    fingerprint: string;
+    creationTime: string;
+    lastUsedTime?: string;
+}
+
+export type UserSSHPublicKeyValue = Omit<UserSSHPublicKey, "key" | "userId">;
+
+export namespace SSHPublicKeyValue {
+    export function validate(value: SSHPublicKeyValue): string | undefined {
+        if (value.name.length === 0) {
+            return "Title must not be empty.";
+        }
+        if (value.name.length > 255) {
+            return "Title too long. Maximum value length is 255 characters.";
+        }
+        if (value.key.length === 0) {
+            return "Key must not be empty.";
+        }
+        try {
+            getData(value);
+        } catch (e) {
+            return "Key is invalid. You must supply a key in OpenSSH public key format.";
+        }
+        return;
+    }
+
+    export function getData(value: SSHPublicKeyValue) {
+        // Begins with 'ssh-rsa', 'ecdsa-sha2-nistp256', 'ecdsa-sha2-nistp384', 'ecdsa-sha2-nistp521', 'ssh-ed25519', 'sk-ecdsa-sha2-nistp256@openssh.com', or 'sk-ssh-ed25519@openssh.com'.
+        const regex =
+            /^(?<type>ssh-rsa|ecdsa-sha2-nistp256|ecdsa-sha2-nistp384|ecdsa-sha2-nistp521|ssh-ed25519|sk-ecdsa-sha2-nistp256@openssh\.com|sk-ssh-ed25519@openssh\.com) (?<key>.*?)( (?<email>.*?))?$/;
+        const resultGroup = regex.exec(value.key.trim());
+        if (!resultGroup) {
+            throw new Error("Key is invalid.");
+        }
+        return {
+            type: resultGroup.groups?.["type"] as string,
+            key: resultGroup.groups?.["key"] as string,
+            email: resultGroup.groups?.["email"] || undefined,
+        };
+    }
+
+    export function getFingerprint(value: SSHPublicKeyValue) {
+        const data = getData(value);
+        let buf = Buffer.from(data.key, "base64");
+        // gitlab style
+        // const hash = createHash("md5").update(buf).digest("hex");
+        // github style
+        const hash = createHash("sha256").update(buf).digest("base64");
+        return hash;
+    }
+
+    export const MAXIMUM_KEY_LENGTH = 5;
+}
+
 export interface GitpodToken {
     /** Hash value (SHA256) of the token (primary key). */
     tokenHash: string;
@@ -564,7 +694,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 {

package/src/teams-projects-protocol.ts

@@ -15,6 +15,7 @@ export interface ProjectConfig {
 export interface ProjectSettings {
     useIncrementalPrebuilds?: boolean;
     usePersistentVolumeClaim?: boolean;
+    keepOutdatedPrebuildsRunning?: boolean;
 }
 
 export interface Project {

package/src/usage.ts

@@ -0,0 +1,146 @@
+/**
+ * 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;
+
+    // "standard" or "XL"
+    workspaceClass: string;
+
+    // When the workspace started
+    startTime: string;
+
+    // When the workspace ended
+    endTime: string;
+
+    // The credits used for this session
+    credits: number;
+
+    // TODO - maybe
+    projectId?: string;
+}
+
+export type BillableWorkspaceType = WorkspaceType;
+
+export const billableSessionDummyData: BillableSession[] = [
+    {
+        attributionId: "some-attribution-id",
+        userId: "prebuild",
+        teamId: "prebuild",
+        instanceId: "some-instance-id",
+        workspaceId: "some-workspace-id",
+        workspaceType: "prebuild",
+        workspaceClass: "XL",
+        startTime: new Date(Date.now() + -3 * 24 * 3600 * 1000).toISOString(), // 3 days ago
+        endTime: new Date().toISOString(),
+        credits: 320,
+        projectId: "project-123",
+    },
+    {
+        attributionId: "some-attribution-id2",
+        userId: "some-user",
+        teamId: "some-team",
+        instanceId: "some-instance-id2",
+        workspaceId: "some-workspace-id2",
+        workspaceType: "regular",
+        workspaceClass: "standard",
+        startTime: new Date(Date.now() + -5 * 24 * 3600 * 1000).toISOString(),
+        endTime: new Date().toISOString(),
+        credits: 130,
+        projectId: "project-123",
+    },
+    {
+        attributionId: "some-attribution-id3",
+        userId: "some-other-user",
+        teamId: "some-other-team",
+        instanceId: "some-instance-id3",
+        workspaceId: "some-workspace-id3",
+        workspaceType: "regular",
+        workspaceClass: "XL",
+        startTime: new Date(Date.now() + -5 * 24 * 3600 * 1000).toISOString(),
+        endTime: new Date(Date.now() + -4 * 24 * 3600 * 1000).toISOString(),
+        credits: 150,
+        projectId: "project-134",
+    },
+    {
+        attributionId: "some-attribution-id4",
+        userId: "some-other-user2",
+        teamId: "some-other-team2",
+        instanceId: "some-instance-id4",
+        workspaceId: "some-workspace-id4",
+        workspaceType: "regular",
+        workspaceClass: "standard",
+        startTime: new Date(Date.now() + -10 * 24 * 3600 * 1000).toISOString(),
+        endTime: new Date(Date.now() + -9 * 24 * 3600 * 1000).toISOString(),
+        credits: 330,
+        projectId: "project-137",
+    },
+    {
+        attributionId: "some-attribution-id5",
+        userId: "some-other-user3",
+        teamId: "some-other-team3",
+        instanceId: "some-instance-id5",
+        workspaceId: "some-workspace-id5",
+        workspaceType: "regular",
+        workspaceClass: "XL",
+        startTime: new Date(Date.now() + -2 * 24 * 3600 * 1000).toISOString(),
+        endTime: new Date().toISOString(),
+        credits: 222,
+        projectId: "project-138",
+    },
+    {
+        attributionId: "some-attribution-id6",
+        userId: "some-other-user4",
+        teamId: "some-other-team4",
+        instanceId: "some-instance-id6",
+        workspaceId: "some-workspace-id3",
+        workspaceType: "regular",
+        workspaceClass: "XL",
+        startTime: new Date(Date.now() + -7 * 24 * 3600 * 1000).toISOString(),
+        endTime: new Date(Date.now() + -6 * 24 * 3600 * 1000).toISOString(),
+        credits: 300,
+        projectId: "project-134",
+    },
+    {
+        attributionId: "some-attribution-id8",
+        userId: "some-other-user5",
+        teamId: "some-other-team5",
+        instanceId: "some-instance-id8",
+        workspaceId: "some-workspace-id3",
+        workspaceType: "regular",
+        workspaceClass: "standard",
+        startTime: new Date(Date.now() + -1 * 24 * 3600 * 1000).toISOString(),
+        endTime: new Date().toISOString(),
+        credits: 100,
+        projectId: "project-567",
+    },
+    {
+        attributionId: "some-attribution-id7",
+        userId: "prebuild",
+        teamId: "some-other-team7",
+        instanceId: "some-instance-id7",
+        workspaceId: "some-workspace-id7",
+        workspaceType: "prebuild",
+        workspaceClass: "XL",
+        startTime: new Date(Date.now() + -1 * 24 * 3600 * 1000).toISOString(),
+        endTime: new Date().toISOString(),
+        credits: 200,
+        projectId: "project-345",
+    },
+];

package/src/util/logging.ts

@@ -6,6 +6,7 @@
 
 const inspect: (object: any) => string = require("util").inspect; // undefined in frontend
 
+let plainLogging: boolean = false; // set to true during development to get non JSON output
 let jsonLogging: boolean = false;
 let component: string | undefined;
 let version: string | undefined;
@@ -309,7 +310,7 @@ function makeLogItem(
     }
 
     const payload: any = payloadArgs.length == 0 ? undefined : payloadArgs.length == 1 ? payloadArgs[0] : payloadArgs;
-    const logItem: any = {
+    const logItem = {
         // undefined fields get eliminated in JSON.stringify()
         ...reportedErrorEvent,
         component,
@@ -321,11 +322,19 @@ function makeLogItem(
         payload,
         loggedViaConsole: calledViaConsole ? true : undefined,
     };
+    if (plainLogging) {
+        return `[${logItem.severity}] [${logItem.component}] ${logItem.message}
+            ${JSON.stringify(payload || "", undefined, "              ")}
+            ${error || ""}
+        `.trim();
+    }
     let result: string = stringifyLogItem(logItem);
 
     if (result.length > maxAllowedLogItemLength && payload !== undefined) {
         delete logItem.payload;
-        logItem.payloadStub = `Payload stripped as log item was longer than ${maxAllowedLogItemLength} characters`;
+        (<any>(
+            logItem
+        )).payloadStub = `Payload stripped as log item was longer than ${maxAllowedLogItemLength} characters`;
 
         result = stringifyLogItem(logItem);
 

package/src/webhook-event.ts

@@ -0,0 +1,55 @@
+/**
+ * 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 WebhookEvent {
+    id: string;
+    creationTime: string;
+    type: "push" | string;
+
+    /**
+     * Typically the webhook installer is referenced here.
+     */
+    authorizedUserId?: string;
+
+    /**
+     * webhook event's payload
+     */
+    rawEvent: string;
+
+    /**
+     * The general status of the received webhook event.
+     */
+    status: WebhookEvent.Status;
+
+    /**
+     * Optional message to help understand errors with handling events.
+     */
+    message?: string;
+
+    /**
+     * If the webhook event is considered to trigger a prebuild, the `prebuildStatus`
+     * contains a more specific status.
+     */
+    prebuildStatus?: WebhookEvent.PrebuildStatus;
+
+    /**
+     * If `prebuildStatus` is `prebuild_triggered` this points to a prebuild.
+     */
+    prebuildId?: string;
+
+    projectId?: string;
+
+    cloneUrl?: string;
+
+    branch?: string;
+
+    commit?: string;
+}
+
+export namespace WebhookEvent {
+    export type Status = "received" | "dismissed_unauthorized" | "ignored" | "processed";
+    export type PrebuildStatus = "ignored_unconfigured" | "prebuild_trigger_failed" | "prebuild_triggered";
+}

package/src/workspace-cluster.ts

@@ -56,12 +56,10 @@ export type WorkspaceManagerConnectionInfo = Pick<WorkspaceCluster, "name" | "ur
 export type AdmissionConstraint =
     | AdmissionConstraintFeaturePreview
     | AdmissionConstraintHasPermission
-    | AdmissionConstraintHasUserLevel
-    | AdmissionConstraintHasMoreResources;
+    | AdmissionConstraintHasClass;
 export type AdmissionConstraintFeaturePreview = { type: "has-feature-preview" };
 export type AdmissionConstraintHasPermission = { type: "has-permission"; permission: PermissionName };
-export type AdmissionConstraintHasUserLevel = { type: "has-user-level"; level: string };
-export type AdmissionConstraintHasMoreResources = { type: "has-more-resources" };
+export type AdmissionConstraintHasClass = { type: "has-class"; id: string; displayName: string };
 
 export namespace AdmissionConstraint {
     export function is(o: any): o is AdmissionConstraint {

package/src/workspace-instance.ts

@@ -72,6 +72,11 @@ export interface WorkspaceInstance {
 
 // WorkspaceInstanceStatus describes the current state of a workspace instance
 export interface WorkspaceInstanceStatus {
+    // version is the current version of the workspace instance status
+    // Note: consider this value opague. The only guarantee given is that it imposes
+    //       a partial order on status updates, i.e. a.version > b.version -> a newer than b.
+    version?: number;
+
     // phase describes a high-level state of the workspace instance
     phase: WorkspaceInstancePhase;