Plan-Addon RateCard Compatibility adjustments (#2708)

Author: GAlexIHU

openmeter/productcatalog/addon.go

@@ -284,3 +284,11 @@ func AddonWithCompatiblePrices() models.ValidatorFunc[Addon] {
 		}
 	}
 }
+
+// Determines if an Addon RateCard will effect a given Plan RateCard
+// Right now we only support a single RateCard per addon effecting a single plan RateCard and we match them by key.
+func AddonRateCardMatcherForAGivenPlanRateCard(planRateCard RateCard) func(addonRateCard RateCard) bool {
+	return func(addonRateCard RateCard) bool {
+		return addonRateCard.Key() == planRateCard.Key()
+	}
+}

openmeter/productcatalog/planaddon.go

@@ -7,6 +7,7 @@ import (
 	"github.com/samber/lo"
 
 	"github.com/openmeterio/openmeter/pkg/models"
+	"github.com/openmeterio/openmeter/pkg/slicesx"
 )
 
 type PlanAddonMeta struct {
@@ -108,11 +109,8 @@ func (c PlanAddon) Validate() error {
 		} else {
 			// Validate ratecards from plan phases and addon.
 			for _, phase := range c.Plan.Phases[phaseIdx:] {
-				// If ratecards can be merged then they are compatible.
-				if err := phase.RateCards.Compatible(c.Addon.RateCards); err != nil {
-					errs = append(errs,
-						fmt.Errorf("invalid phase [phase.key=%s]: ratecards are not compatible: %w", phase.Key, err),
-					)
+				if err := c.validateRateCardsInPhase(phase.RateCards, c.Addon.RateCards); err != nil {
+					errs = append(errs, fmt.Errorf("invalid phase [phase.key=%s]: ratecards are not compatible: %w", phase.Key, err))
 				}
 			}
 		}
@@ -122,3 +120,33 @@ func (c PlanAddon) Validate() error {
 
 	return models.NewNillableGenericValidationError(errors.Join(errs...))
 }
+
+func (c PlanAddon) validateRateCardsInPhase(phaseRateCards, addonRateCards RateCards) error {
+	var errs []error
+
+	// We'll assume phaseRateCards and addonRateCards are otherwise valid by unique constraints and formal contents...
+	for _, phaseRateCard := range phaseRateCards {
+		affectingRateCards := lo.Filter(addonRateCards, slicesx.AsFilterIteratee(AddonRateCardMatcherForAGivenPlanRateCard(phaseRateCard)))
+
+		// No RateCards affect this plan RateCard
+		if len(affectingRateCards) == 0 {
+			continue
+		}
+
+		// For now we only support a single RateCard per addon effecting a single plan RateCard.
+		if len(affectingRateCards) > 1 {
+			errs = append(errs, fmt.Errorf("multiple add-on ratecards affect plan ratecard [plan.ratecard.key=%s]: affecting add-on ratecard keys: %+v", phaseRateCard.Key(), lo.Map(affectingRateCards, func(item RateCard, index int) string {
+				return item.Key()
+			})))
+
+			continue
+		}
+
+		// Finally, let's check that they are compatible
+		if err := rateCardsCompatible(phaseRateCard, affectingRateCards[0]); err != nil {
+			errs = append(errs, fmt.Errorf("plan ratecard is not compatible with add-on ratecard [plan.ratecard.key=%s add-on.ratecard.key=%s]: %w", phaseRateCard.Key(), affectingRateCards[0].Key(), err))
+		}
+	}
+
+	return models.NewNillableGenericValidationError(errors.Join(errs...))
+}

openmeter/productcatalog/ratecard.go

@@ -560,46 +560,6 @@ func (c RateCards) Validate() error {
 	return models.NewNillableGenericValidationError(errors.Join(errs...))
 }
 
-func (c RateCards) Compatible(overlays RateCards) error {
-	if err := c.Validate(); err != nil {
-		return err
-	}
-
-	if err := overlays.Validate(); err != nil {
-		return err
-	}
-
-	var errs []error
-
-	m := make(map[string]rateCardWithOverlays)
-
-	// Collect ratecards by their keys
-	for _, rc := range lo.Union(c, overlays) {
-		_, ok := m[rc.Key()]
-		if !ok {
-			m[rc.Key()] = rateCardWithOverlays{base: rc}
-		}
-
-		m[rc.Key()] = rateCardWithOverlays{
-			base:     m[rc.Key()].base,
-			overlays: append(m[rc.Key()].overlays, rc),
-		}
-	}
-
-	for key, rc := range m {
-		// Skip compatibility check
-		if len(rc.overlays) == 0 {
-			continue
-		}
-
-		if err := rc.Validate(); err != nil {
-			errs = append(errs, fmt.Errorf("incompatible ratecards [key=%s]: %w", key, err))
-		}
-	}
-
-	return models.NewNillableGenericValidationError(errors.Join(errs...))
-}
-
 type rateCardWithOverlays struct {
 	base     RateCard
 	overlays []RateCard
@@ -670,8 +630,8 @@ func rateCardsCompatible(r, v RateCard) error {
 
 	// Validate  Entitlement
 
-	if rMeta.EntitlementTemplate != nil {
-		if vMeta.EntitlementTemplate == nil || rMeta.EntitlementTemplate.Type() != vMeta.EntitlementTemplate.Type() {
+	if rMeta.EntitlementTemplate != nil && vMeta.EntitlementTemplate != nil {
+		if rMeta.EntitlementTemplate.Type() != vMeta.EntitlementTemplate.Type() {
 			errs = append(errs, errors.New("incompatible entitlement template type"))
 		} else {
 			switch rMeta.EntitlementTemplate.Type() {
@@ -693,10 +653,6 @@ func rateCardsCompatible(r, v RateCard) error {
 						rMetered.UsagePeriod.ISOString(), vMetered.UsagePeriod.ISOString()),
 					)
 				}
-
-				if lo.FromPtr(rMetered.IssueAfterReset) > lo.FromPtr(vMetered.IssueAfterReset) {
-					errs = append(errs, errors.New("incompatible issue after reset for metered entitlement"))
-				}
 			case entitlement.EntitlementTypeBoolean:
 			}
 		}

pkg/slicesx/iteratee.go

@@ -0,0 +1,7 @@
+package slicesx
+
+func AsFilterIteratee[T any](f func(T) bool) func(T, int) bool {
+	return func(v T, _ int) bool {
+		return f(v)
+	}
+}