@gitpod/gitpod-protocol 0.1.5-tar-sh-active-users.8 → 0.1.5-tar-sh-active-users.22

package/src/gitpod-service.ts

@@ -60,7 +60,7 @@ import {
 import { RemotePageMessage, RemoteTrackMessage, RemoteIdentifyMessage } from "./analytics";
 import { IDEServer } from "./ide-protocol";
 import { InstallationAdminSettings, TelemetryData } from "./installation-admin-protocol";
-import { ListBilledUsageResponse, ListBilledUsageRequest } from "./usage";
+import { ListUsageRequest, ListUsageResponse } from "./usage";
 import { SupportedWorkspaceClass } from "./workspace-class";
 import { BillingMode } from "./billing-mode";
 
@@ -70,6 +70,8 @@ export interface GitpodClient {
 
     onPrebuildUpdate(update: PrebuildWithStatus): void;
 
+    onNotificationUpdated(): void;
+
     onCreditAlert(creditAlert: CreditAlert): void;
 
     //#region propagating reconnection to iframe
@@ -191,11 +193,6 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     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>;
-    guessProjectConfiguration(projectId: string): Promise<string | undefined>;
-    fetchRepositoryConfiguration(cloneUrl: string): Promise<string | undefined>;
-    guessRepositoryConfiguration(cloneUrl: string): Promise<string | undefined>;
-    setProjectConfiguration(projectId: string, configString: string): Promise<void>;
     updateProjectPartial(partialProject: PartialProject): Promise<void>;
     setProjectEnvironmentVariable(projectId: string, name: string, value: string, censored: boolean): Promise<void>;
     getProjectEnvironmentVariables(projectId: string): Promise<ProjectEnvVar[]>;
@@ -211,7 +208,6 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     deleteGitpodToken(tokenHash: string): Promise<void>;
 
     // misc
-    sendFeedback(feedback: string): Promise<string | undefined>;
     isGitHubAppEnabled(): Promise<boolean>;
     registerGithubApp(installationId: string): Promise<void>;
 
@@ -290,14 +286,20 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
 
     getStripePublishableKey(): Promise<string>;
     getStripeSetupIntentClientSecret(): Promise<string>;
+    findStripeSubscriptionId(attributionId: string): Promise<string | undefined>;
     findStripeSubscriptionIdForTeam(teamId: string): Promise<string | undefined>;
     createOrUpdateStripeCustomerForTeam(teamId: string, currency: string): Promise<void>;
+    createOrUpdateStripeCustomerForUser(currency: string): Promise<void>;
+    subscribeToStripe(attributionId: string, setupIntentId: string): Promise<void>;
     subscribeTeamToStripe(teamId: string, setupIntentId: string): Promise<void>;
+    getStripePortalUrl(attributionId: string): Promise<string>;
     getStripePortalUrlForTeam(teamId: string): Promise<string>;
-    getSpendingLimitForTeam(teamId: string): Promise<number | undefined>;
-    setSpendingLimitForTeam(teamId: string, spendingLimit: number): Promise<void>;
+    getUsageLimit(attributionId: string): Promise<number | undefined>;
+    setUsageLimit(attributionId: string, usageLimit: number): Promise<void>;
+    getUsageLimitForTeam(teamId: string): Promise<number | undefined>;
+    setUsageLimitForTeam(teamId: string, spendingLimit: number): Promise<void>;
 
-    listBilledUsage(req: ListBilledUsageRequest): Promise<ListBilledUsageResponse>;
+    listUsage(req: ListUsageRequest): Promise<ListUsageResponse>;
 
     setUsageAttribution(usageAttribution: string): Promise<void>;
 
@@ -331,9 +333,7 @@ export interface RateLimiterError {
 
 export interface CreateProjectParams {
     name: string;
-    slug?: string;
-    account: string;
-    provider: string;
+    slug: string;
     cloneUrl: string;
     teamId?: string;
     userId?: string;
@@ -572,6 +572,18 @@ export class GitpodCompositeClient<Client extends GitpodClient> implements Gitpo
             }
         }
     }
+
+    onNotificationUpdated(): void {
+        for (const client of this.clients) {
+            if (client.onNotificationUpdated) {
+                try {
+                    client.onNotificationUpdated();
+                } catch (error) {
+                    console.error(error);
+                }
+            }
+        }
+    }
 }
 
 export type GitpodService = GitpodServiceImpl<GitpodClient, GitpodServer>;

package/src/protocol.ts

@@ -8,6 +8,7 @@ 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;
@@ -294,6 +295,7 @@ export const WorkspaceFeatureFlags = {
     persistent_volume_claim: undefined,
     protected_secrets: undefined,
     workspace_class_limiting: undefined,
+    workspace_connection_limiting: undefined,
 };
 export type NamedWorkspaceFeatureFlag = keyof typeof WorkspaceFeatureFlags;
 
