Merge pull request #328 from ansforge/chore/converter-logging

chore(converter): logging structuré

Author: SimonClo

converter/README.md

@@ -74,16 +74,16 @@ gunicorn -w 4 -b 0.0.0.0:8080 converter.converter:app
 
 ```bash
 # Based on https://github.com/ansforge/SAMU-Hub-Sante/blob/main/web/lrm/client/constants.js#L5C30-L45C2
-curl -X POST http://localhost:8080/convert-cisu \
+curl -X POST http://localhost:8080/convert \
   -H "Content-Type: application/json" \
-  -d "$(jq --argjson usecase "$(cat ../src/main/resources/sample/examples/RC-EDA/RC-EDA-FemmeEnceinte-DelphineVigneau.json)" '.edxl.content[0].jsonContent.embeddedJsonContent.message |= (. + $usecase)' tests/edxl_envelope_fire_to_health.json)"
+  -d "$(jq --argjson usecase "$(cat ../src/main/resources/sample/examples/RC-EDA/RC-EDA-FemmeEnceinte-DelphineVigneau.json)" '.sourceVersion = "v3" | .targetVersion = "v3" | .cisuConversion = true | .edxl.content[0].jsonContent.embeddedJsonContent.message |= (. + $usecase)' tests/fixtures/EDXL/edxl_envelope_fire_to_health.json)"
 ```
 
 #### Convert Health to CISU Format
 
 ```bash
 # Based on https://github.com/ansforge/SAMU-Hub-Sante/blob/main/web/lrm/client/constants.js#L5C30-L45C2
-curl -X POST http://localhost:8080/convert-cisu \
+curl -X POST http://localhost:8080/convert \
   -H "Content-Type: application/json" \
-  -d "$(jq --argjson usecase "$(cat ../src/main/resources/sample/examples/RS-EDA/RS-EDA-SMUR_FemmeEnceinte_DelphineVigneau.01.json)" '.edxl.content[0].jsonContent.embeddedJsonContent.message |= (. + $usecase)' tests/edxl_envelope_health_to_fire.json)"
+  -d "$(jq --argjson usecase "$(cat ../src/main/resources/sample/examples/RS-EDA/RS-EDA-SMUR_FemmeEnceinte_DelphineVigneau.01.json)" '.sourceVersion = "v3" | .targetVersion = "v3" | .cisuConversion = true | .edxl.content[0].jsonContent.embeddedJsonContent.message |= (. + $usecase)' tests/fixtures/EDXL/edxl_envelope_health_to_fire.json)"
 ```

converter/converter/cisu/create_case/create_case_cisu_converter.py

@@ -17,6 +17,9 @@
     translate_key_words,
 )
 from converter.cisu.base_cisu_converter import BaseCISUConverter
+import logging
+
+logger = logging.getLogger(__name__)
 
 
 class CreateCaseCISUConverter(BaseCISUConverter):
