[stripe] Set reportId on invoices after updating credits

Author: easyCZ

components/usage/pkg/apiv1/billing.go

@@ -38,13 +38,17 @@ type BillingService struct {
 }
 
 func (s *BillingService) UpdateInvoices(ctx context.Context, in *v1.UpdateInvoicesRequest) (*v1.UpdateInvoicesResponse, error) {
-	credits, err := s.creditSummaryForTeams(in.GetSessions())
+	if in.ReportId == "" {
+		return nil, status.Errorf(codes.InvalidArgument, "missing report ID")
+	}
+
+	creditSummary, err := s.creditSummaryForTeams(in.GetSessions(), in.ReportId)
 	if err != nil {
 		log.Log.WithError(err).Errorf("Failed to compute credit summary.")
 		return nil, status.Errorf(codes.InvalidArgument, "failed to compute credit summary")
 	}
 
-	err = s.stripeClient.UpdateUsage(ctx, credits)
+	err = s.stripeClient.UpdateUsage(ctx, creditSummary)
 	if err != nil {
 		log.Log.WithError(err).Errorf("Failed to update stripe invoices.")
 		return nil, status.Errorf(codes.Internal, "failed to update stripe invoices")
@@ -89,7 +93,7 @@ func (s *BillingService) GetUpcomingInvoice(ctx context.Context, in *v1.GetUpcom
 	}, nil
 }
 
-func (s *BillingService) creditSummaryForTeams(sessions []*v1.BilledSession) (map[string]int64, error) {
+func (s *BillingService) creditSummaryForTeams(sessions []*v1.BilledSession, reportID string) (map[string]stripe.CreditSummary, error) {
 	creditsPerTeamID := map[string]float64{}
 
 	for _, session := range sessions {
@@ -114,9 +118,12 @@ func (s *BillingService) creditSummaryForTeams(sessions []*v1.BilledSession) (ma
 		creditsPerTeamID[id] += session.GetCredits()
 	}
 
-	rounded := map[string]int64{}
+	rounded := map[string]stripe.CreditSummary{}
 	for teamID, credits := range creditsPerTeamID {
-		rounded[teamID] = int64(math.Ceil(credits))
+		rounded[teamID] = stripe.CreditSummary{
+			Credits:  int64(math.Ceil(credits)),
+			ReportID: reportID,
+		}
 	}
 
 	return rounded, nil

components/usage/pkg/apiv1/billing_test.go

@@ -13,25 +13,26 @@ import (
 	"github.com/gitpod-io/gitpod/usage/pkg/stripe"
 	"github.com/google/uuid"
 	"github.com/stretchr/testify/require"
-	timestamppb "google.golang.org/protobuf/types/known/timestamppb"
+	"google.golang.org/protobuf/types/known/timestamppb"
 	"gorm.io/gorm"
 )
 
 func TestCreditSummaryForTeams(t *testing.T) {
 	teamID_A, teamID_B := uuid.New().String(), uuid.New().String()
 	teamAttributionID_A, teamAttributionID_B := db.NewTeamAttributionID(teamID_A), db.NewTeamAttributionID(teamID_B)
+	reportID := "report_id_1"
 
 	scenarios := []struct {
 		Name              string
 		Sessions          []*v1.BilledSession
 		BillSessionsAfter time.Time
-		Expected          map[string]int64
+		Expected          map[string]stripe.CreditSummary
 	}{
 		{
 			Name:              "no instances in report, no summary",
 			BillSessionsAfter: time.Time{},
 			Sessions:          []*v1.BilledSession{},
-			Expected:          map[string]int64{},
+			Expected:          map[string]stripe.CreditSummary{},
 		},
 		{
 			Name:              "skips user attributions",
@@ -41,7 +42,7 @@ func TestCreditSummaryForTeams(t *testing.T) {
 					AttributionId: string(db.NewUserAttributionID(uuid.New().String())),
 				},
 			},
-			Expected: map[string]int64{},
+			Expected: map[string]stripe.CreditSummary{},
 		},
 		{
 			Name:              "two workspace instances",
@@ -58,9 +59,12 @@ func TestCreditSummaryForTeams(t *testing.T) {
 					Credits:       10,
 				},
 			},
-			Expected: map[string]int64{
+			Expected: map[string]stripe.CreditSummary{
 				// total of 2 days runtime, at 10 credits per hour, that's 480 credits
-				teamID_A: 480,
+				teamID_A: {
+					Credits:  480,
+					ReportID: reportID,
+				},
 			},
 		},
 		{
@@ -78,10 +82,16 @@ func TestCreditSummaryForTeams(t *testing.T) {
 					Credits:       (24) * 10,
 				},
 			},
-			Expected: map[string]int64{
+			Expected: map[string]stripe.CreditSummary{
 				// total of 2 days runtime, at 10 credits per hour, that's 480 credits
-				teamID_A: 120,
-				teamID_B: 240,
+				teamID_A: {
+					Credits:  120,
+					ReportID: reportID,
+				},
+				teamID_B: {
+					Credits:  240,
+					ReportID: reportID,
+				},
 			},
 		},
 		{
@@ -101,16 +111,19 @@ func TestCreditSummaryForTeams(t *testing.T) {
 					StartTime:     timestamppb.New(time.Now().AddDate(0, 0, -3)),
 				},
 			},
-			Expected: map[string]int64{
-				teamID_A: 120,
+			Expected: map[string]stripe.CreditSummary{
+				teamID_A: {
+					Credits:  120,
+					ReportID: reportID,
+				},
 			},
 		},
 	}
 
 	for _, s := range scenarios {
 		t.Run(s.Name, func(t *testing.T) {
 			svc := NewBillingService(&stripe.Client{}, s.BillSessionsAfter, &gorm.DB{})
-			actual, err := svc.creditSummaryForTeams(s.Sessions)
+			actual, err := svc.creditSummaryForTeams(s.Sessions, reportID)
 			require.NoError(t, err)
 			require.Equal(t, s.Expected, actual)
 		})

components/usage/pkg/stripe/stripe.go

@@ -16,6 +16,10 @@ import (
 	"github.com/stripe/stripe-go/v72/client"
 )
 
+const (
+	reportIDMetadataKey = "reportId"
+)
+
 type Client struct {
 	sc *client.API
 }
@@ -58,9 +62,14 @@ type Invoice struct {
 	Credits        int64
 }
 
+type CreditSummary struct {
+	Credits  int64
+	ReportID string
+}
+
 // UpdateUsage updates teams' Stripe subscriptions with usage data
 // `usageForTeam` is a map from team name to total workspace seconds used within a billing period.
-func (c *Client) UpdateUsage(ctx context.Context, creditsPerTeam map[string]int64) error {
+func (c *Client) UpdateUsage(ctx context.Context, creditsPerTeam map[string]CreditSummary) error {
 	teamIds := make([]string, 0, len(creditsPerTeam))
 	for k := range creditsPerTeam {
 		teamIds = append(teamIds, k)
@@ -117,7 +126,7 @@ func (c *Client) findCustomers(ctx context.Context, query string) ([]*stripe.Cus
 	return customers, nil
 }
 
-func (c *Client) updateUsageForCustomer(ctx context.Context, customer *stripe.Customer, credits int64) (*UsageRecord, error) {
+func (c *Client) updateUsageForCustomer(ctx context.Context, customer *stripe.Customer, summary CreditSummary) (*UsageRecord, error) {
 	subscriptions := customer.Subscriptions.Data
 	if len(subscriptions) != 1 {
 		return nil, fmt.Errorf("customer has an unexpected number of subscriptions %v (expected 1, got %d)", subscriptions, len(subscriptions))
@@ -136,15 +145,27 @@ func (c *Client) updateUsageForCustomer(ctx context.Context, customer *stripe.Cu
 			Context: ctx,
 		},
 		SubscriptionItem: stripe.String(subscriptionItemId),
-		Quantity:         stripe.Int64(credits),
+		Quantity:         stripe.Int64(summary.Credits),
 	})
 	if err != nil {
 		return nil, fmt.Errorf("failed to register usage for customer %q on subscription item %s", customer.Name, subscriptionItemId)
 	}
 
+	invoice, err := c.GetUpcomingInvoice(ctx, customer.ID)
+	if err != nil {
+		return nil, fmt.Errorf("failed to find upcoming invoice for customer %s: %w", customer.ID, err)
+	}
+
+	_, err = c.UpdateInvoiceMetadata(ctx, invoice.ID, map[string]string{
+		reportIDMetadataKey: summary.ReportID,
+	})
+	if err != nil {
+		return nil, fmt.Errorf("failed to udpate invoice %s metadata with report ID: %w", invoice.ID, err)
+	}
+
 	return &UsageRecord{
 		SubscriptionItemID: subscriptionItemId,
-		Quantity:           credits,
+		Quantity:           summary.Credits,
 	}, nil
 }
 
@@ -205,6 +226,20 @@ func (c *Client) GetUpcomingInvoice(ctx context.Context, customerID string) (*In
 	}, nil
 }
 
+func (c *Client) UpdateInvoiceMetadata(ctx context.Context, invoiceID string, metadata map[string]string) (*stripe.Invoice, error) {
+	invoice, err := c.sc.Invoices.Update(invoiceID, &stripe.InvoiceParams{
+		Params: stripe.Params{
+			Context:  ctx,
+			Metadata: metadata,
+		},
+	})
+	if err != nil {
+		return nil, fmt.Errorf("failed to update invoice %s metadata: %w", invoiceID, err)
+	}
+
+	return invoice, nil
+}
+
 // queriesForCustomersWithTeamIds constructs Stripe query strings to find the Stripe Customer for each teamId
 // It returns multiple queries, each being a big disjunction of subclauses so that we can process multiple teamIds in one query.
 // `clausesPerQuery` is a limit enforced by the Stripe API.