[PRMP-824] Add feature flag to search handler around status (#878)

Author: adamwhitingnhs

lambdas/handlers/document_reference_search_handler.py

@@ -1,7 +1,9 @@
 import json
 
+from enums.feature_flags import FeatureFlags
 from enums.logging_app_interaction import LoggingAppInteraction
 from services.document_reference_search_service import DocumentReferenceSearchService
+from services.feature_flags_service import FeatureFlagService
 from utils.audit_logging_setup import LoggingService
 from utils.decorators.ensure_env_var import ensure_environment_variables
 from utils.decorators.handle_lambda_exceptions import handle_lambda_exceptions
@@ -30,8 +32,17 @@ def lambda_handler(event, context):
     request_context.patient_nhs_no = nhs_number
 
     document_reference_search_service = DocumentReferenceSearchService()
+    upload_lambda_enabled_flag_object = FeatureFlagService().get_feature_flags_by_flag(
+        FeatureFlags.UPLOAD_DOCUMENT_ITERATION_2_ENABLED
+    )
+    doc_upload_iteration2_enabled = upload_lambda_enabled_flag_object[
+        FeatureFlags.UPLOAD_DOCUMENT_ITERATION_2_ENABLED
+    ]
+    doc_status_filter = (
+        {"doc_status": "final"} if doc_upload_iteration2_enabled else None
+    )
     response = document_reference_search_service.get_document_references(
-        nhs_number, check_upload_completed=True, additional_filters={'doc_status': 'final'}
+        nhs_number, check_upload_completed=True, additional_filters=doc_status_filter
     )
     logger.info("User is able to view docs", {"Result": "Successful viewing docs"})
 

lambdas/tests/unit/handlers/test_document_reference_search_handler.py

@@ -2,6 +2,7 @@
 from enum import Enum
 
 import pytest
+from enums.feature_flags import FeatureFlags
 from handlers.document_reference_search_handler import lambda_handler
 from tests.unit.helpers.data.dynamo.dynamo_responses import EXPECTED_RESPONSE
 from utils.lambda_exceptions import DocumentRefSearchException
@@ -21,6 +22,9 @@ def mocked_service(set_env, mocker):
     mocked_class = mocker.patch(
         "handlers.document_reference_search_handler.DocumentReferenceSearchService"
     )
+    mocker.patch(
+        "handlers.document_reference_search_handler.FeatureFlagService.get_feature_flags_by_flag"
+    )
     mocked_service = mocked_class.return_value
     yield mocked_service
 
@@ -119,3 +123,73 @@ def test_lambda_handler_when_dynamo_tables_env_variable_not_supplied_then_return
     ).create_api_gateway_response()
     actual = lambda_handler(valid_id_event_without_auth_header, context)
     assert expected == actual
+
+
+def test_lambda_handler_with_feature_flag_enabled_applies_doc_status_filter(
+    set_env, mocker, valid_id_event_without_auth_header, context
+):
+    """Test that when feature flag is ON, doc_status filter is applied"""
+    mocked_service_class = mocker.patch(
+        "handlers.document_reference_search_handler.DocumentReferenceSearchService"
+    )
+    mocked_service = mocked_service_class.return_value
+    mocked_service.get_document_references.return_value = EXPECTED_RESPONSE
+
+    mocked_feature_flag_service = mocker.patch(
+        "handlers.document_reference_search_handler.FeatureFlagService"
+    )
+    mocked_feature_flag_instance = mocked_feature_flag_service.return_value
+    mocked_feature_flag_instance.get_feature_flags_by_flag.return_value = {
+        FeatureFlags.UPLOAD_DOCUMENT_ITERATION_2_ENABLED: True
+    }
+
+    expected = ApiGatewayResponse(
+        200, json.dumps(EXPECTED_RESPONSE), "GET"
+    ).create_api_gateway_response()
+
+    actual = lambda_handler(valid_id_event_without_auth_header, context)
+
+    assert expected == actual
+    mocked_feature_flag_instance.get_feature_flags_by_flag.assert_called_once_with(
+        FeatureFlags.UPLOAD_DOCUMENT_ITERATION_2_ENABLED
+    )
+    mocked_service.get_document_references.assert_called_once_with(
+        "9000000009",
+        check_upload_completed=True,
+        additional_filters={"doc_status": "final"},
+    )
+
+
+def test_lambda_handler_with_feature_flag_disabled_no_doc_status_filter(
+    set_env, mocker, valid_id_event_without_auth_header, context
+):
+    """Test that when feature flag is OFF, no doc_status filter is applied"""
+    mocked_service_class = mocker.patch(
+        "handlers.document_reference_search_handler.DocumentReferenceSearchService"
+    )
+    mocked_service = mocked_service_class.return_value
+    mocked_service.get_document_references.return_value = EXPECTED_RESPONSE
+
+    mocked_feature_flag_service = mocker.patch(
+        "handlers.document_reference_search_handler.FeatureFlagService"
+    )
+    mocked_feature_flag_instance = mocked_feature_flag_service.return_value
+    mocked_feature_flag_instance.get_feature_flags_by_flag.return_value = {
+        FeatureFlags.UPLOAD_DOCUMENT_ITERATION_2_ENABLED: False
+    }
+
+    expected = ApiGatewayResponse(
+        200, json.dumps(EXPECTED_RESPONSE), "GET"
+    ).create_api_gateway_response()
+
+    actual = lambda_handler(valid_id_event_without_auth_header, context)
+
+    assert expected == actual
+    mocked_feature_flag_instance.get_feature_flags_by_flag.assert_called_once_with(
+        FeatureFlags.UPLOAD_DOCUMENT_ITERATION_2_ENABLED
+    )
+    mocked_service.get_document_references.assert_called_once_with(
+        "9000000009",
+        check_upload_completed=True,
+        additional_filters=None,
+    )