@@ -89,21 +92,25 @@ def from_cisu_to_rs(cls, input_json: Dict[str, Any]) -> Dict[str, Any]:
         Returns:
             Converted EDXL Health JSON
         """
+        logger.info("Starting CISU to Health format conversion")
 
         def set_default_location_freetext(json_data: Dict[str, Any]):
+            logger.debug("Setting default location freetext")
             if not is_field_completed(json_data, "$.location.freetext"):
                 json_data["location"]["freetext"] = (
                     ""  # need at least empty value to pass validation
                 )
 
         def add_location_detail(json_data: Dict[str, Any]):
+            logger.debug("Adding location detail to freetext")
             if is_field_completed(json_data, "$.location.city.detail"):
                 set_default_location_freetext(json_data)
                 json_data["location"]["freetext"] += (
                     "\nDétails de commune : " + json_data["location"]["city"]["detail"]
                 )
 
         def add_case_priority(json_data: Dict[str, Any]):
+            logger.debug("Adding case priority")
             if is_field_completed(json_data, "$.initialAlert.reporting"):
                 if not is_field_completed(json_data, "$.qualification.details"):
                     json_data["qualification"]["details"] = {}
@@ -115,6 +122,7 @@ def add_case_priority(json_data: Dict[str, Any]):
                 )
 
         def merge_notes_freetext(json_data: Dict[str, Any]):
+            logger.debug("Merging freetext notes")
             if not is_field_completed(json_data, "$.initialAlert.notes"):
                 return json_data
 
@@ -136,6 +144,7 @@ def merge_notes_freetext(json_data: Dict[str, Any]):
             return json_data
 
         def add_victims_to_medical_notes(json_data: Dict[str, Any], sender_id: str):
+            logger.debug("Adding victims to medical notes")
             field_value = get_field_value(json_data, "$.qualification.victims")
 
             if field_value is None:
@@ -150,6 +159,7 @@ def add_victims_to_medical_notes(json_data: Dict[str, Any], sender_id: str):
         def add_object_to_medical_notes(
             json_data: Dict[str, Any], note_text: str, sender_id: str
         ):
+            logger.debug("Adding object to medical notes")
             if not is_field_completed(json_data, "$.medicalNote"):
                 json_data["medicalNote"] = []
 
@@ -192,6 +202,7 @@ def add_object_to_medical_notes(
         add_victims_to_medical_notes(output_use_case_json, sender_id)
 
         # - Delete paths - /!\ It must be the last step
+        logger.debug("Removing unnecessary paths")
         delete_paths(output_use_case_json, cls.CISU_PATHS_TO_DELETE)
 
         return cls.format_rs_output_json(output_json, output_use_case_json)
@@ -225,15 +236,18 @@ def from_rs_to_cisu(cls, input_json: Dict[str, Any]) -> Dict[str, Any]:
         Returns:
             Converted EDXL CISU JSON
         """
+        logger.info("Starting Health format to CISU conversion")
 
         def add_victim_information(json_data: Dict[str, Any]):
+            logger.debug("Adding victim information")
             if not is_field_completed(json_data, "$.qualification"):
                 json_data["qualification"] = {}
             json_data["qualification"]["victims"] = cls.get_victim_count(
                 cls, input_usecase_json
             )
 
         def get_call_taker_information(json_data: Dict[str, Any]):
+            logger.debug("Getting call taker information")
             sender_id = get_sender(json_data)
             crra_code = sender_id[
                 len("fr.health.") :
@@ -244,6 +258,7 @@ def get_call_taker_information(json_data: Dict[str, Any]):
             }
 
         def add_default_external_info_type(json_data: Dict[str, Any]):
+            logger.debug("Adding default external info type")
             external_info = get_field_value(json_data, "$.location.externalInfo")
             if external_info is not None:
                 for info in external_info:
@@ -283,6 +298,7 @@ def add_default_external_info_type(json_data: Dict[str, Any]):
         add_default_external_info_type(output_usecase_json)
 
         # Deletions - /!\ it must be done before copying qualification and location fields
+        logger.debug("Removing unnecessary paths")
         delete_paths(output_usecase_json, cls.HEALTH_PATHS_TO_DELETE)
 
         if is_field_completed(input_usecase_json, "$.initialAlert"):

converter/converter/cisu/resources_info/resources_info_cisu_converter.py

@@ -7,6 +7,9 @@
     ResourcesInfoCISUConstants,
 )
 from converter.utils import get_field_value, set_value, delete_paths
+import logging
+
+logger = logging.getLogger(__name__)
 
 
 class ResourcesInfoCISUConverter(BaseCISUConverter):
@@ -20,27 +23,33 @@ def get_cisu_message_type(cls) -> str:
 
     @classmethod
     def from_cisu_to_rs(cls, edxl_json: Dict[str, Any]) -> Dict[str, Any]:
+        logger.info("Converting from CISU to RS format for Resources Info message.")
+        logger.debug(f"Message content: {edxl_json}")
         output_json = cls.copy_cisu_input_content(edxl_json)
         output_use_case_json = cls.copy_cisu_input_use_case_content(edxl_json)
         resources = get_field_value(
             output_use_case_json, ResourcesInfoCISUConstants.RESOURCE_PATH
         )
 
         for resource in resources:
