Push every state field with a value and bump the scene schema

Author: LKasianAnsys

src/ansys/visor/viewer/models/runtime/dataset/runtime_dataset_state.py

@@ -2,15 +2,7 @@
 
 from typing import Any, Dict, List
 
-from pydantic import (
-    BaseModel,
-    ConfigDict,
-    Field,
-    SerializationInfo,
-    SerializerFunctionWrapHandler,
-    field_validator,
-    model_serializer,
-)
+from pydantic import BaseModel, ConfigDict, Field, field_validator
 
 from ansys.visor.viewer.core.visor_colors import VisorPartDefaults
 from ansys.visor.viewer.core.visor_logging import VisorDefaultLogger
@@ -34,10 +26,9 @@ class RuntimePartProperties(BaseModel):
     No field holds ``None`` except ``color_variable``, whose ``None`` is the
     resolved value "not coloured by a variable".
 
-    The wire carries the reference flat, as ``variableId`` and
-    ``variableComponent``.  With no reference, ``variableId`` is ``null`` and
-    ``variableComponent`` is absent; under ``exclude_none`` ``variableId`` is
-    absent too.  Callers pass ``by_alias=True`` so the keys stay camelCase.
+    The wire carries the reference nested, as ``colorVariable`` holding
+    ``variableId`` and ``variableComponent``, or ``null`` with no reference.
+    Callers pass ``by_alias=True`` so the keys stay camelCase.
 
     id: The part's scene-graph node ID.
     opacity: Between 0.0 (fully transparent) and 1.0 (fully opaque).
@@ -53,23 +44,7 @@ class RuntimePartProperties(BaseModel):
     visible: bool
     selected: bool
     diffuse_rgb: List[float] = Field(alias="diffuseRgb")
-    color_variable: VariableReference | None
-
-    @model_serializer(mode="wrap")
-    def _serialize(self, handler: SerializerFunctionWrapHandler, info: SerializationInfo) -> dict:
-        """Emit the reference flat as variableId/variableComponent; with none, variableId is null unless
-        exclude_none."""
-        data: dict = handler(self)
-        data.pop("color_variable", None)
-        id_key = "variableId" if info.by_alias else "variable_id"
-        component_key = "variableComponent" if info.by_alias else "variable_component"
-        reference = self.color_variable
-        if reference is not None:
-            data[id_key] = reference.variable_id
-            data[component_key] = reference.variable_component
-        elif not info.exclude_none:
-            data[id_key] = None
-        return data
+    color_variable: VariableReference | None = Field(alias="colorVariable")
 
     @classmethod
     def default_for(cls, part_id: int) -> "RuntimePartProperties":

src/ansys/visor/viewer/models/runtime/requests/visor_load_state_request.py

@@ -1,16 +1,8 @@
 """Model for loading a Visor viewer state."""
 
-from pydantic import (
-    BaseModel,
-    ConfigDict,
-    Field,
-    SerializationInfo,
-    SerializerFunctionWrapHandler,
-    model_serializer,
-)
+from pydantic import BaseModel, ConfigDict, Field
 
 from ansys.visor.viewer.models.runtime.scene.runtime_app_state import RuntimeAppState
-from ansys.visor.viewer.models.runtime.scene.runtime_view_state import scene_dump_with_view
 
 
 class VisorLoadStateRequest(BaseModel):
@@ -22,15 +14,3 @@ class VisorLoadStateRequest(BaseModel):
     # A unique identifier for the load state request.
     request_id: int
     app_state: RuntimeAppState = Field(alias="appState")
-
-    @model_serializer(mode="wrap")
-    def _dump_in_the_flat_scene_shape(
-            self, handler: SerializerFunctionWrapHandler, info: SerializationInfo
-    ) -> dict:
-        """Move the view's camera and crossSection into appState.scene after unit; emit no view key."""
-        data: dict = handler(self)
-        app_key = "appState" if info.by_alias else "app_state"
-        app_state: dict = data[app_key]
-        view: dict = app_state.pop("view")
-        app_state["scene"] = scene_dump_with_view(app_state["scene"], view)
-        return data

src/ansys/visor/viewer/models/runtime/scene/runtime_view_state.py

@@ -1,7 +1,5 @@
 """Model for the view records the renderer tracks."""
 
-from typing import Any, Dict
-
 from pydantic import BaseModel, ConfigDict, Field
 
 from ansys.visor.viewer.models.common.visor_camera_state import VisorCameraState
@@ -18,17 +16,3 @@ class RuntimeViewState(BaseModel):
 
     camera: VisorCameraState | None  # None until the renderer first sets it
     cross_section: VisorCrossSectionState | None = Field(alias="crossSection")  # None until the renderer first sets it
