feat: implement featurefilters for transaction listing

Author: GAlexIHU

api/spec/packages/aip-client-javascript/src/models/schemas.ts

@@ -2735,6 +2735,7 @@ export const listCreditTransactionsParamsFilter = z
   .object({
     type: creditTransactionType.optional(),
     currency: billingCurrencyCode.optional(),
+    feature_key: stringFieldFilter.optional(),
   })
   .describe('Filter options for listing credit transactions.')
 

api/spec/packages/aip-client-javascript/src/models/types.ts

@@ -1533,6 +1533,21 @@ export interface ListCreditTransactionsParamsFilter {
   type?: 'funded' | 'consumed' | 'expired'
   /** Filter credit transactions by currency. */
   currency?: string
+  /** Filter credit transactions by feature key. Omit to return all credit transactions. Use `exists=false` to return only unrestricted credit transactions. */
+  feature_key?:
+    | string
+    | {
+        eq?: string
+        neq?: string
+        contains?: string
+        ocontains?: string[]
+        oeq?: string[]
+        gt?: string
+        gte?: string
+        lt?: string
+        lte?: string
+        exists?: boolean
+      }
 }
 
 /** A credit transaction represents a single credit movement on the customer's balance. Credit transactions are immutable. */

api/spec/packages/aip/src/customers/credits/operations.tsp

@@ -204,6 +204,13 @@ model ListCreditTransactionsParamsFilter {
    */
   currency?: Currencies.CurrencyCode;
 
+  /**
+   * Filter credit transactions by feature key. Omit to return all credit
+   * transactions. Use `exists=false` to return only unrestricted credit
+   * transactions.
+   */
+  feature_key?: Common.StringFieldFilter;
+
   // TODO: add date filters for created_at and booked_at
 }
 

api/v3/api.gen.go

@@ -13,7 +13,7 @@ import (
 	"github.com/openmeterio/openmeter/openmeter/ledger/customerbalance"
 )
 
