Merge pull request #216 from PolicyEngine/fix/split-api-v2-version-registries

Split api-v2 version registries from the legacy simulation registry

Author: anth-volk

CLAUDE.md

@@ -23,7 +23,7 @@ See [docs/DESIGN.md](docs/DESIGN.md) for the full design including future endpoi
 
 ## Versioned Modal deployments
 
-Each deploy creates a versioned Modal app named `policyengine-v2-us{X}-uk{Y}` (e.g., `policyengine-v2-us1-592-4-uk2-75-1`). Old versions remain deployed and accessible. Cloud Run routes to the correct version via Modal Dict registries (`simulation-api-us-versions`, `simulation-api-uk-versions`).
+Each deploy creates a versioned Modal app named `policyengine-v2-us{X}-uk{Y}` (e.g., `policyengine-v2-us1-592-4-uk2-75-1`). Old versions remain deployed and accessible. Cloud Run routes to the correct version via v2-specific Modal Dict registries (`api-v2-us-versions`, `api-v2-uk-versions`).
 
 **Key files:**
 - `src/policyengine_api/modal/app.py` — Versioned app definition (dynamic name from env vars)

changelog.d/215.fixed.md

@@ -0,0 +1 @@
+Moved api-v2 version routing to dedicated Modal registries so api-v2-alpha deployments no longer overwrite the legacy simulation API registry.

scripts/update_version_registry.py

@@ -2,7 +2,8 @@
 Update Modal version registries after deployment.
 
 Each deployment creates a versioned app (e.g., policyengine-v2-us1-592-4-uk2-75-1).
-This script updates the version dicts to map package versions to app names.
+This script updates the v2-specific version dicts to map package versions to
+app names.
 
 The dicts allow Cloud Run to route requests for specific versions to the
 correct versioned Modal app. Multiple versions coexist — old deployments
@@ -58,7 +59,7 @@ def update_version_dict(
     """Update a version dict: set version → app_name and latest → version.
 
     Args:
-        dict_name: Name of the Modal Dict (e.g., "simulation-api-us-versions")
+        dict_name: Name of the Modal Dict (e.g., "api-v2-us-versions")
         environment: Modal environment (staging or main)
         version: Package version (e.g., "1.592.4")
         app_name: App name to map this version to
@@ -107,7 +108,7 @@ def main():
 
     print("US version registry:")
     update_version_dict(
-        "simulation-api-us-versions",
+        "api-v2-us-versions",
         args.environment,
         args.us_version,
         args.app_name,
@@ -116,7 +117,7 @@ def main():
 
     print("UK version registry:")
     update_version_dict(
-        "simulation-api-uk-versions",
+        "api-v2-uk-versions",
         args.environment,
         args.uk_version,
         args.app_name,

src/policyengine_api/version_resolver.py

@@ -2,8 +2,8 @@
 Resolve policyengine package versions to versioned Modal app names.
 
 Uses Modal Dicts as a version registry:
-  - simulation-api-us-versions: maps US version strings -> app names
-  - simulation-api-uk-versions: maps UK version strings -> app names
+  - api-v2-us-versions: maps US version strings -> app names
+  - api-v2-uk-versions: maps UK version strings -> app names
 
 Each dict also has a "latest" key pointing to the current default version.
 
@@ -22,6 +22,11 @@
 logger = logging.getLogger(__name__)
 
 
+def _registry_name(country: str) -> str:
+    """Return the v2-specific Modal Dict name for a country."""
+    return f"api-v2-{country.lower()}-versions"
+
+
 @functools.lru_cache(maxsize=32)
 def _resolve_app_name(country: str, version: str | None, environment: str) -> str:
     """Look up the Modal app name for a given country+version from Modal Dicts.
@@ -37,7 +42,7 @@ def _resolve_app_name(country: str, version: str | None, environment: str) -> st
     Raises:
         KeyError: If version not found in registry
     """
-    dict_name = f"simulation-api-{country.lower()}-versions"
+    dict_name = _registry_name(country)
     version_dict = modal.Dict.from_name(dict_name, environment_name=environment)
 
     if version is None:

tests/test_update_version_registry.py

@@ -16,7 +16,7 @@ def test_creates_new_entry(self):
 
         with patch("modal.Dict.from_name", return_value=mock_dict):
             update_version_dict(
-                "simulation-api-us-versions",
+                "api-v2-us-versions",
                 "staging",
                 "1.592.4",
                 "policyengine-v2-us1-592-4-uk2-75-1",
@@ -35,7 +35,7 @@ def test_updates_existing_entry(self):
 
         with patch("modal.Dict.from_name", return_value=mock_dict):
             update_version_dict(
-                "simulation-api-us-versions",
+                "api-v2-us-versions",
                 "main",
                 "1.592.4",
                 "new-app-name",
@@ -51,7 +51,7 @@ def test_sets_latest_to_new_version(self):
 
         with patch("modal.Dict.from_name", return_value=mock_dict):
             update_version_dict(
-                "simulation-api-uk-versions",
+                "api-v2-uk-versions",
                 "staging",
                 "2.0.0",
                 "app-v2",
@@ -67,14 +67,14 @@ def test_passes_environment_to_modal(self):
 
         with patch("modal.Dict.from_name", return_value=mock_dict) as from_name:
             update_version_dict(
-                "simulation-api-us-versions",
+                "api-v2-us-versions",
                 "staging",
                 "1.0.0",
                 "app",
             )
 
         from_name.assert_called_once_with(
-            "simulation-api-us-versions",
+            "api-v2-us-versions",
             environment_name="staging",
             create_if_missing=True,
         )
@@ -87,7 +87,7 @@ def test_create_if_missing_flag(self):
 
         with patch("modal.Dict.from_name", return_value=mock_dict) as from_name:
             update_version_dict(
-                "simulation-api-uk-versions",
+                "api-v2-uk-versions",
                 "main",
                 "2.75.1",
                 "app-uk",

tests/test_version_resolver.py

@@ -50,27 +50,25 @@ def test_resolves_specific_version(self):
         mock_dict.__getitem__.assert_called_once_with("1.459.0")
 
     def test_routes_to_correct_dict_for_us(self):
-        """Country 'us' reads from simulation-api-us-versions."""
+        """Country 'us' reads from api-v2-us-versions."""
         mock_dict = MagicMock()
         mock_dict.__getitem__ = MagicMock(return_value="app-name")
 
         with patch("modal.Dict.from_name", return_value=mock_dict) as from_name:
             _resolve_app_name("us", "1.0.0", "main")
 
-        from_name.assert_called_once_with(
-            "simulation-api-us-versions", environment_name="main"
-        )
+        from_name.assert_called_once_with("api-v2-us-versions", environment_name="main")
 
     def test_routes_to_correct_dict_for_uk(self):
-        """Country 'uk' reads from simulation-api-uk-versions."""
+        """Country 'uk' reads from api-v2-uk-versions."""
         mock_dict = MagicMock()
         mock_dict.__getitem__ = MagicMock(return_value="app-name")
 
         with patch("modal.Dict.from_name", return_value=mock_dict) as from_name:
             _resolve_app_name("uk", "2.0.0", "staging")
 
         from_name.assert_called_once_with(
-            "simulation-api-uk-versions", environment_name="staging"
+            "api-v2-uk-versions", environment_name="staging"
         )
 
     def test_lru_cache_returns_same_result(self):