+            logger.debug(f"Processing resource: {resource}")
             state = get_field_value(resource, ResourcesInfoCISUConstants.STATE_PATH)
             set_value(resource, ResourcesInfoCISUConstants.STATE_PATH, [state])
 
         return cls.format_rs_output_json(output_json, output_use_case_json)
 
     @classmethod
     def from_rs_to_cisu(cls, edxl_json: Dict[str, Any]) -> Dict[str, Any]:
+        logger.info("Converting from RS to CISU format for Resources Info message.")
+        logger.debug(f"Message content: {edxl_json}")
         output_json = cls.copy_rs_input_content(edxl_json)
         output_use_case_json = cls.copy_rs_input_use_case_content(edxl_json)
 
         resources = get_field_value(
             output_use_case_json, ResourcesInfoCISUConstants.RESOURCE_PATH
         )
         for resource in resources:
+            logger.debug(f"Processing resource: {resource}")
             rs_vehicle_type = get_field_value(
                 resource, ResourcesInfoCISUConstants.VEHICLE_TYPE_PATH
             )

converter/converter/conversion_strategy/cisu_conversion_strategy.py

@@ -1,3 +1,5 @@
+import logging
+
 from converter.cisu.create_case.create_case_cisu_converter import (
     CreateCaseCISUConverter,
 )
@@ -16,15 +18,20 @@
     extract_message_type_from_message_content,
 )
 
+logger = logging.getLogger(__name__)
+
 
 def cisu_conversion_strategy(edxl_json, source_version, target_version):
-    print(f"CISU Conversion initiated from {source_version} to {target_version}")
+    logger.info(f"CISU Conversion initiated from {source_version} to {target_version}")
 
     direction = compute_message_direction(edxl_json)
     message_content = extract_message_content(edxl_json)
     selected_strategy = select_conversion_strategy(message_content)
 
     if direction == CISUConstants.TO_CISU:
