VED-740B: Align search link.url and entry.fullUrl to match (#786)

* VED-740B: Align search link.url and entry.fullUrl to match

Author: Akol125

backend/src/fhir_service.py

@@ -29,17 +29,20 @@
 logging.basicConfig(level="INFO")
 logger = logging.getLogger()
 
-def get_service_url(
-    service_env: str = os.getenv("IMMUNIZATION_ENV"),
-    service_base_path: str = os.getenv("IMMUNIZATION_BASE_PATH"),
-):
+def get_service_url(service_env: str = os.getenv("IMMUNIZATION_ENV"), service_base_path: str = os.getenv("IMMUNIZATION_BASE_PATH")
+ ) -> str:
+    
+    if not service_base_path:
+        service_base_path = "immunisation-fhir-api/FHIR/R4"
+
     non_prod = ["internal-dev", "int", "sandbox"]
     if service_env in non_prod:
         subdomain = f"{service_env}."
     elif service_env == "prod":
         subdomain = ""
     else:
         subdomain = "internal-dev."
+
     return f"https://{subdomain}api.service.nhs.uk/{service_base_path}"
 
 
@@ -366,7 +369,7 @@ def search_immunizations(
             BundleEntry(
                 resource=Immunization.parse_obj(imms),
                 search=BundleEntrySearch(mode="match"),
-                fullUrl=f"https://api.service.nhs.uk/immunisation-fhir-api/Immunization/{imms['id']}",
+                fullUrl=f"{get_service_url()}/Immunization/{imms['id']}",
             )
             for imms in resources_filtered_for_search
         ]

backend/tests/test_fhir_service.py

@@ -2,7 +2,8 @@
 import uuid
 import datetime
 import unittest
-from unittest.mock import MagicMock
+import os
+from unittest.mock import MagicMock, patch
 from copy import deepcopy
 from unittest.mock import create_autospec, patch
 from decimal import Decimal
@@ -54,22 +55,22 @@ def tearDown(self):
     def test_get_service_url(self):
         """it should create service url"""
         env = "int"
-        base_path = "my-base-path"
+        base_path = "immunisation-fhir-api/FHIR/R4"
         url = get_service_url(env, base_path)
         self.assertEqual(url, f"https://{env}.api.service.nhs.uk/{base_path}")
         # default should be internal-dev
         env = "it-does-not-exist"
-        base_path = "my-base-path"
+        base_path = "immunisation-fhir-api/FHIR/R4"
         url = get_service_url(env, base_path)
         self.assertEqual(url, f"https://internal-dev.api.service.nhs.uk/{base_path}")
         # prod should not have a subdomain
         env = "prod"
-        base_path = "my-base-path"
+        base_path = "immunisation-fhir-api/FHIR/R4"
         url = get_service_url(env, base_path)
         self.assertEqual(url, f"https://api.service.nhs.uk/{base_path}")
         # any other env should fall back to internal-dev (like pr-xx or per-user)
         env = "pr-42"
-        base_path = "my-base-path"
+        base_path = "immunisation-fhir-api/FHIR/R4"
         url = get_service_url(env, base_path)
         self.assertEqual(url, f"https://internal-dev.api.service.nhs.uk/{base_path}")
 
@@ -772,6 +773,8 @@ class TestSearchImmunizations(unittest.TestCase):
     MOCK_SUPPLIER_SYSTEM_NAME = "Test"
 
     def setUp(self):
+        os.environ["IMMUNIZATION_ENV"] = "internal-dev"
+        os.environ["IMMUNIZATION_BASE_PATH"] = "immunisation-fhir-api/FHIR/R4"
         self.authoriser = create_autospec(Authoriser)
         self.imms_repo = create_autospec(ImmunizationRepository)
         self.validator = create_autospec(ImmunizationValidator)
@@ -1083,7 +1086,6 @@ def test_matches_contain_fullUrl(self):
         """All matches must have a fullUrl consisting of their id.
         See http://hl7.org/fhir/R4B/bundle-definitions.html#Bundle.entry.fullUrl.
         Tested because fhir.resources validation doesn't check this as mandatory."""
-
         imms_ids = ["imms-1", "imms-2"]
         imms_list = [create_covid_19_immunization_dict(imms_id) for imms_id in imms_ids]
         self.imms_repo.find_immunizations.return_value = imms_list
@@ -1100,14 +1102,13 @@ def test_matches_contain_fullUrl(self):
         for i, entry in enumerate(entries):
             self.assertEqual(
                 entry.fullUrl,
-                f"https://api.service.nhs.uk/immunisation-fhir-api/Immunization/{imms_ids[i]}",
+                f"https://internal-dev.api.service.nhs.uk/immunisation-fhir-api/FHIR/R4/Immunization/{imms_ids[i]}",
             )
 
     def test_patient_contains_fullUrl(self):
         """Patient must have a fullUrl consisting of its id.
         See http://hl7.org/fhir/R4B/bundle-definitions.html#Bundle.entry.fullUrl.
         Tested because fhir.resources validation doesn't check this as mandatory."""
-
         imms_ids = ["imms-1", "imms-2"]
         imms_list = [create_covid_19_immunization_dict(imms_id) for imms_id in imms_ids]
         self.imms_repo.find_immunizations.return_value = imms_list

e2e/test_search_immunization.py

@@ -6,6 +6,7 @@
 from utils.constants import valid_nhs_number1, valid_nhs_number2, valid_patient_identifier2, valid_patient_identifier1
 from utils.resource import generate_imms_resource, generate_filtered_imms_resource
 from utils.mappings import VaccineTypes
+from lib.env import get_service_base_path
 
 
 class TestSearchImmunization(ImmunizationBaseTest):
@@ -131,7 +132,7 @@ def test_search_backwards_compatible(self):
                 expected_imms_resource["patient"]["reference"] = response_patient["fullUrl"]
                 response_imm = next(item for item in entries if item["resource"]["id"] == imms_id)
                 self.assertEqual(
-                    response_imm["fullUrl"], f"https://api.service.nhs.uk/immunisation-fhir-api/Immunization/{imms_id}"
+                    response_imm["fullUrl"], f"{get_service_base_path()}/Immunization/{imms_id}"
                 )
                 self.assertEqual(response_imm["search"], {"mode": "match"})
                 self.assertEqual(response_imm["resource"], expected_imms_resource)

terraform/endpoints.tf

@@ -24,7 +24,7 @@ locals {
   imms_lambda_env_vars = {
     "DYNAMODB_TABLE_NAME"    = local.imms_table_name,
     "IMMUNIZATION_ENV"       = local.resource_scope,
-    "IMMUNIZATION_BASE_PATH" = strcontains(var.sub_environment, "pr-") ? "immunisation-fhir-api-${var.sub_environment}" : "immunisation-fhir-api"
+    "IMMUNIZATION_BASE_PATH" = strcontains(var.sub_environment, "pr-") ? "immunisation-fhir-api/FHIR/R4-${var.sub_environment}" : "immunisation-fhir-api/FHIR/R4"
     # except for prod and ref, any other env uses PDS int environment
     "PDS_ENV"              = var.pds_environment
     "PDS_CHECK_ENABLED"    = tostring(var.pds_check_enabled)