Skip to content

Preserve column names in page #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
klaidliadon merged 2 commits into from
Feb 12, 2026
Merged

Preserve column names in page #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
43e2776
Preserve column names in page
klaidliadon Feb 12, 2026
fb306e5
refactor: use slices.Clone to copy Sort slice in GetOrder method
klaidliadon Feb 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions page.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package pgkit
import (
"fmt"
"regexp"
"slices"
"strings"

sq "github.com/Masterminds/squirrel"
Expand Down Expand Up @@ -111,8 +112,7 @@ func (p *Page) SetDefaults(o *PaginatorSettings) {
func (p *Page) GetOrder(columnFunc func(string) string, defaultSort ...string) []Sort {
var sorts []Sort
if p != nil && len(p.Sort) != 0 {
// use sort
sorts = p.Sort
sorts = slices.Clone(p.Sort)
}
// fall back to column
if len(sorts) == 0 {
Expand Down
22 changes: 22 additions & 0 deletions page_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ func TestPagination(t *testing.T) {
require.NoError(t, err)
require.Equal(t, `SELECT * FROM t ORDER BY "id" ASC LIMIT 3 OFFSET 0`, sql)
require.Empty(t, args)
// Verify page.Column and page.Sort are not modified
require.Empty(t, page.Column)
require.Len(t, page.Sort, 0)

result = paginator.PrepareResult(make([]T, 0), page)
require.Len(t, result, 0)
Expand Down Expand Up @@ -60,6 +63,9 @@ func TestInvalidSort(t *testing.T) {
require.NoError(t, err)
require.Equal(t, "SELECT * FROM t ORDER BY \"ID; DROP TABLE users;\" ASC, \"name\" DESC LIMIT 11 OFFSET 0", sql)
require.Empty(t, args)
// Verify columns in page.Sort are not quoted
require.Equal(t, "ID; DROP TABLE users;", page.Sort[0].Column)
require.Equal(t, "name", page.Sort[1].Column)
}

func TestPageColumnInjection(t *testing.T) {
Expand All @@ -73,6 +79,8 @@ func TestPageColumnInjection(t *testing.T) {
require.NoError(t, err)
require.Equal(t, "SELECT * FROM t ORDER BY \"id; DROP TABLE users;--\" ASC LIMIT 11 OFFSET 0", sql)
require.Empty(t, args)
// Verify column in page is not quoted
require.Equal(t, "id; DROP TABLE users;--", page.Column)
}

func TestPageColumnSpaces(t *testing.T) {
Expand All @@ -86,6 +94,8 @@ func TestPageColumnSpaces(t *testing.T) {
require.NoError(t, err)
require.Equal(t, "SELECT * FROM t ORDER BY \"id\" ASC, \"name\" ASC LIMIT 11 OFFSET 0", sql)
require.Empty(t, args)
// Verify column in page is not quoted
require.Equal(t, "id, name", page.Column)
}

func TestSortOrderInjection(t *testing.T) {
Expand All @@ -103,6 +113,10 @@ func TestSortOrderInjection(t *testing.T) {
require.NoError(t, err)
require.Equal(t, "SELECT * FROM t ORDER BY \"id\" ASC, \"name\" DESC, \"created_at\" ASC LIMIT 11 OFFSET 0", sql)
require.Empty(t, args)
// Verify columns in page.Sort are not quoted
require.Equal(t, "id", page.Sort[0].Column)
require.Equal(t, "name", page.Sort[1].Column)
require.Equal(t, "created_at", page.Sort[2].Column)
}

func TestPaginationEdgeCases(t *testing.T) {
Expand Down Expand Up @@ -180,6 +194,10 @@ func TestColumnFunc(t *testing.T) {
require.NoError(t, err)
require.Equal(t, `SELECT * FROM t ORDER BY "ID" ASC, "NAME" DESC, "created_at" ASC LIMIT 11 OFFSET 0`, sql)
require.Empty(t, args)
// Verify columns in page.Sort are not quoted
require.Equal(t, "id", page.Sort[0].Column)
require.Equal(t, "name", page.Sort[1].Column)
require.Equal(t, "created_at", page.Sort[2].Column)
}

func TestColumnFallbackUsesColumnFunc(t *testing.T) {
Expand All @@ -199,6 +217,8 @@ func TestColumnFallbackUsesColumnFunc(t *testing.T) {
require.NoError(t, err)
require.Equal(t, `SELECT * FROM t ORDER BY "NAME" ASC LIMIT 11 OFFSET 0`, sql)
require.Empty(t, args)
// Verify column in page is not quoted or transformed
require.Equal(t, "name", page.Column)
}

func TestSortTakesPrecedenceOverColumn(t *testing.T) {
Expand All @@ -218,6 +238,8 @@ func TestSortTakesPrecedenceOverColumn(t *testing.T) {
require.NoError(t, err)
require.Equal(t, `SELECT * FROM t ORDER BY "id" DESC LIMIT 11 OFFSET 0`, sql)
require.Empty(t, args)
// Verify sort column in page is not quoted
require.Equal(t, "id", page.Sort[0].Column)
}

func TestPaginationOffsetAndPageRecompute(t *testing.T) {
Expand Down
Loading