[server] Hook up usage API

Author: geropl

components/dashboard/src/teams/TeamUsage.tsx

@@ -12,6 +12,7 @@ import { getTeamSettingsMenu } from "./TeamSettings";
 import { PaymentContext } from "../payment-context";
 import { getGitpodService } from "../service/service";
 import { BillableSession, BillableWorkspaceType } from "@gitpod/gitpod-protocol/lib/usage";
+import { AttributionId } from "@gitpod/gitpod-protocol/lib/attribution";
 import { Item, ItemField, ItemsList } from "../components/ItemsList";
 import moment from "moment";
 import Property from "../admin/Property";
@@ -29,7 +30,8 @@ function TeamUsage() {
             return;
         }
         (async () => {
-            const billedUsageResult = await getGitpodService().server.getBilledUsage("some-attribution-id");
+            const attributionId = AttributionId.render({ kind: "team", teamId: team.id });
+            const billedUsageResult = await getGitpodService().server.getBilledUsage(attributionId);
             setBilledUsage(billedUsageResult);
         })();
     }, [team]);
@@ -92,7 +94,9 @@ function TeamUsage() {
                             <span className="text-gray-400">{usage.workspaceClass}</span>
                         </div>
                         <div className="my-auto">
-                            <span className="text-gray-700">{getHours(usage.endTime, usage.startTime)}</span>
+                            <span className="text-gray-700">
+                                {getHours(new Date(usage.endTime).getTime(), new Date(usage.startTime).getTime())}
+                            </span>
                         </div>
                         <div className="my-auto">
                             <span className="text-gray-700">{usage.credits}</span>

components/gitpod-protocol/src/usage.ts

@@ -24,10 +24,10 @@ export interface BillableSession {
     workspaceClass: string;
 
     // When the workspace started
-    startTime: number;
+    startTime: string;
 
     // When the workspace ended
-    endTime: number;
+    endTime: string;
 
     // The credits used for this session
     credits: number;
@@ -36,111 +36,4 @@ export interface BillableSession {
     projectId?: string;
 }
 
-export type BillableWorkspaceType = Omit<WorkspaceType, "probe">;
-
-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: Date.now() + -3 * 24 * 3600 * 1000, // 3 days ago
-        endTime: Date.now(),
-        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: Date.now() + -5 * 24 * 3600 * 1000,
-        endTime: Date.now(),
-        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: Date.now() + -5 * 24 * 3600 * 1000,
-        endTime: Date.now() + -4 * 24 * 3600 * 1000,
-        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: Date.now() + -10 * 24 * 3600 * 1000,
-        endTime: Date.now() + -9 * 24 * 3600 * 1000,
-        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: Date.now() + -2 * 24 * 3600 * 1000,
-        endTime: Date.now(),
-        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: Date.now() + -7 * 24 * 3600 * 1000,
-        endTime: Date.now() + -6 * 24 * 3600 * 1000,
-        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: Date.now() + -1 * 24 * 3600 * 1000,
-        endTime: Date.now(),
-        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: Date.now() + -1 * 24 * 3600 * 1000,
-        endTime: Date.now(),
-        credits: 200,
-        projectId: "project-345",
-    },
-];
+export type BillableWorkspaceType = WorkspaceType;

components/server/BUILD.yaml

@@ -17,6 +17,7 @@ packages:
       - components/licensor/typescript:lib
       - components/ws-manager-api/typescript:lib
       - components/supervisor-api/typescript-grpcweb:lib
+      - components/usage-api/typescript:lib
     config:
       packaging: offline-mirror
       yarnLock: ${coreYarnLockBase}/yarn.lock
@@ -55,6 +56,7 @@ packages:
       - components/licensor/typescript:lib
       - components/ws-manager-api/typescript:lib
       - components/supervisor-api/typescript-grpcweb:lib
+      - components/usage-api/typescript:lib
       - :dbtest
     config:
       packaging: library
@@ -80,6 +82,7 @@ packages:
       - components/licensor/typescript:lib
       - components/ws-manager-api/typescript:lib
       - components/supervisor-api/typescript-grpcweb:lib
+      - components/usage-api/typescript:lib
     config:
       packaging: library
       yarnLock: ${coreYarnLockBase}/yarn.lock

components/server/ee/src/workspace/gitpod-server-impl.ts

