add tx filtering by amount

Author: Azorlogh

internal/api/v2/controllers_transactions_list_test.go

@@ -146,6 +146,20 @@ func TestTransactionsList(t *testing.T) {
 				},
 			},
 		},
+		{
+			name: "using amount",
+			body: `{"$lt": {"amount[EUR]": 20}}`,
+			expectQuery: storagecommon.InitialPaginatedQuery[any]{
+				PageSize: bunpaginate.QueryDefaultPageSize,
+				Column:   "id",
+				Order:    pointer.For(bunpaginate.Order(bunpaginate.OrderDesc)),
+				Options: storagecommon.ResourceQuery[any]{
+					PIT:     &now,
+					Builder: query.Lt("EUR", 20),
+					Expand:  make([]string, 0),
+				},
+			},
+		},
 		{
 			name: "using empty cursor",
 			queryParams: url.Values{

internal/storage/ledger/resource_transactions.go

@@ -25,6 +25,7 @@ func (h transactionsResourceHandler) Schema() common.EntitySchema {
 			"reference": common.NewStringField(),
 			"inserted_at": common.NewDateField().Paginated(),
 			"updated_at": common.NewDateField().Paginated(),
+			"amount": common.NewNumericMapField(),
 		},
 	}
 }
@@ -101,6 +102,20 @@ func (h transactionsResourceHandler) ResolveFilter(_ common.ResourceQuery[any],
 		return filterAccountAddressOnTransactions(value.(string), true, false), nil, nil
 	case property == "destination":
 		return filterAccountAddressOnTransactions(value.(string), false, true), nil, nil
+	case amountRegex.Match([]byte(property)):
+		asset := amountRegex.FindStringSubmatch(property)[1]
+
+		selectAmount := h.store.db.NewSelect().
+			ModelTableExpr(fmt.Sprintf("%[1]s, jsonb_array_elements(%[1]s.postings::jsonb) posting", h.store.GetPrefixedRelationName("transactions"))).
+			Where("id = dataset.id").
+			Where("ledger = ?", h.store.ledger.Name).
+			Where("posting->>'asset' = ?", asset).
+			ColumnExpr("sum((posting->'amount')::numeric) amount")
+
+		return h.store.db.NewSelect().
+			TableExpr("(?) amount", selectAmount).
+			ColumnExpr(fmt.Sprintf("amount %s ?", common.ConvertOperatorToSQL(operator)), value).
+			String(), nil, nil
 	case common.MetadataRegex.Match([]byte(property)):
 		match := common.MetadataRegex.FindAllStringSubmatch(property, 3)
 

internal/storage/ledger/transactions.go

@@ -9,6 +9,7 @@ import (
 	"math/big"
 	"slices"
 	"strings"
+	"regexp"
 
 	"github.com/formancehq/ledger/internal/tracing"
 
@@ -28,6 +29,10 @@ import (
 	"github.com/uptrace/bun"
 )
 
+var (
+	amountRegex = regexp.MustCompile(`amount\[(.*)]`)
+)
+
 func (store *Store) CommitTransaction(ctx context.Context, tx *ledger.Transaction, accountMetadata map[string]metadata.Metadata) error {
 	if accountMetadata == nil {
 		accountMetadata = make(map[string]metadata.Metadata)

internal/storage/ledger/transactions_test.go

@@ -730,6 +730,15 @@ func TestTransactionsList(t *testing.T) {
 	err = store.CommitTransaction(ctx, &tx5, nil)
 	require.NoError(t, err)
 
+	tx6 := ledger.NewTransaction().
+		WithPostings(
+			ledger.NewPosting("world", "users:charlie", "EUR", big.NewInt(30)),
+			ledger.NewPosting("users:charlie", "world", "EUR", big.NewInt(30)),
+		).
+		WithTimestamp(now)
+	err = store.CommitTransaction(ctx, &tx6, nil)
+	require.NoError(t, err)
+
 	type testCase struct {
 		name        string
 		query       common.InitialPaginatedQuery[any]
@@ -740,7 +749,7 @@ func TestTransactionsList(t *testing.T) {
 		{
 			name:     "nominal",
 			query:    common.InitialPaginatedQuery[any]{},
-			expected: []ledger.Transaction{tx5, tx4, tx3, tx2, tx1},
+			expected: []ledger.Transaction{tx6, tx5, tx4, tx3, tx2, tx1},
 		},
 		{
 			name: "address filter",
@@ -767,7 +776,7 @@ func TestTransactionsList(t *testing.T) {
 					Builder: query.Match("account", "users:"),
 				},
 			},
-			expected: []ledger.Transaction{tx5, tx4, tx3},
+			expected: []ledger.Transaction{tx6, tx5, tx4, tx3},
 		},
 		{
 			name: "address filter using segment and unbounded segment list",
@@ -776,7 +785,7 @@ func TestTransactionsList(t *testing.T) {
 					Builder: query.Match("account", "users:..."),
 				},
 			},
-			expected: []ledger.Transaction{tx5, tx4, tx3},
+			expected: []ledger.Transaction{tx6, tx5, tx4, tx3},
 		},
 		{
 			name: "filter using metadata",
@@ -846,7 +855,7 @@ func TestTransactionsList(t *testing.T) {
 					Builder: query.Not(query.Exists("metadata", "category")),
 				},
 			},
-			expected: []ledger.Transaction{tx5, tx4},
+			expected: []ledger.Transaction{tx6, tx5, tx4},
 		},
 		{
 			name: "filter using timestamp",
@@ -855,7 +864,16 @@ func TestTransactionsList(t *testing.T) {
 					Builder: query.Match("timestamp", tx5.Timestamp.Format(time.RFC3339Nano)),
 				},
 			},
-			expected: []ledger.Transaction{tx5, tx4},
+			expected: []ledger.Transaction{tx6, tx5, tx4},
+		},
+		{
+			name: "filter using amount",
+			query: common.InitialPaginatedQuery[any]{
+				Options: common.ResourceQuery[any]{
+					Builder: query.Gt("amount[EUR]", 50),
+				},
+			},
+			expected: []ledger.Transaction{tx6, tx1},
 		},
 	}
 

test/e2e/api_transactions_list_test.go

@@ -399,7 +399,7 @@ var _ = Context("Ledger transactions list API tests", func() {
 				}))
 			})
 		})