-
-
-def scene_dump_with_view(scene: Dict[str, Any], view: Dict[str, Any]) -> Dict[str, Any]:
-    """A dumped scene record with the dumped view's keys placed directly after ``unit``.
-
-    The wire carries the camera and the plane inside the scene object, not
-    under a key of their own; this rebuilds that shape from the two dumps.
-    """
-    out: Dict[str, Any] = {}
-    for key, value in scene.items():
-        out[key] = value
-        if key == "unit":
-            out.update(view)
-    return out

src/ansys/visor/viewer/models/runtime/visor_scene_details.py

@@ -1,23 +1,15 @@
 """Model for visor scene details, the data transfer object sent to the client."""
 
-from pydantic import (
-    BaseModel,
-    ConfigDict,
-    Field,
-    SerializationInfo,
-    SerializerFunctionWrapHandler,
-    model_serializer,
-)
+from pydantic import BaseModel, ConfigDict, Field
 
 from ansys.visor.viewer.models.runtime.scene.runtime_scene_state import RuntimeSceneState
 from ansys.visor.viewer.models.runtime.scene.runtime_ui_state import RuntimeUIState
-from ansys.visor.viewer.models.runtime.scene.runtime_view_state import scene_dump_with_view
 from ansys.visor.viewer.models.runtime.vtk.renderer_annotation import RendererAnnotation
 from ansys.visor.viewer.models.runtime.vtk.runtime_vtk_info import RuntimeVTKInfo
 from ansys.visor.viewer.models.runtime.vtk.scene_graph_node_info import SceneGraphNodeInfo
 
 # Bumped whenever the scene-details wire shape changes incompatibly.
-SCENE_DETAILS_SCHEMA_VERSION: int = 3
+SCENE_DETAILS_SCHEMA_VERSION: int = 4
 
 
 class VisorSceneDetails(BaseModel):
@@ -50,31 +42,5 @@ def from_components(
         )
         return cls(ui=ui, scene=scene, vtk_info=vtk_info)
 
-    @model_serializer(mode="wrap")
-    def _dump_in_the_app_state_shape(
-            self, handler: SerializerFunctionWrapHandler, info: SerializationInfo
-    ) -> dict:
-        """Nest ui and scene under appState, beside schemaVersion and vtkInfo.
-
-        The scene object carries null ``camera`` and ``crossSection`` keys
-        after ``unit`` unless ``exclude_none`` is set, which is the shape the
-        client reads.
-        """
-        data: dict = handler(self)
-        schema_key = "schemaVersion" if info.by_alias else "schema_version"
-        app_key = "appState" if info.by_alias else "app_state"
-        vtk_key = "vtkInfo" if info.by_alias else "vtk_info"
-        view = {} if info.exclude_none else {
-            "camera": None,
-            "crossSection" if info.by_alias else "cross_section": None,
-        }
-        out: dict = {}
-        if schema_key in data:
-            out[schema_key] = data[schema_key]
-        out[app_key] = {"ui": data["ui"], "scene": scene_dump_with_view(data["scene"], view)}
-        if vtk_key in data:
-            out[vtk_key] = data[vtk_key]
-        return out
-
 
 VisorSceneDetails.model_rebuild()

src/ansys/visor/viewer/vtk/scene/base.py

@@ -405,7 +405,7 @@ def get_scene_details(self) -> VisorSceneDetails:
 
     def get_scene_details_json(self) -> str:
         """Return the VisorVtkPipelineState as JSON string."""
