Add supportsPagination to root/comment entity config in core-data

[gaambo]

What problem does this address?

When using useEntityRecords, the returned object also contains totalItems and totalPages based on the getEntityRecordsTotalItems and getEntityRecordsTotalPages selectors. Those selectors use meta values of the queries, but those meta values only get set if the entity config has supportsPagination enabled.
See resolvers.js.

At the moment, only the postType and taxonomy entity kinds support pagination. Which means for comments, one can use the per_page query arg, and it works (because it's passed to the REST API), but getEntityRecords does not return the total items and total pages.

I guess the reason behind this is, that comments are under the root kind, and things like site options etc. do not really need pagination. But actually, the globalStyles entity config supports pagination.

A workaround is to use apiFetch and the X-WP-Total headers oneself. But getEntityRecords / useEntityRecords is such a handy feature and nice abstraction over that.

What is your proposed solution?

Enable supportsPagination to the comment entity config in core-data/src/entities.js. Because the underlying api endpoint does in fact support pagination.

There may be other entities that benefit from this support, like menus, menuItems, plugins, ...?

[yeetien]

This same issue affects root/user. getEntityRecordsTotalItems returns incorrect values due to missing supportsPagination flag.

[ramonjd]

This makes sense to me that users and comments would want total counts for pagination purposes.

And, from what I can see, it's in the spirit of the implementing PR: #55164

I queried root.user with and without supportsPagination

Current

With supportsPagination

getEntityRecordsTotalItems will return the total amount of users (in my case 151) instead of the total amount core data knows about from its store.

What do you think @Mamaduka ?

[Mamaduka]

Thanks for the ping, @ramonjd!

Yes, I think this is valid. We'll need to audit the entities and add supportsPagination where needed, this value is based on their REST API controllers. Not every entity supports pagination.

[ramonjd]

PR:

• Core Data: Add 'supportsPagination' to all appropriate entities #71302