Make sure the order of nested order filters is preserved #4171
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
jnugh
force-pushed
the
preserve-order-nested
branch
from
15c9e9b
to
6dcaf8b
Compare
Order filters are being written with underscores in GraphQL but are sent along with dots to access nested entities. The previous solution appended the dot version to the order array. This leads to an issue where every order filter that accesses a nested property will always be added to the query after local properties.
jnugh
force-pushed
the
preserve-order-nested
branch
from
6dcaf8b
to
2fa12b6
Compare
alanpoulain
reviewed
Mar 29, 2021
| $filters = | ||
| \array_slice($filters, 0, $index + 1) + | ||
| [str_replace($this->nestingSeparator, '.', $name) => $value] + | ||
| \array_slice($filters, $index); |
There was a problem hiding this comment.
It does not make a difference in the output as the duplicated key gets merged so I did not notice that this code adds it twice. Will add +1 there as well.
alanpoulain
reviewed
Mar 29, 2021
CHANGELOG.md
Outdated
| @@ -13,6 +13,7 @@ | |||
| * Swagger UI: Remove Google fonts (#4112) | |||
| * Doctrine: Revert #3774 support for binary UUID in search filter (#4134) | |||
| * Do not override Vary headers already set in the Response | |||
| * GraphQL: Make sure the order of order filters is preserved if nested resources are used | |||
There was a problem hiding this comment.
Suggested change
| * GraphQL: Make sure the order of order filters is preserved if nested resources are used | |
| * GraphQL: Make sure the order of order filters is preserved if nested resources are used (#4171) |
alanpoulain
reviewed
Mar 29, 2021
alanpoulain
reviewed
Mar 29, 2021
Comment on lines
225
to
228
| /** | ||
| * Test a regression where the order in which order fitlers were applied | ||
| * was wrong when the data had been ordered by a nested field. | ||
| */ |
There was a problem hiding this comment.
I think this comment is unnecessary.
|
Hello! A tricky one 🙂 Thanks for spotting it and fixing it. |
jnugh
force-pushed
the
preserve-order-nested
branch
from
95d17eb
to
0994e5a
Compare
|
It's probably not a super common use case to sort on a child entity first... |
alanpoulain
reviewed
Mar 29, 2021
Co-authored-by: Alan Poulain <contact@alanpoulain.eu>
alanpoulain
approved these changes
Mar 29, 2021
|
Thank you @jnugh. |
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.
Order filters are being written with underscores in GraphQL but are sent along with dots to access nested entities.
The previous solution appended the dot version to the order array. This leads to an issue where every order filter that accesses a nested property will always be added to the query after local properties.
Looking at the test case: The first order that WAS applied was
localField. It should have beensome.fieldwhich is now the case.