@@ -822,13 +824,12 @@ export interface WorkspaceConfig {
      * Where the config object originates from.
      *
      * repo - from the repository
-     * project-db - from the "Project" stored in the database
      * definitly-gp - from github.com/gitpod-io/definitely-gp
      * derived - computed based on analyzing the repository
      * additional-content - config comes from additional content, usually provided through the project's configuration
      * default - our static catch-all default config
      */
-    _origin?: "repo" | "project-db" | "definitely-gp" | "derived" | "additional-content" | "default";
+    _origin?: "repo" | "definitely-gp" | "derived" | "additional-content" | "default";
 
     /**
      * Set of automatically infered feature flags. That's not something the user can set, but
@@ -1503,10 +1504,12 @@ export interface Terms {
     readonly formElements?: object;
 }
 
+export type BillingStrategy = "other" | "stripe";
 export interface CostCenter {
-    readonly id: string;
+    readonly id: AttributionId;
     /**
      * Unit: credits
      */
     spendingLimit: number;
+    billingStrategy: BillingStrategy;
 }

package/src/teams-projects-protocol.ts

@@ -27,7 +27,6 @@ export interface Project {
     teamId?: string;
     userId?: string;
     appInstallationId: string;
-    config?: ProjectConfig;
     settings?: ProjectSettings;
     creationTime: string;
     /** This is a flag that triggers the HARD DELETION of this entity */

package/src/usage.ts

@@ -4,60 +4,69 @@
  * See License-AGPL.txt in the project root for license information.
  */
 
-import { User, WorkspaceType } from "./protocol";
+import { WorkspaceType } from "./protocol";
 
-export interface BillableSession {
-    // The id of the one paying the bill
+// types below are copied over from components/usage-api/typescript/src/usage/v1/usage_pb.d.ts
+export interface ListUsageRequest {
     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;
+    from?: number;
+    to?: number;
+    order: Ordering;
+    pagination?: PaginationRequest;
 }
 
-export interface ExtendedBillableSession extends BillableSession {
-    contextURL?: string;
-    user?: Pick<User.Profile, "name" | "avatarURL">;
+export enum Ordering {
+    ORDERING_DESCENDING = 0,
+    ORDERING_ASCENDING = 1,
 }
 
-/**
- * This is a paginated request
- */
-export interface ListBilledUsageRequest {
-    attributionId: string;
-    fromDate?: number;
-    toDate?: number;
+export interface PaginationRequest {
     perPage: number;
     page: number;
 }
 
-export interface ListBilledUsageResponse {
-    sessions: ExtendedBillableSession[];
-    totalCreditsUsed: number;
-    totalPages: number;
-    totalSessions: number;
+export interface ListUsageResponse {
+    usageEntriesList: Usage[];
+    pagination?: PaginationResponse;
+    creditBalanceAtStart: number;
+    creditBalanceAtEnd: number;
+}
+
+export interface PaginationResponse {
     perPage: number;
+    totalPages: number;
+    total: number;
     page: number;
 }
 
-export type BillableWorkspaceType = WorkspaceType;
+export type UsageKind = "workspaceinstance" | "invoice";
+export interface Usage {
+    id: string;
+    attributionId: string;
+    description: string;
+    credits: number;
+    effectiveTime?: number;
+    kind: UsageKind;
+    workspaceInstanceId: string;
+    draft: boolean;
+    metadata: WorkspaceInstanceUsageData | InvoiceUsageData;
+}
+
+// the equivalent golang shape is maintained in `/workspace/gitpod/`components/usage/pkg/db/usage.go`
+export interface WorkspaceInstanceUsageData {
+    workspaceId: string;
+    workspaceType: WorkspaceType;
+    workspaceClass: string;
+    contextURL: string;
+    startTime: string;
+    endTime?: string;
+    userId: string;
+    userName: string;
+    userAvatarURL: string;
+}
+
+export interface InvoiceUsageData {
+    invoiceId: string;
+    startDate: string;
+    endDate: string;
+}

package/src/util/timeutil.spec.ts

@@ -45,4 +45,25 @@ export class TimeutilSpec {
         const later = oneMonthLater(from.toISOString(), day);
         expect(later, `expected ${later} to be equal ${expectation}`).to.be.equal(expectation.toISOString());
     }
+
+    @test
+    testDaysBefore2() {
+        const tests: { date: Date; daysEarlier: number; expectation: string }[] = [
+            {
+                date: new Date("2021-07-13T00:00:00.000Z"),
+                daysEarlier: 365,
+                expectation: "2020-07-13T00:00:00.000Z",
+            },
+            {
+                date: new Date("2019-02-01T00:00:00.000Z"),
+                daysEarlier: 365,
+                expectation: "2018-02-01T00:00:00.000Z",
+            },
+        ];
+
+        for (const t of tests) {
+            const actual = daysBefore(t.date.toISOString(), t.daysEarlier);
+            expect(actual).to.equal(t.expectation, `expected ${actual} to be equal ${t.expectation}`);
+        }
+    }
 }