@gitpod/gitpod-protocol 0.1.5-vn-jetbrains-backend-plugin-223.6 → 0.1.5-wk-inte-test-20230117000019.1

package/src/protocol.ts

@@ -1,14 +1,13 @@
 /**
  * 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.
+ * See License.AGPL.txt in the project root for license information.
  */
 
 import { WorkspaceInstance, PortVisibility } from "./workspace-instance";
 import { RoleOrPermission } from "./permission";
 import { Project } from "./teams-projects-protocol";
 import { createHash } from "crypto";
-import { AttributionId } from "./attribution";
 
 export interface UserInfo {
     name?: string;
@@ -213,6 +212,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 {
@@ -256,8 +258,8 @@ export type IDESettings = {
 };
 
 export interface WorkspaceClasses {
-    regular: string;
-    prebuild: string;
+    regular?: string;
+    prebuild?: string;
 }
 
 export interface UserPlatform {
@@ -294,17 +296,13 @@ export type BillingTier = "paid" | "free";
  */
 export const WorkspaceFeatureFlags = {
     full_workspace_backup: undefined,
-    persistent_volume_claim: undefined,
-    protected_secrets: undefined,
     workspace_class_limiting: undefined,
     workspace_connection_limiting: undefined,
+    workspace_psi: undefined,
 };
 export type NamedWorkspaceFeatureFlag = keyof typeof WorkspaceFeatureFlags;
 export namespace NamedWorkspaceFeatureFlag {
-    export const WORKSPACE_PERSISTED_FEATTURE_FLAGS: NamedWorkspaceFeatureFlag[] = [
-        "full_workspace_backup",
-        "persistent_volume_claim",
-    ];
+    export const WORKSPACE_PERSISTED_FEATTURE_FLAGS: NamedWorkspaceFeatureFlag[] = ["full_workspace_backup"];
     export function isWorkspacePersisted(ff: NamedWorkspaceFeatureFlag): boolean {
         return WORKSPACE_PERSISTED_FEATTURE_FLAGS.includes(ff);
     }
@@ -471,7 +469,7 @@ export interface UserSSHPublicKey extends SSHPublicKeyValue {
     lastUsedTime?: string;
 }
 
-export type UserSSHPublicKeyValue = Omit<UserSSHPublicKey, "key" | "userId">;
+export type UserSSHPublicKeyValue = Omit<UserSSHPublicKey, "userId">;
 
 export namespace SSHPublicKeyValue {
     export function validate(value: SSHPublicKeyValue): string | undefined {
@@ -639,6 +637,7 @@ export interface PendingGithubEvent {
     creationDate: Date;
     type: string;
     event: string;
+    deleted: boolean;
 }
 
 export interface Snapshot {
@@ -647,26 +646,12 @@ export interface Snapshot {
     availableTime?: string;
     originalWorkspaceId: string;
     bucketId: string;
-    layoutData?: string;
     state: SnapshotState;
     message?: string;
 }
 
-export interface VolumeSnapshot {
-    id: string;
-    workspaceId: string;
-    creationTime: string;
-    volumeHandle: string;
-}
-
 export type SnapshotState = "pending" | "available" | "error";
 
-export interface LayoutData {
-    workspaceId: string;
-    lastUpdatedTime: string;
-    layoutData: string;
-}
-
 export interface Workspace {
     id: string;
     creationTime: string;
@@ -801,6 +786,10 @@ export interface JetBrainsConfig {
     goland?: JetBrainsProductConfig;
     pycharm?: JetBrainsProductConfig;
     phpstorm?: JetBrainsProductConfig;
+    rubymine?: JetBrainsProductConfig;
+    webstorm?: JetBrainsProductConfig;
+    rider?: JetBrainsProductConfig;
+    clion?: JetBrainsProductConfig;
 }
 export interface JetBrainsProductConfig {
     prebuilds?: JetBrainsPrebuilds;
@@ -1115,14 +1104,17 @@ export namespace SnapshotContext {
     }
 }
 
-export interface StartPrebuildContext extends WorkspaceContext {
-    actual: WorkspaceContext;
+export interface WithCommitHistory {
     commitHistory?: string[];
     additionalRepositoryCommitHistories?: {
         cloneUrl: string;
         commitHistory: string[];
     }[];
-    project?: Project;
+}
+
+export interface StartPrebuildContext extends WorkspaceContext, WithCommitHistory {
+    actual: WorkspaceContext;
+    project: Project;
     branch?: string;
 }
 
@@ -1204,6 +1196,16 @@ export namespace AdditionalContentContext {
     }
 }
 
+export interface OpenPrebuildContext extends WorkspaceContext {
+    openPrebuildID: string;
+}
+
+export namespace OpenPrebuildContext {
+    export function is(ctx: any): ctx is OpenPrebuildContext {
+        return "openPrebuildID" in ctx;
+    }
+}
+
 export interface CommitContext extends WorkspaceContext, GitCheckoutInfo {
     /** @deprecated Moved to .repository.cloneUrl, left here for backwards-compatibility for old workspace contextes in the DB */
     cloneUrl?: string;
@@ -1367,17 +1369,6 @@ export interface WorkspaceCreationResult {
 }
 export type RunningWorkspacePrebuildStarting = "queued" | "starting" | "running";
 
-export enum CreateWorkspaceMode {
-    // Default returns a running prebuild if there is any, otherwise creates a new workspace (using a prebuild if one is available)
-    Default = "default",
-    // ForceNew creates a new workspace irrespective of any running prebuilds. This mode is guaranteed to actually create a workspace - but may degrade user experience as currently runnig prebuilds are ignored.
-    ForceNew = "force-new",
-    // UsePrebuild polls the database waiting for a currently running prebuild to become available. This mode exists to handle the db-sync delay.
-    UsePrebuild = "use-prebuild",
-    // SelectIfRunning returns a list of currently running workspaces for the context URL if there are any, otherwise falls back to Default mode
-    SelectIfRunning = "select-if-running",
-}
-
 export namespace WorkspaceCreationResult {
     export function is(data: any): data is WorkspaceCreationResult {
         return (
@@ -1515,13 +1506,3 @@ export interface StripeConfig {
     individualUsagePriceIds: { [currency: string]: string };
     teamUsagePriceIds: { [currency: string]: string };
 }
-
-export type BillingStrategy = "other" | "stripe";
-export interface CostCenter {
-    readonly id: AttributionId;
-    /**
-     * Unit: credits
-     */
-    spendingLimit: number;
-    billingStrategy: BillingStrategy;
-}

package/src/snapshot-url.spec.ts

@@ -1,7 +1,7 @@
 /**
  * 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.
+ * See License.AGPL.txt in the project root for license information.
  */
 
 import { suite, test } from "mocha-typescript";

package/src/snapshot-url.ts

@@ -1,7 +1,7 @@
 /**
  * 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.
+ * See License.AGPL.txt in the project root for license information.
  */
 
 export interface SnapshotUrl {

package/src/team-subscription-protocol.ts

@@ -1,7 +1,7 @@
 /**
  * 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.
+ * See License.AGPL.txt in the project root for license information.
  */
 
 import { v4 as uuidv4 } from "uuid";

package/src/teams-projects-protocol.ts

@@ -1,10 +1,10 @@
 /**
  * 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.
+ * See License.AGPL.txt in the project root for license information.
  */
 
-import { PrebuiltWorkspaceState } from "./protocol";
+import { PrebuiltWorkspaceState, WorkspaceClasses } from "./protocol";
 import { v4 as uuidv4 } from "uuid";
 import { DeepPartial } from "./util/deep-partial";
 import { WebhookEvent } from "./webhook-event";
@@ -15,8 +15,13 @@ export interface ProjectConfig {
 
 export interface ProjectSettings {
     useIncrementalPrebuilds?: boolean;
-    usePersistentVolumeClaim?: boolean;
     keepOutdatedPrebuildsRunning?: boolean;
+    // whether new workspaces can start on older prebuilds and incrementally update
+    allowUsingPreviousPrebuilds?: boolean;
+    // how many commits in the commit history a prebuild is good (undefined and 0 means every commit is prebuilt)
+    prebuildEveryNthCommit?: number;
+    // preferred workspace classes
+    workspaceClasses?: WorkspaceClasses;
 }
 
 export interface Project {
@@ -45,6 +50,7 @@ export namespace Project {
 
     export interface Overview {
         branches: BranchDetails[];
+        isConsideredInactive?: boolean;
     }
 
     export namespace Overview {
@@ -119,7 +125,6 @@ export interface StartPrebuildResult {
     wsid: string;
     done: boolean;
 }
-
 export interface Team {
     id: string;
     name: string;
@@ -132,6 +137,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

@@ -1,12 +1,14 @@
 /**
  * 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.
+ * See License.AGPL.txt in the project root for license information.
  */
 
 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;
     };
 }

package/src/usage.ts

@@ -1,7 +1,7 @@
 /**
  * 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.
+ * See License.AGPL.txt in the project root for license information.
  */
 
 import { WorkspaceType } from "./protocol";
@@ -69,3 +69,17 @@ export interface InvoiceUsageData {
     startDate: string;
     endDate: string;
 }
+
+export interface CostCenterJSON {
+    attributionId: string;
+    spendingLimit: number;
+    billingStrategy: CostCenter_BillingStrategy;
+    nextBillingTime?: string;
+    billingCycleStart?: string;
+}
+
+export enum CostCenter_BillingStrategy {
+    BILLING_STRATEGY_STRIPE = "BILLING_STRATEGY_STRIPE",
+    BILLING_STRATEGY_OTHER = "BILLING_STRATEGY_OTHER",
+    UNRECOGNIZED = "UNRECOGNIZED",
+}

package/src/util/analytics.ts

@@ -1,7 +1,7 @@
 /**
  * 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.
+ * See License.AGPL.txt in the project root for license information.
  */
 
 import Analytics = require("analytics-node");

package/src/util/async-iterator.ts

@@ -1,7 +1,7 @@
 /**
  * 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.
+ * See License.AGPL.txt in the project root for license information.
  */
 
 // Use asyncIterators with es2015

package/src/util/cancelable.ts

@@ -1,7 +1,7 @@
 /**
  * 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.
+ * See License.AGPL.txt in the project root for license information.
  */
 
 import { Disposable } from "./disposable";

package/src/util/date-time.ts

@@ -1,7 +1,7 @@
 /**
  * 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.
+ * See License.AGPL.txt in the project root for license information.
  */
 
 export function formatDate(date?: string) {

package/src/util/debug-app.ts

@@ -1,7 +1,7 @@
 /**
  * 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.
+ * See License.AGPL.txt in the project root for license information.
  */
 
 import * as http from "http";

package/src/util/deep-partial.ts

@@ -1,7 +1,7 @@
 /**
  * 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.
+ * See License.AGPL.txt in the project root for license information.
  */
 
 /**

package/src/util/deferred.ts

@@ -1,7 +1,7 @@
 /**
  * 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.
+ * See License.AGPL.txt in the project root for license information.
  */
 
 export class Deferred<T> {

package/src/util/garbage-collected-cache.ts

@@ -1,7 +1,7 @@
 /**
  * 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.
+ * See License.AGPL.txt in the project root for license information.
  */
 
 import { repeat } from "./repeat";

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

@@ -1,7 +1,7 @@
 /**
  * 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.
+ * See License.AGPL.txt in the project root for license information.
  */
 
 import { suite, test } from "mocha-typescript";

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

@@ -1,7 +1,7 @@
 /**
  * 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.
+ * See License.AGPL.txt in the project root for license information.
  */
 
 import randomNumber = require("random-number-csprng");

package/src/util/gitpod-cookie.ts

@@ -1,7 +1,7 @@
 /**
  * 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.
+ * See License.AGPL.txt in the project root for license information.
  */
 import * as cookie from "cookie";
 

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

@@ -1,7 +1,7 @@
 /**
  * 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.
+ * See License.AGPL.txt in the project root for license information.
  */
 
 import * as chai from "chai";

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

@@ -1,7 +1,7 @@
 /**
  * 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.
+ * See License.AGPL.txt in the project root for license information.
  */
 
 const URL = require("url").URL || window.URL;
@@ -16,10 +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}\\.`);
+const workspaceUrlPrefixRegex = RegExp(`^(([0-9]{4,6}|debug)-)?${baseWorkspaceIDRegex}\\.`);
 
 export class GitpodHostUrl {
     readonly url: URL;
@@ -77,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 {
@@ -93,6 +100,10 @@ export class GitpodHostUrl {
         return this.with((url) => ({ pathname: "/" }));
     }
 
+    asBilling(): GitpodHostUrl {
+        return this.with((url) => ({ pathname: "/billing" }));
+    }
+
     asLogin(): GitpodHostUrl {
         return this.with((url) => ({ pathname: "/login" }));
     }
@@ -120,10 +131,9 @@ export class GitpodHostUrl {
         });
     }
 
-    asWorkspaceAuth(instanceID: string, redirect?: boolean): GitpodHostUrl {
+    asWorkspaceAuth(instanceID: string): GitpodHostUrl {
         return this.with((url) => ({
             pathname: `/api/auth/workspace-cookie/${instanceID}`,
-            search: redirect ? "redirect" : "",
         }));
     }
 
@@ -139,6 +149,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) {
@@ -146,7 +160,7 @@ export class GitpodHostUrl {
             if (matchResults) {
                 // URL has a workspace prefix
                 // port prefixes are excluded
-                return matchResults[0];
+                return matchResults[1];
             }
         }
 
@@ -155,6 +169,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/grpc.ts

@@ -1,7 +1,7 @@
 /**
  * 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.
+ * See License.AGPL.txt in the project root for license information.
  */
 
 import * as grpc from "@grpc/grpc-js";
@@ -36,6 +36,9 @@ export interface IClientCallMetrics {
     sent(labels: IGrpcCallMetricsLabels): void;
     received(labels: IGrpcCallMetricsLabels): void;
     handled(labels: IGrpcCallMetricsLabelsWithCode): void;
+    startHandleTimer(
+        labels: IGrpcCallMetricsLabels,
+    ): (labels?: Partial<Record<string, string | number>> | undefined) => number;
 }
 
 export function getGrpcMethodType(requestStream: boolean, responseStream: boolean): GrpcMethodType {

package/src/util/jaeger-client-types.ts

@@ -1,7 +1,7 @@
 /**
  * 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.
+ * See License.AGPL.txt in the project root for license information.
  */
 
 import { opentracing } from "jaeger-client";

package/src/util/logging.spec.ts

@@ -1,7 +1,7 @@
 /**
  * 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.
+ * See License.AGPL.txt in the project root for license information.
  */
 
 import { suite, test } from "mocha-typescript";

package/src/util/logging.ts

@@ -1,7 +1,7 @@
 /**
  * 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.
+ * See License.AGPL.txt in the project root for license information.
  */
 
 const inspect: (object: any) => string = require("util").inspect; // undefined in frontend

package/src/util/make-link.ts

@@ -1,7 +1,7 @@
 /**
  * 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.
+ * See License.AGPL.txt in the project root for license information.
  */
 
 function isOpenNewTab(event: MouseEvent): boolean {