feat(vaults): Add cursor-based pagination to getPublicVaults (#635)#587
Merged
Conversation
…exing#635) - Created PaginationQueryDto to handle skip, limit, and cursor inputs. - Added PaginatedVaultsResponseDto envelope {data, total, hasMore}. - Implemented highly optimized keyset lookahead (limit + 1) pagination in vaults.service.ts. - Updated integration tests and controller Swagger docs. - fix: resolved missing NotificationType import in vaults.service.ts
|
@TochukwuJustice is attempting to deploy a commit to the vic's projects Team on Vercel. A member of the Team first needs to authorize it. |
|
@TochukwuJustice 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! 🚀 |
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.
closes #370
Summary of Changes
PaginationQueryDtowith class validation forskip,limit, andcursorparameters. AddedPaginatedVaultsResponseDtoto encapsulate the list response.getPublicVaultsinsidevaults.service.tsto utilize O(1) keyset pagination (relying oncreatedAtindexes) using TypeORM'sLessThan()operator instead of relying purely on heavy SQL offsets.limit + 1query pattern to resolve thehasMoreboolean in a single flat query without needing an expensive secondary count subquery.vaults.integration.spec.tsexpectations to assert against the.data,.total, and.hasMoreenvelope format.NotificationTypeinsidevaults.service.ts.Reason for the Changes
Addresses Issue #635. As the number of public vaults continues to grow, fetching an unpaginated array leads to network timeouts, high memory pressure on the Node.js server, and heavy database load. Returning a strict
{ data, total, hasMore }envelope solves this gracefully while ensuring future frontend clients can continuously scroll through the results using thecursor.