clients, errors, redis_client

JamesW1-NHS · JamesW1-NHS · commit 42eafba679dd · 2025-10-23T18:38:49.000+01:00
diff --git a/lambdas/filenameprocessor/src/audit_table.py b/lambdas/filenameprocessor/src/audit_table.py
@@ -2,9 +2,9 @@
 
 from typing import Optional
 
-from clients import dynamodb_client, logger
+from common.clients import dynamodb_client, logger
+from common.models.errors import UnhandledAuditTableError
 from constants import AUDIT_TABLE_NAME, AuditTableKeys
-from errors import UnhandledAuditTableError
 
 
 def upsert_audit_table(
diff --git a/lambdas/filenameprocessor/src/clients.py b/lambdas/filenameprocessor/src/clients.py
diff --git a/lambdas/filenameprocessor/src/constants.py b/lambdas/filenameprocessor/src/constants.py
@@ -3,7 +3,7 @@
 import os
 from enum import StrEnum
 
-from errors import (
+from common.models.errors import (
     InvalidFileKeyError,
     UnhandledAuditTableError,
     UnhandledSqsError,
diff --git a/lambdas/filenameprocessor/src/elasticache.py b/lambdas/filenameprocessor/src/elasticache.py
@@ -1,6 +1,6 @@
 import json
 
-from clients import redis_client
+from common.redis_client import redis_client
 from constants import (
     ODS_CODE_TO_SUPPLIER_SYSTEM_HASH_KEY,
     SUPPLIER_PERMISSIONS_HASH_KEY,
diff --git a/lambdas/filenameprocessor/src/errors.py b/lambdas/filenameprocessor/src/errors.py
diff --git a/lambdas/filenameprocessor/src/file_name_processor.py b/lambdas/filenameprocessor/src/file_name_processor.py
@@ -10,19 +10,19 @@
 from uuid import uuid4
 
 from audit_table import upsert_audit_table
-from clients import logger, s3_client
+from common.clients import logger, s3_client
+from common.models.errors import (
+    InvalidFileKeyError,
+    UnhandledAuditTableError,
+    UnhandledSqsError,
+    VaccineTypePermissionsError,
+)
 from constants import (
     ERROR_TYPE_TO_STATUS_CODE_MAP,
     SOURCE_BUCKET_NAME,
     FileNotProcessedReason,
     FileStatus,
 )
-from errors import (
-    InvalidFileKeyError,
-    UnhandledAuditTableError,
-    UnhandledSqsError,
-    VaccineTypePermissionsError,
-)
 from file_validation import is_file_in_directory_root, validate_file_key
 from logging_decorator import logging_decorator
 from make_and_upload_ack_file import make_and_upload_the_ack_file
diff --git a/lambdas/filenameprocessor/src/file_validation.py b/lambdas/filenameprocessor/src/file_validation.py
@@ -8,7 +8,7 @@
     get_supplier_system_from_cache,
     get_valid_vaccine_types_from_cache,
 )
-from errors import InvalidFileKeyError
+from common.models.errors import InvalidFileKeyError
 
 
 def is_file_in_directory_root(file_key: str) -> bool:
diff --git a/lambdas/filenameprocessor/src/logging_decorator.py b/lambdas/filenameprocessor/src/logging_decorator.py
@@ -6,7 +6,7 @@
 from datetime import datetime
 from functools import wraps
 
-from clients import firehose_client, logger
+from common.clients import firehose_client, logger
 
 STREAM_NAME = os.getenv("SPLUNK_FIREHOSE_NAME", "immunisation-fhir-api-internal-dev-splunk-firehose")
 
diff --git a/lambdas/filenameprocessor/src/make_and_upload_ack_file.py b/lambdas/filenameprocessor/src/make_and_upload_ack_file.py
@@ -4,7 +4,7 @@
 from csv import writer
 from io import BytesIO, StringIO
 
-from clients import s3_client
+from common.clients import s3_client
 
 
 def make_the_ack_data(message_id: str, message_delivered: bool, created_at_formatted_string: str) -> dict:
diff --git a/lambdas/filenameprocessor/src/send_sqs_message.py b/lambdas/filenameprocessor/src/send_sqs_message.py
@@ -3,8 +3,8 @@
 import os
 from json import dumps as json_dumps
 
-from clients import logger, sqs_client
-from errors import UnhandledSqsError
+from common.clients import logger, sqs_client
+from common.models.errors import UnhandledSqsError
 
 
 def send_to_supplier_queue(message_body: dict, vaccine_type: str, supplier: str) -> None:
diff --git a/lambdas/filenameprocessor/src/supplier_permissions.py b/lambdas/filenameprocessor/src/supplier_permissions.py
@@ -1,8 +1,8 @@
 """Functions for fetching supplier permissions"""
 
-from clients import logger
+from common.clients import logger
+from common.models.errors import VaccineTypePermissionsError
 from elasticache import get_supplier_permissions_from_cache
-from errors import VaccineTypePermissionsError
 
 
 def validate_vaccine_type_permissions(vaccine_type: str, supplier: str) -> list:
diff --git a/lambdas/filenameprocessor/src/utils_for_filenameprocessor.py b/lambdas/filenameprocessor/src/utils_for_filenameprocessor.py
@@ -2,7 +2,7 @@
 
 from datetime import timedelta
 
-from clients import logger, s3_client
+from common.clients import logger, s3_client
 from constants import AUDIT_TABLE_TTL_DAYS
 
 
diff --git a/lambdas/filenameprocessor/tests/test_audit_table.py b/lambdas/filenameprocessor/tests/test_audit_table.py
@@ -19,9 +19,9 @@
 # Ensure environment variables are mocked before importing from src files
 with patch.dict("os.environ", MOCK_ENVIRONMENT_DICT):
     from audit_table import upsert_audit_table
-    from clients import REGION_NAME
+    from common.clients import REGION_NAME
+    from common.models.errors import UnhandledAuditTableError
     from constants import AUDIT_TABLE_NAME, FileStatus
-    from errors import UnhandledAuditTableError
 
 dynamodb_client = boto3_client("dynamodb", region_name=REGION_NAME)
 
diff --git a/lambdas/filenameprocessor/tests/test_elasticache.py b/lambdas/filenameprocessor/tests/test_elasticache.py
@@ -16,7 +16,7 @@
 
 # Ensure environment variables are mocked before importing from src files
 with patch.dict("os.environ", MOCK_ENVIRONMENT_DICT):
-    from clients import REGION_NAME
+    from common.clients import REGION_NAME
     from elasticache import (
         get_supplier_permissions_from_cache,
         get_supplier_system_from_cache,
diff --git a/lambdas/filenameprocessor/tests/test_file_key_validation.py b/lambdas/filenameprocessor/tests/test_file_key_validation.py
@@ -12,7 +12,7 @@
 
 # Ensure environment variables are mocked before importing from src files
 with patch.dict("os.environ", MOCK_ENVIRONMENT_DICT):
-    from errors import InvalidFileKeyError
+    from common.models.errors import InvalidFileKeyError
     from file_validation import (
         is_file_in_directory_root,
         is_valid_datetime,
diff --git a/lambdas/filenameprocessor/tests/test_lambda_handler.py b/lambdas/filenameprocessor/tests/test_lambda_handler.py
@@ -35,7 +35,7 @@
 
 # Ensure environment variables are mocked before importing from src files
 with patch.dict("os.environ", MOCK_ENVIRONMENT_DICT):
-    from clients import REGION_NAME
+    from common.clients import REGION_NAME
     from constants import AUDIT_TABLE_NAME, AuditTableKeys, FileStatus
     from file_name_processor import handle_record, lambda_handler
 
diff --git a/lambdas/filenameprocessor/tests/test_logging_decorator.py b/lambdas/filenameprocessor/tests/test_logging_decorator.py
@@ -27,7 +27,7 @@
 
 # Ensure environment variables are mocked before importing from src files
 with patch.dict("os.environ", MOCK_ENVIRONMENT_DICT):
-    from clients import REGION_NAME
+    from common.clients import REGION_NAME
     from file_name_processor import lambda_handler
     from logging_decorator import generate_and_send_logs, send_log_to_firehose
 
@@ -91,7 +91,7 @@ def run(self, result=None):
             # Time is incremented by 1.0 for each call to time.time for ease of testing.
             # Range is set to a large number (100) due to many calls being made to time.time for some tests.
             patch("logging_decorator.time.time", side_effect=[0.0 + i for i in range(100)]),
-            patch("clients.redis_client.hkeys", return_value=["FLU"]),
+            patch("common.redis_client.redis_client.hkeys", return_value=["FLU"]),
         ]
 
         # Set up the ExitStack. Note that patches need to be explicitly started so that they will be applied even when
diff --git a/lambdas/filenameprocessor/tests/test_make_and_upload_ack_file.py b/lambdas/filenameprocessor/tests/test_make_and_upload_ack_file.py
@@ -18,7 +18,7 @@
 
 # Ensure environment variables are mocked before importing from src files
 with patch.dict("os.environ", MOCK_ENVIRONMENT_DICT):
-    from clients import REGION_NAME
+    from common.clients import REGION_NAME
     from make_and_upload_ack_file import (
         make_and_upload_the_ack_file,
         make_the_ack_data,
diff --git a/lambdas/filenameprocessor/tests/test_send_sqs_message.py b/lambdas/filenameprocessor/tests/test_send_sqs_message.py
@@ -13,8 +13,8 @@
 
 # Ensure environment variables are mocked before importing from src files
 with patch.dict("os.environ", MOCK_ENVIRONMENT_DICT):
-    from clients import REGION_NAME
-    from errors import UnhandledSqsError
+    from common.clients import REGION_NAME
+    from common.models.errors import UnhandledSqsError
     from send_sqs_message import make_and_send_sqs_message, send_to_supplier_queue
 
 sqs_client = boto3_client("sqs", region_name=REGION_NAME)
diff --git a/lambdas/filenameprocessor/tests/test_supplier_permissions.py b/lambdas/filenameprocessor/tests/test_supplier_permissions.py
@@ -7,7 +7,7 @@
 
 # Ensure environment variables are mocked before importing from src files
 with patch.dict("os.environ", MOCK_ENVIRONMENT_DICT):
-    from errors import VaccineTypePermissionsError
+    from common.models.errors import VaccineTypePermissionsError
     from supplier_permissions import validate_vaccine_type_permissions
 
 
diff --git a/lambdas/filenameprocessor/tests/test_utils_for_filenameprocessor.py b/lambdas/filenameprocessor/tests/test_utils_for_filenameprocessor.py
@@ -18,7 +18,7 @@
 
 # Ensure environment variables are mocked before importing from src files
 with patch.dict("os.environ", MOCK_ENVIRONMENT_DICT):
-    from clients import REGION_NAME
+    from common.clients import REGION_NAME
     from constants import AUDIT_TABLE_TTL_DAYS
     from utils_for_filenameprocessor import get_creation_and_expiry_times, move_file
 
diff --git a/lambdas/filenameprocessor/tests/utils_for_tests/generic_setup_and_teardown.py b/lambdas/filenameprocessor/tests/utils_for_tests/generic_setup_and_teardown.py
@@ -11,7 +11,7 @@
 
 # Ensure environment variables are mocked before importing from src files
 with patch.dict("os.environ", MOCK_ENVIRONMENT_DICT):
-    from clients import REGION_NAME
+    from common.clients import REGION_NAME
     from constants import AUDIT_TABLE_NAME, AuditTableKeys
 
 
diff --git a/lambdas/filenameprocessor/tests/utils_for_tests/utils_for_filenameprocessor_tests.py b/lambdas/filenameprocessor/tests/utils_for_tests/utils_for_filenameprocessor_tests.py
@@ -11,7 +11,7 @@
 with patch.dict("os.environ", MOCK_ENVIRONMENT_DICT):
     from csv import DictReader
 
-    from clients import REGION_NAME
+    from common.clients import REGION_NAME
     from constants import (
         AUDIT_TABLE_NAME,
         ODS_CODE_TO_SUPPLIER_SYSTEM_HASH_KEY,
diff --git a/lambdas/redis_sync/tests/test_redis_cacher.py b/lambdas/redis_sync/tests/test_redis_cacher.py
@@ -8,7 +8,7 @@ class TestRedisCacher(unittest.TestCase):
     def setUp(self):
         self.mock_s3_reader = patch("redis_cacher.S3Reader").start()
         self.mock_transform_map = patch("redis_cacher.transform_map").start()
-        self.mock_redis_client = patch("common.redis_client.redis_client").start()
+        self.mock_redis_client = patch("common.redis_client.global_redis_client").start()
         self.mock_logger_info = patch("logging.Logger.info").start()
         self.mock_logger_warning = patch("logging.Logger.warning").start()
 
diff --git a/lambdas/shared/src/common/clients.py b/lambdas/shared/src/common/clients.py
@@ -41,5 +41,6 @@ def get_sqs_client():
 
 firehose_client = boto3_client("firehose", region_name=REGION_NAME)
 secrets_manager_client = boto3_client("secretsmanager", region_name=REGION_NAME)
+lambda_client = boto3_client("lambda", region_name=REGION_NAME)
 dynamodb_client = boto3_client("dynamodb", region_name=REGION_NAME)
 dynamodb_resource = boto3_resource("dynamodb", region_name=REGION_NAME)
diff --git a/lambdas/shared/src/common/models/errors.py b/lambdas/shared/src/common/models/errors.py
@@ -207,6 +207,18 @@ class UnhandledAuditTableError(Exception):
     """A custom exception for when an unexpected error occurs whilst adding the file to the audit table."""
 
 
+class VaccineTypePermissionsError(Exception):
+    """A custom exception for when the supplier does not have the necessary vaccine type permissions."""
+
+
+class InvalidFileKeyError(Exception):
+    """A custom exception for when the file key is invalid."""
+
+
+class UnhandledSqsError(Exception):
+    """A custom exception for when an unexpected error occurs whilst sending a message to SQS."""
+
+
 @dataclass
 class InvalidPatientId(ValidationError):
     """Use this when NHS Number is invalid or doesn't exist"""
diff --git a/lambdas/shared/src/common/redis_client.py b/lambdas/shared/src/common/redis_client.py
@@ -7,12 +7,15 @@
 REDIS_HOST = os.getenv("REDIS_HOST", "")
 REDIS_PORT = os.getenv("REDIS_PORT", 6379)
 
-redis_client = None
+redis_client = redis.StrictRedis(host=os.getenv("REDIS_HOST"), port=os.getenv("REDIS_PORT"), decode_responses=True)
+
+# for lambdas which require a global redis_client
+global_redis_client = None
 
 
 def get_redis_client():
-    global redis_client
-    if redis_client is None:
+    global global_redis_client
+    if global_redis_client is None:
         logger.info(f"Connecting to Redis at {REDIS_HOST}:{REDIS_PORT}")
-        redis_client = redis.StrictRedis(host=REDIS_HOST, port=REDIS_PORT, decode_responses=True)
-    return redis_client
+        global_redis_client = redis.StrictRedis(host=REDIS_HOST, port=REDIS_PORT, decode_responses=True)
+    return global_redis_client
diff --git a/lambdas/shared/tests/test_common/test_redis_client.py b/lambdas/shared/tests/test_common/test_redis_client.py
@@ -31,16 +31,16 @@ def test_os_environ(self):
         self.assertEqual(redis_client.REDIS_HOST, self.REDIS_HOST)
         self.assertEqual(redis_client.REDIS_PORT, self.REDIS_PORT)
 
-    def test_redis_client(self):
-        """Test redis client is not initialized on import"""
+    def test_global_redis_client(self):
+        """Test global_redis_client is not initialized on import"""
         importlib.reload(redis_client)
-        self.mock_redis.assert_not_called()
+        self.assertEqual(redis_client.global_redis_client, None)
 
-    def test_redis_client_initialization(self):
-        """Test redis client is initialized exactly once even with multiple invocations"""
+    def test_global_redis_client_initialization(self):
+        """Test global_redis_client is initialized exactly once even with multiple invocations"""
         importlib.reload(redis_client)
         redis_client.get_redis_client()
+        self.assertNotEqual(redis_client.global_redis_client, None)
+        call_count = self.mock_redis.call_count
         redis_client.get_redis_client()
-        self.mock_redis.assert_called_once_with(host=self.REDIS_HOST, port=self.REDIS_PORT, decode_responses=True)
-        self.assertTrue(hasattr(redis_client, "redis_client"))
-        self.assertIsInstance(redis_client.redis_client, self.mock_redis.return_value.__class__)
+        self.assertEqual(self.mock_redis.call_count, call_count)

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`get_supplier_system_from_cache,`
`9`	`9`	`get_valid_vaccine_types_from_cache,`
`10`	`10`	`)`
`11`		`-from errors import InvalidFileKeyError`
	`11`	`+from common.models.errors import InvalidFileKeyError`
`12`	`12`
`13`	`13`
`14`	`14`	`def is_file_in_directory_root(file_key: str) -> bool:`