Skip to content

[usage-api] Use better typescript generator #12903

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 13, 2022
Merged

[usage-api] Use better typescript generator #12903

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 14 additions & 18 deletions components/server/ee/src/billing/billing-service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,8 @@
import { User } from "@gitpod/gitpod-protocol";
import { AttributionId } from "@gitpod/gitpod-protocol/lib/attribution";
import { log } from "@gitpod/gitpod-protocol/lib/util/logging";
import { GetUpcomingInvoiceResponse } from "@gitpod/usage-api/lib/usage/v1/billing_pb";
import {
CachingUsageServiceClientProvider,
CachingBillingServiceClientProvider,
} from "@gitpod/usage-api/lib/usage/v1/sugar";
import { BillingServiceClient, BillingServiceDefinition } from "@gitpod/usage-api/lib/usage/v1/billing.pb";
import { UsageServiceClient, UsageServiceDefinition } from "@gitpod/usage-api/lib/usage/v1/usage.pb";
import { inject, injectable } from "inversify";
import { UserService } from "../../../src/user/user-service";

Expand All @@ -24,14 +21,18 @@ export interface UsageLimitReachedResult {
@injectable()
export class BillingService {
@inject(UserService) protected readonly userService: UserService;
@inject(CachingUsageServiceClientProvider)
protected readonly usageServiceClientProvider: CachingUsageServiceClientProvider;
@inject(CachingBillingServiceClientProvider)
protected readonly billingServiceClientProvider: CachingBillingServiceClientProvider;
@inject(UsageServiceDefinition.name)
protected readonly usageService: UsageServiceClient;
@inject(BillingServiceDefinition.name)
protected readonly billingService: BillingServiceClient;

async checkUsageLimitReached(user: User): Promise<UsageLimitReachedResult> {
const attributionId = await this.userService.getWorkspaceUsageAttributionId(user);
const costCenter = await this.usageServiceClientProvider.getDefault().getCostCenter(attributionId);
const costCenter = (
await this.usageService.getCostCenter({
attributionId: AttributionId.render(attributionId),
})
).costCenter;
if (!costCenter) {
const err = new Error("No CostCenter found");
log.error({ userId: user.id }, err.message, err, { attributionId });
Expand All @@ -42,9 +43,9 @@ export class BillingService {
};
}

const upcomingInvoice = await this.getUpcomingInvoice(attributionId);
const currentInvoiceCredits = upcomingInvoice.getCredits();
if (currentInvoiceCredits >= costCenter.spendingLimit) {
const upcomingInvoice = await this.billingService.getUpcomingInvoice(attributionId);
const currentInvoiceCredits = upcomingInvoice.credits | 0;
if (currentInvoiceCredits >= (costCenter.spendingLimit || 0)) {
log.info({ userId: user.id }, "Usage limit reached", {
attributionId,
currentInvoiceCredits,
Expand Down Expand Up @@ -72,9 +73,4 @@ export class BillingService {
attributionId,
};
}

async getUpcomingInvoice(attributionId: AttributionId): Promise<GetUpcomingInvoiceResponse> {
const response = await this.billingServiceClientProvider.getDefault().getUpcomingInvoice(attributionId);
return response;
}
}
117 changes: 60 additions & 57 deletions components/server/ee/src/workspace/gitpod-server-impl.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,12 @@ import { EligibilityService } from "../user/eligibility-service";
import { AccountStatementProvider } from "../user/account-statement-provider";
import { GithubUpgradeURL, PlanCoupon } from "@gitpod/gitpod-protocol/lib/payment-protocol";
import { ListUsageRequest, ListUsageResponse } from "@gitpod/gitpod-protocol/lib/usage";
import * as usage_grpc from "@gitpod/usage-api/lib/usage/v1/usage_pb";
import {
CostCenter_BillingStrategy,
ListUsageRequest_Ordering,
UsageServiceClient,
Usage_Kind,
} from "@gitpod/usage-api/lib/usage/v1/usage.pb";
import {
AssigneeIdentityIdentifier,
TeamSubscription,
Expand Down Expand Up @@ -107,14 +112,13 @@ import { BitbucketAppSupport } from "../bitbucket/bitbucket-app-support";
import { URL } from "url";
import { UserCounter } from "../user/user-counter";
import { AttributionId } from "@gitpod/gitpod-protocol/lib/attribution";
import { CachingUsageServiceClientProvider } from "@gitpod/usage-api/lib/usage/v1/sugar";
import { Timestamp } from "google-protobuf/google/protobuf/timestamp_pb";
import { EntitlementService, MayStartWorkspaceResult } from "../../../src/billing/entitlement-service";
import { BillingMode } from "@gitpod/gitpod-protocol/lib/billing-mode";
import { BillingModes } from "../billing/billing-mode";
import { getExperimentsClientForBackend } from "@gitpod/gitpod-protocol/lib/experiments/configcat-server";
import { BillingService } from "../billing/billing-service";
import Stripe from "stripe";
import { UsageServiceDefinition } from "@gitpod/usage-api/lib/usage/v1/usage.pb";

@injectable()
export class GitpodServerEEImpl extends GitpodServerImpl {
Expand Down Expand Up @@ -154,8 +158,8 @@ export class GitpodServerEEImpl extends GitpodServerImpl {

@inject(UserService) protected readonly userService: UserService;

@inject(CachingUsageServiceClientProvider)
protected readonly usageServiceClientProvider: CachingUsageServiceClientProvider;
@inject(UsageServiceDefinition.name)
protected readonly usageService: UsageServiceClient;

@inject(EntitlementService) protected readonly entitlementService: EntitlementService;

Expand Down Expand Up @@ -2149,10 +2153,14 @@ export class GitpodServerEEImpl extends GitpodServerImpl {

await this.stripeService.setDefaultPaymentMethodForCustomer(customer, setupIntentId);
await this.stripeService.createSubscriptionForCustomer(customer);
await this.usageServiceClientProvider.getDefault().setCostCenter({
id: attrId,
spendingLimit: this.defaultSpendingLimit,
billingStrategy: "stripe",

// Creating a cost center for this team
await this.usageService.setCostCenter({
costCenter: {
attributionId: attributionId,
spendingLimit: this.defaultSpendingLimit,
billingStrategy: CostCenter_BillingStrategy.BILLING_STRATEGY_STRIPE,
},
});
} catch (error) {
log.error(`Failed to subscribe '${attributionId}' to Stripe`, error);
Expand Down Expand Up @@ -2218,9 +2226,11 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
const attributionId: AttributionId = { kind: "team", teamId };
await this.guardCostCenterAccess(ctx, user.id, attributionId, "get");

const costCenter = await this.usageServiceClientProvider.getDefault().getCostCenter(attributionId);
if (costCenter) {
return costCenter.spendingLimit;
const costCenter = await this.usageService.getCostCenter({
attributionId: AttributionId.render(attributionId),
});
if (costCenter?.costCenter) {
return costCenter.costCenter.spendingLimit;
}
return undefined;
}
Expand All @@ -2232,14 +2242,17 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
if (typeof usageLimit !== "number" || usageLimit < 0) {
throw new ResponseError(ErrorCodes.BAD_REQUEST, "Unexpected `usageLimit` value.");
}
const attributionId: AttributionId = { kind: "team", teamId };
await this.guardCostCenterAccess(ctx, user.id, attributionId, "update");

const costCenter = await this.usageServiceClientProvider.getDefault().getCostCenter(attributionId);
await this.usageServiceClientProvider.getDefault().setCostCenter({
id: attributionId,
spendingLimit: usageLimit,
billingStrategy: costCenter?.billingStrategy || "other",
const attrId: AttributionId = { kind: "team", teamId };
await this.guardCostCenterAccess(ctx, user.id, attrId, "update");
const attributionId = AttributionId.render(attrId);
const costCenter = await this.usageService.getCostCenter({ attributionId });
await this.usageService.setCostCenter({
costCenter: {
attributionId,
spendingLimit: usageLimit,
billingStrategy:
costCenter?.costCenter?.billingStrategy || CostCenter_BillingStrategy.BILLING_STRATEGY_OTHER,
},
});
}

Expand Down Expand Up @@ -2271,50 +2284,40 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
const user = this.checkAndBlockUser("listUsage");
await this.guardCostCenterAccess(ctx, user.id, attributionId, "get");

const timestampFrom = from ? Timestamp.fromDate(new Date(from)) : undefined;
const timestampTo = to ? Timestamp.fromDate(new Date(to)) : undefined;

const usageClient = this.usageServiceClientProvider.getDefault();
const request = new usage_grpc.ListUsageRequest();
request.setAttributionId(AttributionId.render(attributionId));
request.setFrom(timestampFrom);
if (to) {
request.setTo(timestampTo);
}
request.setOrder(req.order);
if (req.pagination) {
const paginatedRequest = new usage_grpc.PaginatedRequest();
paginatedRequest.setPage(req.pagination.page);
paginatedRequest.setPerPage(req.pagination.perPage);
request.setPagination(paginatedRequest);
}
const response = await usageClient.listUsage(ctx, request);
const pagination = response.getPagination();
const response = await this.usageService.listUsage({
attributionId: AttributionId.render(attributionId),
from: from ? new Date(from) : undefined,
to: to ? new Date(to) : undefined,
order: ListUsageRequest_Ordering.ORDERING_DESCENDING,
pagination: {
page: req.pagination?.page,
perPage: req.pagination?.perPage,
},
});
return {
usageEntriesList: response.getUsageEntriesList().map((u) => {
usageEntriesList: response.usageEntries.map((u) => {
return {
id: u.getId(),
attributionId: u.getAttributionId(),
effectiveTime: u.getEffectiveTime()!.toDate().getTime(),
credits: u.getCredits(),
description: u.getDescription(),
draft: u.getDraft(),
workspaceInstanceId: u.getWorkspaceInstanceId(),
kind:
u.getKind() === usage_grpc.Usage.Kind.KIND_WORKSPACE_INSTANCE ? "workspaceinstance" : "invoice",
metadata: JSON.parse(u.getMetadata()),
id: u.id,
attributionId: u.attributionId,
effectiveTime: u.effectiveTime && u.effectiveTime.getTime(),
credits: u.credits,
description: u.description,
draft: u.draft,
workspaceInstanceId: u.workspaceInstanceId,
kind: u.kind === Usage_Kind.KIND_WORKSPACE_INSTANCE ? "workspaceinstance" : "invoice",
metadata: JSON.parse(u.metadata),
};
}),
pagination: pagination
pagination: response.pagination
? {
page: pagination.getPage(),
perPage: pagination.getPerPage(),
total: pagination.getTotal(),
totalPages: pagination.getTotalPages(),
page: response.pagination.page,
perPage: response.pagination.perPage,
total: response.pagination.total,
totalPages: response.pagination.totalPages,
}
: undefined,
creditBalanceAtEnd: response.getCreditBalanceAtEnd(),
creditBalanceAtStart: response.getCreditBalanceAtStart(),
creditBalanceAtEnd: response.creditBalanceAtEnd,
creditBalanceAtStart: response.creditBalanceAtStart,
};
}

Expand Down
25 changes: 7 additions & 18 deletions components/server/src/container-module.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,15 +100,9 @@ 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,
CachingBillingServiceClientProvider,
UsageServiceClientCallMetrics,
UsageServiceClientConfig,
UsageServiceClientProvider,
BillingServiceClientCallMetrics,
BillingServiceClientConfig,
} from "@gitpod/usage-api/lib/usage/v1/sugar";
import { UsageServiceClient, UsageServiceDefinition } from "@gitpod/usage-api/lib/usage/v1/usage.pb";
import { BillingServiceClient, BillingServiceDefinition } from "@gitpod/usage-api/lib/usage/v1/billing.pb";
import { createChannel, createClient } from "nice-grpc";
import { CommunityEntitlementService, EntitlementService } from "./billing/entitlement-service";
import {
ConfigCatClientFactory,
Expand Down Expand Up @@ -264,19 +258,14 @@ export const productionContainerModule = new ContainerModule((bind, unbind, isBo

bind(NewsletterSubscriptionController).toSelf().inSingletonScope();

bind(UsageServiceClientConfig).toDynamicValue((ctx) => {
bind<UsageServiceClient>(UsageServiceDefinition.name).toDynamicValue((ctx) => {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@svenefftinge, shouldn't that be bound in singleton scope?

Asking, because of that one of the changes being introduced/deployed after which we see a severe memory leak.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I think it can be in singleton scope as well. But if this increases leakage it could be there are other components that leak as well and hold references to these instances.

const config = ctx.container.get<Config>(Config);
return { address: config.usageServiceAddr };
return createClient(UsageServiceDefinition, createChannel(config.usageServiceAddr));
});
bind(CachingUsageServiceClientProvider).toSelf().inSingletonScope();
bind(UsageServiceClientProvider).toService(CachingImageBuilderClientProvider);
bind(UsageServiceClientCallMetrics).toService(IClientCallMetrics);

bind(CachingBillingServiceClientProvider).toSelf().inSingletonScope();
bind(BillingServiceClientCallMetrics).toService(IClientCallMetrics);
bind(BillingServiceClientConfig).toDynamicValue((ctx) => {
bind<BillingServiceClient>(BillingServiceDefinition.name).toDynamicValue((ctx) => {
const config = ctx.container.get<Config>(Config);
return { address: config.usageServiceAddr };
return createClient(BillingServiceDefinition, createChannel(config.usageServiceAddr));
});

bind(EntitlementService).to(CommunityEntitlementService).inSingletonScope();
Expand Down
16 changes: 8 additions & 8 deletions components/server/src/workspace/workspace-starter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,10 +125,8 @@ import { WorkspaceClasses, WorkspaceClassesConfig } from "./workspace-classes";
import { EntitlementService } from "../billing/entitlement-service";
import { BillingModes } from "../../ee/src/billing/billing-mode";
import { AttributionId } from "@gitpod/gitpod-protocol/lib/attribution";
import { CachingBillingServiceClientProvider } from "@gitpod/usage-api/lib/usage/v1/sugar";
import { Timestamp } from "google-protobuf/google/protobuf/timestamp_pb";
import { BillingServiceClient, BillingServiceDefinition, System } from "@gitpod/usage-api/lib/usage/v1/billing.pb";
import { BillingMode } from "@gitpod/gitpod-protocol/lib/billing-mode";
import { System } from "@gitpod/usage-api/lib/usage/v1/billing_pb";
import { LogContext } from "@gitpod/gitpod-protocol/lib/util/logging";

export interface StartWorkspaceOptions {
Expand Down Expand Up @@ -283,8 +281,8 @@ export class WorkspaceStarter {
@inject(TeamDB) protected readonly teamDB: TeamDB;
@inject(EntitlementService) protected readonly entitlementService: EntitlementService;
@inject(BillingModes) protected readonly billingModes: BillingModes;
@inject(CachingBillingServiceClientProvider)
protected readonly billingServiceClientProvider: CachingBillingServiceClientProvider;
@inject(BillingServiceDefinition.name)
protected readonly billingService: BillingServiceClient;

public async startWorkspace(
ctx: TraceContext,
Expand Down Expand Up @@ -554,13 +552,15 @@ export class WorkspaceStarter {

if (instance.usageAttributionId) {
const creationTime = new Date(instance.creationTime);
const timestamped = Timestamp.fromDate(creationTime);
const parsedAttributionId = AttributionId.parse(instance.usageAttributionId);
if (parsedAttributionId) {
const billingMode = await this.billingModes.getBillingMode(parsedAttributionId, creationTime);
if (billingMode && billingMode.mode === "chargebee") {
const billingClient = this.billingServiceClientProvider.getDefault();
await billingClient.setBilledSession(instance.id, timestamped, System.SYSTEM_CHARGEBEE);
await this.billingService.setBilledSession({
instanceId: instance.id,
from: creationTime,
system: System.SYSTEM_CHARGEBEE,
});
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion components/usage-api/generate.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@ go_protoc "$COMPONENTS_DIR" "usage/v1"
mkdir -p go/v1
mv go/usage/v1/*.pb.go go/v1
rm -rf go/usage
typescript_protoc "$COMPONENTS_DIR" "usage/v1"
typescript_ts_protoc "$COMPONENTS_DIR" "usage/v1"

update_license
21 changes: 8 additions & 13 deletions components/usage-api/typescript/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,19 @@
"lib"
],
"scripts": {
"build": "mkdir -p lib; tsc && cp -fR src/* lib",
"watch": "leeway exec --package .:lib --transitive-dependencies --filter-type yarn --components --parallel -- tsc -w --preserveWatchOutput",
"test": "mocha --opts mocha.opts './**/*.spec.ts' --exclude './node_modules/**'",
"test:brk": "yarn test --inspect-brk"
"build": "mkdir -p lib; tsc",
"watch": "leeway exec --package .:lib --transitive-dependencies --filter-type yarn --components --parallel -- tsc -w --preserveWatchOutput"
},
"overrides": {
"long": "4.0.0"
},
"dependencies": {
"@gitpod/gitpod-protocol": "0.1.5",
"@grpc/grpc-js": "^1.3.7",
"google-protobuf": "^3.19.1",
"opentracing": "^0.14.4"
"long": "4.0.0",
"nice-grpc": "^2.0.0",
"ts-proto": "^1.125.0"
},
"devDependencies": {
"@testdeck/mocha": "0.1.2",
"@types/chai": "^4.1.2",
"@types/google-protobuf": "^3.15.5",
"@types/node": "^16.11.0",
"grpc-tools": "^1.11.2",
"grpc_tools_node_protoc_ts": "^5.3.2",
"typescript": "~4.4.2",
"typescript-formatter": "^7.2.2"
}
Expand Down
Loading