feat(orchestrator): support pagination for /instances and /overview

[JudeNiroshan]

JIRA: FLPATH-749

Description

Use query parameters in the GET request to identify the following options:

• pageSize
• page
• orderBy
• orderDirection

E.g.: http://localhost:7007/api/orchestrator/v2/workflows/instances?pageSize=10&page=2&orderBy=start&orderDirection=DESC

Response structure for the /v2/workflows/instances & /v2/workflows/overview should be as below:

{
    items: [],
    paginationInfo: {
        pageSize: 10,
        page: 2,
        totalCount: 50
    }
}

[batzionb]

If you're already getting all of the instances why not just do the pagination logic here?
I'm concerned this is making things slower... the whole idea of pagination is to make things faster

[batzionb]

@caponetto
WDYT

[JudeNiroshan]

why not just do the pagination logic here?

The only reason I thought was the data payload retrieved from the graphQL is smaller compared to retrieving the full query with attributes.

[batzionb]

can you please check what the difference in payload is?

[JudeNiroshan]

It depends on the number of all instances and the process definition structure. When the number of nodes is high, the instance will have a larger JSON output. When the result payload is larger, it can lead to graphQL query complexity. It will result in a runtime error.

However, if we have the totalCount as a result output[1] in the graphQL, we can remove this method.

[1] apache/incubator-kie-kogito-apps#2012

Here is a simple comparison which I did with the default orchestrator container we use in our dev setup. I have mostly executed the Hello world workflow. I have 12 workflow instances.

• GraphQL query without pagination params(returns all instance data) - 2.76KB
• GraphQL query only to fetch all IDs - 450B

[batzionb]

please remove the changes from V1

[JudeNiroshan]

743cfca

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

[batzionb]

IIUC the behavior in v1 in which by default it's sorted asc by start won't be here anymore

[batzionb]

I see it's fine because the frontend overrides it anyhow to be desc

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: batzionb

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• plugins/orchestrator-backend/OWNERS [batzionb]
• plugins/orchestrator-common/OWNERS [batzionb]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment