Fix sort with pagination and composite fields #9150
Merged
Conversation
This file contains 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
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Summary
Implemented cursor-based pagination improvements for composite fields in the GraphQL API, focusing on proper handling of nested sorting structures and pagination direction.
- Added support for nested sorting in
ObjectRecordOrderBytype to handle composite fields likefullNamewith nested properties - Introduced
buildCompositeWhereConditionfunction incompute-cursor-arg-filter.tsfor proper handling of composite field pagination - Added validation logic in
validateAndGetOrderByto ensure proper orderBy parameters for cursor-based queries - Added comprehensive test suite in
compute-cursor-arg-filter.spec.tscovering composite field pagination scenarios - Fixed ascending/descending order determination for nested properties in composite fields
3 file(s) reviewed, 2 comment(s)
Edit PR Review Bot Settings | Greptile
Comment on lines
+32
to
+46
| const validateAndGetOrderBy = ( | ||
| key: string, | ||
| orderBy: ObjectRecordOrderBy, | ||
| ): Record<string, any> => { | ||
| const keyOrderBy = orderBy.find((order) => key in order); | ||
|
|
||
| if (!keyOrderBy) { | ||
| throw new GraphqlQueryRunnerException( | ||
| 'Invalid cursor', | ||
| GraphqlQueryRunnerExceptionCode.INVALID_CURSOR, | ||
| ); | ||
| } | ||
|
|
||
| return keyOrderBy; | ||
| }; |
There was a problem hiding this comment.
style: Consider caching the orderBy lookup result to avoid repeated array searches in a loop
| }); | ||
| }); | ||
|
|
||
| describe('composite field handling', () => { |
There was a problem hiding this comment.
logic: Missing test case for backward pagination with composite fields - current test only verifies forward pagination
ijreilly
approved these changes
Dec 19, 2024
charlesBochet
deleted the
c--fix-sort-by-with-pagination-and-composite-fields
branch
mdrazak2001
pushed a commit
to mdrazak2001/twenty
that referenced
this pull request
Dec 20, 2024
Fixes twentyhq#8863 ## Description This PR fixes an issue with cursor-based pagination when dealing with composite fields (like `fullName`). Previously, the pagination direction was incorrectly determined for composite fields because the code wasn't properly handling nested object structures in the `orderBy` parameter. Refactored the code accordingly.
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.
Fixes #8863
Description
This PR fixes an issue with cursor-based pagination when dealing with composite fields (like
fullName). Previously, the pagination direction was incorrectly determined for composite fields because the code wasn't properly handling nested object structures in theorderByparameter.Refactored the code accordingly.