feat(orchestrator): add column filters

[gciavarrini]

The orchestrator UI needs to filter by any column.

At this time only in, like, equal, isnull operator for string are supported.
FieldFilters can be combined by LogicalFilters (and, or).
Filters are available for /v2/workflows/instances and /v2/workflows/overview endpoints.

Usage example

Overviews

Equal

curl --request POST \
  --url http://localhost:7007/api/orchestrator/v2/workflows/overview \
   -H "Authorization: $token" \
  --header 'Content-Type: application/json' \
  --data '{
  "filters": {
    "operator": "OR",
    "filters": [
      {
        "field": "name",
        "operator": "EQ",
        "value": "Hello World Workflow"
      },
      {
        "field": "id",
        "operator": "EQ",
        "value": "yamlgreet"
      }
    ]
  },
  "paginationInfo": {
    "offset": 0,
    "pageSize": 10
  }
}'

returns

{"items":[{"id":"9fa2a881-c932-468d-83a9-687b9f1e62a7","processId":"hello_world","processName":"Hello World Workflow","businessKey":null,"category":"infrastructure","start":"2024-10-03T10:23:32.654Z","end":"2024-10-03T10:23:32.645Z","duration":"a few seconds","workflowdata":{"myKey":"myValue","mantra":"Serverless Workflow is awesome!","greeting":"Hello World"},"status":"Completed","nodes":[{"id":"e298367d-cbfa-4af7-a454-b1a186cbe25e","__typename":"NodeInstance"},{"id":"36d5d322-b711-472f-9a3f-23f5a74d6904","__typename":"NodeInstance"},{"id":"1e7da447-c8c4-4918-9a31-539b1f1eba6b","__typename":"NodeInstance"},{"id":"22b8c488-7858-4c38-8d31-17cd500ed7eb","__typename":"NodeInstance"}]}],"paginationInfo":{"pageSize":10,"offset":0,"totalCount":1}}

Like

curl --request POST \
  --url http://localhost:7007/api/orchestrator/v2/workflows/instances \
  -H "Authorization: $token" \
  --header "Content-Type: application/json" \
  --data '{
    "filters": {
      "field": "processName",
      "operator": "LIKE",
      "value": "Hello%"
    },
    "paginationInfo": {
      "offset": 0,
      "pageSize": 10
    }
  }'

returns

{"items":[{"id":"9fa2a881-c932-468d-83a9-687b9f1e62a7","processId":"hello_world","processName":"Hello World Workflow","businessKey":null,"category":"infrastructure","start":"2024-10-03T10:23:32.654Z","end":"2024-10-03T10:23:32.645Z","duration":"a few seconds","workflowdata":{"myKey":"myValue","mantra":"Serverless Workflow is awesome!","greeting":"Hello World"},"status":"Completed","nodes":[{"id":"e298367d-cbfa-4af7-a454-b1a186cbe25e","__typename":"NodeInstance"},{"id":"36d5d322-b711-472f-9a3f-23f5a74d6904","__typename":"NodeInstance"},{"id":"1e7da447-c8c4-4918-9a31-539b1f1eba6b","__typename":"NodeInstance"},{"id":"22b8c488-7858-4c38-8d31-17cd500ed7eb","__typename":"NodeInstance"}]}],"paginationInfo":{"pageSize":10,"offset":0,"totalCount":1}}

Instances

Equal

curl --request POST \
  --url http://localhost:7007/api/orchestrator/v2/workflows/instances \
  -H "Authorization: $token" \
  --header "Content-Type: application/json" \
  --data '{
    "filters": {
      "field": "processName",
      "operator": "EQ",
      "value": "Hello World Workflow"
    },
    "paginationInfo": {
      "offset": 0,
      "pageSize": 10
    }
  }'

returns

{"items":[{"id":"9fa2a881-c932-468d-83a9-687b9f1e62a7","processId":"hello_world","processName":"Hello World Workflow","businessKey":null,"category":"infrastructure","start":"2024-10-03T10:23:32.654Z","end":"2024-10-03T10:23:32.645Z","duration":"a few seconds","workflowdata":{"myKey":"myValue","mantra":"Serverless Workflow is awesome!","greeting":"Hello World"},"status":"Completed","nodes":[{"id":"e298367d-cbfa-4af7-a454-b1a186cbe25e","__typename":"NodeInstance"},{"id":"36d5d322-b711-472f-9a3f-23f5a74d6904","__typename":"NodeInstance"},{"id":"1e7da447-c8c4-4918-9a31-539b1f1eba6b","__typename":"NodeInstance"},{"id":"22b8c488-7858-4c38-8d31-17cd500ed7eb","__typename":"NodeInstance"}]}],"paginationInfo":{"pageSize":10,"offset":0,"totalCount":1}}

Jira issue

Fix FLPATH-1757

[batzionb]

hi,
I tried this post request and got error

  curl --request POST \
  --url http://localhost:7007/api/orchestrator/v2/workflows/instances \
  -H "Authorization: Bearer $token" \
  --header "Content-Type: application/json" \
  --data '{
    "filters": {
      "field": "processName",
      "operator": "EQ",
      "value": "Wait or Error"
    },
    "paginationInfo": {
      "offset": 0,
      "pageSize": 10
    }
  }'

what am I missing?

[gciavarrini]

hi, I tried this post request and got error

@batzionb there was a bug. Can you retry? I also added another example in the PR description.

[batzionb]

That post command works now

Now I tried the LIKE operator and I get an empty list in the items field, altghough I do get the correct totalCount

curl --request POST \
 --url http://localhost:7007/api/orchestrator/v2/workflows/instances \
 -H "Authorization: Bearer $token" \
 --header "Content-Type: application/json" \
 --data '{
   "filters": {
     "field": "processName",
     "operator": "LIKE",
     "value": "Wait"
   },
   "paginationInfo": {
     "offset": 0,
     "pageSize": 10
   }
 }'

[gciavarrini]

@batzionb @ydayagi PTAL

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
1 Accepted issue

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[batzionb]

/lgtm