Merge pull request #3112 from PolicyEngine/feat/add-metadata-to-simulation-api-calls

Add ingredient metadata to simulation API calls

Author: anth-volk

changelog_entry.yaml

@@ -0,0 +1,4 @@
+- bump: patch
+  changes:
+    added:
+    - Ingredient metadata (policy IDs, process ID) to simulation API calls for improved Logfire tracing

policyengine_api/services/economy_service.py

@@ -433,7 +433,17 @@ def _handle_create_impact(
             }
         )
 
-        sim_api_execution = simulation_api.run(sim_config.model_dump())
+        # Build params with metadata for Logfire tracing in the simulation API.
+        # The _metadata field will be captured by the Logfire span before
+        # SimulationOptions validation (which silently ignores extra fields).
+        sim_params = sim_config.model_dump()
+        sim_params["_metadata"] = {
+            "reform_policy_id": setup_options.reform_policy_id,
+            "baseline_policy_id": setup_options.baseline_policy_id,
+            "process_id": setup_options.process_id,
+        }
+
+        sim_api_execution = simulation_api.run(sim_params)
         execution_id = simulation_api.get_execution_id(sim_api_execution)
 
         progress_log = {

tests/unit/services/test_economy_service.py

@@ -186,6 +186,41 @@ def test__given_no_previous_impact__creates_new_simulation(
             mock_simulation_api.run.assert_called_once()
             mock_reform_impacts_service.set_reform_impact.assert_called_once()
 
+        def test__given_no_previous_impact__includes_metadata_in_simulation_params(
+            self,
+            economy_service,
+            base_params,
+            mock_country_package_versions,
+            mock_get_dataset_version,
+            mock_policy_service,
+            mock_reform_impacts_service,
+            mock_simulation_api,
+            mock_logger,
+            mock_datetime,
+            mock_numpy_random,
+        ):
+            """Verify that _metadata with policy IDs is passed to simulation API."""
+            mock_reform_impacts_service.get_all_reform_impacts.return_value = (
+                []
+            )
+
+            economy_service.get_economic_impact(**base_params)
+
+            # Get the params passed to simulation_api.run()
+            call_args = mock_simulation_api.run.call_args
+            sim_params = call_args[0][0]  # First positional argument
+
+            # Verify _metadata is included with correct values
+            assert "_metadata" in sim_params
+            assert (
+                sim_params["_metadata"]["reform_policy_id"] == MOCK_POLICY_ID
+            )
+            assert (
+                sim_params["_metadata"]["baseline_policy_id"]
+                == MOCK_BASELINE_POLICY_ID
+            )
+            assert sim_params["_metadata"]["process_id"] == MOCK_PROCESS_ID
+
         def test__given_exception__raises_error(
             self,
             economy_service,