Skip to content

refactor: remove recursive line lookups #3517

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
turip merged 1 commit into from
Oct 16, 2025
Merged

refactor: remove recursive line lookups #3517

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
18 changes: 2 additions & 16 deletions openmeter/billing/adapter/invoice.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ func (a *adapter) expandInvoiceLineItems(query *db.BillingInvoiceQuery, expand b
billinginvoiceline.StatusIn(requestedStatuses...),
)

a.expandLineItems(q)
a.expandLineItemsWithDetailedLines(q)
})
}

Expand Down Expand Up @@ -570,17 +570,6 @@ func (a *adapter) UpdateInvoice(ctx context.Context, in billing.UpdateInvoiceAda
updatedLines = billing.NewInvoiceLines(lines)
}

// Let's return the updated invoice
if !in.ExpandedFields.DeletedLines && updatedLines.IsPresent() {
// If we haven't requested deleted lines, let's filter them out, as if there were lines marked deleted
// the adapter update would return them as well.
updatedLines = billing.NewInvoiceLines(
lo.Filter(updatedLines.OrEmpty(), func(line *billing.Line, _ int) bool {
return line.DeletedAt == nil
}),
)
}

// If we had just updated the lines, let's reuse that result, as it's quite an expensive operation
// to look up the lines again.
if in.ExpandedFields.Lines && updatedLines.IsPresent() {
Expand Down Expand Up @@ -748,10 +737,7 @@ func (a *adapter) mapInvoiceFromDB(ctx context.Context, invoice *db.BillingInvoi
}

if expand.Lines {
mappedLines, err := a.mapInvoiceLineFromDB(ctx, mapInvoiceLineFromDBInput{
lines: invoice.Edges.BillingInvoiceLines,
includeDeleted: expand.DeletedLines,
})
mappedLines, err := a.mapInvoiceLineFromDB(invoice.Edges.BillingInvoiceLines)
if err != nil {
return billing.Invoice{}, err
}
Expand Down
223 changes: 117 additions & 106 deletions openmeter/billing/adapter/invoicelinemapper.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,128 +1,154 @@
package billingadapter

import (
"context"
"fmt"
"time"

"github.com/samber/lo"

"github.com/openmeterio/openmeter/openmeter/billing"
"github.com/openmeterio/openmeter/openmeter/ent/db"
"github.com/openmeterio/openmeter/openmeter/ent/db/billinginvoiceline"
"github.com/openmeterio/openmeter/openmeter/ent/db/predicate"
"github.com/openmeterio/openmeter/pkg/convert"
"github.com/openmeterio/openmeter/pkg/models"
"github.com/openmeterio/openmeter/pkg/slicesx"
"github.com/openmeterio/openmeter/pkg/timeutil"
)

type mapInvoiceLineFromDBInput struct {
lines []*db.BillingInvoiceLine
includeDeleted bool
}

func (a *adapter) mapInvoiceLineFromDB(ctx context.Context, in mapInvoiceLineFromDBInput) ([]*billing.Line, error) {
pendingParentIDs := make([]string, 0, len(in.lines))
resolvedChildrenOfIDs := make(map[string]struct{}, len(in.lines))

for _, line := range in.lines {
if line.ParentLineID != nil {
pendingParentIDs = append(pendingParentIDs, *line.ParentLineID)
}
func (a *adapter) mapInvoiceLineFromDB(dbLines []*db.BillingInvoiceLine) ([]*billing.Line, error) {
lines := make([]*billing.Line, 0, len(dbLines))

if line.Status != billing.InvoiceLineStatusDetailed {
resolvedChildrenOfIDs[line.ID] = struct{}{}
for _, dbLine := range dbLines {
line, err := a.mapInvoiceLineWithoutReferences(dbLine)
if err != nil {
return nil, fmt.Errorf("mapping line [id=%s]: %w", dbLine.ID, err)
}
}

// NOTE: Given that the invoice lines can be in parent-child relationship we might fetch
// duplicate lines, so we need to deduplicate them.
//
// We cannot get around this limitation, as a parent line might have more children than the ones we have
// saved.
references, err := a.fetchInvoiceLineNewReferences(ctx, pendingParentIDs, lo.Keys(resolvedChildrenOfIDs), in.includeDeleted)
if err != nil {
return nil, err
}

references = append(references, in.lines...)
// Let's map any detailed lines
detailedLines := make([]*billing.Line, 0, len(dbLine.Edges.DetailedLines))
for _, dbDetailedLine := range dbLine.Edges.DetailedLines {
detailedLine, err := a.mapInvoiceDetailedLineWithoutReferences(dbDetailedLine)
if err != nil {
return nil, fmt.Errorf("mapping detailed line [parentID=%s,id=%s]: %w", dbLine.ID, dbDetailedLine.ID, err)
}

mappedEntities := make(map[string]*billing.Line, len(references))
detailedLine.SaveDBSnapshot()

for _, dbLine := range references {
if _, ok := mappedEntities[dbLine.ID]; ok {
continue
detailedLines = append(detailedLines, detailedLine)
}

entity, err := a.mapInvoiceLineWithoutReferences(dbLine)
if err != nil {
return nil, err
}
line.Children = billing.NewLineChildren(detailedLines)

line.SaveDBSnapshot()

mappedEntities[dbLine.ID] = &entity
lines = append(lines, line)
}

for _, entity := range mappedEntities {
if entity.ParentLineID != nil {
parent, ok := mappedEntities[*entity.ParentLineID]
if !ok {
// We don't care about the parent if it's not loaded as it might be too deep
continue
}
return lines, nil
}

entity.ParentLine = parent
// We only add children references if we know that those has been properly resolved
if _, ok := resolvedChildrenOfIDs[parent.ID]; ok {
parent.Children = append(parent.Children, entity)
}
}
}
func (a *adapter) mapInvoiceLineWithoutReferences(dbLine *db.BillingInvoiceLine) (*billing.Line, error) {
invoiceLine := &billing.Line{
LineBase: billing.LineBase{
ManagedResource: models.NewManagedResource(models.ManagedResourceInput{
Namespace: dbLine.Namespace,
ID: dbLine.ID,
CreatedAt: dbLine.CreatedAt.In(time.UTC),
UpdatedAt: dbLine.UpdatedAt.In(time.UTC),
DeletedAt: convert.TimePtrIn(dbLine.DeletedAt, time.UTC),
Name: dbLine.Name,
Description: dbLine.Description,
}),

result := make([]*billing.Line, 0, len(mappedEntities))
for _, dbEntity := range in.lines {
entity, ok := mappedEntities[dbEntity.ID]
if !ok {
return nil, fmt.Errorf("missing entity[%s]", dbEntity.ID)
}
Metadata: dbLine.Metadata,
Annotations: dbLine.Annotations,
InvoiceID: dbLine.InvoiceID,
Status: dbLine.Status,
ManagedBy: dbLine.ManagedBy,

entity.SaveDBSnapshot()
Period: billing.Period{
Start: dbLine.PeriodStart.In(time.UTC),
End: dbLine.PeriodEnd.In(time.UTC),
},

result = append(result, entity)
}
ParentLineID: dbLine.ParentLineID,
SplitLineGroupID: dbLine.SplitLineGroupID,
ChildUniqueReferenceID: dbLine.ChildUniqueReferenceID,

return result, nil
}
InvoiceAt: dbLine.InvoiceAt.In(time.UTC),

Type: dbLine.Type,
Currency: dbLine.Currency,

func (a *adapter) fetchInvoiceLineNewReferences(ctx context.Context, parentIDs []string, childrenOf []string, includeDeletedLines bool) ([]*db.BillingInvoiceLine, error) {
if len(parentIDs) == 0 && len(childrenOf) == 0 {
return nil, nil
TaxConfig: lo.EmptyableToPtr(dbLine.TaxConfig),
RateCardDiscounts: lo.FromPtr(dbLine.RatecardDiscounts),
Totals: billing.Totals{
Amount: dbLine.Amount,
ChargesTotal: dbLine.ChargesTotal,
DiscountsTotal: dbLine.DiscountsTotal,
TaxesInclusiveTotal: dbLine.TaxesInclusiveTotal,
TaxesExclusiveTotal: dbLine.TaxesExclusiveTotal,
TaxesTotal: dbLine.TaxesTotal,
Total: dbLine.Total,
},
ExternalIDs: billing.LineExternalIDs{
Invoicing: lo.FromPtr(dbLine.InvoicingAppExternalID),
},
},
}

query := a.db.BillingInvoiceLine.Query()
if dbLine.SubscriptionID != nil && dbLine.SubscriptionPhaseID != nil && dbLine.SubscriptionItemID != nil {
invoiceLine.Subscription = &billing.SubscriptionReference{
SubscriptionID: *dbLine.SubscriptionID,
PhaseID: *dbLine.SubscriptionPhaseID,
ItemID: *dbLine.SubscriptionItemID,
BillingPeriod: timeutil.ClosedPeriod{
From: lo.FromPtr(dbLine.SubscriptionBillingPeriodFrom).In(time.UTC),
To: lo.FromPtr(dbLine.SubscriptionBillingPeriodTo).In(time.UTC),
},
}
}

query = a.expandLineItems(query)
if dbLine.Type != billing.InvoiceLineTypeUsageBased {
return invoiceLine, fmt.Errorf("only usage based lines can be top level lines [line_id=%s]", dbLine.ID)
}

predicates := make([]predicate.BillingInvoiceLine, 0, 2)
if len(parentIDs) > 0 {
predicates = append(predicates, billinginvoiceline.IDIn(lo.Uniq(parentIDs)...))
ubpLine := dbLine.Edges.UsageBasedLine
if ubpLine == nil {
return nil, fmt.Errorf("manual usage based line is missing")
}

if len(childrenOf) > 0 {
predicates = append(predicates, billinginvoiceline.ParentLineIDIn(lo.Uniq(childrenOf)...))
invoiceLine.UsageBased = &billing.UsageBasedLine{
ConfigID: ubpLine.ID,
FeatureKey: lo.FromPtr(ubpLine.FeatureKey),
Price: ubpLine.Price,
Quantity: dbLine.Quantity,
MeteredQuantity: ubpLine.MeteredQuantity,
PreLinePeriodQuantity: ubpLine.PreLinePeriodQuantity,
MeteredPreLinePeriodQuantity: ubpLine.MeteredPreLinePeriodQuantity,
}

query = query.Where(billinginvoiceline.Or(predicates...))
if len(dbLine.Edges.LineUsageDiscounts) > 0 {
discounts, err := slicesx.MapWithErr(dbLine.Edges.LineUsageDiscounts, a.mapInvoiceLineUsageDiscountFromDB)
if err != nil {
return nil, fmt.Errorf("mapping invoice line usage discounts[%s] failed: %w", dbLine.ID, err)
}

invoiceLine.Discounts.Usage = discounts
}

if !includeDeletedLines {
query = query.Where(billinginvoiceline.DeletedAtIsNil())
if len(dbLine.Edges.LineAmountDiscounts) > 0 {
discounts, err := slicesx.MapWithErr(dbLine.Edges.LineAmountDiscounts, a.mapInvoiceLineAmountDiscountFromDB)
if err != nil {
return nil, fmt.Errorf("mapping invoice line amount discounts[%s] failed: %w", dbLine.ID, err)
}
invoiceLine.Discounts.Amount = discounts
}

return query.All(ctx)
return invoiceLine, nil
}

func (a *adapter) mapInvoiceLineWithoutReferences(dbLine *db.BillingInvoiceLine) (billing.Line, error) {
invoiceLine := billing.Line{
func (a *adapter) mapInvoiceDetailedLineWithoutReferences(dbLine *db.BillingInvoiceLine) (*billing.DetailedLine, error) {
invoiceLine := &billing.DetailedLine{
LineBase: billing.LineBase{
ManagedResource: models.NewManagedResource(models.ManagedResourceInput{
Namespace: dbLine.Namespace,
Expand Down Expand Up @@ -183,32 +209,17 @@ func (a *adapter) mapInvoiceLineWithoutReferences(dbLine *db.BillingInvoiceLine)
}
}

switch dbLine.Type {
case billing.InvoiceLineTypeFee:
invoiceLine.FlatFee = &billing.FlatFeeLine{
ConfigID: dbLine.Edges.FlatFeeLine.ID,
PerUnitAmount: dbLine.Edges.FlatFeeLine.PerUnitAmount,
Quantity: lo.FromPtr(dbLine.Quantity),
Category: dbLine.Edges.FlatFeeLine.Category,
PaymentTerm: dbLine.Edges.FlatFeeLine.PaymentTerm,
Index: dbLine.Edges.FlatFeeLine.Index,
}
case billing.InvoiceLineTypeUsageBased:
ubpLine := dbLine.Edges.UsageBasedLine
if ubpLine == nil {
return invoiceLine, fmt.Errorf("manual usage based line is missing")
}
invoiceLine.UsageBased = &billing.UsageBasedLine{
ConfigID: ubpLine.ID,
FeatureKey: lo.FromPtr(ubpLine.FeatureKey),
Price: ubpLine.Price,
Quantity: dbLine.Quantity,
MeteredQuantity: ubpLine.MeteredQuantity,
PreLinePeriodQuantity: ubpLine.PreLinePeriodQuantity,
MeteredPreLinePeriodQuantity: ubpLine.MeteredPreLinePeriodQuantity,
}
default:
return invoiceLine, fmt.Errorf("unsupported line type[%s]: %s", dbLine.ID, dbLine.Type)
if dbLine.Type != billing.InvoiceLineTypeFee {
return nil, fmt.Errorf("only fee typed lines can be detailed lines [line_id=%s]", dbLine.ID)
}

invoiceLine.FlatFee = &billing.FlatFeeLine{
ConfigID: dbLine.Edges.FlatFeeLine.ID,
PerUnitAmount: dbLine.Edges.FlatFeeLine.PerUnitAmount,
Quantity: lo.FromPtr(dbLine.Quantity),
Category: dbLine.Edges.FlatFeeLine.Category,
PaymentTerm: dbLine.Edges.FlatFeeLine.PaymentTerm,
Index: dbLine.Edges.FlatFeeLine.Index,
}

if len(dbLine.Edges.LineUsageDiscounts) > 0 {
Expand Down
Loading
Loading