@@ -46,6 +46,7 @@ import {
     FindPrebuildsParams,
     TeamMemberRole,
     WORKSPACE_TIMEOUT_DEFAULT_SHORT,
+    WorkspaceType,
 } from "@gitpod/gitpod-protocol";
 import { ResponseError } from "vscode-jsonrpc";
 import {
@@ -70,7 +71,7 @@ import { BlockedRepository } from "@gitpod/gitpod-protocol/lib/blocked-repositor
 import { EligibilityService } from "../user/eligibility-service";
 import { AccountStatementProvider } from "../user/account-statement-provider";
 import { GithubUpgradeURL, PlanCoupon } from "@gitpod/gitpod-protocol/lib/payment-protocol";
-import { BillableSession, billableSessionDummyData } from "@gitpod/gitpod-protocol/lib/usage";
+import { BillableSession } from "@gitpod/gitpod-protocol/lib/usage";
 import {
     AssigneeIdentityIdentifier,
     TeamSubscription,
@@ -106,6 +107,8 @@ import { URL } from "url";
 import { UserCounter } from "../user/user-counter";
 import { getExperimentsClientForBackend } from "@gitpod/gitpod-protocol/lib/experiments/configcat-server";
 import { AttributionId } from "@gitpod/gitpod-protocol/lib/attribution";
+import { CachingUsageServiceClientProvider } from "@gitpod/usage-api/lib/usage/v1/sugar";
+import * as usage from "@gitpod/usage-api/lib/usage/v1/usage_pb";
 
 @injectable()
 export class GitpodServerEEImpl extends GitpodServerImpl {
@@ -145,6 +148,9 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
 
     @inject(UserService) protected readonly userService: UserService;
 
+    @inject(CachingUsageServiceClientProvider)
+    protected readonly usageServiceClientProvider: CachingUsageServiceClientProvider;
+
     initialize(
         client: GitpodClient | undefined,
         user: User | undefined,
@@ -2064,7 +2070,11 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
 
         await this.guardCostCenterAccess(ctx, user.id, attributionId, "get");
 
-        return billableSessionDummyData;
+        const usageClient = this.usageServiceClientProvider.getDefault();
+        const response = await usageClient.getBilledUsage(ctx, attributionId);
+        const sessions = response.getSessionsList().map((s) => this.mapBilledSession(s));
+
+        return sessions;
     }
 
     protected async guardCostCenterAccess(
@@ -2102,6 +2112,29 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
 
         await this.guardAccess({ kind: "costCenter", /*subject: costCenter,*/ owner }, operation);
     }
+
+    protected mapBilledSession(s: usage.BilledSession): BillableSession {
+        function mandatory<T>(s: T, m: (s: T) => string = (s) => "" + s): string {
+            if (!s) {
+                throw new Error("empty value in usage.BilledSession");
+            }
+            return m(s);
+        }
+        return {
+            attributionId: mandatory(s.getAttributionId()),
+            userId: s.getUserId() || undefined,
+            teamId: s.getTeamId() || undefined,
+            projectId: s.getProjectId() || undefined,
+            workspaceId: mandatory(s.getWorkspaceId()),
+            instanceId: mandatory(s.getInstanceId()),
+            workspaceType: mandatory(s.getWorkspaceType()) as WorkspaceType,
+            workspaceClass: mandatory(s.getWorkspaceClass()),
+            startTime: mandatory(s.getStartTime(), (t) => t!.toDate().toISOString()),
+            endTime: mandatory(s.getEndTime(), (t) => t!.toDate().toISOString()),
+            credits: s.getCredits(), // optional
+        };
+    }
+
     // (SaaS) – admin
     async adminGetAccountStatement(ctx: TraceContext, userId: string): Promise<AccountStatement> {
         traceAPIParams(ctx, { userId });

components/server/package.json

@@ -36,6 +36,7 @@
     "@gitpod/image-builder": "0.1.5",
     "@gitpod/licensor": "0.1.5",
     "@gitpod/supervisor-api-grpcweb": "0.1.5",
+    "@gitpod/usage-api": "0.1.5",
     "@gitpod/ws-manager": "0.1.5",
     "@google-cloud/storage": "^5.6.0",
     "@improbable-eng/grpc-web-node-http-transport": "^0.14.0",

components/server/src/config.ts

@@ -149,6 +149,12 @@ export interface ConfigSerialized {
      */
     imageBuilderAddr: string;
 
+    /**
+     * The address usage service clients connect to
+     * Example: usage:8080
+     */
+    usageServiceAddr: string;
+
     codeSync: CodeSyncConfig;
 
     vsxRegistryUrl: string;

components/server/src/container-module.ts

@@ -100,6 +100,12 @@ import { InstallationAdminTelemetryDataProvider } from "./installation-admin/tel
 import { IDEService } from "./ide-service";
 import { LicenseEvaluator } from "@gitpod/licensor/lib";
 import { WorkspaceClusterImagebuilderClientProvider } from "./workspace/workspace-cluster-imagebuilder-client-provider";
+import {
+    CachingUsageServiceClientProvider,
+    UsageServiceClientCallMetrics,
+    UsageServiceClientConfig,
+    UsageServiceClientProvider,
+} from "@gitpod/usage-api/lib/usage/v1/sugar";
 
 export const productionContainerModule = new ContainerModule((bind, unbind, isBound, rebind) => {
     bind(Config).toConstantValue(ConfigFile.fromFile());
@@ -247,4 +253,12 @@ export const productionContainerModule = new ContainerModule((bind, unbind, isBo
     bind(ProjectsService).toSelf().inSingletonScope();
 
     bind(NewsletterSubscriptionController).toSelf().inSingletonScope();
+
+    bind(UsageServiceClientConfig).toDynamicValue((ctx) => {
+        const config = ctx.container.get<Config>(Config);
+        return { address: config.usageServiceAddr };
+    });
+    bind(CachingUsageServiceClientProvider).toSelf().inSingletonScope();
+    bind(UsageServiceClientProvider).toService(CachingImageBuilderClientProvider);
+    bind(UsageServiceClientCallMetrics).toService(IClientCallMetrics);
 });

install/installer/pkg/components/server/configmap.go

@@ -9,6 +9,7 @@ import (
 	"regexp"
 
 	"github.com/gitpod-io/gitpod/installer/pkg/common"
+	"github.com/gitpod-io/gitpod/installer/pkg/components/usage"
 	"github.com/gitpod-io/gitpod/installer/pkg/components/workspace"
 	"github.com/gitpod-io/gitpod/installer/pkg/config/v1/experimental"
 	corev1 "k8s.io/api/core/v1"
@@ -222,6 +223,7 @@ func configmap(ctx *common.RenderContext) ([]runtime.Object, error) {
 		},
 		ContentServiceAddr:           "content-service:8080",
 		ImageBuilderAddr:             "image-builder-mk3:8080",
+		UsageServiceAddr:             fmt.Sprintf("%s:%d", usage.Component, usage.GRPCServicePort),
 		CodeSync:                     CodeSync{},
 		VSXRegistryUrl:               fmt.Sprintf("https://open-vsx.%s", ctx.Config.Domain), // todo(sje): or "https://{{ .Values.vsxRegistry.host | default "open-vsx.org" }}" if not using OpenVSX proxy
 		EnablePayment:                chargebeeSecret != "" || stripeSecret != "" || stripeConfig != "",

install/installer/pkg/components/server/types.go

@@ -30,6 +30,7 @@ type ConfigSerialized struct {
 	RunDbDeleter                      bool     `json:"runDbDeleter"`
 	ContentServiceAddr                string   `json:"contentServiceAddr"`
 	ImageBuilderAddr                  string   `json:"imageBuilderAddr"`
+	UsageServiceAddr                  string   `json:"usageServiceAddr"`
 	VSXRegistryUrl                    string   `json:"vsxRegistryUrl"`
 	ChargebeeProviderOptionsFile      string   `json:"chargebeeProviderOptionsFile"`
 	StripeSecretsFile                 string   `json:"stripeSecretsFile"`

install/installer/pkg/components/usage/constants.go

@@ -8,7 +8,7 @@ const (
 	Component             = "usage"
 	gRPCContainerPort     = 9001
 	gRPCPortName          = "grpc"
-	gRPCServicePort       = 9001
+	GRPCServicePort       = 9001
 	stripeSecretMountPath = "stripe-secret"
 	stripeKeyFilename     = "apikeys"
 	configJSONFilename    = "config.json"

install/installer/pkg/components/usage/service.go

@@ -13,7 +13,7 @@ func service(ctx *common.RenderContext) ([]runtime.Object, error) {
 		{
 			Name:          gRPCPortName,
 			ContainerPort: gRPCContainerPort,
-			ServicePort:   gRPCServicePort,
+			ServicePort:   GRPCServicePort,
 		},
 	})(ctx)
 }