fix: consider only non-empty values when parsing pagination parameter…

…s from URLs
ory · Jan 4, 2024 · 164edc3 · 164edc3
1 parent e77628a
commit 164edc3
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 4 deletions.
diff --git a/pagination/keysetpagination/header.go b/pagination/keysetpagination/header.go
@@ -10,6 +10,7 @@ import (
 	"strconv"
 	"strings"
 
+	"github.com/ory/x/stringsx"
 	"github.com/pkg/errors"
 )
 
@@ -94,8 +95,8 @@ func Header(w http.ResponseWriter, u *url.URL, p *Paginator) {
 // Parse returns the pagination options from the URL query.
 func Parse(q url.Values, p PageTokenConstructor) ([]Option, error) {
 	var opts []Option
-	if q.Has("page_token") {
-		pageToken, err := url.QueryUnescape(q.Get("page_token"))
+	if pt := stringsx.Coalesce(q["page_token"]...); pt != "" {
+		pageToken, err := url.QueryUnescape(pt)
 		if err != nil {
 			return nil, errors.WithStack(err)
 		}
@@ -105,8 +106,8 @@ func Parse(q url.Values, p PageTokenConstructor) ([]Option, error) {
 		}
 		opts = append(opts, WithToken(parsed))
 	}
-	if q.Get("page_size") != "" {
-		size, err := strconv.Atoi(q.Get("page_size"))
+	if ps := stringsx.Coalesce(q["page_size"]...); ps != "" {
+		size, err := strconv.Atoi(ps)
 		if err != nil {
 			return nil, errors.WithStack(err)
 		}

diff --git a/pagination/keysetpagination/paginator_test.go b/pagination/keysetpagination/paginator_test.go
@@ -168,6 +168,26 @@ func TestParse(t *testing.T) {
 		_, err := Parse(url.Values{"page_size": {"invalid-int"}}, NewStringPageToken)
 		require.ErrorIs(t, err, strconv.ErrSyntax)
 	})
+
+	t.Run("empty tokens and page sizes work as if unset, empty values are skipped", func(t *testing.T) {
+		opts, err := Parse(url.Values{}, NewStringPageToken)
+		require.NoError(t, err)
+		paginator := GetPaginator(append(opts, WithDefaultToken(StringPageToken("default")))...)
+		assert.Equal(t, "default", paginator.Token().Encode())
+		assert.Equal(t, 100, paginator.Size())
+
+		opts, err = Parse(url.Values{"page_token": {""}, "page_size": {""}}, NewStringPageToken)
+		require.NoError(t, err)
+		paginator = GetPaginator(append(opts, WithDefaultToken(StringPageToken("default2")))...)
+		assert.Equal(t, "default2", paginator.Token().Encode())
+		assert.Equal(t, 100, paginator.Size())
+
+		opts, err = Parse(url.Values{"page_token": {"", "foo", ""}, "page_size": {"", "123", ""}}, NewStringPageToken)
+		require.NoError(t, err)
+		paginator = GetPaginator(append(opts, WithDefaultToken(StringPageToken("default3")))...)
+		assert.Equal(t, "foo", paginator.Token().Encode())
+		assert.Equal(t, 123, paginator.Size())
+	})
 }
 
 func TestPaginateWithAdditionalColumn(t *testing.T) {