_log_data_from_body

Author: JamesW1-NHS

backend/src/log_structure.py

@@ -6,13 +6,26 @@
 
 from log_firehose import FirehoseLogger
 
+from models.utils.validation_utils import get_vaccine_type
+
 logging.basicConfig()
 logger = logging.getLogger()
 logger.setLevel("INFO")
 
 
 firehose_logger = FirehoseLogger()
 
+def _log_data_from_body(event, log_data):
+    if event.get("body"):
+        imms = json.loads(event["body"])
+        if imms.get("protocolApplied"):
+            vaccine_type = get_vaccine_type(imms)
+            log_data["vaccine_type"] = vaccine_type
+        if imms.get("identifier"):
+            local_id = imms["identifier"][0]["value"] + "^" + imms["identifier"][0]["system"]
+            log_data["local_id"] = local_id
+    return log_data
+
 
 def function_info(func):
     """This decorator prints the execution information for the decorated function."""
@@ -43,6 +56,7 @@ def wrapper(*args, **kwargs):
             print(f"Result:{result}")
             end = time.time()
             log_data["time_taken"] = f"{round(end - start, 5)}s"
+            log_data = _log_data_from_body(event, log_data)
             status = "500"
             status_code = "Exception"
             diagnostics = str()
@@ -78,6 +92,7 @@ def wrapper(*args, **kwargs):
             log_data["error"] = str(e)
             end = time.time()
             log_data["time_taken"] = f"{round(end - start, 5)}s"
+            log_data = _log_data_from_body(event, log_data)
             logger.exception(json.dumps(log_data))
             firehose_log["event"] = log_data
             firehose_logger.send_log(firehose_log)

backend/tests/test_log_structure_wrapper.py

@@ -8,6 +8,15 @@
 @patch('log_structure.logger')
 class TestFunctionInfoWrapper(unittest.TestCase):
 
+    def setUp(self):
+        super().setUp()
+        self.redis_patcher = patch("models.utils.validation_utils.redis_client")
+        self.mock_redis_client = self.redis_patcher.start()
+
+    def tearDown(self):
+        self.redis_patcher.stop()
+        super().tearDown()
+
     @staticmethod
     def mock_success_function(_event, _context):
         return "Success"
@@ -18,14 +27,16 @@ def mock_function_raises(_event, _context):
 
     def test_successful_execution(self, mock_logger, mock_firehose_logger):
         # Arrange
+        self.mock_redis_client.hget.return_value = "FLU"
         wrapped_function = function_info(self.mock_success_function)
         event = {
             'headers': {
                 'X-Correlation-ID': 'test_correlation',
                 'X-Request-ID': 'test_request'
             },
             'path': '/test',
-            'requestContext': {'resourcePath': '/test'}
+            'requestContext': {'resourcePath': '/test'},
+            'body': "{\"identifier\": [{\"system\": \"http://test\", \"value\": \"12345\"}], \"protocolApplied\": [{\"targetDisease\": [{\"coding\": [{\"system\": \"http://snomed.info/sct\", \"code\": \"840539006\", \"display\": \"Disease caused by severe acute respiratory syndrome coronavirus 2\"}]}]}]}"
         }
 
         # Act
@@ -45,8 +56,12 @@ def test_successful_execution(self, mock_logger, mock_firehose_logger):
         self.assertEqual(logged_info['X-Request-ID'], 'test_request')
         self.assertEqual(logged_info['actual_path'], '/test')
         self.assertEqual(logged_info['resource_path'], '/test')
+        self.assertEqual(logged_info['local_id'], '12345^http://test')
+        self.assertEqual(logged_info['vaccine_type'], 'FLU')
 
     def test_exception_handling(self, mock_logger, mock_firehose_logger):
+        # Arrange
+        self.mock_redis_client.hget.return_value = "FLU"
 
         #Act
         decorated_function_raises = function_info(self.mock_function_raises)
@@ -57,7 +72,9 @@ def test_exception_handling(self, mock_logger, mock_firehose_logger):
                 'X-Correlation-ID': 'failed_test_correlation',
                 'X-Request-ID': 'failed_test_request'
             },
-                'path': '/failed_test', 'requestContext': {'resourcePath': '/failed_test'}}
+                'path': '/failed_test', 'requestContext': {'resourcePath': '/failed_test'},
+                'body': "{\"identifier\": [{\"system\": \"http://test\", \"value\": \"12345\"}], \"protocolApplied\": [{\"targetDisease\": [{\"coding\": [{\"system\": \"http://snomed.info/sct\", \"code\": \"840539006\", \"display\": \"Disease caused by severe acute respiratory syndrome coronavirus 2\"}]}]}]}"}
+
             context = {}
             decorated_function_raises(event, context)
 
@@ -74,4 +91,6 @@ def test_exception_handling(self, mock_logger, mock_firehose_logger):
         self.assertEqual(logged_info['X-Request-ID'], 'failed_test_request')
         self.assertEqual(logged_info['actual_path'], '/failed_test')
         self.assertEqual(logged_info['resource_path'], '/failed_test')
-        self.assertEqual(logged_info['error'], str(ValueError("Test error")))
+        self.assertEqual(logged_info['error'], str(ValueError("Test error")))
+        self.assertEqual(logged_info['local_id'], '12345^http://test')
+        self.assertEqual(logged_info['vaccine_type'], 'FLU')