Skip to content

chore: implement default pagination limit #13673

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

Closed
wants to merge 4 commits into from
Closed

chore: implement default pagination limit #13673

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3fda812
chore: implement default pagination limit
Emyrk Jun 26, 2024
dba75be
fixup! chore: implement default pagination limit
Emyrk Jun 26, 2024
90683be
fix defaults for test
Emyrk Jun 26, 2024
b5e6460
linting
Emyrk Jun 26, 2024
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
2 changes: 1 addition & 1 deletion coderd/pagination.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ func parsePagination(w http.ResponseWriter, r *http.Request) (p codersdk.Paginat
parser := httpapi.NewQueryParamParser()
params := codersdk.Pagination{
AfterID: parser.UUID(queryParams, uuid.Nil, "after_id"),
Limit: int(parser.PositiveInt32(queryParams, 0, "limit")),
Limit: int(parser.PositiveInt32(queryParams, 20, "limit")),
Offset: int(parser.PositiveInt32(queryParams, 0, "offset")),
}
if len(parser.Errors) > 0 {
Expand Down
6 changes: 6 additions & 0 deletions coderd/pagination_internal_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ import (
func TestPagination(t *testing.T) {
t.Parallel()
const invalidValues = "Query parameters have invalid values"
emptyReq, _ := http.NewRequestWithContext(context.Background(), http.MethodGet, "/", nil)
defaults, ok := parsePagination(httptest.NewRecorder(), emptyReq)
require.True(t, ok)

testCases := []struct {
Name string

Expand Down Expand Up @@ -98,13 +102,15 @@ func TestPagination(t *testing.T) {
ExpectedParams: codersdk.Pagination{
AfterID: uuid.Nil,
Offset: 150,
Limit: defaults.Limit,
},
},
{
Name: "ValidAfterID",
AfterID: "5f2005fc-acc4-4e5e-a7fa-be017359c60b",
ExpectedParams: codersdk.Pagination{
AfterID: uuid.MustParse("5f2005fc-acc4-4e5e-a7fa-be017359c60b"),
Limit: defaults.Limit,
},
},
}
Expand Down