feat: sync remote design to client after get_active_design call (#1014)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: RobPasMue

src/ansys/geometry/core/modeler.py

@@ -166,17 +166,30 @@ def create_design(self, name: str) -> "Design":
             )
         return self._designs[design.design_id]
 
-    def get_active_design(self) -> "Design":
+    def get_active_design(self, sync_with_backend: bool = True) -> "Design":
         """
         Get the active design on the modeler object.
 
+        Parameters
+        ----------
+        sync_with_backend : bool, default: True
+            Whether to sync the active design with the remote service. If set to False,
+            the active design may be out-of-sync with the remote service. This is useful
+            when the active design is known to be up-to-date.
+
         Returns
         -------
         Design
             Design object already existing on the modeler.
         """
         for _, design in self._designs.items():
             if design._is_active:
+
+                # Check if sync_with_backend is requested
+                if sync_with_backend:
+                    design._update_design_inplace()
+
+                # Return the active design
                 return design
 
         return None

tests/integration/test_design.py

@@ -1834,5 +1834,6 @@ def test_multiple_designs(modeler: Modeler, tmp_path_factory: pytest.TempPathFac
 def test_get_active_design(modeler: Modeler):
     """Return the active design from the designs dictionary of the modeler."""
     design1 = modeler.create_design("Design1")
+    d1_id = design1.design_id
     active_design = modeler.get_active_design()
-    assert active_design.design_id == design1.design_id
+    assert active_design.design_id == d1_id