Merge pull request #130 from PolicyEngine/fix/alembic-head-issue

Fix Alembic multiple head revisions

Author: anth-volk

CHANGELOG.md

@@ -1,3 +1,10 @@
+0.3.1 (2026-03-11)
+
+# Fixed
+
+- Add Alembic merge migration to resolve multiple head revisions from parallel feature branches (#129)
+
+
 0.3.0 (2026-03-11)
 
 # Added

alembic/versions/20260305_0cbd97809414_add_adds_subtracts_to_variables.py

@@ -5,26 +5,27 @@
 Create Date: 2026-03-05 20:26:07.571012
 
 """
+
 from typing import Sequence, Union
 
 import sqlalchemy as sa
 
 from alembic import op
 
 # revision identifiers, used by Alembic.
-revision: str = '0cbd97809414'
-down_revision: Union[str, Sequence[str], None] = '886921687770'
+revision: str = "0cbd97809414"
+down_revision: Union[str, Sequence[str], None] = "886921687770"
 branch_labels: Union[str, Sequence[str], None] = None
 depends_on: Union[str, Sequence[str], None] = None
 
 
 def upgrade() -> None:
     """Upgrade schema."""
-    op.add_column('variables', sa.Column('adds', sa.JSON(), nullable=True))
-    op.add_column('variables', sa.Column('subtracts', sa.JSON(), nullable=True))
+    op.add_column("variables", sa.Column("adds", sa.JSON(), nullable=True))
+    op.add_column("variables", sa.Column("subtracts", sa.JSON(), nullable=True))
 
 
 def downgrade() -> None:
     """Downgrade schema."""
-    op.drop_column('variables', 'subtracts')
-    op.drop_column('variables', 'adds')
+    op.drop_column("variables", "subtracts")
+    op.drop_column("variables", "adds")

alembic/versions/20260311_db93db748457_merge_parallel_branches.py

@@ -0,0 +1,30 @@
+"""merge_parallel_branches
+
+Revision ID: db93db748457
+Revises: 0cbd97809414, add_variable_label, 67608331ee8a, add_filter_strategy
+Create Date: 2026-03-11 22:30:07.234183
+
+"""
+
+from typing import Sequence, Union
+
+# revision identifiers, used by Alembic.
+revision: str = "db93db748457"
+down_revision: Union[str, Sequence[str], None] = (
+    "0cbd97809414",
+    "add_variable_label",
+    "67608331ee8a",
+    "add_filter_strategy",
+)
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    """Upgrade schema."""
+    pass
+
+
+def downgrade() -> None:
+    """Downgrade schema."""
+    pass

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "policyengine-api-v2"
-version = "0.3.0"
+version = "0.3.1"
 description = "FastAPI service for PolicyEngine microsimulations"
 readme = "README.md"
 requires-python = ">=3.13"

src/policyengine_api/api/analysis.py

@@ -857,15 +857,19 @@ def build_dynamic(dynamic_id):
     # Reconstruct scoping strategy from DB columns (if applicable)
     from policyengine_api.utils.strategy_reconstruction import reconstruct_strategy
 
-    baseline_region = session.get(Region, baseline_sim.region_id) if baseline_sim.region_id else None
+    baseline_region = (
+        session.get(Region, baseline_sim.region_id) if baseline_sim.region_id else None
+    )
     baseline_strategy = reconstruct_strategy(
         filter_strategy=baseline_sim.filter_strategy,
         filter_field=baseline_sim.filter_field,
         filter_value=baseline_sim.filter_value,
         region_type=baseline_region.region_type.value if baseline_region else None,
     )
 
-    reform_region = session.get(Region, reform_sim.region_id) if reform_sim.region_id else None
+    reform_region = (
+        session.get(Region, reform_sim.region_id) if reform_sim.region_id else None
+    )
     reform_strategy = reconstruct_strategy(
         filter_strategy=reform_sim.filter_strategy,
         filter_field=reform_sim.filter_field,
@@ -1038,15 +1042,19 @@ def build_dynamic(dynamic_id):
     # Reconstruct scoping strategy from DB columns (if applicable)
     from policyengine_api.utils.strategy_reconstruction import reconstruct_strategy
 
-    baseline_region = session.get(Region, baseline_sim.region_id) if baseline_sim.region_id else None
+    baseline_region = (
+        session.get(Region, baseline_sim.region_id) if baseline_sim.region_id else None
+    )
     baseline_strategy = reconstruct_strategy(
         filter_strategy=baseline_sim.filter_strategy,
         filter_field=baseline_sim.filter_field,
         filter_value=baseline_sim.filter_value,
         region_type=baseline_region.region_type.value if baseline_region else None,
     )
 
-    reform_region = session.get(Region, reform_sim.region_id) if reform_sim.region_id else None
+    reform_region = (
+        session.get(Region, reform_sim.region_id) if reform_sim.region_id else None
+    )
     reform_strategy = reconstruct_strategy(
         filter_strategy=reform_sim.filter_strategy,
         filter_field=reform_sim.filter_field,
@@ -1249,7 +1257,9 @@ def economic_impact(
     # Extract filter parameters from region (if present)
     filter_field = region.filter_field if region and region.requires_filter else None
     filter_value = region.filter_value if region and region.requires_filter else None
-    filter_strategy = region.filter_strategy if region and region.requires_filter else None
+    filter_strategy = (
+        region.filter_strategy if region and region.requires_filter else None
+    )
 
     # Get model version
     model_version = _get_model_version(request.tax_benefit_model_name, session)
@@ -1446,7 +1456,9 @@ def economy_custom(
         region_obj.filter_value if region_obj and region_obj.requires_filter else None
     )
     filter_strategy = (
-        region_obj.filter_strategy if region_obj and region_obj.requires_filter else None
+        region_obj.filter_strategy
+        if region_obj and region_obj.requires_filter
+        else None
     )
 
     model_version = _get_model_version(request.tax_benefit_model_name, session)

tests/test_analysis.py

@@ -981,7 +981,9 @@ def test__given_constituency_region__then_region_has_weight_replacement_strategy
 
         # Then
         assert resolved_region is not None
-        assert resolved_region.filter_strategy == FILTER_STRATEGIES["WEIGHT_REPLACEMENT"]
+        assert (
+            resolved_region.filter_strategy == FILTER_STRATEGIES["WEIGHT_REPLACEMENT"]
+        )
 
     def test__given_national_region__then_filter_strategy_is_none(
         self, session: Session

tests/test_strategy_reconstruction.py

@@ -25,7 +25,6 @@
     REGION_TYPES,
 )
 
-
 # ---------------------------------------------------------------------------
 # Mock strategy classes (match the real constructor signatures)
 # ---------------------------------------------------------------------------
@@ -277,9 +276,18 @@ def test__given_constituency_weight_replacement__then_gcs_config_matches(self):
         )
 
         # Then
-        assert result.weight_matrix_bucket == EXPECTED_CONSTITUENCY_CONFIG["weight_matrix_bucket"]
-        assert result.weight_matrix_key == EXPECTED_CONSTITUENCY_CONFIG["weight_matrix_key"]
-        assert result.lookup_csv_bucket == EXPECTED_CONSTITUENCY_CONFIG["lookup_csv_bucket"]
+        assert (
+            result.weight_matrix_bucket
+            == EXPECTED_CONSTITUENCY_CONFIG["weight_matrix_bucket"]
+        )
+        assert (
+            result.weight_matrix_key
+            == EXPECTED_CONSTITUENCY_CONFIG["weight_matrix_key"]
+        )
+        assert (
+            result.lookup_csv_bucket
+            == EXPECTED_CONSTITUENCY_CONFIG["lookup_csv_bucket"]
+        )
         assert result.lookup_csv_key == EXPECTED_CONSTITUENCY_CONFIG["lookup_csv_key"]
 
     def test__given_local_authority_weight_replacement__then_returns_weight_replacement_instance(
@@ -306,10 +314,21 @@ def test__given_local_authority_weight_replacement__then_gcs_config_matches(self
         )
 
         # Then
-        assert result.weight_matrix_bucket == EXPECTED_LOCAL_AUTHORITY_CONFIG["weight_matrix_bucket"]
-        assert result.weight_matrix_key == EXPECTED_LOCAL_AUTHORITY_CONFIG["weight_matrix_key"]
-        assert result.lookup_csv_bucket == EXPECTED_LOCAL_AUTHORITY_CONFIG["lookup_csv_bucket"]
-        assert result.lookup_csv_key == EXPECTED_LOCAL_AUTHORITY_CONFIG["lookup_csv_key"]
+        assert (
+            result.weight_matrix_bucket
+            == EXPECTED_LOCAL_AUTHORITY_CONFIG["weight_matrix_bucket"]
+        )
+        assert (
+            result.weight_matrix_key
+            == EXPECTED_LOCAL_AUTHORITY_CONFIG["weight_matrix_key"]
+        )
+        assert (
+            result.lookup_csv_bucket
+            == EXPECTED_LOCAL_AUTHORITY_CONFIG["lookup_csv_bucket"]
+        )
+        assert (
+            result.lookup_csv_key == EXPECTED_LOCAL_AUTHORITY_CONFIG["lookup_csv_key"]
+        )
 
 
 # ---------------------------------------------------------------------------

tests/test_variable_labels.py

@@ -1,13 +1,14 @@
 """Tests for variable label field across all variable endpoints."""
 
-import pytest
-
-from test_fixtures.fixtures_variables import (  # noqa: F811
+from test_fixtures.fixtures_variables import (
     create_variable,
-    uk_model_version,
-    us_model_version,
 )
-
+from test_fixtures.fixtures_variables import (
+    uk_model_version as uk_model_version,  # noqa: F811
+)
+from test_fixtures.fixtures_variables import (
+    us_model_version as us_model_version,  # noqa: F811
+)
 
 # ---------------------------------------------------------------------------
 # GET /variables - label in list responses
@@ -18,7 +19,10 @@ class TestListVariablesLabel:
     """Tests that label is returned when listing variables."""
 
     def test_label_returned_in_response(
-        self, client, session, us_model_version  # noqa: F811
+        self,
+        client,
+        session,
+        us_model_version,  # noqa: F811
     ):
         """Variable with a label should include it in the list response."""
         create_variable(
@@ -35,7 +39,10 @@ def test_label_returned_in_response(
         assert data[0]["label"] == "Employment income"
 
     def test_null_label_returned_when_absent(
-        self, client, session, us_model_version  # noqa: F811
+        self,
+        client,
+        session,
+        us_model_version,  # noqa: F811
     ):
         """Variable without a label should return null."""
         create_variable(
@@ -52,7 +59,10 @@ def test_null_label_returned_when_absent(
         assert data[0]["label"] is None
 
     def test_empty_label_returned(
-        self, client, session, us_model_version  # noqa: F811
+        self,
+        client,
+        session,
+        us_model_version,  # noqa: F811
     ):
         """Variable with an empty string label should return it as-is."""
         create_variable(
@@ -76,7 +86,10 @@ class TestSearchVariablesByLabel:
     """Tests that the search parameter matches against labels."""
 
     def test_search_matches_label(
-        self, client, session, us_model_version  # noqa: F811
+        self,
+        client,
+        session,
+        us_model_version,  # noqa: F811
     ):
         """Searching for a term in the label should return the variable."""
         create_variable(
@@ -105,7 +118,10 @@ def test_search_matches_label(
         assert data[0]["name"] == "employment_income"
 
     def test_search_label_case_insensitive(
-        self, client, session, us_model_version  # noqa: F811
+        self,
+        client,
+        session,
+        us_model_version,  # noqa: F811
     ):
         """Label search should be case-insensitive."""
         create_variable(
@@ -126,7 +142,10 @@ def test_search_label_case_insensitive(
         assert len(response.json()) == 1
 
     def test_search_partial_label_match(
-        self, client, session, us_model_version  # noqa: F811
+        self,
+        client,
+        session,
+        us_model_version,  # noqa: F811
     ):
         """Partial label matches should be returned."""
         create_variable(
@@ -156,7 +175,10 @@ class TestGetVariableLabel:
     """Tests that label is returned when fetching a single variable."""
 
     def test_label_in_get_response(
-        self, client, session, us_model_version  # noqa: F811
+        self,
+        client,
+        session,
+        us_model_version,  # noqa: F811
     ):
         """GET /variables/{id} should include the label field."""
         var = create_variable(
@@ -171,7 +193,10 @@ def test_label_in_get_response(
         assert response.json()["label"] == "Employment income"
 
     def test_null_label_in_get_response(
-        self, client, session, us_model_version  # noqa: F811
+        self,
+        client,
+        session,
+        us_model_version,  # noqa: F811
     ):
         """GET /variables/{id} should return null for missing label."""
         var = create_variable(
@@ -195,7 +220,10 @@ class TestVariablesByNameLabel:
     """Tests that label is included in by-name lookup responses."""
 
     def test_label_in_by_name_response(
-        self, client, session, us_model_version  # noqa: F811
+        self,
+        client,
+        session,
+        us_model_version,  # noqa: F811
     ):
         """POST /variables/by-name should include the label field."""
         create_variable(
@@ -215,7 +243,10 @@ def test_label_in_by_name_response(
         assert data[0]["label"] == "Employment income"
 
     def test_mixed_labels_in_by_name_response(
-        self, client, session, us_model_version  # noqa: F811
+        self,
+        client,
+        session,
+        us_model_version,  # noqa: F811
     ):
         """Variables with and without labels should both be returned correctly."""
         create_variable(