Fixed
-----
- Numerous fixes related to reliability of Queue Server operation.
- Implemented changes to make Queue Server compatible with ``aioredis`` v2.
Added
-----
- The new ``--update-existing-plans-devices`` CLI parameter of ``start-re-manager`` was added that
controls when the file that stores existing plans and devices is updated.
- A new parameter of ``permissions_reload`` 0MQ API: ``reload_plans_devices`` (boolean, the default
value is ``False``). If set ``True``, the parameter forces RE Manager to load the list of
existing plans and devices from the disk file. The API may be called with ``reload_plans_devices=True``
using ``qserver`` CLI tool as ``qserver permissions reload lists``.
- A new parameter of ``permissions_reload`` 0MQ API: ``reload_permissions`` (boolean, the default
value is ``True``). If ``True``, permissions are reloaded from the disk file (if allowed), otherwise
the currently used permissions are used in computations.
- Extended the number of states of worker environment. Currently used states include ``initializing``,
``idle``, ``executing_plan``, ``executing_task``, ``closing``, ``closed``.
- A new status fields (``status`` 0MQ API): ``worker_environment_state``, ``worker_background_tasks``,
``task_results_uid``, ``plans_existing_uid``, ``devices_existing_uid``.
- Extended the number of sections in specification of user group permissions (e.g. in
``user_group_permissions.yaml`` file). The new sections (``allowed_functions`` and ``forbidden_functions``)
define conditions for names of functions that are accessible using ``function_execute`` API by users
from each user groups.
- New 0MQ API: ``script_upload``, ``function_execute``, ``task_result``, ``plans_existing``,
``devices_existing``. CLI implementation: ``qserver script upload`` (``script_upload`` API),
``qserver function execute`` (``function_execute`` API), ``qserver task result`` (``task_result`` API),
``qserver existing devices`` (``devices_existing`` API), ``qserver existing plans`` (``plans_existing`` API).
- A new 0MQ API: ``permissions_set`` and ``permissions_get`` that allow uploading and downloading
user group permissions. CLI support for the new API: ``qserver permissions set <fln.yaml>`` and
``qserver permissions get``.
- A new parameter of ``start-re-manager`` CLI tool: ``--user-group-permissions-reload``. The parameter accepts
values ``NEVER``, ``ON_REQUEST`` and ``ON_STARTUP``.
- A new section in documentation on management of user group permissions.
Changed
-------
- Refactoring of the code for management of user group permissions and lists of existing and
allowed plans and devices to make it more consistent. The identical lists of user permissions
and existing plans and devices are now maintained by worker and manager processes.
- The lists of existing plans and devices used by RE Manager (both manager and worker processes)
is automatically updated each time plans and devices in are changed in RE namespace (currently
RE namespace is changed only when a new worker environment is opened).
- All sections for user group permissions are now optional. The ``forbidden_plans``,
``forbidden_devices`` and ``forbidden_functions`` sections could be skipped if there are
no forbidden items that need to be excluded. Skipping ``allowed_...`` section disables all
items (plans, devices or functions) for the group, e.g. if ``allowed_plans`` is skipped,
users from this group will not be able to submit or run any plans. Since rules for
the ``root`` group are applied to the lists accessible by users from all other groups,
skipping ``allowed_plans`` for ``root`` disables all plans for all other groups.