feat: updating webapi for new modeler worfklow

unifying

add not implemented errors

introduce WebTask from which SimulationTask and BatchTask subclass

fix to taskType

Test fixes and fixture to clear TaskFactory registry

Remove compose_modeler in favor of Tidy3dBaseModel.from_file

Unifying detail and delete methods

Passing taskType, cleanup and using MODAL_CM and TERMINAL_CM

cleanup

Author: momchil-flex

.github/workflows/tidy3d-python-client-tests.yml

@@ -347,7 +347,7 @@ jobs:
           BRANCH_NAME="${STEPS_EXTRACT_BRANCH_NAME_OUTPUTS_BRANCH_NAME}"
           echo $BRANCH_NAME
           # Allow only Jira keys from known projects, even if the branch has an author prefix
-          ALLOWED_JIRA_PROJECTS=("FXC" "SCEM")
+          ALLOWED_JIRA_PROJECTS=("FXC" "SCEM" "SCRF")
           JIRA_PROJECT_PATTERN=$(IFS='|'; echo "${ALLOWED_JIRA_PROJECTS[*]}")
           JIRA_PATTERN="(${JIRA_PROJECT_PATTERN})-[0-9]+"
 

docs/api/submit_simulations.rst

@@ -94,7 +94,6 @@ Information Containers
    :template: module.rst
 
    tidy3d.web.core.task_info.TaskInfo
-   tidy3d.web.core.task_info.TaskStatus
 
 
 Mode Solver Web API

tests/test_plugins/smatrix/test_run_functions.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-import json
 from unittest.mock import MagicMock
 
 import pydantic.v1 as pd
@@ -14,38 +13,15 @@
     make_component_modeler as make_modal_component_modeler,
 )
 from tidy3d import SimulationDataMap
-from tidy3d.components.base import Tidy3dBaseModel
 from tidy3d.components.data.sim_data import SimulationData
 from tidy3d.plugins.smatrix.data.terminal import TerminalComponentModelerData
 from tidy3d.plugins.smatrix.run import (
     _run_local,
-    compose_modeler,
     compose_modeler_data,
     create_batch,
 )
 
 
-def test_compose_modeler_unsupported_type(tmp_path, monkeypatch):
-    # Create a dummy HDF5 file path
-    modeler_file = tmp_path / "dummy_modeler.hdf5"
-
-    # Prepare a dummy JSON string with an unsupported type
-    dummy_json = {"type": "UnsupportedComponentModeler", "some_key": "some_value"}
-    dummy_json_str = json.dumps(dummy_json)
-
-    # Mock Tidy3dBaseModel._json_string_from_hdf5 to return our dummy JSON string
-    def mock_json_string_from_hdf5(filepath):
-        if filepath == str(modeler_file):
-            return dummy_json_str
-        return ""
-
-    monkeypatch.setattr(Tidy3dBaseModel, "_json_string_from_hdf5", mock_json_string_from_hdf5)
-
-    # Expect a TypeError when calling compose_modeler with the unsupported type
-    with pytest.raises(TypeError, match="Unsupported modeler type: str"):
-        compose_modeler(modeler_file=str(modeler_file))
-
-
 def test_create_batch(monkeypatch, tmp_path):
     # Mock Batch and Batch.to_file
     mock_batch_instance = MagicMock()

tests/test_plugins/test_array_factor.py

@@ -363,16 +363,15 @@ def make_antenna_sim():
         remove_dc_component=False,  # Include DC component for more accuracy at low frequencies
     )
 
-    sim_unit = list(modeler.sim_dict.values())[0]
-
-    return sim_unit
+    return modeler
 
 
 def test_rectangular_array_calculator_array_make_antenna_array():
     """Test automatic antenna array creation."""
     freq0 = 10e9
     wavelength0 = td.C_0 / 10e9
