feat: add cursor-based pagination alongside offset pagination (#826)#1095
Merged
RUKAYAT-CODER merged 1 commit intoJul 27, 2026
Merged
Conversation
|
@extolkom Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
Contributor
|
Thank you for contributing to the project. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #826
Adds cursor-based pagination to
CoursesController,NotificationsController, andAuditLogServicelist endpoints,alongside the existing OFFSET/LIMIT pagination, so large tables can be
paginated with O(1) seek cost instead of an ever-growing OFFSET scan.
Existing offset-based pagination continues to work unchanged.
What's included
New shared service
src/common/services/pagination.service.ts—PaginationServicewith
paginate(qb, cursor?, limit):{id, createdAt}),seeks rows after that position ordered by
createdAtthenid(id as tiebreaker to prevent gaps/duplicates on
createdAtcollisions), and returns
nextCursor(Base64-encoded, ornullon the last page).
unchanged, for backward compatibility.
Endpoints updated
CoursesController,NotificationsController,AuditLogService—each list endpoint now accepts an optional
cursorquery paramalongside existing
offset/limitparams. Response DTOs extendedwith
cursorandnextCursorfields. No existing params or DTOfields were removed or renamed.
Docs
docs/API_DOCUMENTATION_GUIDE.md— new section documenting thecursor format, how to request the first page (no cursor) and
subsequent pages (pass
nextCursorascursor), and confirmingoffset/limit remains supported.
Tests
[test file path]— covers:nextCursorwhen more rows exist(verified against the full fixture dataset)
nextCursorisnullon the last pageScope / non-goals
endpoint couldn't cleanly adopt
PaginationServiceand why, andthat it was left on offset-only pagination pending discussion]
Acceptance criteria (from #826)
nextCursorfieldVerification
npm run build— [pass/fail]npm run lint— [pass/fail]npm test— [pass/fail summary]origin/mainNotes for reviewers
The
createdAt+idtiebreaker ordering inPaginationServiceisthe part most likely to need scrutiny — worth double-checking the
seek-comparison logic (
WHERE (createdAt, id) > (cursorCreatedAt, cursorId)or equivalent) actually matches the index/sort order used,since a subtly wrong comparison here is exactly the kind of bug that
won't show up unless two rows share a
createdAtvalue in the testdata.