@gitpod/gitpod-protocol 0.1.5-tar-sh-active-users.37 → 0.1.5-tar-sh-active-users-new.2

package/src/gitpod-service.ts

@@ -227,16 +227,6 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
      */
     getSnapshots(workspaceID: string): Promise<string[]>;
 
-    /**
-     * stores/updates layout information for the given workspace
-     */
-    storeLayout(workspaceId: string, layoutData: string): Promise<void>;
-
-    /**
-     * retrieves layout information for the given workspace
-     */
-    getLayout(workspaceId: string): Promise<string | undefined>;
-
     guessGitTokenScopes(params: GuessGitTokenScopesParams): Promise<GuessedGitTokenScopes>;
 
     /**
@@ -287,9 +277,8 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     getStripePublishableKey(): Promise<string>;
     getStripeSetupIntentClientSecret(): Promise<string>;
     findStripeSubscriptionId(attributionId: string): Promise<string | undefined>;
-    createOrUpdateStripeCustomerForTeam(teamId: string, currency: string): Promise<void>;
-    createOrUpdateStripeCustomerForUser(currency: string): Promise<void>;
-    subscribeToStripe(attributionId: string, setupIntentId: string): Promise<void>;
+    createStripeCustomerIfNeeded(attributionId: string, currency: string): Promise<void>;
+    subscribeToStripe(attributionId: string, setupIntentId: string, usageLimit: number): Promise<number | undefined>;
     getStripePortalUrl(attributionId: string): Promise<string>;
     getUsageLimit(attributionId: string): Promise<number | undefined>;
     setUsageLimit(attributionId: string, usageLimit: number): Promise<void>;
@@ -297,6 +286,7 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     listUsage(req: ListUsageRequest): Promise<ListUsageResponse>;
 
     setUsageAttribution(usageAttribution: string): Promise<void>;
+    listAvailableUsageAttributionIds(): Promise<string[]>;
 
     getBillingModeForUser(): Promise<BillingMode>;
     getBillingModeForTeam(teamId: string): Promise<BillingMode>;
@@ -439,7 +429,6 @@ export namespace GitpodServer {
     }
     export interface TakeSnapshotOptions {
         workspaceId: string;
-        layoutData?: string;
         /* this is here to enable backwards-compatibility and untangling rollout between workspace, IDE and meta */
         dontWait?: boolean;
     }

package/src/index.ts

@@ -13,7 +13,6 @@ export * from "./license-protocol";
 export * from "./workspace-instance";
 export * from "./permission";
 export * from "./admin-protocol";
-export * from "./email-protocol";
 export * from "./headless-workspace-log";
 export * from "./context-url";
 export * from "./teams-projects-protocol";

package/src/messaging/error.ts

@@ -94,4 +94,7 @@ export namespace ErrorCodes {
 
     // 640 Headless logs are not available (yet)
     export const HEADLESS_LOG_NOT_YET_AVAILABLE = 640;
+
+    // 650 Invalid Value
+    export const INVALID_VALUE = 650;
 }

package/src/plans.ts

