Skip to content

Commit 97baea5

Browse files
changes: UI Server dependency stack upgrades
1 parent e1d9fcc commit 97baea5

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

src/reference/changes.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,32 @@ This largely replicates the functionality of the Rose :envvar:`ROSE_DATAC`
199199
environment variable, but does not require the use of ``rose task-env``.
200200

201201

202+
Cylc UI Server
203+
^^^^^^^^^^^^^^
204+
205+
The dependency stack of the Cylc UI Server (used to serve the Cylc GUI) has
206+
been overhauled.
207+
208+
This allows the UI Server to be installed with newer versions of Python then
209+
the old dependency stack allowed.
210+
211+
* Previously the UI Server worked with Python 3.8-3.9.
212+
* It now works with Python 3.9 or higher.
213+
214+
This will likely bring efficiency improvements.
215+
216+
Additionally, the Cylc UI Server has now been configured to send "heartbeat"
217+
pings down its open websocket connections. This helps to prevent web proxies
218+
from closing Cylc GUI connections when workflows are idle, preventing erroneous
219+
GUI disconnects.
220+
221+
For more information see the
222+
`Cylc configuration <https://github.com/cylc/cylc-uiserver/blob/3ab99ecec09077132fa912d0752a06b14764f05d/cylc/uiserver/jupyter_config.py#L63-L66>`_
223+
and the docs for the ``websocket_ping_interval`` and ``websocket_ping_timeout``
224+
configurations in
225+
`tornado <https://www.tornadoweb.org/en/stable/web.html#tornado.web.Application.settings>`_.
226+
227+
202228
Cylc 8.4
203229
--------
204230

0 commit comments

Comments
 (0)