DataViews: sort author by name + allow custom sort function #64064
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
oandregal
added
[Type] Bug
oandregal
commented
Jul 29, 2024
oandregal
commented
Jul 29, 2024
|
Size Change: +2.14 kB (+0.12%) Total Size: 1.76 MB
ℹ️ View Unchanged
|
oandregal
commented
Jul 29, 2024
| view.sort?.direction ?? 'desc' | ||
| ); | ||
| } | ||
|
|
||
| if ( | ||
| typeof valueA === 'number' && |
There was a problem hiding this comment.
Note that I've left the existing logic here because type is optional. When/If make it required this could be removed.
oandregal
force-pushed
the
fix/post-fields-author-sorting
branch
from
fbddc9c
to
4460490
Compare
oandregal
commented
Jul 30, 2024
| return integer; | ||
| } | ||
|
|
||
| // If no type found, the sort function doesn't do anything. |
There was a problem hiding this comment.
What do we think of this? What do we do if the type is not found?
oandregal
commented
Jul 30, 2024
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
youknowriad
reviewed
Jul 30, 2024
| @@ -0,0 +1,20 @@ | |||
| /** | |||
There was a problem hiding this comment.
Nice file :)
Should we move the "control" to the field types definition?
There was a problem hiding this comment.
Yes! And validation, etc. I'll do that in a follow-up.
There was a problem hiding this comment.
Validation moved to the type definition at #64164
youknowriad
reviewed
Jul 30, 2024
packages/dataviews/src/types.ts
Outdated
| a: Item, | ||
| b: Item, | ||
| direction: SortDirection, | ||
| getValue: ( args: { item: Item } ) => any |
There was a problem hiding this comment.
I think we should remove getValue from here. It's redundant with the field itself, we're defining the field here. Instead we should update the "normalize" function to inject it when we fallback to the field type sort function.
youknowriad
reviewed
Jul 30, 2024
| itemA: Item, | ||
| itemB: Item, | ||
| direction: SortDirection, | ||
| getValue: ( args: { item: Item } ) => any |
There was a problem hiding this comment.
I've thinking a bit more here, I think we shouldn't pass getValue here at all, we should just pass valueA and valueB that are both integers (instead of itemA and itemB). At this point (field type), there's no need to know about the item or the field or anything.
There was a problem hiding this comment.
I've pushed eaa0b63
I like this more than previous approaches and it could scale well. For example, in validation, the field types such as integer would need to have access to elements as well, so we'd add that.
It's not entirely perfect, though: a generic field type such as integer doesn't know the "id" of the data it's working with so the item parameter there is useless.
There was a problem hiding this comment.
Passing only the values is how I started. The trade-off with that approach is that it presumes the custom sort function wants to access data that's defined elsewhere, but it may want to access data that comes as part of the item (see author custom function).
There was a problem hiding this comment.
Passing only the values is how I started. The trade-off with that approach is that it presumes the custom sort function wants to access data that's defined elsewhere, but it may want to access data that comes as part of the item (see author custom function).
This is only true for field.sort not for fieldType.sort where you always want to use the data.
|
Flaky tests detected in eaa0b63. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/10161069692
|
youknowriad
reviewed
Jul 30, 2024
| direction: SortDirection, | ||
| getValue: ( args: { item: Item } ) => any | ||
| a: { | ||
| item: Item; |
There was a problem hiding this comment.
Why have Item here at all? I was thinking a: any, b: any should be sufficient no?
There was a problem hiding this comment.
I see what you did, I think you're misunderstanding what I'm suggesting. I'm suggesting that fieldType.sort and field.sort to have different APIs. one receives the items, the other receives the values. Do you want me to try to commit what I have in mind?
There was a problem hiding this comment.
@youknowriad please, be welcome to push. In my mind both functions are instances of the same idea, so they'd have the same signature. But I'm open to try different things: push and we can discuss what's there.
There was a problem hiding this comment.
For me field types and fields work at different levels, field types work on values, fields work on items, so it doesn't make sense to have the same API.
I've pushed what I had in mind in 621ac69
Feel free to revert if you don't like it.
youknowriad
approved these changes
Aug 1, 2024
This was referenced Aug 1, 2024
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.
What?
This PR sorts author by name instead of id. It does so by also allowing fields to provide a custom sort function.
Why?
Author ids don't mean anything to users, we should sort it by name.
Note that the REST API allows sorting by author but it really sorts by "author id". The wp-admin doesn't allow sorting the post/page list by author.
How?
integer, which provides a default sorting function.Testing Instructions
The expected result is that the order is pages created by alpha, then beta, then gamma. In
trunk, the order is by id (this is: alpha, gamma, beta).