diff --git a/doc/changelog.d/232.maintenance.md b/doc/changelog.d/232.maintenance.md new file mode 100644 index 00000000..32c33cbf --- /dev/null +++ b/doc/changelog.d/232.maintenance.md @@ -0,0 +1 @@ +Move streamed-render protocols out of server_renderer diff --git a/src/ansys/visor/viewer/app/trame/server_loop_bridge.py b/src/ansys/visor/viewer/app/trame/server_loop_bridge.py index e3db74db..d9c13070 100644 --- a/src/ansys/visor/viewer/app/trame/server_loop_bridge.py +++ b/src/ansys/visor/viewer/app/trame/server_loop_bridge.py @@ -15,7 +15,7 @@ from trame_rca.view_adapter import RcaViewAdapter from ansys.visor.viewer.app.trame.async_runner import AsyncRunner -from ansys.visor.viewer.renderer.server_renderer import FrameRequester +from ansys.visor.viewer.renderer.streamed_protocols import FrameRequester class ServerLoopBridge(FrameRequester): diff --git a/src/ansys/visor/viewer/app/trame/server_state_publisher.py b/src/ansys/visor/viewer/app/trame/server_state_publisher.py index 7691f412..dc22cc7e 100644 --- a/src/ansys/visor/viewer/app/trame/server_state_publisher.py +++ b/src/ansys/visor/viewer/app/trame/server_state_publisher.py @@ -16,7 +16,7 @@ from ansys.visor.viewer.app.trame.async_runner import AsyncRunner from ansys.visor.viewer.models.common.visor_camera_state import VisorCameraState from ansys.visor.viewer.models.common.visor_cross_section_state import VisorCrossSectionState -from ansys.visor.viewer.renderer.server_renderer import ViewRecordPublisher +from ansys.visor.viewer.renderer.streamed_protocols import ViewRecordPublisher SERVER_CAMERA_STATE_KEY: str = "server_camera_state" """State key carrying the server's camera record, as its camelCase fields, or None.""" diff --git a/src/ansys/visor/viewer/renderer/server_renderer.py b/src/ansys/visor/viewer/renderer/server_renderer.py index df72e7bf..85e5d04c 100644 --- a/src/ansys/visor/viewer/renderer/server_renderer.py +++ b/src/ansys/visor/viewer/renderer/server_renderer.py @@ -13,37 +13,18 @@ from __future__ import annotations -from typing import Protocol - # Registers the OpenGL2 factory overrides, so vtkRenderWindow() is a # concrete off-screen-capable window rather than the abstract base. import vtkmodules.vtkRenderingOpenGL2 # noqa: F401 from vtkmodules.vtkCommonCore import vtkObject from vtkmodules.vtkRenderingCore import vtkRenderWindow -from ansys.visor.viewer.models.common.visor_camera_state import VisorCameraState -from ansys.visor.viewer.models.common.visor_cross_section_state import VisorCrossSectionState from ansys.visor.viewer.renderer.pipeline_renderer import VtkPipelineRenderer - -INITIAL_WINDOW_SIZE: tuple[int, int] = (300, 300) -"""Window size before the client reports its canvas; trame-rca's pre-resize image size.""" - - -class FrameRequester(Protocol): - """Where a ServerRenderer asks for a streamed frame.""" - - def request_frame(self) -> None: - """Ask for a streamed frame; callable from any thread.""" - - -class ViewRecordPublisher(Protocol): - """Where a ServerRenderer publishes its camera and cross-section plane records.""" - - def publish_camera(self, camera_state: VisorCameraState | None) -> None: - """Publish the camera record to clients, or None when there is none; callable from any thread.""" - - def publish_cross_section(self, cross_section_state: VisorCrossSectionState | None) -> None: - """Publish the plane record to clients, or None when there is none; callable from any thread.""" +from ansys.visor.viewer.renderer.streamed_protocols import ( + INITIAL_WINDOW_SIZE, + FrameRequester, + ViewRecordPublisher, +) class ServerRenderer(VtkPipelineRenderer): diff --git a/src/ansys/visor/viewer/renderer/server_window.py b/src/ansys/visor/viewer/renderer/server_window.py index dd58b2f1..04b7aeaf 100644 --- a/src/ansys/visor/viewer/renderer/server_window.py +++ b/src/ansys/visor/viewer/renderer/server_window.py @@ -1,7 +1,7 @@ """ VisorRcaWindow ============== -trame-rca remote-controlled area over a :class:`ServerRenderer`. +trame-rca remote-controlled area over an :class:`RcaRenderTarget`. trame-rca's scheduler reads :attr:`VisorRcaWindow.img_cols_rows` on the event loop thread, and its resize and interaction RPCs arrive on the same thread. @@ -25,7 +25,7 @@ from trame_rca.rca.protocol import RemoteControlledAreaProtocol from ansys.visor.viewer.renderer.gl_context_lock import SceneLock -from ansys.visor.viewer.renderer.server_renderer import INITIAL_WINDOW_SIZE, ServerRenderer +from ansys.visor.viewer.renderer.streamed_protocols import INITIAL_WINDOW_SIZE, RcaRenderTarget GESTURE_END_EVENT_TYPES: frozenset[str] = frozenset( {"LeftButtonRelease", "MiddleButtonRelease", "RightButtonRelease", "MouseWheel"} @@ -38,10 +38,10 @@ class VisorRcaWindow: - """trame-rca area over a ServerRenderer that touches VTK only while holding the scene lock.""" + """trame-rca area over an RcaRenderTarget that touches VTK only while holding the scene lock.""" _capture: RemoteControlledAreaProtocol - _renderer: ServerRenderer + _renderer: RcaRenderTarget _vtk_lock: SceneLock _reschedule: Callable[[], None] _pending_size: tuple[int, int] | None @@ -53,7 +53,7 @@ class VisorRcaWindow: def __init__( self, capture: RemoteControlledAreaProtocol, - renderer: ServerRenderer, + renderer: RcaRenderTarget, vtk_lock: SceneLock, reschedule: Callable[[], None], ) -> None: diff --git a/src/ansys/visor/viewer/renderer/streamed_protocols.py b/src/ansys/visor/viewer/renderer/streamed_protocols.py new file mode 100644 index 00000000..2af0f8f3 --- /dev/null +++ b/src/ansys/visor/viewer/renderer/streamed_protocols.py @@ -0,0 +1,71 @@ +""" +Streamed-render protocols +========================= +The names a streamed view's renderer, window, loop bridge and state publisher +share, kept apart from :mod:`ansys.visor.viewer.renderer.server_renderer` so +that importing them does not import the off-screen VTK pipeline. +""" + +from __future__ import annotations + +from typing import TYPE_CHECKING, Protocol + +from ansys.visor.viewer.models.common.visor_camera_state import VisorCameraState +from ansys.visor.viewer.models.common.visor_cross_section_state import VisorCrossSectionState + +if TYPE_CHECKING: + from vtkmodules.vtkRenderingCore import vtkRenderWindow + +INITIAL_WINDOW_SIZE: tuple[int, int] = (300, 300) +"""Window size before the client reports its canvas; trame-rca's pre-resize image size.""" + +BACKGROUND_RGB: dict[bool, tuple[float, float, float]] = { + False: (247 / 255, 247 / 255, 247 / 255), + True: (54 / 255, 60 / 255, 67 / 255), +} +"""Viewer background per theme, keyed on dark. + +The values of ``--visor-viewer-background`` in the client's +``public/css/theme-light.css`` and ``public/css/theme-dark.css``. +""" + + +class FrameRequester(Protocol): + """Where a ServerRenderer asks for a streamed frame.""" + + def request_frame(self) -> None: + """Ask for a streamed frame; callable from any thread.""" + + +class ViewRecordPublisher(Protocol): + """Where a ServerRenderer publishes its camera and cross-section plane records.""" + + def publish_camera(self, camera_state: VisorCameraState | None) -> None: + """Publish the camera record to clients, or None when there is none; callable from any thread.""" + + def publish_cross_section(self, cross_section_state: VisorCrossSectionState | None) -> None: + """Publish the plane record to clients, or None when there is none; callable from any thread.""" + + +class RcaRenderTarget(Protocol): + """The renderer surface VisorRcaWindow captures from and resizes.""" + + @property + def render_window(self) -> vtkRenderWindow: + """The window the capture reads and releases.""" + + @property + def background_rgb(self) -> tuple[float, float, float]: + """The colour the placeholder frame is filled with.""" + + def set_viewport_size(self, width: int, height: int) -> None: + """Resize to the client canvas in device pixels.""" + + def set_pixel_scale(self, pixel_scale: float) -> None: + """Take the client's device pixels per CSS pixel.""" + + def record_pipeline_camera(self) -> None: + """Record and publish the camera after a gesture; caller holds the lock.""" + + def record_cross_section_plane(self) -> None: + """Record and publish a dragged plane after a gesture; caller holds the lock.""" diff --git a/src/ansys/visor/viewer/vtk/scene/server_scene.py b/src/ansys/visor/viewer/vtk/scene/server_scene.py index 5dd85fab..d4bab18d 100644 --- a/src/ansys/visor/viewer/vtk/scene/server_scene.py +++ b/src/ansys/visor/viewer/vtk/scene/server_scene.py @@ -19,23 +19,14 @@ from ansys.visor.viewer.renderer.gl_context_lock import GlContextLock from ansys.visor.viewer.renderer.server_renderer import ServerRenderer from ansys.visor.viewer.renderer.server_window import VisorRcaWindow +from ansys.visor.viewer.renderer.streamed_protocols import BACKGROUND_RGB from ansys.visor.viewer.vtk.scene.base import VisorSceneBase if TYPE_CHECKING: from ansys.visor.viewer.app.trame.server_loop_bridge import ServerLoopBridge from ansys.visor.viewer.models.runtime.picking.geometry_pick import GeometryPick from ansys.visor.viewer.models.runtime.scene.runtime_app_state import RuntimeAppState - from ansys.visor.viewer.renderer.server_renderer import ViewRecordPublisher - -BACKGROUND_RGB: dict[bool, tuple[float, float, float]] = { - False: (247 / 255, 247 / 255, 247 / 255), - True: (54 / 255, 60 / 255, 67 / 255), -} -"""Viewer background per theme, keyed on dark. - -The values of ``--visor-viewer-background`` in the client's -``public/css/theme-light.css`` and ``public/css/theme-dark.css``. -""" + from ansys.visor.viewer.renderer.streamed_protocols import ViewRecordPublisher class VisorServerScene(VisorSceneBase): diff --git a/tests/unit/renderer/test_streamed_protocols.py b/tests/unit/renderer/test_streamed_protocols.py new file mode 100644 index 00000000..b874ccf5 --- /dev/null +++ b/tests/unit/renderer/test_streamed_protocols.py @@ -0,0 +1,43 @@ +""" +Unit tests for what the streamed modules load on import. + +A fresh interpreter imports the trame app and the state publisher a streamed +session uses, then reports every loaded module name. Neither may pull in the +off-screen VTK pipeline, nor trame-vtklocal through it. +""" + +from __future__ import annotations + +import json +import subprocess +import sys + +import pytest + +_IMPORT_SCRIPT = ( + "import json, sys\n" + "import ansys.visor.viewer.app.trame.server_app\n" + "import ansys.visor.viewer.app.trame.server_state_publisher\n" + "print(json.dumps(sorted(sys.modules)))\n" +) + + +@pytest.fixture(scope="module") +def loaded_modules() -> set[str]: + """Module names loaded by a fresh interpreter after importing the streamed modules.""" + result = subprocess.run( + [sys.executable, "-c", _IMPORT_SCRIPT], + capture_output=True, + text=True, + check=True, + ) + # Settings loading may print first; the module list is the last line. + return set(json.loads(result.stdout.strip().splitlines()[-1])) + + +def test_streamed_imports_leave_server_renderer_unloaded(loaded_modules: set[str]) -> None: + assert "ansys.visor.viewer.renderer.server_renderer" not in loaded_modules + + +def test_streamed_imports_leave_trame_vtklocal_unloaded(loaded_modules: set[str]) -> None: + assert "trame_vtklocal" not in loaded_modules