[NXP-30188] Dedicate default WorkManager queue for Custom Works - Nuxeo Issue Tracker

XML

Word

Printable

Details

Type: Bug
Status: Resolved
Priority: Minor
Resolution: Fixed
Affects Version/s: 10.10, 11.4
Fix Version/s: 10.10-HF44, 11.5, 2021.1
Component/s: Events / Works

Release Notes Summary:
Works in the default queue are now segregated to custom work queues.
Tags:
- nxplatform
- platform-review
Upgrade notes:
Hide

On master/lts 2021 the common queue is activated by default and you can tune the number of threads for the following queues from nuxeo.conf:

nuxeo.work.queue.common.threads=4 nuxeo.work.queue.thumbnail.threads=4 nuxeo.work.queue.video.threads=2 nuxeo.work.queue.picture.threads=2

On 10.10HF44 the common queue is not activated by default you have to explicitly add this option:

nuxeo.work.queue.common.enabled=true # nuxeo.work.queue.common.threads=4

Also on 10.10 there is now a dedicated queue for thumbnail generation that can be controlled by:

nuxeo.work.queue.thumbnail.enabled=true nuxeo.work.queue.thumbnail.threads=4
Show
On master/lts 2021 the common queue is activated by default and you can tune the number of threads for the following queues from nuxeo.conf: nuxeo.work.queue.common.threads=4 nuxeo.work.queue.thumbnail.threads=4 nuxeo.work.queue.video.threads=2 nuxeo.work.queue.picture.threads=2 On 10.10HF44 the common queue is not activated by default you have to explicitly add this option: nuxeo.work.queue.common.enabled= true # nuxeo.work.queue.common.threads=4 Also on 10.10 there is now a dedicated queue for thumbnail generation that can be controlled by: nuxeo.work.queue.thumbnail.enabled= true nuxeo.work.queue.thumbnail.threads=4
Team:
PLATFORM
Sprint:
nxplatform #29, nxplatform #30
Story Points:
3

Description

We want to segregate the works that are today executed in the default queue.

The goal is to dedicate the default queue to custom contributed Works (and asynchronous listeners), so they are not mixed with other essential Nuxeo works.

A possible solution:

Create a common queue for all Nuxeo Works and asynchronous listeners that are today executed in the default queue, the new queue will be defined in the common-base template.
Create a dedicated updateThumListener for the thumbnail listener because most of the time it requires a dedicated queue
Keep the default queue for other (non-Nuxeo) contributions, this queue should stay empty for a stock Nuxeo

The activation of this common queue will depend on an option like nuxeo.work.common-queue.enabled.

On 10.10 this common queue will not be activated by default to prevent any regression or behavior change.

On 11.x and 2021.x the common queue will be activated by default.