-		When("listing transactions using filter on a single match", func() {
+		When("listing transactions using filter on multiple matches", func() {
 			var (
 				err      error
 				response *operations.V2ListTransactionsResponse
@@ -444,6 +444,40 @@ var _ = Context("Ledger transactions list API tests", func() {
 				}))
 			})
 		})
+		When("listing transactions using filter on amount", func() {
+			var (
+				err      error
+				response *operations.V2ListTransactionsResponse
+				now      = time.Now().Round(time.Second).UTC()
+			)
+			JustBeforeEach(func(specContext SpecContext) {
+				response, err = Wait(specContext, DeferClient(testServer)).Ledger.V2.ListTransactions(
+					ctx,
+					operations.V2ListTransactionsRequest{
+						RequestBody: map[string]interface{}{
+							"$gt": map[string]any{
+								"amount[EUR]": 10,
+							},
+						},
+						Ledger:   "default",
+						PageSize: pointer.For(pageSize),
+						Pit:      &now,
+					},
+				)
+				Expect(err).To(BeNil())
+			})
+			_ = response
+			It("Should be ok", func() {
+				Expect(response.V2TransactionsCursorResponse.Cursor.Next).NotTo(BeNil())
+				cursor := &common.ColumnPaginatedQuery[any]{}
+				Expect(bunpaginate.UnmarshalCursor(*response.V2TransactionsCursorResponse.Cursor.Next, cursor)).To(BeNil())
+				Expect(cursor.PageSize).To(Equal(uint64(10)))
+				Expect(cursor.Options).To(Equal(common.ResourceQuery[any]{
+					Builder: query.Gt("amount[EUR]", float64(10.0)),
+					PIT:     pointer.For(libtime.New(now)),
+				}))
+			})
+		})
 		When("listing transactions using invalid filter", func() {
 			var (
 				err error