@gitpod/gitpod-protocol 0.1.5-vn-6525.77 → 0.1.5-vn-fix-undefined-context-ref-on-jb-gateway.1

package/src/gitpod-service.ts

@@ -47,7 +47,12 @@ import { LicenseService } from "./license-protocol";
 import { Emitter } from "./util/event";
 import { AccountStatement, CreditAlert } from "./accounting-protocol";
 import { GithubUpgradeURL, PlanCoupon } from "./payment-protocol";
-import { TeamSubscription, TeamSubscriptionSlot, TeamSubscriptionSlotResolved } from "./team-subscription-protocol";
+import {
+    TeamSubscription,
+    TeamSubscription2,
+    TeamSubscriptionSlot,
+    TeamSubscriptionSlotResolved,
+} from "./team-subscription-protocol";
 import { RemotePageMessage, RemoteTrackMessage, RemoteIdentifyMessage } from "./analytics";
 import { IDEServer } from "./ide-protocol";
 import { InstallationAdminSettings, TelemetryData } from "./installation-admin-protocol";
@@ -189,6 +194,7 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
 
     // misc
     sendFeedback(feedback: string): Promise<string | undefined>;
+    isGitHubAppEnabled(): Promise<boolean>;
     registerGithubApp(installationId: string): Promise<void>;
 
     /**
@@ -234,7 +240,9 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
      */
     getChargebeeSiteId(): Promise<string>;
     createPortalSession(): Promise<{}>;
+    createTeamPortalSession(teamId: string): Promise<{}>;
     checkout(planId: string, planQuantity?: number): Promise<{}>;
+    teamCheckout(teamId: string, planId: string): Promise<{}>;
     getAvailableCoupons(): Promise<PlanCoupon[]>;
     getAppliedCoupons(): Promise<PlanCoupon[]>;
 
@@ -246,6 +254,7 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     subscriptionCancel(subscriptionId: string): Promise<void>;
     subscriptionCancelDowngrade(subscriptionId: string): Promise<void>;
 
+    getTeamSubscription(teamId: string): Promise<TeamSubscription2 | undefined>;
     tsGet(): Promise<TeamSubscription[]>;
     tsGetSlots(): Promise<TeamSubscriptionSlotResolved[]>;
     tsGetUnassignedSlot(teamSubscriptionId: string): Promise<TeamSubscriptionSlot | undefined>;
