feat: store status details in DB

openmeter/billing/adapter/invoice.go

@@ -460,6 +460,7 @@ func (a *adapter) UpdateInvoice(ctx context.Context, in billing.UpdateInvoiceAda
 			SetMetadata(in.Metadata).
 			// Currency is immutable
 			SetStatus(in.Status).
+			SetOrClearStatusDetailsCache(lo.EmptyableToPtr(in.StatusDetails)).
 			// Type is immutable
 			SetNumber(in.Number).
 			SetOrClearDescription(in.Description).
@@ -668,6 +669,7 @@ func (a *adapter) mapInvoiceFromDB(ctx context.Context, invoice *db.BillingInvoi
 			Metadata:         invoice.Metadata,
 			Currency:         invoice.Currency,
 			Status:           invoice.Status,
+			StatusDetails:    invoice.StatusDetailsCache,
 			Type:             invoice.Type,
 			Number:           invoice.Number,
 			Description:      invoice.Description,

openmeter/billing/httpdriver/invoice.go

@@ -59,7 +59,7 @@ func (h *handler) ListInvoices() ListInvoicesHandler {
 
 				IssuedAfter:  input.IssuedAfter,
 				IssuedBefore: input.IssuedBefore,
-				Expand:       mapInvoiceExpandToEntity(lo.FromPtrOr(input.Expand, nil)).SetGatheringTotals(true),
+				Expand:       mapInvoiceExpandToEntity(lo.FromPtrOr(input.Expand, nil)).SetRecalculateGatheringInvoice(true),
 
 				Order:   sortx.Order(lo.FromPtrOr(input.Order, api.InvoiceOrderByOrderingOrder(sortx.OrderDefault))),
 				OrderBy: lo.FromPtrOr(input.OrderBy, ""),
@@ -196,7 +196,7 @@ func (h *handler) GetInvoice() GetInvoiceHandler {
 					ID:        params.InvoiceID,
 					Namespace: ns,
 				},
-				Expand: mapInvoiceExpandToEntity(params.Expand).SetDeletedLines(params.IncludeDeletedLines).SetGatheringTotals(true),
+				Expand: mapInvoiceExpandToEntity(params.Expand).SetDeletedLines(params.IncludeDeletedLines).SetRecalculateGatheringInvoice(true),
 			}, nil
 		},
 		func(ctx context.Context, request GetInvoiceRequest) (GetInvoiceResponse, error) {

openmeter/billing/invoice.go

@@ -208,9 +208,9 @@ type InvoiceExpand struct {
 	DeletedLines bool
 	SplitLines   bool
 
-	// GatheringTotals is used to calculate the totals of the invoice when gathering, this is temporary
-	// until we implement the full progressive billing stack.
-	GatheringTotals bool
+	// RecalculateGatheringInvoice is used to calculate the totals and status details of the invoice when gathering,
+	// this is temporary until we implement the full progressive billing stack, including gathering invoice recalculations.
+	RecalculateGatheringInvoice bool
 }
 
 var InvoiceExpandAll = InvoiceExpand{
@@ -241,8 +241,8 @@ func (e InvoiceExpand) SetSplitLines(v bool) InvoiceExpand {
 	return e
 }
 
-func (e InvoiceExpand) SetGatheringTotals(v bool) InvoiceExpand {
-	e.GatheringTotals = v
+func (e InvoiceExpand) SetRecalculateGatheringInvoice(v bool) InvoiceExpand {
+	e.RecalculateGatheringInvoice = v
 	return e
 }
 

openmeter/billing/service/invoice.go

@@ -39,7 +39,7 @@ func (s *Service) ListInvoices(ctx context.Context, input billing.ListInvoicesIn
 			return billing.ListInvoicesResponse{}, fmt.Errorf("error resolving status details for invoice [%s]: %w", invoices.Items[i].ID, err)
 		}
 
-		if input.Expand.GatheringTotals {
+		if input.Expand.RecalculateGatheringInvoice {
 			invoices.Items[i], err = s.recalculateGatheringInvoice(ctx, recalculateGatheringInvoiceInput{
 				Invoice: invoices.Items[i],
 				Expand:  input.Expand,
@@ -71,6 +71,18 @@ func (s *Service) resolveWorkflowApps(ctx context.Context, invoice billing.Invoi
 }
 
 func (s *Service) resolveStatusDetails(ctx context.Context, invoice billing.Invoice) (billing.Invoice, error) {
+	if invoice.Status == billing.InvoiceStatusGathering {
+		// Let's use the default and recalculateGatheringInvoice will fix the gaps
+		return invoice, nil
+	}
+
+	// If we are not in a time sensitive state and the status details is not empty, we can return the invoice as is, so we
+	// don't have to lock the invoice in the DB
+	if !lo.IsEmpty(invoice.StatusDetails) &&
+		invoice.Status != billing.InvoiceStatusDraftWaitingAutoApproval { // The status details depends on the current time, so we should recalculate
+		return invoice, nil
+	}
+
 	// let's resolve the statatus details (the invoice state machine has this side-effect after the callback)
 	resolvedInvoice, err := s.WithInvoiceStateMachine(ctx, invoice, func(ctx context.Context, sm *InvoiceStateMachine) error {
 		return nil
@@ -176,10 +188,11 @@ func (s *Service) recalculateGatheringInvoice(ctx context.Context, in recalculat
 	// TODO[later]: If this sugar is removed due to properly implemented progressive billing stack, we need to cache the when the invoice is first invoicable in the db
 	// so that we don't have to fetch all the lines to have proper status details.
 
-	if hasInvoicableLines.IsAbsent() {
-		invoice.StatusDetails.AvailableActions.Invoice = nil
-	} else {
-		invoice.StatusDetails.AvailableActions.Invoice = &billing.InvoiceAvailableActionInvoiceDetails{}
+	invoice.StatusDetails = billing.InvoiceStatusDetails{
+		Immutable: false,
+		AvailableActions: billing.InvoiceAvailableActions{
+			Invoice: lo.If(hasInvoicableLines.IsPresent(), &billing.InvoiceAvailableActionInvoiceDetails{}).Else(nil),
+		},
 	}
 
 	return invoice, nil
@@ -201,7 +214,7 @@ func (s *Service) GetInvoiceByID(ctx context.Context, input billing.GetInvoiceBy
 		return billing.Invoice{}, fmt.Errorf("error resolving status details for invoice [%s]: %w", invoice.ID, err)
 	}
 
-	if input.Expand.GatheringTotals {
+	if input.Expand.RecalculateGatheringInvoice {
 		invoice, err = s.recalculateGatheringInvoice(ctx, recalculateGatheringInvoiceInput{
 			Invoice: invoice,
 			Expand:  input.Expand,

openmeter/billing/service/invoicestate.go

@@ -262,18 +262,9 @@ func (s *Service) WithInvoiceStateMachine(ctx context.Context, invoice billing.I
 func (m *InvoiceStateMachine) StatusDetails(ctx context.Context) (billing.InvoiceStatusDetails, error) {
 	if m.Invoice.Status == billing.InvoiceStatusGathering {
 		// Gathering is a special state that is not part of the state machine, due to
-		// cross invoice operations
-		return billing.InvoiceStatusDetails{
-			Immutable: false,
-			// The invoicable state is calculated in the services recalculateGatheringInvoice for now, as the
-			// line data is available there. On the long run we need to cache this information.
-			//
-			// For now, as a safety measure we lie here, as the recalculation will be performed either ways
-			// and the CreateInvoice method will validate this once more.
-			AvailableActions: billing.InvoiceAvailableActions{
-				Invoice: &billing.InvoiceAvailableActionInvoiceDetails{},
-			},
-		}, nil
+		// cross invoice operations, for now the sugar around grathering invoices will handle
+		// the status details.
+		return billing.InvoiceStatusDetails{}, nil
 	}
 
 	var outErr, err error