feat(taxcode): prevent deletion of plan-referenced tax codes and validate tax codes on plan publish

Author: borbelyr-kong

app/common/productcatalog.go

@@ -25,6 +25,7 @@ import (
 	"github.com/openmeterio/openmeter/openmeter/productcatalog/planaddon"
 	planaddonadapter "github.com/openmeterio/openmeter/openmeter/productcatalog/planaddon/adapter"
 	planaddonservice "github.com/openmeterio/openmeter/openmeter/productcatalog/planaddon/service"
+	"github.com/openmeterio/openmeter/openmeter/productcatalog/taxcoderesolver"
 	"github.com/openmeterio/openmeter/openmeter/streaming"
 	"github.com/openmeterio/openmeter/openmeter/taxcode"
 	"github.com/openmeterio/openmeter/openmeter/watermill/eventbus"
@@ -49,6 +50,7 @@ var Cost = wire.NewSet(
 
 var Plan = wire.NewSet(
 	NewPlanService,
+	NewTaxCodeResolver,
 )
 
 var Addon = wire.NewSet(
@@ -71,6 +73,8 @@ func NewFeatureConnector(
 
 var NewFeatureResolver = featureresolver.New
 
+var NewTaxCodeResolver = taxcoderesolver.New
+
 func NewCostService(
 	featureConnector feature.FeatureConnector,
 	meterService meter.Service,
@@ -88,6 +92,7 @@ func NewPlanService(
 	logger *slog.Logger,
 	db *entdb.Client,
 	featureResolver productcatalog.FeatureResolver,
+	taxCodeResolver productcatalog.TaxCodeResolver,
 	taxCodeService taxcode.Service,
 	publisher eventbus.Publisher,
 ) (plan.Service, error) {
@@ -102,6 +107,7 @@ func NewPlanService(
 	return planservice.New(planservice.Config{
 		Adapter:         adapter,
 		FeatureResolver: featureResolver,
+		TaxCodeResolver: taxCodeResolver,
 		TaxCode:         taxCodeService,
 		Logger:          logger.With("subsystem", "productcatalog.plan"),
 		Publisher:       publisher,

cmd/billing-worker/wire_gen.go

@@ -121,6 +121,16 @@ var ErrRateCardFeatureArchived = models.NewValidationIssue(
 	commonhttp.WithHTTPStatusCodeAttribute(http.StatusBadRequest),
 )
 
+const ErrCodeRateCardTaxCodeNotFound models.ErrorCode = "rate_card_tax_code_not_found"
+
+var ErrRateCardTaxCodeNotFound = models.NewValidationIssue(
+	ErrCodeRateCardTaxCodeNotFound,
+	"tax code not found",
+	models.WithFieldString("taxConfig"),
+	models.WithCriticalSeverity(),
+	commonhttp.WithHTTPStatusCodeAttribute(http.StatusBadRequest),
+)
+
 const ErrCodeRateCardFeatureMismatch models.ErrorCode = "rate_card_feature_mismatch"
 
 var ErrRateCardFeatureMismatch = models.NewValidationIssue(

cmd/jobs/internal/wire_gen.go

@@ -365,3 +365,24 @@ func ValidatePlanWithFeatures(ctx context.Context, resolver NamespacedFeatureRes
 		return errors.Join(errs...)
 	}
 }
+
+func ValidatePlanWithTaxCodes(ctx context.Context, resolver NamespacedTaxCodeResolver) models.ValidatorFunc[Plan] {
+	return func(p Plan) error {
+		var errs []error
+
+		for _, phase := range p.Phases {
+			phaseFieldSelector := models.NewFieldSelectorGroup(
+				models.NewFieldSelector("phases").
+					WithExpression(
+						models.NewFieldAttrValue("key", phase.Key),
+					),
+			)
+
+			if err := ValidateRateCardsWithTaxCodes(ctx, resolver)(phase.RateCards); err != nil {
+				errs = append(errs, models.ErrorWithFieldPrefix(phaseFieldSelector, err))
+			}
+		}
+
+		return errors.Join(errs...)
+	}
+}

cmd/server/wire_gen.go

@@ -437,6 +437,16 @@ func (s service) PublishPlan(ctx context.Context, params plan.PublishPlanInput)
 			)
 		}
 
+		// Validate plan with tax codes
+		err = pp.ValidateWith(
+			productcatalog.ValidatePlanWithTaxCodes(ctx, s.taxCodeResolver.WithNamespace(params.Namespace)),
+		)
+		if err != nil {
+			errs = append(errs, fmt.Errorf("invalid plan [id=%s key=%s version=%d]: %w",
+				p.ID, p.Key, p.Version, err),
+			)
+		}
+
 		// Check for incompatible add-ons assigned to this plan
 
 		if p.Addons == nil {

openmeter/productcatalog/errors.go

@@ -17,6 +17,7 @@ type Config struct {
 	Publisher eventbus.Publisher
 
 	FeatureResolver productcatalog.FeatureResolver
+	TaxCodeResolver productcatalog.TaxCodeResolver
 }
 
 func New(config Config) (plan.Service, error) {
@@ -28,6 +29,10 @@ func New(config Config) (plan.Service, error) {
 		return nil, errors.New("feature resolver is required")
 	}
 
+	if config.TaxCodeResolver == nil {
+		return nil, errors.New("tax code resolver is required")
+	}
+
 	if config.Logger == nil {
 		return nil, errors.New("logger is required")
 	}
@@ -47,6 +52,7 @@ func New(config Config) (plan.Service, error) {
 		publisher: config.Publisher,
 
 		featureResolver: config.FeatureResolver,
+		taxCodeResolver: config.TaxCodeResolver,
 	}, nil
 }
 
@@ -59,4 +65,5 @@ type service struct {
 	publisher eventbus.Publisher
 
 	featureResolver productcatalog.FeatureResolver
+	taxCodeResolver productcatalog.TaxCodeResolver
 }

openmeter/productcatalog/plan.go

@@ -937,3 +937,41 @@ func ValidateRateCardsWithFeatures(ctx context.Context, resolver NamespacedFeatu
 		return errors.Join(errs...)
 	}
 }
+
+func ValidateRateCardsWithTaxCodes(ctx context.Context, resolver NamespacedTaxCodeResolver) func(cards RateCards) error {
+	return func(rateCards RateCards) error {
+		var errs []error
+
+		for _, rateCard := range rateCards {
+			rc := rateCard.AsMeta()
+
+			rateCardFieldSelector := models.NewFieldSelectorGroup(
+				models.NewFieldSelector("rateCards").
+					WithExpression(
+						models.NewFieldAttrValue("key", rateCard.Key()),
+					),
+			)
+
+			if rc.TaxConfig == nil || rc.TaxConfig.TaxCodeID == nil {
+				continue
+			}
+
+			tc, err := resolver.ResolveTaxCode(ctx, *rc.TaxConfig.TaxCodeID)
+			if err != nil {
+				if models.IsGenericNotFoundError(err) || taxcode.IsTaxCodeNotFoundError(err) {
+					errs = append(errs, models.ErrorWithFieldPrefix(rateCardFieldSelector, ErrRateCardTaxCodeNotFound))
+				} else {
+					errs = append(errs, fmt.Errorf("failed to resolve tax code for ratecard: %w", err))
+				}
+
+				continue
+			}
+
+			if tc == nil || tc.DeletedAt != nil {
+				errs = append(errs, models.ErrorWithFieldPrefix(rateCardFieldSelector, ErrRateCardTaxCodeNotFound))
+			}
+		}
+
+		return errors.Join(errs...)
+	}
+}

openmeter/productcatalog/plan/service/plan.go

@@ -0,0 +1,19 @@
+package productcatalog
+
+import (
+	"context"
+
+	"github.com/openmeterio/openmeter/openmeter/taxcode"
+)
+
+// TaxCodeResolver resolves tax codes across namespaces and can create a namespace-scoped resolver.
+type TaxCodeResolver interface {
+	ResolveTaxCode(ctx context.Context, namespace string, id string) (*taxcode.TaxCode, error)
+	WithNamespace(namespace string) NamespacedTaxCodeResolver
+}
+
+// NamespacedTaxCodeResolver resolves tax codes within a fixed namespace.
+type NamespacedTaxCodeResolver interface {
+	ResolveTaxCode(ctx context.Context, id string) (*taxcode.TaxCode, error)
+	Namespace() string
+}