@@ -529,13 +538,14 @@ const hasWindow = typeof window !== "undefined";
 const phasesOrder: Record<WorkspaceInstancePhase, number> = {
     unknown: 0,
     preparing: 1,
-    pending: 2,
-    creating: 3,
-    initializing: 4,
-    running: 5,
-    interrupted: 6,
-    stopping: 7,
-    stopped: 8,
+    building: 2,
+    pending: 3,
+    creating: 4,
+    initializing: 5,
+    running: 6,
+    interrupted: 7,
+    stopping: 8,
+    stopped: 9,
 };
 export class WorkspaceInstanceUpdateListener {
     private readonly onDidChangeEmitter = new Emitter<void>();

package/src/license-protocol.ts

@@ -15,9 +15,15 @@ export type LicenseIssue = "seats-exhausted";
 export interface LicenseInfo {
     key: string;
     seats: number;
+    userCount?: number;
     valid: boolean;
     validUntil: string;
     plan?: string;
+    features?: string[];
+    enabledFeatures?: string[];
+    type?: string;
+    errorMsg?: string;
+    fallbackAllowed: boolean;
 }
 
 export interface GetLicenseInfoResult {
@@ -33,5 +39,6 @@ export enum LicenseFeature {
 export interface LicenseService {
     validateLicense(): Promise<LicenseValidationResult>;
     getLicenseInfo(): Promise<GetLicenseInfoResult>;
+    adminGetLicense(): Promise<LicenseInfo>;
     licenseIncludesFeature(feature: LicenseFeature): Promise<boolean>;
 }

package/src/messaging/error.ts

@@ -5,6 +5,9 @@
  */
 
 export namespace ErrorCodes {
+    // 400 Unauthorized
+    export const BAD_REQUEST = 400;
+
     // 401 Unauthorized
     export const NOT_AUTHENTICATED = 401;
 

package/src/protocol.ts

@@ -68,13 +68,19 @@ export namespace User {
         });
         return res;
     }
-    export function getPrimaryEmail(user: User): string {
+
+    /**
+     * Tries to return 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 {
         const identities = user.identities.filter((i) => !!i.primaryEmail);
         if (identities.length <= 0) {
-            throw new Error(`No identity with primary email for user: ${user.id}!`);
+            return undefined;
         }
 
-        return identities[0].primaryEmail!;
+        return identities[0].primaryEmail || undefined;
     }
     export function getName(user: User): string | undefined {
         const name = user.fullName || user.name;
@@ -89,6 +95,47 @@ export namespace User {
         }
         return undefined;
     }
+
+    export function hasPreferredIde(user: User) {
+        return (
+            typeof user?.additionalData?.ideSettings?.defaultIde !== "undefined" ||
+            typeof user?.additionalData?.ideSettings?.useLatestVersion !== "undefined"
+        );
+    }
+
+    export function isOnboardingUser(user: User) {
+        return !hasPreferredIde(user);
+    }
+
+    export function migrationIDESettings(user: User) {
+        if (
+            !user?.additionalData?.ideSettings ||
+            Object.keys(user.additionalData.ideSettings).length === 0 ||
+            user.additionalData.ideSettings.settingVersion === "2.0"
+        ) {
+            return;
+        }
+        const newIDESettings: IDESettings = {
+            settingVersion: "2.0",
+        };
+        const ideSettings = user.additionalData.ideSettings;
+        if (ideSettings.useDesktopIde) {
+            if (ideSettings.defaultDesktopIde === "code-desktop") {
+                newIDESettings.defaultIde = "code-desktop";
+            } else if (ideSettings.defaultDesktopIde === "code-desktop-insiders") {
+                newIDESettings.defaultIde = "code-desktop";
+                newIDESettings.useLatestVersion = true;
+            } else {
+                newIDESettings.defaultIde = ideSettings.defaultDesktopIde;
+                newIDESettings.useLatestVersion = ideSettings.useLatestVersion;
+            }
+        } else {
+            const useLatest = ideSettings.defaultIde === "code-latest";
+            newIDESettings.defaultIde = "code";
+            newIDESettings.useLatestVersion = useLatest;
+        }
+        user.additionalData.ideSettings = newIDESettings;
+    }
 }
 
 export interface AdditionalUserData {
@@ -115,8 +162,11 @@ export interface EmailNotificationSettings {
 }
 
 export type IDESettings = {
+    settingVersion?: string;
     defaultIde?: string;
+    // DEPRECATED: Use defaultIde after `settingVersion: 2.0`, no more specialify desktop or browser.
     useDesktopIde?: boolean;
+    // DEPRECATED: Same with useDesktopIde.
     defaultDesktopIde?: string;
     useLatestVersion?: boolean;
 };
@@ -182,6 +232,45 @@ export interface UserEnvVar extends UserEnvVarValue {
 }
 
 export namespace UserEnvVar {
+    /**
+     * @param variable
+     * @returns Either a string containing an error message or undefined.
+     */
+    export function validate(variable: UserEnvVarValue): string | undefined {
+        const name = variable.name;
+        const pattern = variable.repositoryPattern;
+        if (name.trim() === "") {
+            return "Name must not be empty.";
+        }
+        if (name.length > 255) {
+            return "Name too long. Maximum name length is 255 characters.";
+        }
+        if (!/^[a-zA-Z_]+[a-zA-Z0-9_]*$/.test(name)) {
+            return "Name must match /^[a-zA-Z_]+[a-zA-Z0-9_]*$/.";
+        }
+        if (variable.value.trim() === "") {
+            return "Value must not be empty.";
+        }
+        if (variable.value.length > 32767) {
+            return "Value too long. Maximum value length is 32767 characters.";
+        }
+        if (pattern.trim() === "") {
+            return "Scope must not be empty.";
+        }
+        const split = pattern.split("/");
+        if (split.length < 2) {
+            return "A scope must use the form 'organization/repo'.";
+        }
+        for (const name of split) {
+            if (name !== "*") {
+                if (!/^[a-zA-Z0-9_\-.\*]+$/.test(name)) {
+                    return "Invalid scope segment. Only ASCII characters, numbers, -, _, . or * are allowed.";
+                }
+            }
+        }
+        return undefined;
+    }
+
     // DEPRECATED: Use ProjectEnvVar instead of repositoryPattern - https://github.com/gitpod-com/gitpod/issues/5322
     export function normalizeRepoPattern(pattern: string) {
         return pattern.toLocaleLowerCase();
@@ -399,6 +488,12 @@ export interface Snapshot {
     message?: string;
 }
 
+export interface VolumeSnapshot {
+    id: string;
+    creationTime: string;
+    volumeHandle: string;
+}
+
 export type SnapshotState = "pending" | "available" | "error";
 
 export interface LayoutData {
@@ -536,6 +631,19 @@ export interface VSCodeConfig {
     extensions?: string[];
 }
 
+export interface JetBrainsConfig {
+    intellij?: JetBrainsProductConfig;
+    goland?: JetBrainsProductConfig;
+    pycharm?: JetBrainsProductConfig;
+    phpstorm?: JetBrainsProductConfig;
+}
+export interface JetBrainsProductConfig {
+    prebuilds?: JetBrainsPrebuilds;
+}
+export interface JetBrainsPrebuilds {
+    version?: "stable" | "latest" | "both";
+}
+
 export interface RepositoryCloneInformation {
     url: string;
     checkoutLocation?: string;
@@ -552,6 +660,7 @@ export interface WorkspaceConfig {
     gitConfig?: { [config: string]: string };
     github?: GithubAppConfig;
     vscode?: VSCodeConfig;
+    jetbrains?: JetBrainsConfig;
 
     /** deprecated. Enabled by default **/
     experimentalNetwork?: boolean;
@@ -769,6 +878,7 @@ export namespace ExternalImageConfigFile {
 
 export interface WorkspaceContext {
     title: string;
+    ref?: string;
     /** This contains the URL portion of the contextURL (which might contain other modifiers as well). It's optional because it's not set for older workspaces. */
     normalizedContextURL?: string;
     forceCreateNewWorkspace?: boolean;
@@ -1150,12 +1260,6 @@ export interface AuthProviderInfo {
     };
 }
 
-export namespace AuthProviderInfo {
-    export function isGitHubEnterprise(info?: AuthProviderInfo): boolean {
-        return !!info && info.authProviderType === "GitHub" && info.host !== "github.com";
-    }
-}
-
 export interface AuthProviderEntry {
     readonly id: string;
     readonly type: AuthProviderEntry.Type;

package/src/team-subscription-protocol.ts

@@ -33,6 +33,29 @@ export namespace TeamSubscription {
     };
 }
 
+export interface TeamSubscription2 {
+    id: string;
+    teamId: string;
+    planId: string;
+    startDate: string;
+    endDate?: string;
+    quantity: number;
+    /** The Chargebee subscription id */
+    paymentReference: string;
+    cancellationDate?: string;
+}
+
+export namespace TeamSubscription2 {
+    export const create = (ts2: Omit<TeamSubscription2, "id">): TeamSubscription2 => {
+        const withId = ts2 as TeamSubscription2;
+        withId.id = uuidv4();
+        return withId;
+    };
+    export const isActive = (ts2: TeamSubscription2, date: string): boolean => {
+        return ts2.startDate <= date && (ts2.endDate === undefined || date < ts2.endDate);
+    };
+}
+
 /**
  * A slot represents one unit of a TeamSubscription that gets assigned to one user at a time
  */

package/src/teams-projects-protocol.ts

@@ -69,6 +69,11 @@ export namespace Project {
 
 export type PartialProject = DeepPartial<Project> & Pick<Project, "id">;
 
+export interface ProjectUsage {
+    lastWebhookReceived: string;
+    lastWorkspaceStart: string;
+}
+
 export interface PrebuildWithStatus {
     info: PrebuildInfo;
     status: PrebuiltWorkspaceState;

package/src/util/generate-workspace-id.spec.ts

@@ -14,7 +14,7 @@ const expect = chai.expect;
 @suite
 class TestGenerateWorkspaceId {
     @test public async testGenerateWorkspaceId() {
-        for (let i = 0; i < 100; i++) {
+        for (let i = 0; i < 10; i++) {
             const id = await generateWorkspaceID();
             expect(new GitpodHostUrl().withWorkspacePrefix(id, "eu").workspaceId).to.equal(id);
         }
@@ -32,13 +32,20 @@ class TestGenerateWorkspaceId {
             ["foo", "bar", "foo-bar-"],
             ["f", "bar", ".{2,16}-bar-"],
             ["gitpod-io", "gitpod", "gitpodio-gitpod-"],
+            ["breatheco-de", "python-flask-api-tutorial", "breathecode-pythonflask-"],
+            ["short", "muchlongerthaneleven", "short-muchlongerthanel-"],
+            ["muchlongerthaneleven", "short", "muchlongerthanel-short-"],
             [
                 'this is rather long and has some "§$"% special chars',
                 "also here pretty long and needs abbreviation",
-                "thisisratherlon-alsohere-",
+                "thisisrathe-alsoherepre-",
             ],
-            ["breatheco-de", "python-flask-api-tutorial", "breathecode-pythonflaska-"],
             ["UPPER", "CaSe", "upper-case-"],
+            [
+                "superlongfirstsegment",
+                "---------",
+                "superlong" /* we don't mantch for the whole first segment, because it has different length depending on the animal that is used to replace the -------*/,
+            ],
         ];
         for (const d of data) {
             const id = await generateWorkspaceID(d[0], d[1]);

package/src/util/generate-workspace-id.ts

@@ -3,15 +3,19 @@
  * Licensed under the GNU Affero General Public License (AGPL).
  * See License-AGPL.txt in the project root for license information.
  */
+
 import randomNumber = require("random-number-csprng");
 
 export async function generateWorkspaceID(firstSegment?: string, secondSegment?: string): Promise<string> {
     const firstSeg = clean(firstSegment) || (await random(colors));
-    const secSeg = clean(secondSegment, Math.min(15, 23 - firstSeg.length)) || (await random(animals));
-    return firstSeg + "-" + secSeg + "-" + (await random(characters, 11));
+    const secSeg = clean(secondSegment) || (await random(animals));
+    function fit(makeFit: string, otherSeg: string) {
+        return makeFit.substring(0, Math.max(segLength, 2 * segLength - otherSeg.length));
+    }
+    return fit(firstSeg, secSeg) + "-" + fit(secSeg, firstSeg) + "-" + (await random(characters, segLength));
 }
 
-function clean(segment: string | undefined, maxChars: number = 15) {
+function clean(segment: string | undefined, maxChars: number = 16) {
     if (!segment) {
         return undefined;
     }
@@ -35,6 +39,8 @@ async function random(array: string[], length: number = 1): Promise<string> {
     return result;
 }
 
+const segLength = 11;
+
 const characters = "abcdefghijklmnopqrstuvwxyz0123456789".split("");
 
 export const colors = [

package/src/util/logging.ts

@@ -315,7 +315,6 @@ function makeLogItem(
         component,
         severity,
         time: new Date().toISOString(),
-        environment: process.env.KUBE_STAGE,
         context,
         message,
         error,

package/src/util/tracing.ts

@@ -22,17 +22,15 @@ export type TraceContextWithSpan = TraceContext & {
 export namespace TraceContext {
     export function startSpan(operation: string, parentCtx?: TraceContext): opentracing.Span {
         const options: opentracing.SpanOptions = {};
-        if (parentCtx && parentCtx.span && !!parentCtx.span.context().toSpanId()) {
-            options.childOf = parentCtx.span;
+
+        // references should contain span id.
+        // cf. https://github.com/jaegertracing/jaeger-client-node/issues/432
+        if (!!parentCtx?.span) {
+            const ctx = parentCtx?.span?.context();
+            if (ctx && !!ctx.toTraceId() && !!ctx.toSpanId()) {
+                options.references = [opentracing.followsFrom(ctx)];
+            }
         }
-        // TODO(gpl) references lead to a huge amount of errors in prod logs. Avoid those until we have time to figure out how to fix it.
-        // if (referencedSpans) {
-        //     // note: allthough followsForm's type says it takes 'opentracing.Span | opentracing.SpanContext', it only works with SpanContext (typing mismatch)
-        //     // note2: we need to filter out debug spans (spanId === "")
-        //     options.references = referencedSpans.filter(s => s !== undefined)
-        //         .filter(s => !!s!.context().toSpanId())
-        //         .map(s => followsFrom(s!.context()));
-        // }
 
         return opentracing.globalTracer().startSpan(operation, options);
     }

package/src/workspace-instance.ts

@@ -98,9 +98,13 @@ export type WorkspaceInstancePhase =
     | "unknown"
 
     // Preparing means that we haven't actually started the workspace instance just yet, but rather
-    // are still preparing for launch. This means we're building the Docker image for the workspace.
+    // are still preparing for launch.
     | "preparing"
 
+    // Building means that we are building the Docker image for the workspace. A workspace will enter this phase only
+    // if an image build is required for that workspace.
+    | "building"
+
     // Pending means the workspace does not yet consume resources in the cluster, but rather is looking for
     // some space within the cluster. If for example the cluster needs to scale up to accomodate the
     // workspace, the workspace will be in Pending state until that happened.
@@ -204,6 +208,12 @@ export interface WorkspaceInstanceRepoStatus {
     totalUnpushedCommits?: number;
 }
 
+// ConfigurationIdeConfig ide config of WorkspaceInstanceConfiguration
+export interface ConfigurationIdeConfig {
+    useLatest?: boolean;
+    desktopIdeAlias?: string;
+}
+
 // WorkspaceInstanceConfiguration contains all per-instance configuration
 export interface WorkspaceInstanceConfiguration {
     // theiaVersion is the version of Theia this workspace instance uses
@@ -221,6 +231,8 @@ export interface WorkspaceInstanceConfiguration {
 
     // supervisorImage is the ref of the supervisor image this instance uses.
     supervisorImage?: string;
+
+    ideConfig?: ConfigurationIdeConfig;
 }
 
 /**

package/src/wsready.ts

@@ -4,7 +4,7 @@
  * See License-AGPL.txt in the project root for license information.
  */
 
-// generated using github.com/32leaves/bel on 2022-02-15 11:53:18.380158212 +0000 UTC m=+0.011913675
+// generated using github.com/32leaves/bel on 2022-05-18 18:19:49.011672619 +0000 UTC m=+0.006607361
 // DO NOT MODIFY
 
 export enum WorkspaceInitSource {