[NXP-28008] Make Task endpoint paginable - Nuxeo Issue Tracker

XML

Word

Printable

Details

Type: Improvement
Status: Resolved
Priority: Minor
Resolution: Fixed
Affects Version/s: 10.10
Fix Version/s: 10.10-HF22, 11.1, 2021.0
Component/s: Rest API, Workflow

Release Notes Summary:
The Task endpoint is paginable.
Release Notes Description:
Hide

This improvement led to the following changes:

ActionContext does not contain anymore an array called tasks with all the tasks available for the current user/group;

This means that all contributions relying on the existence of tasks array on ActionContext won't work properly and need to be adapted to use the new pageable approach;

All the default WebUI task listing views are now paginated. As in other listings on WebUI, the way to request more tasks is to scroll through the list;

For coherency purposes, on the default WebUI home page (where four dashboards can be seen) the tasks dashboard is limited to 15 entries as the other three dashboards (Recently Viewed, Recently Edited and Favorite Items);

We've deprecated the previous way of fetching tasks, so it is not expected from now on to use an non-pageable approach for getting tasks;
Show
This improvement led to the following changes: ActionContext does not contain anymore an array called tasks with all the tasks available for the current user/group; This means that all contributions relying on the existence of tasks array on ActionContext won't work properly and need to be adapted to use the new pageable approach; All the default WebUI task listing views are now paginated. As in other listings on WebUI, the way to request more tasks is to scroll through the list; For coherency purposes, on the default WebUI home page (where four dashboards can be seen) the tasks dashboard is limited to 15 entries as the other three dashboards (Recently Viewed, Recently Edited and Favorite Items); We've deprecated the previous way of fetching tasks, so it is not expected from now on to use an non-pageable approach for getting tasks;
Tags:
- SupCom
- nxGang
Backlog priority:
500
Impact type:

API change
Team:
GANG
Sprint:
nxGang Sprint 11.1.22, nxGang Sprint 11.1.23, nxGang Sprint 11.1.24, nxGang Sprint 11.1.25, nxGang Sprint 11.1.26
Story Points:
5

Description

As follow up of ~~NXP-27823~~, we need to clean up Task endpoint implementation.

define a page provider that does the same thing than https://github.com/nuxeo/nuxeo/blob/10.10/addons/nuxeo-platform-document-routing/nuxeo-routing-core/src/main/java/org/nuxeo/ecm/platform/routing/core/impl/DocumentRoutingServiceImpl.java#L1331 except for workflowModelName (which is not feasable)
turn Task Object into a paginable endpoint and use the above page provider def and adapt document model to Task object when returning results
introduce a nuxeo-tasks-provider element
make task listing widget use this element (dashboard, drawer menu and page)
for 10.10 in order to keep backward compat:
- introduce a special http header
- depending on its value choose either old getTasks service method (not paginated but support workflowModelName param) or the new page provider def (paginated but no workflowModelName param support)
- make web ui use this header