Fix tests and refactor checks

stellar · Dec 19, 2024 · 8909ffc · 8909ffc
1 parent 1acc9af
commit 8909ffc
Show file tree

Hide file tree

Showing 3 changed files with 50 additions and 41 deletions.
diff --git a/cmd/stellar-rpc/internal/methods/get_events.go b/cmd/stellar-rpc/internal/methods/get_events.go
@@ -118,25 +118,6 @@ func (g *GetEventsRequest) Valid(maxLimit uint) error {
 		return err
 	}
 
-	// Validate the paging limit (if it exists)
-	if g.Pagination != nil && g.Pagination.Cursor != nil {
-		if g.StartLedger != 0 || g.EndLedger != 0 {
-			return errors.New("ledger ranges and cursor cannot both be set")
-		}
-	}
-
-	if g.StartLedger <= 0 {
-		return errors.New("startLedger must be positive")
-	}
-
-	if g.EndLedger < g.StartLedger {
-		return errors.New("startLedger must be >= endLedger")
-	}
-
-	if g.Pagination != nil && g.Pagination.Limit > maxLimit {
-		return fmt.Errorf("limit must not exceed %d", maxLimit)
-	}
-
 	// Validate filters
 	if len(g.Filters) > maxFiltersLimit {
 		return errors.New("maximum 5 filters per request")
@@ -147,6 +128,24 @@ func (g *GetEventsRequest) Valid(maxLimit uint) error {
 		}
 	}
 
+	if g.Pagination != nil {
+		if g.Pagination.Cursor != nil && (g.StartLedger != 0 || g.EndLedger != 0) {
+			return errors.New("ledger ranges and cursor cannot both be set")
+		}
+		if g.Pagination.Limit > maxLimit {
+			return fmt.Errorf("limit must not exceed %d", maxLimit)
+		}
+		return nil
+	}
+
+	// Pagination not enabled
+	if g.StartLedger <= 0 {
+		return errors.New("startLedger must be positive")
+	}
+	if g.EndLedger > 0 && g.EndLedger < g.StartLedger {
+		return errors.New("startLedger must be >= endLedger")
+	}
+
 	return nil
 }
 
@@ -530,7 +529,7 @@ func (h eventsRPCHandler) getEvents(ctx context.Context, request GetEventsReques
 		// here endLedger is always exclusive when fetching events
 		// so search window is max Cursor value with endLedger - 1
 		maxCursor := db.MaxCursor
-		maxCursor.Event = endLedger - 1
+		maxCursor.Ledger = endLedger - 1
 		cursor = maxCursor.String()
 	}
 

diff --git a/cmd/stellar-rpc/internal/methods/get_events_test.go b/cmd/stellar-rpc/internal/methods/get_events_test.go
@@ -4,7 +4,6 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
-	"math"
 	"path"
 	"strconv"
 	"strings"
@@ -656,8 +655,10 @@ func TestGetEvents(t *testing.T) {
 				TransactionHash:          ledgerCloseMeta.TransactionHash(i).HexString(),
 			})
 		}