-    sim_unit = make_antenna_sim()
+    modeler = make_antenna_sim()
+    sim_unit = list(modeler.sim_dict.values())[0]
     array_calculator = mw.RectangularAntennaArrayCalculator(
         array_size=(1, 2, 3),
         spacings=(0.5 * wavelength0, 0.6 * wavelength0, 0.4 * wavelength0),
@@ -437,8 +436,9 @@ def test_rectangular_array_calculator_array_make_antenna_array():
     assert len(sim_array.sources) == 6
 
     # check that override_structures are duplicated
-    assert len(sim_unit.grid_spec.override_structures) == 2
-    assert len(sim_array.grid_spec.override_structures) == 7
+    # assert len(sim_unit.grid_spec.override_structures) == 2
+    # assert len(sim_array.grid_spec.override_structures) == 7
+    assert sim_unit.grid.boundaries == modeler.base_sim.grid.boundaries
 
     # check that phase shifts are applied correctly
     phases_expected = array_calculator._antenna_phases
@@ -674,7 +674,8 @@ def test_rectangular_array_calculator_simulation_data_from_array_factor():
         phase_shifts=(np.pi / 3, np.pi / 4, np.pi / 5),
     )
 
-    sim_unit = make_antenna_sim()
+    modeler = make_antenna_sim()
+    sim_unit = list(modeler.sim_dict.values())[0]
 
     monitor = sim_unit.monitors[0]
     monitor_directivity = sim_unit.monitors[2]

tests/test_web/test_local_cache.py

@@ -43,7 +43,7 @@
     resolve_local_cache,
 )
 from tidy3d.web.cli.app import tidy3d_cli
-from tidy3d.web.core.task_core import BatchTask
+from tidy3d.web.core.task_core import BatchTask, SimulationTask
 
 common.CONNECTION_RETRY_TIME = 0.1
 
@@ -245,7 +245,9 @@ def _fake_field_map_from_file(*args, **kwargs):
     monkeypatch.setattr(
         io_utils, "load_simulation", lambda task_id, *args, **kwargs: TASK_TO_SIM[task_id]
     )
-    monkeypatch.setattr(BatchTask, "is_batch", lambda *args, **kwargs: "success")
+    monkeypatch.setattr(
+        SimulationTask, "get", lambda *args, **kwargs: SimpleNamespace(taskType="FDTD")
+    )
     monkeypatch.setattr(
         BatchTask, "detail", lambda *args, **kwargs: SimpleNamespace(status="success")
     )

tests/test_web/test_webapi.py

@@ -415,7 +415,7 @@ def test_run_with_invalid_priority(mock_webapi, priority):
 
 
 @responses.activate
-def test_get_run_info(mock_get_run_info):
+def test_get_run_info(mock_get_run_info, mock_get_info):
     assert get_run_info(TASK_ID) == (100, 0)
 
 

tests/test_web/test_webapi_eme.py

@@ -260,7 +260,7 @@ def test_get_info(mock_get_info):
 
 
 @responses.activate
-def test_get_run_info(mock_get_run_info):
+def test_get_run_info(mock_get_run_info, mock_get_info):
     assert get_run_info(TASK_ID) == (100, 0)
 
 

tests/test_web/test_webapi_heat.py

@@ -250,7 +250,7 @@ def test_get_info(mock_get_info):
 
 
 @responses.activate
-def test_get_run_info(mock_get_run_info):
+def test_get_run_info(mock_get_run_info, mock_get_info):
     assert get_run_info(TASK_ID) == (100, 0)
 
 

tests/test_web/test_webapi_mode.py

@@ -307,7 +307,7 @@ def test_get_info(mock_get_info):
 
 
 @responses.activate
-def test_get_run_info(mock_get_run_info):
+def test_get_run_info(mock_get_run_info, mock_get_info):
     assert get_run_info(TASK_ID) == (100, 0)
 
 

tests/test_web/test_webapi_mode_sim.py

@@ -303,7 +303,7 @@ def test_get_info(mock_get_info):
 
 
 @responses.activate
-def test_get_run_info(mock_get_run_info):
+def test_get_run_info(mock_get_run_info, mock_get_info):
     assert get_run_info(TASK_ID) == (100, 0)