+        logger.info(
+            "Conversion RS -> CISU",
+        )
         if target_version != CISUConstants.MAINTAINED_CISU_VERSION:
             raise ValueError(
                 f"Unknown target version {target_version}. Must be: {CISUConstants.MAINTAINED_CISU_VERSION}"
@@ -36,6 +43,9 @@ def cisu_conversion_strategy(edxl_json, source_version, target_version):
 
         return selected_strategy.from_rs_to_cisu(rs_json_message)
     elif direction == CISUConstants.FROM_CISU:
+        logger.info(
+            "Conversion CISU -> RS",
+        )
         if source_version != CISUConstants.MAINTAINED_CISU_VERSION:
             raise ValueError(
                 f"Unknown source version {source_version}. Must be: {CISUConstants.MAINTAINED_CISU_VERSION}"

converter/converter/conversion_strategy/health_conversion_strategy.py

@@ -32,6 +32,7 @@
     GeoPositionsUpdateConverter,
 )
 from converter.versions.rpis.rpis_converter import RpisConverter
+import logging
 
 from converter.utils import (
     extract_message_content,
@@ -40,7 +41,9 @@
 
 
 def health_conversion_strategy(edxl_json, source_version: str, target_version: str):
-    print(f"Health Conversion initiated from {source_version} to {target_version}")
+    logging.info(
+        f"Health Conversion initiated from {source_version} to {target_version}"
+    )
 
     message_content = extract_message_content(edxl_json)
     selected_strategy = select_conversion_strategy(message_content)

converter/converter/converter.py

@@ -1,12 +1,22 @@
-from flask import Flask, request, jsonify
-
+from flask import Flask, request, jsonify, g
+import logging
 from converter.conversion_strategy.conversion_strategy import conversion_strategy
+from converter.utils import (
+    get_sender,
+    get_recipient,
+    extract_message_type_from_message_content,
+    extract_message_content,
+)
+from converter.logging_config import configure_logging, LoggingKeys
+
+configure_logging()
 
 app = Flask(__name__)
+logger = logging.getLogger(__name__)
 
 
 def raise_error(message, code: int = 400):
-    print(f"[ERROR] {message}")
+    logger.error(message)
     return jsonify({"error": message}), code
 
 
@@ -16,11 +26,26 @@ def convert():
         return raise_error("Content-Type must be application/json")
 
     req_data = request.get_json()
+    logger.debug(f"Received conversion request: {req_data}")
     source_version = req_data.get("sourceVersion")
     target_version = req_data.get("targetVersion")
     edxl_json = req_data.get("edxl")
     is_cisu_conversion = req_data.get("cisuConversion", False)
 
+    # Store data in request context to be used in logs
+    try:
+        setattr(g, LoggingKeys.DISTRIBUTION_ID.value, edxl_json.get("distributionID"))
+        setattr(g, LoggingKeys.SENDER_ID.value, get_sender(edxl_json))
+        setattr(g, LoggingKeys.RECIPIENT_ID.value, get_recipient(edxl_json))
+        message_content = extract_message_content(edxl_json)
+        setattr(
+            g,
+            LoggingKeys.MESSAGE_TYPE.value,
+            extract_message_type_from_message_content(message_content),
+        )
+    except Exception:
+        pass
+
     if not source_version or not target_version or not edxl_json:
         return raise_error(
             f"Missing required fields: sourceVersion={source_version}, targetVersion={target_version}, edxl present={edxl_json is not None}"

converter/converter/logging_config.py

@@ -0,0 +1,43 @@
+import logging
+from pythonjsonlogger.json import JsonFormatter
+from flask import has_request_context, g
+from enum import Enum
+
+
+class LoggingKeys(Enum):
+    DISTRIBUTION_ID = "distributionId"
+    SENDER_ID = "senderId"
+    RECIPIENT_ID = "recipientId"
+    MESSAGE_TYPE = "messageType"
+
+
+# Using filter to add context variable: https://docs.python.org/3/howto/logging-cookbook.html#using-filters-to-impart-contextual-information
+class DistributionContextFilter(logging.Filter):
+    def filter(self, record):
+        if has_request_context():
+            for key in LoggingKeys:
+                setattr(record, key.value, getattr(g, key.value, None))
+        return True
+
+
+def configure_logging():
+    root = logging.getLogger()
+    for h in root.handlers[:]:
+        root.removeHandler(h)
+
+    handler = logging.StreamHandler()
+
+    formatter = JsonFormatter(
+        "%(asctime)s %(levelname)s %(message)s",
+        rename_fields={
+            "asctime": "timestamp",
+            "levelname": "level",
+        },
+    )
+    handler.setFormatter(formatter)
+    handler.addFilter(DistributionContextFilter())
+
+    root.addHandler(handler)
+    root.setLevel(logging.INFO)
+
+    root.propagate = True

converter/converter/utils.py

@@ -4,9 +4,12 @@
 from typing import List, Dict, Any, Optional
 from jsonpath_ng import parse
 from yaml import dump
+import logging
 
 from converter.constants import Constants
 
+logger = logging.getLogger(__name__)
+
 
 def get_recipient(edxl_json: Dict[str, Any]) -> str:
     return edxl_json["descriptor"]["explicitAddress"]["explicitAddressValue"]
@@ -141,7 +144,7 @@ def is_field_completed(json_data: Dict[str, Any], json_path: str):
         jsonpath_expr = parse(json_path)
         return len(jsonpath_expr.find(json_data)) >= 1
     except Exception as e:
-        print(f"Error raised in is_field_completed : {e}")
+        logger.error(f"Error raised in is_field_completed : {e}")
         raise
 
 
@@ -158,7 +161,7 @@ def get_field_value(json_data: Dict[str, Any], json_path: str):
         return matches[0].value
 
     except Exception as e:
-        print(f"Error raised in is_field_completed : {e}")
+        logger.error(f"Error raised in is_field_completed : {e}")
         raise
 
 
@@ -194,7 +197,7 @@ def update_json_value(data, jsonpath_query, new_value):
             match.full_path.update(data, new_value)
 
     except Exception as e:
-        print(f"Error raised in update_json_value: {e}")
+        logger.error(f"Error raised in update_json_value: {e}")
         raise