fix: s3 logs (#744)

### Description

Please explain the changes you made here.

### Checklist

- [ ] Created tests which fail without the change (if possible)
- [ ] All tests passing
- [ ] Extended the documentation, if necessary

Author: Rotheem

app/core/myeclpay/endpoints_myeclpay.py

@@ -4,7 +4,7 @@
 import uuid
 from datetime import UTC, date, datetime, timedelta
 from pathlib import Path
-from uuid import UUID, uuid4
+from uuid import UUID
 
 import calypsso
 from fastapi import (
@@ -1409,8 +1409,8 @@ async def create_user_devices(
     hyperion_myeclpay_logger.info(
         wallet_device_creation.ed25519_public_key,
         extra={
-            "s3_subfolder": MYECLPAY_DEVICES_S3_SUBFOLDER,
-            "s3_filename": f"{user.id}-{str(uuid4())[:8]}",
+            "s3_subfolder": f"{MYECLPAY_DEVICES_S3_SUBFOLDER}/{user.id}",
+            "s3_filename": str(wallet_device_db.id),
         },
     )
 
@@ -2164,8 +2164,8 @@ async def store_scan_qrcode(
         hyperion_myeclpay_logger.info(
             format_transaction_log(transaction),
             extra={
-                "subfolder": MYECLPAY_LOGS_S3_SUBFOLDER,
-                "retention": RETENTION_DURATION,
+                "s3_subfolder": MYECLPAY_LOGS_S3_SUBFOLDER,
+                "s3_retention": RETENTION_DURATION,
             },
         )
         message = Message(
@@ -2340,8 +2340,8 @@ async def refund_transaction(
     hyperion_myeclpay_logger.info(
         format_refund_log(refund),
         extra={
-            "subfolder": MYECLPAY_LOGS_S3_SUBFOLDER,
-            "retention": RETENTION_DURATION,
+            "s3_subfolder": MYECLPAY_LOGS_S3_SUBFOLDER,
+            "s3_retention": RETENTION_DURATION,
         },
     )
 
@@ -2490,8 +2490,8 @@ async def cancel_transaction(
     hyperion_myeclpay_logger.info(
         format_cancel_log(transaction_id),
         extra={
-            "subfolder": MYECLPAY_LOGS_S3_SUBFOLDER,
-            "retention": RETENTION_DURATION,
+            "s3_subfolder": MYECLPAY_LOGS_S3_SUBFOLDER,
+            "s3_retention": RETENTION_DURATION,
         },
     )
 

app/core/myeclpay/utils_myeclpay.py

@@ -113,7 +113,7 @@ async def validate_transfer_callback(
     hyperion_myeclpay_logger.info(
         format_transfer_log(transfer),
         extra={
-            "subfolder": MYECLPAY_LOGS_S3_SUBFOLDER,
-            "retention": RETENTION_DURATION,
+            "s3_subfolder": MYECLPAY_LOGS_S3_SUBFOLDER,
+            "s3_retention": RETENTION_DURATION,
         },
     )

app/types/s3_access.py

@@ -40,7 +40,7 @@ def __init__(
             or s3_bucket_name is None
         ):
             self.failure_logger.critical(
-                "S3_ACCESS_KEY_ID or S3_SECRET_ACCESS_KEY or S3_MYECLPAY_LOGS_BUCKET_NAME is not set. Working with fallback logger only.",
+                "S3_ACCESS_KEY_ID or S3_SECRET_ACCESS_KEY or S3_BUCKET_NAME is not set. Working with fallback logger only.",
             )
             self.s3 = None
             return
@@ -69,7 +69,7 @@ def write_file(
         self,
         message: str,
         filename: str,
-        subfolder: str = "",
+        subfolder: str | None = None,
         retention: int = 0,
     ):
         """Write in an S3 bucket with object locking if needed.
@@ -90,14 +90,13 @@ def write_file(
         # If there is a "/" in the filename the s3 while consider it as a folder
         if not re.match(AUTHORIZED_FILE_STRING, filename):
             raise InvalidS3FileNameError(filename)
-        if subfolder != "" and not re.match(AUTHORIZED_FOLDER_STRING, subfolder):
+        if subfolder is not None and not re.match(AUTHORIZED_FOLDER_STRING, subfolder):
             raise InvalidS3FolderError(subfolder)
 
-        filename = (
-            f"{self.folder}/{subfolder}/{filename}"
-            if self.folder != ""
-            else f"{subfolder}/{filename}"
-        )
+        if subfolder is not None:
+            filename = subfolder + "/" + filename
+        if self.folder != "":
+            filename = self.folder + "/" + filename
 
         file_object = BytesIO(message.encode("utf-8"))
 
@@ -127,7 +126,7 @@ def write_file(
     def get_file_with_name(
         self,
         filename: str,
-        subfolder: str = "",
+        subfolder: str | None = None,
     ) -> str:
         """Get a file from S3 with a given name and subfolder.
         The filename must not contain a "/" because S3 will consider it as a folder.
@@ -145,14 +144,13 @@ def get_file_with_name(
         # If there is a "/" in the filename the s3 while consider it as a folder
         if not re.match(AUTHORIZED_FILE_STRING, filename):
             raise InvalidS3FileNameError(filename)
-        if subfolder != "" and not re.match(AUTHORIZED_FOLDER_STRING, subfolder):
+        if subfolder is not None and not re.match(AUTHORIZED_FOLDER_STRING, subfolder):
             raise InvalidS3FolderError(subfolder)
 
-        filename = (
-            f"{self.folder}/{subfolder}/{filename}"
-            if self.folder != ""
-            else f"{subfolder}/{filename}"
-        )
+        if subfolder is not None:
+            filename = subfolder + "/" + filename
+        if self.folder != "":
+            filename = self.folder + "/" + filename
 
         file_object = BytesIO()
         if self.s3 is None:

app/utils/loggers_tools/s3_handler.py

@@ -1,10 +1,13 @@
+import string
 from datetime import UTC, datetime
 from logging import StreamHandler
-from uuid import uuid4
 
 from typing_extensions import override
 
 from app.types.s3_access import S3Access
+from app.utils.tools import get_random_string
+
+alphanum = string.ascii_lowercase + string.digits
 
 
 class S3LogHandler(StreamHandler):
@@ -27,13 +30,13 @@ def __init__(
 
     @override
     def emit(self, record):
-        filename = getattr(record, "s3_filename", None)
-        subfolder = str(getattr(record, "s3_subfolder", ""))
+        filename: str | None = getattr(record, "s3_filename", None)
+        subfolder: str | None = getattr(record, "s3_subfolder", None)
         retention: int = getattr(record, "s3_retention", 0)
 
         if filename is None:
             now = datetime.now(UTC)
-            filename = now.strftime("%Y-%m-%dT%H:%M:%S.%fZ") + str(uuid4())[8:]
+            filename = now.strftime("%Y-%m-%dT%H:%M:%S.%fZ") + get_random_string(8)
 
         msg = self.format(record)
         self.s3_access.write_file(msg, filename, subfolder, retention)

pyproject.toml

@@ -6,7 +6,7 @@ authors = [{ name = "AEECL ECLAIR" }]
 
 # Hyperion follows Semantic Versioning
 # https://semver.org/
-version = "4.5.2"
+version = "4.5.3"
 minimal-titan-version-code = 139
 requires-python = ">= 3.11, < 3.13"