fix: page size ignored when a cursor is used (#914)

Author: gfyrag

internal/api/v2/common.go

@@ -63,51 +63,63 @@ func getExpand(r *http.Request) []string {
 }
 
 func getOffsetPaginatedQuery[v any](r *http.Request, paginationConfig common.PaginationConfig, modifiers ...func(*v) error) (*storagecommon.OffsetPaginatedQuery[v], error) {
-	return bunpaginate.Extract[storagecommon.OffsetPaginatedQuery[v]](r, func() (*storagecommon.OffsetPaginatedQuery[v], error) {
+	ret, err := bunpaginate.Extract[storagecommon.OffsetPaginatedQuery[v]](r, func() (*storagecommon.OffsetPaginatedQuery[v], error) {
 		rq, err := getResourceQuery[v](r, modifiers...)
 		if err != nil {
 			return nil, err
 		}
 
-		pageSize, err := bunpaginate.GetPageSize(
+		return &storagecommon.OffsetPaginatedQuery[v]{
+			Options: *rq,
+		}, nil
+	})
+	if err != nil {
+		return nil, err
+	}
+
+	if ret.PageSize == 0 || r.URL.Query().Get(bunpaginate.QueryKeyPageSize) != "" {
+		ret.PageSize, err = bunpaginate.GetPageSize(
 			r,
 			bunpaginate.WithMaxPageSize(paginationConfig.MaxPageSize),
 			bunpaginate.WithDefaultPageSize(paginationConfig.DefaultPageSize),
 		)
 		if err != nil {
 			return nil, err
 		}
+	}
 
-		return &storagecommon.OffsetPaginatedQuery[v]{
-			PageSize: pageSize,
-			Options:  *rq,
-		}, nil
-	})
+	return ret, nil
 }
 
 func getColumnPaginatedQuery[v any](r *http.Request, paginationConfig common.PaginationConfig, defaultPaginationColumn string, order bunpaginate.Order, modifiers ...func(*v) error) (*storagecommon.ColumnPaginatedQuery[v], error) {
-	return bunpaginate.Extract[storagecommon.ColumnPaginatedQuery[v]](r, func() (*storagecommon.ColumnPaginatedQuery[v], error) {
+	ret, err := bunpaginate.Extract[storagecommon.ColumnPaginatedQuery[v]](r, func() (*storagecommon.ColumnPaginatedQuery[v], error) {
 		rq, err := getResourceQuery[v](r, modifiers...)
 		if err != nil {
 			return nil, err
 		}
 
-		pageSize, err := bunpaginate.GetPageSize(
+		return &storagecommon.ColumnPaginatedQuery[v]{
+			Column:  defaultPaginationColumn,
+			Order:   pointer.For(order),
+			Options: *rq,
+		}, nil
+	})
+	if err != nil {
+		return nil, err
+	}
+
+	if ret.PageSize == 0 || r.URL.Query().Get(bunpaginate.QueryKeyPageSize) != "" {
+		ret.PageSize, err = bunpaginate.GetPageSize(
 			r,
 			bunpaginate.WithMaxPageSize(paginationConfig.MaxPageSize),
 			bunpaginate.WithDefaultPageSize(paginationConfig.DefaultPageSize),
 		)
 		if err != nil {
 			return nil, err
 		}
+	}
 
-		return &storagecommon.ColumnPaginatedQuery[v]{
-			PageSize: pageSize,
-			Column:   defaultPaginationColumn,
-			Order:    pointer.For(order),
-			Options:  *rq,
-		}, nil
-	})
+	return ret, nil
 }
 
 func getResourceQuery[v any](r *http.Request, modifiers ...func(*v) error) (*storagecommon.ResourceQuery[v], error) {

internal/api/v2/controllers_transactions_list_test.go

@@ -151,7 +151,9 @@ func TestTransactionsList(t *testing.T) {
 			queryParams: url.Values{
 				"cursor": []string{bunpaginate.EncodeCursor(storagecommon.ColumnPaginatedQuery[any]{})},
 			},
-			expectQuery: storagecommon.ColumnPaginatedQuery[any]{},
+			expectQuery: storagecommon.ColumnPaginatedQuery[any]{
+				PageSize: bunpaginate.QueryDefaultPageSize,
+			},
 		},
 		{
 			name: "using invalid cursor",

test/e2e/api_transactions_list_test.go

@@ -127,6 +127,38 @@ var _ = Context("Ledger transactions list API tests", func() {
 				Expect(rsp.V2TransactionsCursorResponse.Cursor.Data).To(Equal(expectedTxs))
 			})
 		})
+		When("listing transactions using a page size of 5", func() {
+			var (
+				rsp *operations.V2ListTransactionsResponse
+				err error
+			)
+			JustBeforeEach(func(specContext SpecContext) {
+				rsp, err = Wait(specContext, DeferClient(testServer)).Ledger.V2.ListTransactions(
+					ctx,
+					operations.V2ListTransactionsRequest{
+						Ledger:   "default",
+						PageSize: pointer.For(int64(5)),
+					},
+				)
+				Expect(err).ToNot(HaveOccurred())
+			})
+			When("using next page with a page size of 10", func() {
+				JustBeforeEach(func(specContext SpecContext) {
+					rsp, err = Wait(specContext, DeferClient(testServer)).Ledger.V2.ListTransactions(
+						ctx,
+						operations.V2ListTransactionsRequest{
+							Ledger:   "default",
+							Cursor:   rsp.V2TransactionsCursorResponse.Cursor.Next,
+							PageSize: pointer.For(int64(10)),
+						},
+					)
+					Expect(err).ToNot(HaveOccurred())
+				})
+				It("Should return 10 elements", func() {
+					Expect(rsp.V2TransactionsCursorResponse.Cursor.Data).To(HaveLen(10))
+				})
+			})
+		})
 		When(fmt.Sprintf("listing transactions using page size of %d", pageSize), func() {
 			var (
 				rsp *operations.V2ListTransactionsResponse