[usage] Introduce an explicit CostCenter.BillingCycleStart time

Author: jankeromnes

components/gitpod-db/src/typeorm/migration/1667919924081-CostCenterBillingCycleStart.ts

@@ -0,0 +1,26 @@
+/**
+ * Copyright (c) 2022 Gitpod GmbH. All rights reserved.
+ * Licensed under the GNU Affero General Public License (AGPL).
+ * See License-AGPL.txt in the project root for license information.
+ */
+
+import { MigrationInterface, QueryRunner } from "typeorm";
+import { columnExists } from "./helper/helper";
+
+const D_B_COST_CENTER = "d_b_cost_center";
+const COL_BILLING_CYCLE_START = "billingCycleStart";
+
+export class CostCenterNextBillingTime1663055856941 implements MigrationInterface {
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        if (!(await columnExists(queryRunner, D_B_COST_CENTER, COL_BILLING_CYCLE_START))) {
+            await queryRunner.query(
+                `ALTER TABLE ${D_B_COST_CENTER} ADD COLUMN ${COL_BILLING_CYCLE_START} varchar(30) NOT NULL, ALGORITHM=INPLACE, LOCK=NONE `,
+            );
+            await queryRunner.query(
+                `ALTER TABLE ${D_B_COST_CENTER} ADD INDEX(${COL_BILLING_CYCLE_START}), ALGORITHM=INPLACE, LOCK=NONE `,
+            );
+        }
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {}
+}

components/server/ee/src/billing/billing-mode.spec.db.ts

@@ -77,9 +77,10 @@ class UsageServiceClientMock implements UsageServiceClient {
         return {
             costCenter: {
                 attributionId: request.attributionId,
+                spendingLimit: 1234,
                 billingStrategy,
                 nextBillingTime: new Date(), // does not matter here.
-                spendingLimit: 1234,
+                billingCycleStart: new Date(), // does not matter here.
             },
         };
     }

components/usage-api/go/v1/usage.pb.go

@@ -195,6 +195,7 @@ export interface CostCenter {
   billingStrategy: CostCenter_BillingStrategy;
   /** next_billing_time specifies when the next billing cycle happens. Only set when billing strategy is 'other'. This property is readonly. */
   nextBillingTime: Date | undefined;
+  billingCycleStart: Date | undefined;
 }
 
 export enum CostCenter_BillingStrategy {
@@ -1077,6 +1078,7 @@ function createBaseCostCenter(): CostCenter {
     spendingLimit: 0,
     billingStrategy: CostCenter_BillingStrategy.BILLING_STRATEGY_STRIPE,
     nextBillingTime: undefined,
+    billingCycleStart: undefined,
   };
 }
 
@@ -1094,6 +1096,9 @@ export const CostCenter = {
     if (message.nextBillingTime !== undefined) {
       Timestamp.encode(toTimestamp(message.nextBillingTime), writer.uint32(34).fork()).ldelim();
     }
+    if (message.billingCycleStart !== undefined) {
+      Timestamp.encode(toTimestamp(message.billingCycleStart), writer.uint32(42).fork()).ldelim();
+    }
     return writer;
   },
 
@@ -1116,6 +1121,9 @@ export const CostCenter = {
         case 4:
           message.nextBillingTime = fromTimestamp(Timestamp.decode(reader, reader.uint32()));
           break;
+        case 5:
+          message.billingCycleStart = fromTimestamp(Timestamp.decode(reader, reader.uint32()));
+          break;
         default:
           reader.skipType(tag & 7);
           break;
@@ -1132,6 +1140,7 @@ export const CostCenter = {
         ? costCenter_BillingStrategyFromJSON(object.billingStrategy)
         : CostCenter_BillingStrategy.BILLING_STRATEGY_STRIPE,
       nextBillingTime: isSet(object.nextBillingTime) ? fromJsonTimestamp(object.nextBillingTime) : undefined,
+      billingCycleStart: isSet(object.billingCycleStart) ? fromJsonTimestamp(object.billingCycleStart) : undefined,
     };
   },
 
@@ -1142,6 +1151,7 @@ export const CostCenter = {
     message.billingStrategy !== undefined &&
       (obj.billingStrategy = costCenter_BillingStrategyToJSON(message.billingStrategy));
     message.nextBillingTime !== undefined && (obj.nextBillingTime = message.nextBillingTime.toISOString());
+    message.billingCycleStart !== undefined && (obj.billingCycleStart = message.billingCycleStart.toISOString());
     return obj;
   },
 
@@ -1151,6 +1161,7 @@ export const CostCenter = {
     message.spendingLimit = object.spendingLimit ?? 0;
     message.billingStrategy = object.billingStrategy ?? CostCenter_BillingStrategy.BILLING_STRATEGY_STRIPE;
     message.nextBillingTime = object.nextBillingTime ?? undefined;
+    message.billingCycleStart = object.billingCycleStart ?? undefined;
     return message;
   },
 };

components/usage-api/typescript/src/usage/v1/usage.pb.ts

@@ -129,6 +129,7 @@ message CostCenter {
 
     // next_billing_time specifies when the next billing cycle happens. Only set when billing strategy is 'other'. This property is readonly.
     google.protobuf.Timestamp next_billing_time = 4;
+    google.protobuf.Timestamp billing_cycle_start = 5;
 }
 
 message ResetUsageRequest {}

components/usage-api/usage/v1/usage.proto

@@ -191,10 +191,11 @@ func (s *UsageService) GetCostCenter(ctx context.Context, in *v1.GetCostCenterRe
 
 func dbCostCenterToAPI(c db.CostCenter) *v1.CostCenter {
 	return &v1.CostCenter{
-		AttributionId:   string(c.ID),
-		SpendingLimit:   c.SpendingLimit,
-		BillingStrategy: convertBillingStrategyToAPI(c.BillingStrategy),
-		NextBillingTime: timestamppb.New(c.NextBillingTime.Time()),
+		AttributionId:     string(c.ID),
+		SpendingLimit:     c.SpendingLimit,
+		BillingStrategy:   convertBillingStrategyToAPI(c.BillingStrategy),
+		NextBillingTime:   timestamppb.New(c.NextBillingTime.Time()),
+		BillingCycleStart: timestamppb.New(c.BillingCycleStart.Time()),
 	}
 }