log partial detail where available

Author: JamesW1-NHS

backend/src/log_structure.py

@@ -20,13 +20,19 @@ def _log_data_from_body(event) -> dict:
     if event.get("body"):
         try:
             imms = json.loads(event["body"])
+        except json.decoder.JSONDecodeError:
+            # it can't be parsed
+            return log_data
+        try:
             vaccine_type = get_vaccine_type(imms)
             log_data["vaccine_type"] = vaccine_type
+        except Exception:
+            pass
+        try:
             local_id = imms["identifier"][0]["value"] + "^" + imms["identifier"][0]["system"]
             log_data["local_id"] = local_id
         except Exception:
-            # if there's no body, or it can't be parsed
-            return {}
+            pass
     return log_data
 
 

backend/tests/test_log_structure_wrapper.py

@@ -99,7 +99,7 @@ def test_exception_handling(self, mock_logger, mock_firehose_logger):
         self.assertEqual(logged_info['local_id'], '12345^http://test')
         self.assertEqual(logged_info['vaccine_type'], 'FLU')
 
-    def test_invalid_body(self, mock_logger, mock_firehose_logger):
+    def test_body_missing(self, mock_logger, mock_firehose_logger):
         # Arrange
         wrapped_function = function_info(self.mock_success_function)
         event = {
@@ -109,8 +109,7 @@ def test_invalid_body(self, mock_logger, mock_firehose_logger):
                 'SupplierSystem': 'test_supplier'
             },
             'path': '/test',
-            'requestContext': {'resourcePath': '/test'},
-            'body': "{\"identifier\": [{\"system\": \"http://test\", \"value\": \"12345\"}], \"protocolApplied\": []}"
+            'requestContext': {'resourcePath': '/test'}
         }
 
         # Act
@@ -128,31 +127,95 @@ def test_invalid_body(self, mock_logger, mock_firehose_logger):
         self.assertNotIn('local_id', logged_info)
         self.assertNotIn('vaccine_type', logged_info)
 
-    def test_nonexistent_body(self, mock_logger, mock_firehose_logger):
-        # Arrange
-        wrapped_function = function_info(self.mock_success_function)
-        event = {
-            'headers': {
-                'X-Correlation-ID': 'test_correlation',
-                'X-Request-ID': 'test_request',
-                'SupplierSystem': 'test_supplier'
+    def test_body_not_json(self, mock_logger, mock_firehose_logger):
+        # Act
+        decorated_function_raises = function_info(self.mock_function_raises)
+
+        with self.assertRaises(ValueError):
+            #Assert
+            event = {'headers': {
+                'X-Correlation-ID': 'failed_test_correlation',
+                'X-Request-ID': 'failed_test_request',
+                'SupplierSystem': 'failed_test_supplier'
             },
-            'path': '/test',
-            'requestContext': {'resourcePath': '/test'}
-        }
+                'path': '/failed_test', 'requestContext': {'resourcePath': '/failed_test'},
+                'body': "invalid"}
 
-        # Act
-        result = wrapped_function(event, {})
+            context = {}
+            decorated_function_raises(event, context)
 
-        # Assert
-        args, kwargs = mock_logger.info.call_args
+        #Assert
+        args, kwargs = mock_logger.exception.call_args
         logged_info = json.loads(args[0])
 
-        self.assertEqual(logged_info['X-Correlation-ID'], 'test_correlation')
-        self.assertEqual(logged_info['X-Request-ID'], 'test_request')
-        self.assertEqual(logged_info['supplier'], 'test_supplier')
-        self.assertEqual(logged_info['actual_path'], '/test')
-        self.assertEqual(logged_info['resource_path'], '/test')
+        self.assertEqual(logged_info['X-Correlation-ID'], 'failed_test_correlation')
+        self.assertEqual(logged_info['X-Request-ID'], 'failed_test_request')
+        self.assertEqual(logged_info['supplier'], 'failed_test_supplier')
+        self.assertEqual(logged_info['actual_path'], '/failed_test')
+        self.assertEqual(logged_info['resource_path'], '/failed_test')
         self.assertNotIn('local_id', logged_info)
         self.assertNotIn('vaccine_type', logged_info)
 
+    def test_body_invalid_identifier(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)
+
+        with self.assertRaises(ValueError):
+            #Assert
+            event = {'headers': {
+                'X-Correlation-ID': 'failed_test_correlation',
+                'X-Request-ID': 'failed_test_request',
+                'SupplierSystem': 'failed_test_supplier'
+            },
+                'path': '/failed_test', 'requestContext': {'resourcePath': '/failed_test'},
+                'body': "{\"identifier\": [], \"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)
+
+        #Assert
+        args, kwargs = mock_logger.exception.call_args
+        logged_info = json.loads(args[0])
+
+        self.assertEqual(logged_info['X-Correlation-ID'], 'failed_test_correlation')
+        self.assertEqual(logged_info['X-Request-ID'], 'failed_test_request')
+        self.assertEqual(logged_info['supplier'], 'failed_test_supplier')
+        self.assertEqual(logged_info['actual_path'], '/failed_test')
+        self.assertEqual(logged_info['resource_path'], '/failed_test')
+        self.assertNotIn('local_id', logged_info)
+        self.assertEqual(logged_info['vaccine_type'], 'FLU')
+
+    def test_body_invalid_protocol_applied(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)
+
+        with self.assertRaises(ValueError):
+            #Assert
+            event = {'headers': {
+                'X-Correlation-ID': 'failed_test_correlation',
+                'X-Request-ID': 'failed_test_request',
+                'SupplierSystem': 'failed_test_supplier'
+            },
+                'path': '/failed_test', 'requestContext': {'resourcePath': '/failed_test'},
+                'body': "{\"identifier\": [{\"system\": \"http://test\", \"value\": \"12345\"}], \"protocolApplied\": []}"}
+
+            context = {}
+            decorated_function_raises(event, context)
+
+        #Assert
+        args, kwargs = mock_logger.exception.call_args
+        logged_info = json.loads(args[0])
+
+        self.assertEqual(logged_info['X-Correlation-ID'], 'failed_test_correlation')
+        self.assertEqual(logged_info['X-Request-ID'], 'failed_test_request')
+        self.assertEqual(logged_info['supplier'], 'failed_test_supplier')
+        self.assertEqual(logged_info['actual_path'], '/failed_test')
+        self.assertEqual(logged_info['resource_path'], '/failed_test')
+        self.assertEqual(logged_info['local_id'], '12345^http://test')
+        self.assertNotIn('vaccine_type', logged_info)