@@ -131,7 +131,7 @@ export namespace Plans {
         githubPlanNumber: 1,
 
         type: "free",
-        name: "Open Source",
+        name: "Free",
         currency: "USD",
         pricePerMonth: 0,
         hoursPerMonth: 100,
@@ -146,7 +146,7 @@ export namespace Plans {
         githubPlanNumber: 5,
 
         type: "free-50",
-        name: "Open Source",
+        name: "Free",
         currency: "USD",
         pricePerMonth: 0,
         hoursPerMonth: 50,

package/src/protocol.ts

@@ -286,6 +286,8 @@ export interface UserFeatureSettings {
     permanentWSFeatureFlags?: NamedWorkspaceFeatureFlag[];
 }
 
+export type BillingTier = "paid" | "free";
+
 /**
  * The values of this type MUST MATCH enum values in WorkspaceFeatureFlag from ws-manager/client/core_pb.d.ts
  * If they don't we'll break things during workspace startup.
@@ -296,6 +298,7 @@ export const WorkspaceFeatureFlags = {
     protected_secrets: undefined,
     workspace_class_limiting: undefined,
     workspace_connection_limiting: undefined,
+    workspace_psi: undefined,
 };
 export type NamedWorkspaceFeatureFlag = keyof typeof WorkspaceFeatureFlags;
 export namespace NamedWorkspaceFeatureFlag {
@@ -637,6 +640,7 @@ export interface PendingGithubEvent {
     creationDate: Date;
     type: string;
     event: string;
+    deleted: boolean;
 }
 
 export interface Snapshot {
@@ -645,7 +649,6 @@ export interface Snapshot {
     availableTime?: string;
     originalWorkspaceId: string;
     bucketId: string;
-    layoutData?: string;
     state: SnapshotState;
     message?: string;
 }
@@ -659,12 +662,6 @@ export interface VolumeSnapshot {
 
 export type SnapshotState = "pending" | "available" | "error";
 
-export interface LayoutData {
-    workspaceId: string;
-    lastUpdatedTime: string;
-    layoutData: string;
-}
-
 export interface Workspace {
     id: string;
     creationTime: string;
@@ -726,7 +723,7 @@ export interface Workspace {
 
 export type WorkspaceSoftDeletion = "user" | "gc";
 
-export type WorkspaceType = "regular" | "prebuild" | "probe"; // TODO(gpl) Removed prove here
+export type WorkspaceType = "regular" | "prebuild";
 
 export namespace Workspace {
     export function getFullRepositoryName(ws: Workspace): string | undefined {
@@ -799,6 +796,8 @@ export interface JetBrainsConfig {
     goland?: JetBrainsProductConfig;
     pycharm?: JetBrainsProductConfig;
     phpstorm?: JetBrainsProductConfig;
+    rubymine?: JetBrainsProductConfig;
+    webstorm?: JetBrainsProductConfig;
 }
 export interface JetBrainsProductConfig {
     prebuilds?: JetBrainsPrebuilds;
@@ -815,8 +814,8 @@ export interface RepositoryCloneInformation {
 
 export interface CoreDumpConfig {
     enabled?: boolean;
-	softLimit?: number;
-	hardLimit?: number;
+    softLimit?: number;
+    hardLimit?: number;
 }
 
 export interface WorkspaceConfig {
@@ -1113,13 +1112,16 @@ export namespace SnapshotContext {
     }
 }
 
-export interface StartPrebuildContext extends WorkspaceContext {
-    actual: WorkspaceContext;
+export interface WithCommitHistory {
     commitHistory?: string[];
     additionalRepositoryCommitHistories?: {
         cloneUrl: string;
         commitHistory: string[];
     }[];
+}
+
+export interface StartPrebuildContext extends WorkspaceContext, WithCommitHistory {
+    actual: WorkspaceContext;
     project?: Project;
     branch?: string;
 }
@@ -1163,17 +1165,6 @@ export namespace WithEnvvarsContext {
     }
 }
 
-export interface WorkspaceProbeContext extends WorkspaceContext {
-    responseURL: string;
-    responseToken: string;
-}
-
-export namespace WorkspaceProbeContext {
-    export function is(context: any): context is WorkspaceProbeContext {
-        return context && "responseURL" in context && "responseToken" in context;
-    }
-}
-
 export type RefType = "branch" | "tag" | "revision";
 export namespace RefType {
     export const getRefType = (commit: Commit): RefType => {
@@ -1213,6 +1204,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;
@@ -1385,6 +1386,8 @@ export enum CreateWorkspaceMode {
     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",
+    // UseLastSuccessfulPrebuild returns ...
+    UseLastSuccessfulPrebuild = "use-last-successful-prebuild",
 }
 
 export namespace WorkspaceCreationResult {
@@ -1520,6 +1523,11 @@ export interface Terms {
     readonly formElements?: object;
 }
 
+export interface StripeConfig {
+    individualUsagePriceIds: { [currency: string]: string };
+    teamUsagePriceIds: { [currency: string]: string };
+}
+
 export type BillingStrategy = "other" | "stripe";
 export interface CostCenter {
     readonly id: AttributionId;

package/src/teams-projects-protocol.ts

@@ -45,6 +45,7 @@ export namespace Project {
 
     export interface Overview {
         branches: BranchDetails[];
+        isConsideredInactive?: boolean;
     }
 
     export namespace Overview {

package/src/util/nice-grpc.ts

@@ -0,0 +1,93 @@
+/**
+ * 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 { isAbortError } from "abort-controller-x";
+import {
+    CallOptions,
+    ClientError,
+    ClientMiddleware,
+    ClientMiddlewareCall,
+    Status,
+    MethodDescriptor,
+} from "nice-grpc-common";
+import { GrpcMethodType, IClientCallMetrics } from "./grpc";
+
+function getLabels(method: MethodDescriptor) {
+    const callType = method.requestStream
+        ? method.responseStream
+            ? "bidi_stream"
+            : "client_stream"
+        : method.responseStream
+        ? "server_stream"
+        : "unary";
+    const { path } = method;
+    const [serviceName, methodName] = path.split("/").slice(1);
+
+    return {
+        type: callType as GrpcMethodType,
+        service: serviceName,
+        method: methodName,
+    };
+}
+
+async function* incrementStreamMessagesCounter<T>(iterable: AsyncIterable<T>, callback: () => void): AsyncIterable<T> {
+    for await (const item of iterable) {
+        callback();
+        yield item;
+    }
+}
+
+export function prometheusClientMiddleware(metrics: IClientCallMetrics): ClientMiddleware {
+    return async function* prometheusClientMiddlewareGenerator<Request, Response>(
+        call: ClientMiddlewareCall<Request, Response>,
+        options: CallOptions,
+    ): AsyncGenerator<Response, Response | void, undefined> {
+        const labels = getLabels(call.method);
+
+        metrics.started(labels);
+
+        let settled = false;
+        let status: Status = Status.OK;
+
+        try {
+            let request;
+
+            if (!call.requestStream) {
+                request = call.request;
+            } else {
+                request = incrementStreamMessagesCounter(call.request, metrics.sent.bind(metrics, labels));
+            }
+
+            if (!call.responseStream) {
+                const response = yield* call.next(request, options);
+                settled = true;
+                return response;
+            } else {
+                yield* incrementStreamMessagesCounter(
+                    call.next(request, options),
+                    metrics.received.bind(metrics, labels),
+                );
+                settled = true;
+                return;
+            }
+        } catch (err) {
+            settled = true;
+            if (err instanceof ClientError) {
+                status = err.code;
+            } else if (isAbortError(err)) {
+                status = Status.CANCELLED;
+            } else {
+                status = Status.UNKNOWN;
+            }
+            throw err;
+        } finally {
+            if (!settled) {
+                status = Status.CANCELLED;
+            }
+            metrics.handled({ ...labels, code: Status[status] });
+        }
+    };
+}

package/src/workspace-cluster.ts

@@ -15,6 +15,10 @@ export interface WorkspaceCluster {
     // Must be identical to the installationShortname of the cluster it represents!
     name: string;
 
+    // The name of the application cluster to which this cluster should be registered.
+    // The name can be at most 60 characters.
+    applicationCluster: string;
+
     // URL of the cluster's ws-manager API
     url: string;
 
@@ -86,20 +90,21 @@ export interface WorkspaceClusterDB {
      * Deletes the cluster identified by this name, if any.
      * @param name
      */
-    deleteByName(name: string): Promise<void>;
+    deleteByName(name: string, applicationCluster: string): Promise<void>;
 
     /**
      * Finds a WorkspaceCluster with the given name. If there is none, `undefined` is returned.
      * @param name
      */
-    findByName(name: string): Promise<WorkspaceCluster | undefined>;
+    findByName(name: string, applicationCluster: string): Promise<WorkspaceCluster | undefined>;
 
     /**
      * Lists all WorkspaceClusterWoTls for which the given predicate is true (does not return TLS for size/speed concerns)
      * @param predicate
      */
-    findFiltered(predicate: DeepPartial<WorkspaceClusterFilter>): Promise<WorkspaceClusterWoTLS[]>;
-}
-export interface WorkspaceClusterFilter extends Pick<WorkspaceCluster, "state" | "govern" | "url"> {
-    minScore: number;
+    findFiltered(predicate: WorkspaceClusterFilter): Promise<WorkspaceClusterWoTLS[]>;
 }
+
+export type WorkspaceClusterFilter = Pick<WorkspaceCluster, "applicationCluster"> &
+    DeepPartial<Pick<WorkspaceCluster, "name" | "state" | "govern" | "url">> &
+    Partial<{ minScore: number }>;

package/src/wsready.ts

@@ -4,15 +4,14 @@
  * See License-AGPL.txt in the project root for license information.
  */
 
-// generated using github.com/32leaves/bel on 2022-07-21 07:41:48.081573085 +0000 UTC m=+0.009109470
+// generated using github.com/32leaves/bel on 2022-10-10 21:41:56.018177383 +0000 UTC m=+0.010324839
 // DO NOT MODIFY
 
-export interface WorkspaceReadyMessage {
-    source: WorkspaceInitSource;
-}
-
 export enum WorkspaceInitSource {
     WorkspaceInitFromBackup = "from-backup",
     WorkspaceInitFromPrebuild = "from-prebuild",
     WorkspaceInitFromOther = "from-other",
 }
+export interface WorkspaceReadyMessage {
+    source: WorkspaceInitSource;
+}

package/lib/email-protocol.d.ts

@@ -1,49 +0,0 @@
-/**
- * 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.
- */
-export declare type EMailState = "scheduledInternal" | "scheduledSendgrid";
-export interface EMailStatus {
-    /** The time the email entry was inserted into the DB */
-    scheduledInternalTime: string;
-    /** The time the email state transitioned to "scheduledSendgrid" */
-    scheduledSendgridTime?: string;
-    /** In case of any errors during sending with Sendgrid it gets noted here */
-    error?: string;
-}
-export declare namespace EMailStatus {
-    function getState(status: EMailStatus): EMailState;
-}
-export interface EmailAddress {
-    name?: string;
-    email: string;
-}
-export interface EMailParameters {
-    /** undefined means default from template */
-    subject?: string;
-    /** The sender address */
-    senderAddress: string | EmailAddress;
-    /** The replyTo address */
-    replyToAddress?: string | EmailAddress;
-    /** The SendGrid template id */
-    templateId: string;
-    /** The parameters for the SendGrid template */
-    templateParams: {};
-}
-export declare type EMail = {
-    /** The unique id of this email (uuid/v4 for now) */
-    uid: string;
-    /** The id of the user this email was sent to */
-    userId: string;
-    /** The address this email was sent to */
-    recipientAddress: string;
-    /** Which campaign scheduled this email  */
-    campaignId: string;
-    /** The parameters this email was sent with (template id, template params, etc) */
-    params: EMailParameters;
-} & EMailStatus;
-export declare namespace EMail {
-    const create: (ts: Omit<EMail, "uid">) => EMail;
-}
-//# sourceMappingURL=email-protocol.d.ts.map

package/lib/email-protocol.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"email-protocol.d.ts","sourceRoot":"","sources":["../src/email-protocol.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,oBAAY,UAAU,GAAG,mBAAmB,GAAG,mBAAmB,CAAC;AAEnE,MAAM,WAAW,WAAW;IACxB,wDAAwD;IACxD,qBAAqB,EAAE,MAAM,CAAC;IAC9B,mEAAmE;IACnE,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,4EAA4E;IAC5E,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AACD,yBAAiB,WAAW,CAAC;IACzB,SAAgB,QAAQ,CAAC,MAAM,EAAE,WAAW,GAAG,UAAU,CAKxD;CACJ;AAED,MAAM,WAAW,YAAY;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,eAAe;IAC5B,4CAA4C;IAC5C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yBAAyB;IACzB,aAAa,EAAE,MAAM,GAAG,YAAY,CAAC;IACrC,0BAA0B;IAC1B,cAAc,CAAC,EAAE,MAAM,GAAG,YAAY,CAAC;IACvC,+BAA+B;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,+CAA+C;IAC/C,cAAc,EAAE,EAAE,CAAC;CACtB;AAED,oBAAY,KAAK,GAAG;IAChB,oDAAoD;IACpD,GAAG,EAAE,MAAM,CAAC;IACZ,gDAAgD;IAChD,MAAM,EAAE,MAAM,CAAC;IACf,yCAAyC;IACzC,gBAAgB,EAAE,MAAM,CAAC;IACzB,2CAA2C;IAC3C,UAAU,EAAE,MAAM,CAAC;IACnB,kFAAkF;IAClF,MAAM,EAAE,eAAe,CAAC;CAC3B,GAAG,WAAW,CAAC;AAEhB,yBAAiB,KAAK,CAAC;IACZ,MAAM,MAAM,OAAQ,KAAK,KAAK,EAAE,KAAK,CAAC,KAAG,KAI/C,CAAC;CACL"}

package/lib/email-protocol.js

@@ -1,28 +0,0 @@
-"use strict";
-/**
- * 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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EMail = exports.EMailStatus = void 0;
-const uuid_1 = require("uuid");
-var EMailStatus;
-(function (EMailStatus) {
-    function getState(status) {
-        if (status.scheduledSendgridTime) {
-            return "scheduledSendgrid";
-        }
-        return "scheduledInternal";
-    }
-    EMailStatus.getState = getState;
-})(EMailStatus = exports.EMailStatus || (exports.EMailStatus = {}));
-var EMail;
-(function (EMail) {
-    EMail.create = (ts) => {
-        const withId = ts;
-        withId.uid = (0, uuid_1.v4)();
-        return withId;
-    };
-})(EMail = exports.EMail || (exports.EMail = {}));
-//# sourceMappingURL=email-protocol.js.map

package/lib/email-protocol.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"email-protocol.js","sourceRoot":"","sources":["../src/email-protocol.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AAEH,+BAAoC;AAYpC,IAAiB,WAAW,CAO3B;AAPD,WAAiB,WAAW;IACxB,SAAgB,QAAQ,CAAC,MAAmB;QACxC,IAAI,MAAM,CAAC,qBAAqB,EAAE;YAC9B,OAAO,mBAAmB,CAAC;SAC9B;QACD,OAAO,mBAAmB,CAAC;IAC/B,CAAC;IALe,oBAAQ,WAKvB,CAAA;AACL,CAAC,EAPgB,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAO3B;AAiCD,IAAiB,KAAK,CAMrB;AAND,WAAiB,KAAK;IACL,YAAM,GAAG,CAAC,EAAsB,EAAS,EAAE;QACpD,MAAM,MAAM,GAAG,EAAW,CAAC;QAC3B,MAAM,CAAC,GAAG,GAAG,IAAA,SAAM,GAAE,CAAC;QACtB,OAAO,MAAM,CAAC;IAClB,CAAC,CAAC;AACN,CAAC,EANgB,KAAK,GAAL,aAAK,KAAL,aAAK,QAMrB"}

package/src/email-protocol.ts

@@ -1,65 +0,0 @@
-/**
- * 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 { v4 as uuidv4 } from "uuid";
-
-export type EMailState = "scheduledInternal" | "scheduledSendgrid";
-
-export interface EMailStatus {
-    /** The time the email entry was inserted into the DB */
-    scheduledInternalTime: string;
-    /** The time the email state transitioned to "scheduledSendgrid" */
-    scheduledSendgridTime?: string;
-    /** In case of any errors during sending with Sendgrid it gets noted here */
-    error?: string;
-}
-export namespace EMailStatus {
-    export function getState(status: EMailStatus): EMailState {
-        if (status.scheduledSendgridTime) {
-            return "scheduledSendgrid";
-        }
-        return "scheduledInternal";
-    }
-}
-
-export interface EmailAddress {
-    name?: string;
-    email: string;
-}
-
-export interface EMailParameters {
-    /** undefined means default from template */
-    subject?: string;
-    /** The sender address */
-    senderAddress: string | EmailAddress;
-    /** The replyTo address */
-    replyToAddress?: string | EmailAddress;
-    /** The SendGrid template id */
-    templateId: string;
-    /** The parameters for the SendGrid template */
-    templateParams: {};
-}
-
-export type EMail = {
-    /** The unique id of this email (uuid/v4 for now) */
-    uid: string;
-    /** The id of the user this email was sent to */
-    userId: string;
-    /** The address this email was sent to */
-    recipientAddress: string;
-    /** Which campaign scheduled this email  */
-    campaignId: string;
-    /** The parameters this email was sent with (template id, template params, etc) */
-    params: EMailParameters;
-} & EMailStatus;
-
-export namespace EMail {
-    export const create = (ts: Omit<EMail, "uid">): EMail => {
-        const withId = ts as EMail;
-        withId.uid = uuidv4();
-        return withId;
-    };
-}