Merge branch 'master' into VED-717-Readme-VSCode

Author: JamesW1-NHS

.github/workflows/continuous-integration.yml

@@ -8,7 +8,7 @@ jobs:
     if: github.ref == 'refs/heads/master'
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           fetch-depth: 0  # This causes all history to be fetched, which is required for calculate-version to function	
 

.github/workflows/deploy-template.yml

@@ -24,7 +24,7 @@ jobs:
         run: aws sts get-caller-identity
 
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           fetch-depth: 1
 
@@ -53,7 +53,7 @@ jobs:
       name: int
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - uses: aws-actions/configure-aws-credentials@v4
         with:
@@ -85,7 +85,7 @@ jobs:
       contents: read
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - uses: aws-actions/configure-aws-credentials@v4
         with:

.github/workflows/sonarcloud.yml

@@ -17,7 +17,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           fetch-depth: 0
 

ack_backend/src/convert_message_to_ack_row.py

@@ -1,7 +1,7 @@
 """Functions for converting the incoming message body into a row of ack data"""
 
 from typing import Union
-from logging_decorators import convert_messsage_to_ack_row_logging_decorator
+from logging_decorators import convert_message_to_ack_row_logging_decorator
 from update_ack_file import create_ack_data
 
 
@@ -19,7 +19,7 @@ def get_error_message_for_ack_file(message_diagnostics) -> Union[None, str]:
     return message_diagnostics.get("error_message", "Unable to determine diagnostics issue")
 
 
-@convert_messsage_to_ack_row_logging_decorator
+@convert_message_to_ack_row_logging_decorator
 def convert_message_to_ack_row(message, created_at_formatted_string):
     """
     Takes a single message and returns the ack data row for that message.

ack_backend/src/logging_decorators.py

@@ -22,22 +22,29 @@ def send_log_to_firehose(log_data: dict) -> None:
 
 
 def generate_and_send_logs(
-    start_time, base_log_data: dict, additional_log_data: dict, is_error_log: bool = False
+    start_time: float,
+    base_log_data: dict,
+    additional_log_data: dict,
+    use_ms_precision: bool = False,
+    is_error_log: bool = False
 ) -> None:
     """Generates log data which includes the base_log_data, additional_log_data, and time taken (calculated using the
     current time and given start_time) and sends them to Cloudwatch and Firehose."""
-    log_data = {**base_log_data, "time_taken": f"{round(time.time() - start_time, 5)}s", **additional_log_data}
+    seconds_elapsed = time.time() - start_time
+    formatted_time_elapsed = f"{round(seconds_elapsed * 1000, 5)}ms" if use_ms_precision else \
+        f"{round(seconds_elapsed, 5)}s"
+
+    log_data = {**base_log_data, "time_taken": formatted_time_elapsed, **additional_log_data}
     log_function = logger.error if is_error_log else logger.info
     log_function(json.dumps(log_data))
     send_log_to_firehose(log_data)
 
 
-def convert_messsage_to_ack_row_logging_decorator(func):
+def convert_message_to_ack_row_logging_decorator(func):
     """This decorator logs the information on the conversion of a single message to an ack data row"""
 
     @wraps(func)
     def wrapper(message, created_at_formatted_string):
-
         base_log_data = {"function_name": f"ack_processor_{func.__name__}", "date_time": str(datetime.now())}
         start_time = time.time()
 
@@ -57,13 +64,14 @@ def wrapper(message, created_at_formatted_string):
                 "operation_requested": message.get("operation_requested", "unknown"),
                 **process_diagnostics(diagnostics, file_key, message_id),
             }
-            generate_and_send_logs(start_time, base_log_data, additional_log_data)
+            generate_and_send_logs(start_time, base_log_data, additional_log_data, use_ms_precision=True)
 
             return result
 
         except Exception as error:
             additional_log_data = {"status": "fail", "statusCode": 500, "diagnostics": str(error)}
-            generate_and_send_logs(start_time, base_log_data, additional_log_data, is_error_log=True)
+            generate_and_send_logs(start_time, base_log_data, additional_log_data, use_ms_precision=True,
+                                   is_error_log=True)
             raise
 
     return wrapper

ack_backend/tests/utils/values_for_ack_backend_tests.py

@@ -157,7 +157,7 @@ class ValidValues:
         "vaccine_type": MOCK_MESSAGE_DETAILS.vaccine_type,
         "message_id": MOCK_MESSAGE_DETAILS.row_id,
         "operation_requested": "CREATE",
-        "time_taken": "1.0s",
+        "time_taken": "1000.0ms",
         "local_id": MOCK_MESSAGE_DETAILS.local_id,
         "statusCode": 200,
         "diagnostics": "Operation completed successfully",
@@ -234,7 +234,7 @@ class InvalidValues:
         "vaccine_type": "unknown",
         "message_id": "unknown",
         "operation_requested": "unknown",
-        "time_taken": "1.0s",
+        "time_taken": "1000.0ms",
         "local_id": "unknown",
         "statusCode": 500,
         "diagnostics": "An unhandled error occurred during batch processing",