Fixes for SimulationCampaign (#360)

* Add entity_id filter in SimulationCampaign
* Fix SimulationCampaign simulation prefix
* Add circuit filter

Author: eleftherioszisis

app/filters/simulation.py

@@ -13,10 +13,14 @@
 class SimulationFilterBase(NameFilterMixin, IdFilterMixin, CustomFilter):
     entity_id: uuid.UUID | None = None
     entity_id__in: list[uuid.UUID] | None = None
-    circuit: Annotated[NestedCircuitFilter | None, NestedCircuitFilterDep] = None
 
 
 class NestedSimulationFilter(SimulationFilterBase):
+    circuit: Annotated[
+        NestedCircuitFilter | None,
+        FilterDepends(with_prefix("simulation__circuit", NestedCircuitFilter)),
+    ]
+
     class Constants(CustomFilter.Constants):
         model = Simulation
 
@@ -25,6 +29,8 @@ class SimulationFilter(EntityFilterMixin, SimulationFilterBase):
     simulation_campaign_id: uuid.UUID | None = None
     simulation_campaign_id__in: list[uuid.UUID] | None = None
 
+    circuit: Annotated[NestedCircuitFilter | None, NestedCircuitFilterDep] = None
+
     order_by: list[str] = ["-creation_date"]  # noqa: RUF012
 
     class Constants(CustomFilter.Constants):

app/filters/simulation_campaign.py

@@ -1,14 +1,29 @@
+import uuid
 from typing import Annotated
 
+from fastapi_filter import with_prefix
+
 from app.db.model import SimulationCampaign
 from app.dependencies.filter import FilterDepends
 from app.filters.base import CustomFilter
+from app.filters.circuit import NestedCircuitFilter, NestedCircuitFilterDep
 from app.filters.common import EntityFilterMixin, NameFilterMixin
-from app.filters.simulation import NestedSimulationFilter, NestedSimulationFilterDep
+from app.filters.simulation import NestedSimulationFilter
 
 
 class SimulationCampaignFilter(CustomFilter, EntityFilterMixin, NameFilterMixin):
-    simulation: Annotated[NestedSimulationFilter | None, NestedSimulationFilterDep] = None
+    entity_id: uuid.UUID | None = None
+    entity_id__in: list[uuid.UUID] | None = None
+
+    circuit: Annotated[
+        NestedCircuitFilter | None,
+        NestedCircuitFilterDep,
+    ] = None
+
+    simulation: Annotated[
+        NestedSimulationFilter | None,
+        FilterDepends(with_prefix("simulation", NestedSimulationFilter)),
+    ] = None
 
     order_by: list[str] = ["-creation_date"]  # noqa: RUF012
 

app/queries/factory.py

@@ -129,6 +129,7 @@ def _get_alias[T: type[Identifiable]](db_cls: T, name: str | None = None) -> T:
         "post_region": {"id": post_region_alias.id, "label": post_region_alias.name},
         "simulation": {"id": simulation_alias.id, "label": simulation_alias.name},
         "simulation.circuit": {"id": circuit_alias.id, "label": circuit_alias.name},
+        "circuit": {"id": circuit_alias.id, "label": circuit_alias.name},
         "ion_channel": {"id": ion_channel_alias.id, "label": ion_channel_alias.label},
         "em_dense_reconstruction_dataset": {
             "id": em_dense_reconstruction_dataset_alias.id,
@@ -219,9 +220,10 @@ def _get_alias[T: type[Identifiable]](db_cls: T, name: str | None = None) -> T:
         "simulation": lambda q: q.outerjoin(
             simulation_alias, db_model_class.id == simulation_alias.simulation_campaign_id
         ),
-        "simulation.circuit": lambda q: q.join(
+        "simulation.circuit": lambda q: q.outerjoin(
             circuit_alias, simulation_alias.entity_id == circuit_alias.id
         ),
+        "circuit": lambda q: q.join(circuit_alias, db_model_class.entity_id == circuit_alias.id),
         "used": lambda q: q.outerjoin(
             Usage, db_model_class.id == Usage.usage_activity_id
         ).outerjoin(used_alias, Usage.usage_entity_id == used_alias.id),

app/service/simulation_campaign.py

@@ -155,6 +155,7 @@ def read_many(
         "created_by",
         "updated_by",
         "contribution",
+        "circuit",
         "simulation",
         "simulation.circuit",
     ]

tests/test_simulation_campaign.py

@@ -226,9 +226,7 @@ def multiple_circuits(db, brain_atlas_id, subject_id, brain_region_id, license_i
 
 
 @pytest.fixture
-def campaigns_with_different_circuits(
-    db, json_data, person_id, simulation_json_data, multiple_circuits
-):
+def campaigns_with_different_circuits(db, json_data, person_id, multiple_circuits):
     campaigns = []
 
     for i, circuit in enumerate(multiple_circuits):
@@ -238,6 +236,7 @@ def campaigns_with_different_circuits(
                 **(
                     json_data
                     | {
+                        "entity_id": str(circuit.id),
                         "name": f"campaign-circuit-{i}",
                         "description": f"Campaign for circuit {i}",
                         "created_by_id": person_id,
@@ -252,15 +251,14 @@ def campaigns_with_different_circuits(
         add_db(
             db,
             Simulation(
-                **simulation_json_data
-                | {
-                    "name": f"simulation-circuit-{i}",
-                    "simulation_campaign_id": campaign.id,
-                    "entity_id": circuit.id,
-                    "created_by_id": person_id,
-                    "updated_by_id": person_id,
-                    "authorized_project_id": PROJECT_ID,
-                }
+                name=f"simulation-{i}",
+                description=f"simulation-description-{i}",
+                entity_id=circuit.id,
+                simulation_campaign_id=campaign.id,
+                created_by_id=person_id,
+                updated_by_id=person_id,
+                authorized_project_id=PROJECT_ID,
+                scan_parameters={"foo1": "bar1", "foo2": "bar2"},
             ),
         )
 
@@ -269,45 +267,64 @@ def campaigns_with_different_circuits(
 
 def test_filter_by_circuit_id(client, campaigns_with_different_circuits, multiple_circuits):  # noqa: ARG001
     first_circuit_id = str(multiple_circuits[0].id)
-    data = assert_request(client.get, url=ROUTE, params={"circuit__id": first_circuit_id}).json()[
+
+    data = assert_request(client.get, url=ROUTE, params={"entity_id": first_circuit_id}).json()[
         "data"
     ]
+    assert len(data) == 1
+    assert data[0]["name"] == "campaign-circuit-0"
+
+    data = assert_request(
+        client.get, url=ROUTE, params={"simulation__circuit__id": first_circuit_id}
+    ).json()["data"]
 
     assert len(data) == 1
     assert data[0]["name"] == "campaign-circuit-0"
 
     second_circuit_id = str(multiple_circuits[1].id)
-    data = assert_request(client.get, url=ROUTE, params={"circuit__id": second_circuit_id}).json()[
-        "data"
-    ]
+    data = assert_request(
+        client.get, url=ROUTE, params={"simulation__circuit__id": second_circuit_id}
+    ).json()["data"]
 
     assert len(data) == 1
     assert data[0]["name"] == "campaign-circuit-1"
 
 
 def test_filter_by_circuit_name(client, campaigns_with_different_circuits, multiple_circuits):  # noqa: ARG001
     data = assert_request(
-        client.get, url=ROUTE, params={"circuit__name": "micro-circuit-1"}
+        client.get, url=ROUTE, params={"simulation__circuit__name": "micro-circuit-1"}
     ).json()["data"]
 
     assert len(data) == 1
     assert data[0]["name"] == "campaign-circuit-0"
 
     data = assert_request(
-        client.get, url=ROUTE, params={"circuit__name__in": "micro-circuit-2"}
+        client.get, url=ROUTE, params={"simulation__circuit__name__in": "micro-circuit-2"}
     ).json()["data"]
 
     assert len(data) == 1
     assert data[0]["name"] == "campaign-circuit-1"
 
 
 def test_filter_by_circuit_scale(client, campaigns_with_different_circuits, multiple_circuits):  # noqa: ARG001
+    data = assert_request(
+        client.get, url=ROUTE, params={"simulation__circuit__scale": CircuitScale.microcircuit}
+    ).json()["data"]
+
+    assert len(data) == 2
+
     data = assert_request(
         client.get, url=ROUTE, params={"circuit__scale": CircuitScale.microcircuit}
     ).json()["data"]
 
     assert len(data) == 2
 
+    data = assert_request(
+        client.get, url=ROUTE, params={"simulation__circuit__scale": CircuitScale.pair}
+    ).json()["data"]
+
+    assert len(data) == 1
+
     data = assert_request(
         client.get, url=ROUTE, params={"circuit__scale": CircuitScale.pair}
     ).json()["data"]
@@ -320,6 +337,12 @@ def test_filter_by_circuit_scale_empty(
     campaigns_with_different_circuits,  # noqa: ARG001
     multiple_circuits,  # noqa: ARG001
 ):
+    data = assert_request(
+        client.get, url=ROUTE, params={"simulation__circuit__scale": CircuitScale.small}
+    ).json()["data"]
+
+    assert len(data) == 0
+
     data = assert_request(
         client.get, url=ROUTE, params={"circuit__scale": CircuitScale.small}
     ).json()["data"]
@@ -331,7 +354,7 @@ def test_filter_by_circuit_scale_in(client, campaigns_with_different_circuits, m
     data = assert_request(
         client.get,
         url=ROUTE,
-        params={"circuit__scale__in": [CircuitScale.microcircuit, CircuitScale.pair]},
+        params={"simulation__circuit__scale__in": [CircuitScale.microcircuit, CircuitScale.pair]},
     ).json()["data"]
 
     assert len(data) == 3
@@ -344,6 +367,16 @@ def test_filter_by_circuit_build_category(
     campaigns_with_different_circuits,  # noqa: ARG001
     multiple_circuits,  # noqa: ARG001
 ):
+    data = assert_request(
+        client.get,
+        url=ROUTE,
+        params={"simulation__circuit__build_category": CircuitBuildCategory.computational_model},
+    ).json()["data"]
+
+    assert len(data) == 2
+    campaign_names = {campaign["name"] for campaign in data}
+    assert campaign_names == {"campaign-circuit-0", "campaign-circuit-2"}
+
     data = assert_request(
         client.get,
         url=ROUTE,
@@ -354,6 +387,15 @@ def test_filter_by_circuit_build_category(
     campaign_names = {campaign["name"] for campaign in data}
     assert campaign_names == {"campaign-circuit-0", "campaign-circuit-2"}
 
+    data = assert_request(
+        client.get,
+        url=ROUTE,
+        params={"simulation__circuit__build_category": CircuitBuildCategory.em_reconstruction},
+    ).json()["data"]
+
+    assert len(data) == 1
+    assert data[0]["name"] == "campaign-circuit-1"
+
     data = assert_request(
         client.get,
         url=ROUTE,
@@ -373,7 +415,7 @@ def test_filter_by_circuit_build_category_in(
         client.get,
         url=ROUTE,
         params={
-            "circuit__build_category__in": [
+            "simulation__circuit__build_category__in": [
                 CircuitBuildCategory.computational_model,
                 CircuitBuildCategory.em_reconstruction,
             ],
@@ -383,3 +425,16 @@ def test_filter_by_circuit_build_category_in(
     assert len(data) == 3
     campaign_names = {campaign["name"] for campaign in data}
     assert campaign_names == {"campaign-circuit-0", "campaign-circuit-1", "campaign-circuit-2"}
+
+    data = assert_request(
+        client.get,
+        url=ROUTE,
+        params={
+            "circuit__build_category__in": [
+                CircuitBuildCategory.computational_model,
+                CircuitBuildCategory.em_reconstruction,
+            ],
+        },
+    ).json()["data"]
+
+    assert len(data) == 3