-func fromAPICreditBalanceFeatureFilter(f *api.StringFieldFilter) (mo.Option[creditpurchase.FeatureFilters], error) {
+func fromAPICustomerCreditFeatureFilter(f *api.StringFieldFilter) (mo.Option[creditpurchase.FeatureFilters], error) {
 	if f == nil {
 		return customerbalance.AllFeatureFilter(), nil
 	}
@@ -26,7 +26,7 @@ func fromAPICreditBalanceFeatureFilter(f *api.StringFieldFilter) (mo.Option[cred
 		return customerbalance.AllFeatureFilter(), errors.New("exists=true operator is not supported")
 	}
 
-	if op := unsupportedCreditBalanceFeatureKeyOperator(f); op != "" {
+	if op := unsupportedCustomerCreditFeatureKeyOperator(f); op != "" {
 		return customerbalance.AllFeatureFilter(), fmt.Errorf("%s operator is not supported", op)
 	}
 
@@ -48,7 +48,7 @@ func fromAPICreditBalanceFeatureFilter(f *api.StringFieldFilter) (mo.Option[cred
 	return featureFilter, nil
 }
 
-func unsupportedCreditBalanceFeatureKeyOperator(f *api.StringFieldFilter) string {
+func unsupportedCustomerCreditFeatureKeyOperator(f *api.StringFieldFilter) string {
 	switch {
 	case f.Neq != nil:
 		return "neq"

…/customers/credits/get_balance_filter.go …lers/customers/credits/feature_filter.goapi/v3/handlers/customers/credits/get_balance_filter.go renamed to api/v3/handlers/customers/credits/feature_filter.go api/v3/handlers/customers/credits/get_balance_filter.go renamed to api/v3/handlers/customers/credits/feature_filter.go

@@ -12,7 +12,7 @@ import (
 	"github.com/openmeterio/openmeter/openmeter/ledger/customerbalance"
 )
 
-func TestParseCreditBalanceFeatureFilter(t *testing.T) {
+func TestFromAPICustomerCreditFeatureFilter(t *testing.T) {
 	tests := []struct {
 		name    string
 		filter  *api.StringFieldFilter
@@ -62,7 +62,7 @@ func TestParseCreditBalanceFeatureFilter(t *testing.T) {
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			got, err := fromAPICreditBalanceFeatureFilter(tt.filter)
+			got, err := fromAPICustomerCreditFeatureFilter(tt.filter)
 			if tt.wantErr {
 				require.Error(t, err)
 				return

…rs/customers/credits/get_balance_test.go …customers/credits/feature_filter_test.goapi/v3/handlers/customers/credits/get_balance_test.go renamed to api/v3/handlers/customers/credits/feature_filter_test.go api/v3/handlers/customers/credits/get_balance_test.go renamed to api/v3/handlers/customers/credits/feature_filter_test.go

@@ -81,7 +81,7 @@ func (h *handler) GetCustomerCreditBalance() GetCustomerCreditBalanceHandler {
 			}
 
 			if args.Params.Filter != nil {
-				featureFilter, err := fromAPICreditBalanceFeatureFilter(args.Params.Filter.FeatureKey)
+				featureFilter, err := fromAPICustomerCreditFeatureFilter(args.Params.Filter.FeatureKey)
 				if err != nil {
 					return GetCustomerCreditBalanceRequest{}, newFeatureKeyFilterBadRequest(ctx, err)
 				}

api/v3/handlers/customers/credits/get_balance.go

@@ -98,6 +98,13 @@ func (h *handler) ListCreditTransactions() ListCreditTransactionsHandler {
 					currency := currencyx.Code(*args.Params.Filter.Currency)
 					req.Currency = &currency
 				}
+
+				featureFilter, err := fromAPICustomerCreditFeatureFilter(args.Params.Filter.FeatureKey)
+				if err != nil {
+					return ListCreditTransactionsRequest{}, newFeatureKeyFilterBadRequest(ctx, err)
+				}
+
+				req.FeatureFilter = featureFilter
 			}
 
 			return req, nil

api/v3/handlers/customers/credits/list_transactions.go

@@ -8190,8 +8190,8 @@ components:
           allOf:
             - $ref: '#/components/schemas/StringFieldFilter'
           description: |-
-            Filter credit balance by feature key. Omit to return the total portfolio
-            value. Use `exists=false` to return only unrestricted balance.
+            Filter credit balance by feature key. Omit to return the total portfolio value.
+            Use `exists=false` to return only unrestricted balance.
       additionalProperties: false
       description: Filter options for getting a credit balance.
     GovernanceFeatureAccess:
@@ -8687,6 +8687,12 @@ components:
           allOf:
             - $ref: '#/components/schemas/BillingCurrencyCode'
           description: Filter credit transactions by currency.
+        feature_key:
+          allOf:
+            - $ref: '#/components/schemas/StringFieldFilter'
+          description: |-
+            Filter credit transactions by feature key. Omit to return all credit transactions.
+            Use `exists=false` to return only unrestricted credit transactions.
       additionalProperties: false
       description: Filter options for listing credit transactions.
     ListCurrenciesParamsFilter:

api/v3/openapi.yaml

@@ -6,6 +6,8 @@ import (
 	"slices"
 
 	"entgo.io/ent/dialect/sql"
+	"github.com/lib/pq"
+	"github.com/samber/mo"
 
 	"github.com/openmeterio/openmeter/openmeter/billing/charges/creditpurchase"
 	"github.com/openmeterio/openmeter/openmeter/billing/charges/meta"
@@ -20,15 +22,20 @@ func (a *adapter) ListFundedCreditActivities(ctx context.Context, input creditpu
 }
 
 func ListFundedCreditActivities(ctx context.Context, dbClient *db.Client, input creditpurchase.ListFundedCreditActivitiesInput) (creditpurchase.ListFundedCreditActivitiesResult, error) {
+	creditPurchasePredicates := []predicate.ChargeCreditPurchase{
+		dbchargecreditpurchase.Namespace(input.Customer.Namespace),
+		dbchargecreditpurchase.CustomerIDEQ(input.Customer.ID),
+		dbchargecreditpurchase.DeletedAtIsNil(),
+	}
+	if featurePredicate := fundedCreditActivityFeatureFilterPredicate(input.FeatureFilter); featurePredicate != nil {
+		creditPurchasePredicates = append(creditPurchasePredicates, featurePredicate)
+	}
+
 	query := dbClient.ChargeCreditPurchaseCreditGrant.Query().
 		Where(
 			dbchargecreditpurchasecreditgrant.Namespace(input.Customer.Namespace),
 			dbchargecreditpurchasecreditgrant.DeletedAtIsNil(),
-			dbchargecreditpurchasecreditgrant.HasCreditPurchaseWith(
-				dbchargecreditpurchase.Namespace(input.Customer.Namespace),
-				dbchargecreditpurchase.CustomerIDEQ(input.Customer.ID),
-				dbchargecreditpurchase.DeletedAtIsNil(),
-			),
+			dbchargecreditpurchasecreditgrant.HasCreditPurchaseWith(creditPurchasePredicates...),
 		).
 		WithCreditPurchase(func(q *db.ChargeCreditPurchaseQuery) {
 			q.Where(
@@ -53,11 +60,7 @@ func ListFundedCreditActivities(ctx context.Context, dbClient *db.Client, input
 	}
 
 	if input.Currency != nil {
-		query = query.Where(
-			dbchargecreditpurchasecreditgrant.HasCreditPurchaseWith(
-				dbchargecreditpurchase.CurrencyEQ(*input.Currency),
-			),
-		)
+		query = query.Where(dbchargecreditpurchasecreditgrant.HasCreditPurchaseWith(dbchargecreditpurchase.CurrencyEQ(*input.Currency)))
 	}
 
 	if input.AsOf != nil {
@@ -130,6 +133,27 @@ func ListFundedCreditActivities(ctx context.Context, dbClient *db.Client, input
 	}, nil
 }
 
+func fundedCreditActivityFeatureFilterPredicate(filter mo.Option[creditpurchase.FeatureFilters]) predicate.ChargeCreditPurchase {
+	if filter.IsAbsent() {
+		return nil
+	}
+
+	features := filter.OrEmpty()
+	if features == nil {
+		return dbchargecreditpurchase.FeatureFiltersIsNil()
+	}
+	features = features.Normalize()
+
+	return dbchargecreditpurchase.Or(
+		dbchargecreditpurchase.FeatureFiltersIsNil(),
+		func(s *sql.Selector) {
+			s.Where(sql.P(func(b *sql.Builder) {
+				b.Ident(s.C(dbchargecreditpurchase.FieldFeatureFilters)).WriteString(" @> ").Arg(pq.StringArray{features[0]})
+			}))
+		},
+	)
+}
+
 func fundedCreditActivityAfterPredicate(cursor creditpurchase.FundedCreditActivityCursor) predicate.ChargeCreditPurchaseCreditGrant {
 	return dbchargecreditpurchasecreditgrant.Or(
 		dbchargecreditpurchasecreditgrant.GrantedAtLT(cursor.FundedAt),