-		cursor := db.Cursor{Ledger: 1, Tx: math.MaxUint32, Event: math.MaxUint32 - 1}.String()
-		assert.Equal(t, GetEventsResponse{expected, 1, cursor}, results)
+		cursor := db.MaxCursor
+		cursor.Ledger = 1
+		cursorStr := cursor.String()
+		assert.Equal(t, GetEventsResponse{expected, 1, cursorStr}, results)
 	})
 
 	t.Run("filtering by contract id", func(t *testing.T) {
@@ -803,9 +804,11 @@ func TestGetEvents(t *testing.T) {
 				TransactionHash:          ledgerCloseMeta.TransactionHash(4).HexString(),
 			},
 		}
-		cursor := db.Cursor{Ledger: 1, Tx: math.MaxUint32, Event: math.MaxUint32 - 1}.String()
 
-		assert.Equal(t, GetEventsResponse{expected, 1, cursor}, results)
+		cursor := db.MaxCursor
+		cursor.Ledger = 1
+		cursorStr := cursor.String()
+		assert.Equal(t, GetEventsResponse{expected, 1, cursorStr}, results)
 
 		results, err = handler.getEvents(ctx, GetEventsRequest{
 			StartLedger: 1,
@@ -839,7 +842,7 @@ func TestGetEvents(t *testing.T) {
 
 		expected[0].ValueJSON = valueJs
 		expected[0].TopicJSON = topicsJs
-		require.Equal(t, GetEventsResponse{expected, 1, cursor}, results)
+		require.Equal(t, GetEventsResponse{expected, 1, cursorStr}, results)
 	})
 
 	t.Run("filtering by both contract id and topic", func(t *testing.T) {
@@ -950,9 +953,10 @@ func TestGetEvents(t *testing.T) {
 				TransactionHash:          ledgerCloseMeta.TransactionHash(3).HexString(),
 			},
 		}
-		cursor := db.Cursor{Ledger: 1, Tx: math.MaxUint32, Event: math.MaxUint32 - 1}.String()
-
-		assert.Equal(t, GetEventsResponse{expected, 1, cursor}, results)
+		cursor := db.MaxCursor
+		cursor.Ledger = 1
+		cursorStr := cursor.String()
+		assert.Equal(t, GetEventsResponse{expected, 1, cursorStr}, results)
 	})
 
 	t.Run("filtering by event type", func(t *testing.T) {
@@ -1027,9 +1031,10 @@ func TestGetEvents(t *testing.T) {
 				TransactionHash:          ledgerCloseMeta.TransactionHash(0).HexString(),
 			},
 		}
-		cursor := db.Cursor{Ledger: 1, Tx: math.MaxUint32, Event: math.MaxUint32 - 1}.String()
-
-		assert.Equal(t, GetEventsResponse{expected, 1, cursor}, results)
+		cursor := db.MaxCursor
+		cursor.Ledger = 1
+		cursorStr := cursor.String()
+		assert.Equal(t, GetEventsResponse{expected, 1, cursorStr}, results)
 	})
 
 	t.Run("with limit", func(t *testing.T) {
@@ -1218,7 +1223,9 @@ func TestGetEvents(t *testing.T) {
 
 		// Note: endLedger is always exclusive when fetching events
 		// so search window is always max Cursor value with endLedger - 1
-		cursor = db.Cursor{Ledger: uint32(endLedger - 1), Tx: math.MaxUint32, Event: math.MaxUint32 - 1}.String()
+		rawCursor := db.MaxCursor
+		rawCursor.Ledger = uint32(endLedger - 1)
+		cursor = rawCursor.String()
 		assert.Equal(t, GetEventsResponse{[]EventInfo{}, 5, cursor}, results)
 	})
 }

diff --git a/cmd/stellar-rpc/internal/methods/get_transactions.go b/cmd/stellar-rpc/internal/methods/get_transactions.go
@@ -36,24 +36,27 @@ type GetTransactionsRequest struct {
 
 // isValid checks the validity of the request parameters.
 func (req GetTransactionsRequest) isValid(maxLimit uint, ledgerRange ledgerbucketwindow.LedgerRange) error {
-	if req.Pagination != nil && req.Pagination.Cursor != "" {
-		if req.StartLedger != 0 {
+	if err := IsValidFormat(req.Format); err != nil {
+		return err
+	}
+	if req.Pagination != nil {
+		if req.Pagination.Cursor != "" && req.StartLedger != 0 {
 			return errors.New("startLedger and cursor cannot both be set")
 		}
+		if req.Pagination.Limit > maxLimit {
+			return fmt.Errorf("limit must not exceed %d", maxLimit)
+		}
+		return nil
 	}
+	// Pagination is not enabled
 	if req.StartLedger < ledgerRange.FirstLedger.Sequence || req.StartLedger > ledgerRange.LastLedger.Sequence {
 		return fmt.Errorf(
 			"start ledger must be between the oldest ledger: %d and the latest ledger: %d for this rpc instance",
 			ledgerRange.FirstLedger.Sequence,
 			ledgerRange.LastLedger.Sequence,
 		)
 	}
-
-	if req.Pagination != nil && req.Pagination.Limit > maxLimit {
-		return fmt.Errorf("limit must not exceed %d", maxLimit)
-	}
-
-	return IsValidFormat(req.Format)
+	return nil
 }
 
 type TransactionDetails struct {