Merge pull request #252 from NHSDigital/programme-types

Filter programmes by team's programme_types from JWT

Author: mikejamesthompson

mavis/reporting/api_client/client.py

@@ -88,13 +88,20 @@ def get_variables(self) -> list[dict]:
         ]
 
     def get_programmes(self) -> list[dict]:
-        return [
+        all_programmes = [
             {"value": "flu", "text": "Flu"},
             {"value": "hpv", "text": "HPV"},
             {"value": "menacwy", "text": "MenACWY"},
             {"value": "td_ipv", "text": "Td/IPV"},
         ]
 
+        programme_types = (self.session or {}).get("programme_types", [])
+
+        if not programme_types:
+            return all_programmes
+
+        return [p for p in all_programmes if p["value"] in programme_types]
+
     def get_year_groups(self) -> list[dict]:
         return [
             {"value": "0", "text": "Reception"},

mavis/reporting/helpers/auth_helper.py

@@ -89,6 +89,7 @@ def log_user_in(data: dict[str, Any], session: SessionMixin):
     session["user_id"] = jwt_data["user"]["id"]
     session["jwt"] = minimal_jwt(jwt_data)
     session["user_nav"] = data["user_nav"]
+    session["programme_types"] = jwt_data["programme_types"]
 
 
 def minimal_jwt(data):

tests/api_client/test_client.py

@@ -86,3 +86,28 @@ def test_td_ipv_returns_years_9_to_11(self, api_client):
     def test_unknown_programme_returns_empty_list(self, api_client):
         result = api_client.get_year_groups_for_programme("unknown")
         assert result == []
+
+
+class TestGetProgrammes:
+    def test_returns_all_when_no_programme_types(self, app):
+        client = MavisApiClient(
+            app=app, session={"jwt": "x", "cis2_info": {}, "programme_types": []}
+        )
+        result = client.get_programmes()
+        values = [p["value"] for p in result]
+        assert values == ["flu", "hpv", "menacwy", "td_ipv"]
+
+    def test_filters_by_programme_types(self, app):
+        client = MavisApiClient(
+            app=app,
+            session={"jwt": "x", "programme_types": ["flu", "hpv"]},
+        )
+        result = client.get_programmes()
+        values = [p["value"] for p in result]
+        assert values == ["flu", "hpv"]
+
+    def test_returns_all_when_cis2_info_missing(self, app):
+        client = MavisApiClient(app=app, session={"jwt": "x"})
+        result = client.get_programmes()
+        values = [p["value"] for p in result]
+        assert values == ["flu", "hpv", "menacwy", "td_ipv"]

tests/helpers.py

@@ -33,6 +33,7 @@ def mock_user_info():
                 "team": {"name": "SAIS Team 1"},
                 "workgroups": ["r1l"],
             },
+            "programme_types": ["flu", "hpv"],
         },
         "user_nav": {
             "items": [

tests/helpers/test_auth_helper.py

@@ -45,3 +45,9 @@ def test_log_user_in_sets_jwt(logged_in_session, user_data):
         == user_data["jwt_data"]["user"]["reporting_api_session_token"]
     )
     assert jwt_payload["data"]["cis2_info"] == user_data["jwt_data"]["cis2_info"]
+
+
+def test_log_user_in_sets_programme_types(logged_in_session, user_data):
+    assert (
+        logged_in_session["programme_types"] == user_data["jwt_data"]["programme_types"]
+    )