feat(common): disable keyvalue sorting using null compareFn #57487
Conversation
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
75488e5 to
6352cd2
Compare
|
Gentle ping @pkozlowski-opensource |
pkozlowski-opensource
approved these changes
Oct 16, 2024
|
Closing and re-opening since a few CI jobs are missing here (Edit: turned out public API failed) |
6352cd2 to
3398a93
Compare
pkozlowski-opensource
approved these changes
Oct 16, 2024
pkozlowski-opensource
approved these changes
Oct 16, 2024
thePunderWoman
approved these changes
Oct 16, 2024
The keyvalue pipe sorts the entries of the input by key. This has been the subject of debate in the past (angular#42490). The core of the discussions is that it is often desirable (and perhaps expected) that they natural ordering of the input is respected. There are at least two workarounds to restore natural ordering, such as a `compareFn` that simply returns `1` or a custom pipe. However, both of these require code for pipe consumers to maintain or copy around to many places. Allowing `null` as `compareFn` and treating it as "natural order" is fairly simple to understand, backward compatible and was suggested a few times on angular#42490 where it seemed to be received well. Using `null` is also possible in templates without any component code changes.
3398a93 to
20fbd79
Compare
|
I tried rebasing here since running EDIT: Or maybe it did add some updates without me noticing... |
|
@sbarfurth — I think @JeanMeche pushed to your PR to take care of it, so that's why there is no diff 😄 All good now. |
|
@sbarfurth I did it for you, we're good to go. The PR is in the merge queue ! |
|
Ah sorry about that, missed the push. Thanks! |
|
This PR was merged into the repository by commit 13c1306. The changes were merged into the following branches: main |
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
The keyvalue pipe sorts the entries of the input by key. This has been the subject of debate in the past (#42490). The core of the discussions is that it is often desirable (and perhaps expected) that they natural ordering of the input is respected. There are at least two workarounds to restore natural ordering, such as a
compareFnthat simply returns1or a custom pipe. However, both of these require code for pipe consumers to maintain or copy around to many places.What is the new behavior?
Allowing
nullascompareFnand treating it as "natural order" is fairly simple to understand, backward compatible and was suggested a few times on #42490 where it seemed to be received well. Usingnullis also possible in templates without any component code changes.Does this PR introduce a breaking change?
Other information
n/a