Skip to content

BillingMode: add Json RPC API methods (2/4) #11813

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.

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
Aug 5, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions components/gitpod-protocol/src/gitpod-service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ import { InstallationAdminSettings, TelemetryData } from "./installation-admin-p
import { Currency } from "./plans";
import { BillableSession, BillableSessionRequest } from "./usage";
import { SupportedWorkspaceClass } from "./workspace-class";
import { BillingMode } from "./billing-mode";

export interface GitpodClient {
onInstanceUpdate(instance: WorkspaceInstance): void;
Expand Down Expand Up @@ -298,6 +299,9 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,

setUsageAttribution(usageAttribution: string): Promise<void>;

getBillingModeForUser(): Promise<BillingMode>;
getBillingModeForTeam(teamId: string): Promise<BillingMode>;

/**
* Analytics
*/
Expand Down
24 changes: 22 additions & 2 deletions components/server/ee/src/workspace/gitpod-server-impl.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

import { injectable, inject } from "inversify";
import { GitpodServerImpl, traceAPIParams, traceWI, censor } from "../../../src/workspace/gitpod-server-impl";
import { TraceContext } from "@gitpod/gitpod-protocol/lib/util/tracing";
import { TraceContext, TraceContextWithSpan } from "@gitpod/gitpod-protocol/lib/util/tracing";
import {
GitpodServer,
GitpodClient,
Expand Down Expand Up @@ -106,12 +106,14 @@ import { ClientMetadata, traceClientMetadata } from "../../../src/websocket/webs
import { BitbucketAppSupport } from "../bitbucket/bitbucket-app-support";
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";
import { Timestamp } from "google-protobuf/google/protobuf/timestamp_pb";
import { EntitlementService } 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";

@injectable()
export class GitpodServerEEImpl extends GitpodServerImpl {
Expand Down Expand Up @@ -157,6 +159,8 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
@inject(CostCenterDB) protected readonly costCenterDB: CostCenterDB;
@inject(EntitlementService) protected readonly entitlementService: EntitlementService;

@inject(BillingModes) protected readonly billingModes: BillingModes;

initialize(
client: GitpodClient | undefined,
user: User | undefined,
Expand Down Expand Up @@ -2190,6 +2194,22 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
};
}

async getBillingModeForUser(ctx: TraceContextWithSpan): Promise<BillingMode> {
traceAPIParams(ctx, {});

const user = this.checkUser("getBillingModeForUser");
return this.billingModes.getBillingModeForUser(user, new Date());
}

async getBillingModeForTeam(ctx: TraceContextWithSpan, teamId: string): Promise<BillingMode> {
traceAPIParams(ctx, { teamId });

this.checkAndBlockUser("getBillingModeForTeam");
const team = await this.guardTeamOperation(teamId, "get");

return this.billingModes.getBillingModeForTeam(team, new Date());
}

// (SaaS) – admin
async adminGetAccountStatement(ctx: TraceContext, userId: string): Promise<AccountStatement> {
traceAPIParams(ctx, { userId });
Expand Down
3 changes: 3 additions & 0 deletions components/server/src/auth/rate-limiter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,9 @@ function getConfig(config: RateLimiterConfig): RateLimiterConfig {
subscribeTeamToStripe: { group: "default", points: 1 },
getStripePortalUrlForTeam: { group: "default", points: 1 },
listBilledUsage: { group: "default", points: 1 },
getBillingModeForTeam: { group: "default", points: 1 },
getBillingModeForUser: { group: "default", points: 1 },

trackEvent: { group: "default", points: 1 },
trackLocation: { group: "default", points: 1 },
identifyUser: { group: "default", points: 1 },
Expand Down
22 changes: 20 additions & 2 deletions components/server/src/workspace/gitpod-server-impl.ts
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,11 @@ import {
} from "@gitpod/gitpod-protocol/lib/team-subscription-protocol";
import { Cancelable } from "@gitpod/gitpod-protocol/lib/util/cancelable";
import { log, LogContext } from "@gitpod/gitpod-protocol/lib/util/logging";
import { InterfaceWithTraceContext, TraceContext } from "@gitpod/gitpod-protocol/lib/util/tracing";
import {
InterfaceWithTraceContext,
TraceContext,
TraceContextWithSpan,
} from "@gitpod/gitpod-protocol/lib/util/tracing";
import {
IdentifyMessage,
RemoteIdentifyMessage,
Expand Down Expand Up @@ -171,6 +175,7 @@ import { Currency } from "@gitpod/gitpod-protocol/lib/plans";
import { getExperimentsClientForBackend } from "@gitpod/gitpod-protocol/lib/experiments/configcat-server";
import { BillableSession, BillableSessionRequest } from "@gitpod/gitpod-protocol/lib/usage";
import { WorkspaceClusterImagebuilderClientProvider } from "./workspace-cluster-imagebuilder-client-provider";
import { BillingMode } from "@gitpod/gitpod-protocol/lib/billing-mode";

// shortcut
export const traceWI = (ctx: TraceContext, wi: Omit<LogContext, "userId">) => TraceContext.setOWI(ctx, wi); // userId is already taken care of in WebsocketConnectionManager
Expand Down Expand Up @@ -2056,13 +2061,14 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
return await this.projectsService.getProjectEnvironmentVariables(projectId);
}

protected async guardTeamOperation(teamId: string | undefined, op: ResourceAccessOp): Promise<void> {
protected async guardTeamOperation(teamId: string | undefined, op: ResourceAccessOp): Promise<Team> {
const team = await this.teamDB.findTeamById(teamId || "");
if (!team) {
throw new ResponseError(ErrorCodes.NOT_FOUND, "Team not found");
}
const members = await this.teamDB.findMembersByTeam(team.id);
await this.guardAccess({ kind: "team", subject: team, members }, op);
return team;
}

public async getTeams(ctx: TraceContext): Promise<Team[]> {
Expand Down Expand Up @@ -3227,6 +3233,18 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
}
}

async getBillingModeForUser(ctx: TraceContextWithSpan): Promise<BillingMode> {
traceAPIParams(ctx, {});

return BillingMode.NONE;
}

async getBillingModeForTeam(ctx: TraceContextWithSpan, teamId: string): Promise<BillingMode> {
traceAPIParams(ctx, { teamId });

return BillingMode.NONE;
}

//
//#endregion

Expand Down