Skip to content

[usage] Introduce GetBalance API #13214

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 23, 2022
Merged

[usage] Introduce GetBalance API #13214

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
7 changes: 2 additions & 5 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 @@ -40,13 +40,10 @@ export class BillingService {
};
}

const now = new Date();
const currentBalance = await this.usageService.listUsage({
const getBalanceResponse = await this.usageService.getBalance({
attributionId: AttributionId.render(attributionId),
from: now,
to: now,
});
const currentInvoiceCredits = currentBalance.creditBalanceAtEnd | 0;
const currentInvoiceCredits = getBalanceResponse.credits;
if (currentInvoiceCredits >= (costCenter.spendingLimit || 0)) {
log.info({ userId: user.id }, "Usage limit reached", {
attributionId,
Expand Down
305 changes: 219 additions & 86 deletions components/usage-api/go/v1/usage.pb.go
View file
Open in desktop

Large diffs are not rendered by default.

38 changes: 38 additions & 0 deletions components/usage-api/go/v1/usage_grpc.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

121 changes: 121 additions & 0 deletions components/usage-api/typescript/src/usage/v1/usage.pb.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,14 @@ export interface SetCostCenterRequest {
export interface SetCostCenterResponse {
}

export interface GetBalanceRequest {
attributionId: string;
}

export interface GetBalanceResponse {
credits: number;
}

export interface GetCostCenterRequest {
attributionId: string;
}
Expand Down Expand Up @@ -865,6 +873,100 @@ export const SetCostCenterResponse = {
},
};

function createBaseGetBalanceRequest(): GetBalanceRequest {
return { attributionId: "" };
}

export const GetBalanceRequest = {
encode(message: GetBalanceRequest, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
if (message.attributionId !== "") {
writer.uint32(10).string(message.attributionId);
}
return writer;
},

decode(input: _m0.Reader | Uint8Array, length?: number): GetBalanceRequest {
const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
let end = length === undefined ? reader.len : reader.pos + length;
const message = createBaseGetBalanceRequest();
while (reader.pos < end) {
const tag = reader.uint32();
switch (tag >>> 3) {
case 1:
message.attributionId = reader.string();
break;
default:
reader.skipType(tag & 7);
break;
}
}
return message;
},

fromJSON(object: any): GetBalanceRequest {
return { attributionId: isSet(object.attributionId) ? String(object.attributionId) : "" };
},

toJSON(message: GetBalanceRequest): unknown {
const obj: any = {};
message.attributionId !== undefined && (obj.attributionId = message.attributionId);
return obj;
},

fromPartial(object: DeepPartial<GetBalanceRequest>): GetBalanceRequest {
const message = createBaseGetBalanceRequest();
message.attributionId = object.attributionId ?? "";
return message;
},
};

function createBaseGetBalanceResponse(): GetBalanceResponse {
return { credits: 0 };
}

export const GetBalanceResponse = {
encode(message: GetBalanceResponse, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
if (message.credits !== 0) {
writer.uint32(33).double(message.credits);
}
return writer;
},

decode(input: _m0.Reader | Uint8Array, length?: number): GetBalanceResponse {
const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
let end = length === undefined ? reader.len : reader.pos + length;
const message = createBaseGetBalanceResponse();
while (reader.pos < end) {
const tag = reader.uint32();
switch (tag >>> 3) {
case 4:
message.credits = reader.double();
break;
default:
reader.skipType(tag & 7);
break;
}
}
return message;
},

fromJSON(object: any): GetBalanceResponse {
return { credits: isSet(object.credits) ? Number(object.credits) : 0 };
},

toJSON(message: GetBalanceResponse): unknown {
const obj: any = {};
message.credits !== undefined && (obj.credits = message.credits);
return obj;
},

fromPartial(object: DeepPartial<GetBalanceResponse>): GetBalanceResponse {
const message = createBaseGetBalanceResponse();
message.credits = object.credits ?? 0;
return message;
},
};

function createBaseGetCostCenterRequest(): GetCostCenterRequest {
return { attributionId: "" };
}
Expand Down Expand Up @@ -1087,6 +1189,15 @@ export const UsageServiceDefinition = {
responseStream: false,
options: {},
},
/** GetBalance returns the current credits balance for the given attributionId */
getBalance: {
name: "GetBalance",
requestType: GetBalanceRequest,
requestStream: false,
responseType: GetBalanceResponse,
responseStream: false,
options: {},
},
},
} as const;

Expand All @@ -1108,6 +1219,11 @@ export interface UsageServiceServiceImplementation<CallContextExt = {}> {
): Promise<DeepPartial<ReconcileUsageResponse>>;
/** ListUsage retrieves all usage for the specified attributionId and theb given time range */
listUsage(request: ListUsageRequest, context: CallContext & CallContextExt): Promise<DeepPartial<ListUsageResponse>>;
/** GetBalance returns the current credits balance for the given attributionId */
getBalance(
request: GetBalanceRequest,
context: CallContext & CallContextExt,
): Promise<DeepPartial<GetBalanceResponse>>;
}

export interface UsageServiceClient<CallOptionsExt = {}> {
Expand All @@ -1128,6 +1244,11 @@ export interface UsageServiceClient<CallOptionsExt = {}> {
): Promise<ReconcileUsageResponse>;
/** ListUsage retrieves all usage for the specified attributionId and theb given time range */
listUsage(request: DeepPartial<ListUsageRequest>, options?: CallOptions & CallOptionsExt): Promise<ListUsageResponse>;
/** GetBalance returns the current credits balance for the given attributionId */
getBalance(
request: DeepPartial<GetBalanceRequest>,
options?: CallOptions & CallOptionsExt,
): Promise<GetBalanceResponse>;
}

export interface DataLoaderOptions {
Expand Down
11 changes: 11 additions & 0 deletions components/usage-api/usage/v1/usage.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ service UsageService {

// ListUsage retrieves all usage for the specified attributionId and theb given time range
rpc ListUsage(ListUsageRequest) returns (ListUsageResponse) {}

// GetBalance returns the current credits balance for the given attributionId
rpc GetBalance(GetBalanceRequest) returns (GetBalanceResponse) {}
}

message ReconcileUsageRequest {
Expand Down Expand Up @@ -98,6 +101,14 @@ message SetCostCenterRequest {
message SetCostCenterResponse {
}

message GetBalanceRequest {
string attribution_id = 1;
}

message GetBalanceResponse {
double credits = 4;
}

message GetCostCenterRequest {
string attribution_id = 1;
}
Expand Down
14 changes: 14 additions & 0 deletions components/usage/pkg/apiv1/usage.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,20 @@ func (s *UsageService) ListUsage(ctx context.Context, in *v1.ListUsageRequest) (
}, nil
}

func (s *UsageService) GetBalance(ctx context.Context, in *v1.GetBalanceRequest) (*v1.GetBalanceResponse, error) {
attrId, err := db.ParseAttributionID(in.AttributionId)
if err != nil {
return nil, err
}
credits, err := db.GetBalance(ctx, s.conn, attrId)
if err != nil {
return nil, err
}
return &v1.GetBalanceResponse{
Credits: credits.ToCredits(),
}, nil
}

func (s *UsageService) GetCostCenter(ctx context.Context, in *v1.GetCostCenterRequest) (*v1.GetCostCenterResponse, error) {
if in.AttributionId == "" {
return nil, status.Errorf(codes.InvalidArgument, "Empty attributionId")
Expand Down
24 changes: 24 additions & 0 deletions components/usage/pkg/db/usage.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,30 @@ type Balance struct {
CreditCents CreditCents `gorm:"column:creditCents;type:bigint;" json:"creditCents"`
}

func GetBalance(ctx context.Context, conn *gorm.DB, attributionId AttributionID) (CreditCents, error) {
rows, err := conn.WithContext(ctx).
Model(&Usage{}).
Select("sum(creditCents) as balance").
Where("attributionId = ?", string(attributionId)).
Group("attributionId").
Rows()
if err != nil {
return 0, fmt.Errorf("failed to get rows for list balance query: %w", err)
}
defer rows.Close()

if !rows.Next() {
return 0, nil
}

var balance CreditCents
err = conn.ScanRows(rows, &balance)
if err != nil {
return 0, fmt.Errorf("failed to scan row: %w", err)
}
return balance, nil
Comment on lines +211 to +231
Copy link
Member

Choose a reason for hiding this comment

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

It should be possible to do it this way, if you wanted

var balance Balance
	tx := conn.WithContext(ctx).
		Table((&Usage{}).TableName()).
		Select("attributionId, sum(creditCents) as creditCents").
		Where("attributionId = ?", string(attributionId)).
		Group("attributionId").
		First(&balance)
	if tx.Error != nil {
		if tx.Error == gorm.ErrRecordNotFound {
			return 0, nil
		}
		
		return 0, fmt.Errorf("failed to get rows for list balance query: %w", tx.Error)
	}

	return balance.CreditCents, nil

Copy link
Member Author

Choose a reason for hiding this comment

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

Why would you prefer that? btw. I realized I unnecessarily added a group by clause. Will remove that and add the suggested test in a follow-up PR.

Copy link
Member

Choose a reason for hiding this comment

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

Just because it removes the need for the manual iteration over rows, which can hurt readability for those not familiar with gorm. It also handles the not found case a bit more explicitly which helps readability. But I don't mind, just wanted to offer an alternative in case you wanted to go with it.

}

func ListBalance(ctx context.Context, conn *gorm.DB) ([]Balance, error) {
var balances []Balance
rows, err := conn.WithContext(ctx).
Expand Down
34 changes: 34 additions & 0 deletions components/usage/pkg/db/usage_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,3 +322,37 @@ func TestListBalance(t *testing.T) {
CreditCents: -50,
})
}

func TestGetBalance(t *testing.T) {
Copy link
Member

Choose a reason for hiding this comment

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

Please add a test for when there are no usage records for an attributionID and it should return a 0

Copy link
Member Author

Choose a reason for hiding this comment

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

Added it here

teamAttributionID := db.NewTeamAttributionID(uuid.New().String())
userAttributionID := db.NewUserAttributionID(uuid.New().String())

conn := dbtest.ConnectForTests(t)
dbtest.CreateUsageRecords(t, conn,
dbtest.NewUsage(t, db.Usage{
AttributionID: teamAttributionID,
CreditCents: 100,
}),
dbtest.NewUsage(t, db.Usage{
AttributionID: teamAttributionID,
CreditCents: 900,
}),
dbtest.NewUsage(t, db.Usage{
AttributionID: userAttributionID,
CreditCents: 450,
}),
dbtest.NewUsage(t, db.Usage{
AttributionID: userAttributionID,
CreditCents: -500,
Kind: db.InvoiceUsageKind,
}),
)

teamBalance, err := db.GetBalance(context.Background(), conn, teamAttributionID)
require.NoError(t, err)
require.EqualValues(t, 1000, int(teamBalance))

userBalance, err := db.GetBalance(context.Background(), conn, userAttributionID)
require.NoError(t, err)
require.EqualValues(t, -50, int(userBalance))
}