-        return json.dumps(self.get_scene_details().model_dump(exclude_none=True, by_alias=True))
+        return json.dumps(self.get_scene_details().model_dump(by_alias=True))
 
     def clear(self):
         """Remove all actors from the renderer and reset the scene.

src/ansys/visor/visor-client/src/jest-tests/AppStateProjectionLoad.test.ts

@@ -8,7 +8,7 @@ import type VisorVtkSceneNode from '../state/appstate/vtkInfo/VisorVtkSceneNode.
  * widget flag.
  *
  * Two persisted fields used to write the same wasm camera property --
- * `scene.orthographicEnabled` and `scene.camera.parallelProjection` -- both
+ * `scene.orthographicEnabled` and `view.camera.parallelProjection` -- both
  * pushed into one unordered promise array, with only the first also setting
  * the cached flag `getAppStateAsync` reads back. Which one won was
  * unspecified. This module pins that there is now exactly one writer, that it
@@ -110,6 +110,8 @@ describe('setAppStateAsync applies projection from the camera alone', () => {
             {
                 scene: {
                     orthographicEnabled: PERSISTED_ORTHOGRAPHIC_ENABLED,
+                },
+                view: {
                     camera: { parallelProjection: CAMERA_PARALLEL_PROJECTION },
                 },
             },
@@ -131,6 +133,8 @@ describe('setAppStateAsync applies projection from the camera alone', () => {
             {
                 scene: {
                     orthographicEnabled: true,
+                },
+                view: {
                     camera: {},
                 },
             },

src/ansys/visor/visor-client/src/jest-tests/PartStateColorVariable.test.ts

@@ -0,0 +1,21 @@
+import VisorPartState from '../state/appstate/VisorPartState.tsx';
+
+describe('a part state parses the delivered colorVariable', () => {
+    test('a nested colorVariable parses onto the node reference', () => {
+        const part = new VisorPartState({
+            id: '1',
+            colorVariable: { variableId: 'POINT::pressure::1', variableComponent: 2 },
+        });
+
+        expect(part.variableId).toBe('POINT::pressure::1');
+        expect(part.variableComponent).toBe(2);
+    });
+
+    test('a null colorVariable parses as no reference', () => {
+        const part = new VisorPartState({ id: '1', colorVariable: null });
+
+        expect(part.variableId).toBeNull();
+        expect(part.variableComponent).toBeUndefined();
+    });
+});
+

src/ansys/visor/visor-client/src/jest-tests/SchemaVersion.test.tsx

@@ -26,6 +26,43 @@ describe('SchemaVersion', () => {
         expect(error.expectedVersion).toBe(SCENE_DETAILS_SCHEMA_VERSION);
     });
 
+    test('scene details at schema version 3 are rejected', () => {
+        let thrown: unknown = null;
+        try {
+            new VisorSceneDetails({ schemaVersion: 3, appState: undefined, vtkInfo: undefined });
+        } catch (err) {
+            thrown = err;
+        }
+        expect(thrown).toBeInstanceOf(SchemaVersionMismatchError);
+        const error = thrown as SchemaVersionMismatchError;
+        expect(error.payloadVersion).toBe(3);
+        expect(error.expectedVersion).toBe(4);
+    });
+
+    test('scene details with a null orthographicEnabled parse and leave it undefined', () => {
+        const details = new VisorSceneDetails({
+            schemaVersion: 4,
+            ui: {},
+            scene: { unit: '', orthographicEnabled: null },
+            vtkInfo: {
+                sceneGraph: {
+                    id: 0,
+                    dataArrays: [],
+                    name: '',
+                    isGroupNode: true,
+                    isActorNode: false,
+                    nodeType: 'root',
+                    diffuseColor: [1, 1, 1],
+                    bounds: [],
+                    children: [],
+                },
+                rendererAnnotation: null,
+            },
+        });
+
+        expect(details.appState.scene.orthographicEnabled).toBeUndefined();
+    });
+
     test('parseRendererAnnotation returns null for a null or undefined annotation', () => {
         expect(parseRendererAnnotation(null)).toBeNull();
         expect(parseRendererAnnotation(undefined)).toBeNull();

src/ansys/visor/visor-client/src/jest-tests/VariableRecordProjection.test.tsx

@@ -380,7 +380,10 @@ describe('setAppStateAsync holds a delivered variable block', () => {
                         '0': {
                             id: '0',
                             partStates: {
-                                '1': { id: '1', variableId: PRESSURE_ID, variableComponent: -1 },
+                                '1': {
+                                    id: '1',
+                                    colorVariable: { variableId: PRESSURE_ID, variableComponent: -1 },
+                                },
                             },
                         },
                     },
@@ -529,7 +532,10 @@ function deliveryColouringPartA(record: Record<string, unknown>) {
                 '0': {
                     id: '0',
                     partStates: {
-                        '1': { id: '1', variableId: PRESSURE_ID, variableComponent: -1 },
+                        '1': {
+                            id: '1',
+                            colorVariable: { variableId: PRESSURE_ID, variableComponent: -1 },
+                        },
                     },
                 },
             },

src/ansys/visor/visor-client/src/state/appstate/VisorAppState.tsx

@@ -30,6 +30,10 @@ export default class VisorAppState {
 
             this._ui.copy(data.ui, replace);
             this._scene.copy(data.scene, replace);
+            // The camera and the plane arrive under view and are held on the
+            // scene's camera and crossSection records.
+            this._scene.camera.copy(data.view?.camera, replace);
+            this._scene.crossSection.copy(data.view?.crossSection, replace);
         }
         return this;
     }
@@ -42,6 +46,10 @@ export default class VisorAppState {
         return {
             ui: this.ui.toDict(),
             scene: this.scene.toDict(),
+            view: {
+                camera: this.scene.camera.toDict(),
+                crossSection: this.scene.crossSection.toDict(),
+            },
         };
     }
 }