minor refactor email

Author: pcrespov

.codecov.yml

@@ -25,9 +25,6 @@ component_management:
         branches:
           - "!master"
   individual_components:
-    - component_id: api
-      paths:
-        - api/**
     - component_id: pkg_aws_library
       paths:
         - packages/aws-library/**

services/web/server/src/simcore_service_webserver/email/_handlers.py

@@ -5,23 +5,18 @@
 from models_library.emails import LowerCaseEmailStr
 from pydantic import BaseModel, Field
 from servicelib.aiohttp.requests_validation import parse_request_body_as
+from servicelib.logging_errors import create_troubleshootting_log_kwargs
 
 from .._meta import API_VTAG
 from ..login.decorators import login_required
 from ..products import products_web
 from ..products.models import Product
 from ..security.decorators import permission_required
-from ..utils import get_traceback_string
 from ..utils_aiohttp import envelope_json_response
 from ._core import check_email_server_responsiveness, send_email_from_template
 from .settings import get_plugin_settings
 
-logger = logging.getLogger(__name__)
-
-
-#
-# API schema models
-#
+_logger = logging.getLogger(__name__)
 
 
 class TestEmail(BaseModel):
@@ -39,28 +34,15 @@ class TestEmail(BaseModel):
 
 class EmailTestFailed(BaseModel):
     test_name: str
-    error_type: str
-    error_message: str
-    traceback: str
-
-    @classmethod
-    def create_from_exception(cls, error: Exception, test_name: str):
-        return cls(
-            test_name=test_name,
-            error_type=f"{type(error)}",
-            error_message=f"{error}",
-            traceback=get_traceback_string(error),
-        )
+    error_code: str | None = None
+    user_message: str = "Email test failed"
 
 
 class EmailTestPassed(BaseModel):
     fixtures: dict[str, Any]
     info: dict[str, Any]
 
 
-#
-# API routes
-#
 routes = web.RouteTableDef()
 
 
@@ -109,10 +91,24 @@ async def test_email(request: web.Request):
         )
 
     except Exception as err:  # pylint: disable=broad-except
-        logger.exception(
-            "test_email failed for %s",
-            f"{settings.model_dump_json(indent=1)}",
+
+        _logger.exception(
+            **create_troubleshootting_log_kwargs(
+                user_error_msg="Email test failed",
+                error=err,
+                error_context={
+                    "template_name": body.template_name,
+                    "to": body.to,
+                    "from_": body.from_ or product.support_email,
+                    "settings": settings.model_dump(),
+                },
+                tip="Check SMTP settings and network connectivity",
+            )
         )
         return envelope_json_response(
-            EmailTestFailed.create_from_exception(error=err, test_name="test_email")
+            EmailTestFailed(
+                test_name="test_email",
+                error_code=getattr(err, "error_code", None),
+                user_message="Email test failed. Please check the logs for more details.",
+            )
         )

services/web/server/src/simcore_service_webserver/utils.py

@@ -3,59 +3,18 @@
 """
 
 import asyncio
-import hashlib
 import logging
 import os
-import sys
-import traceback
 import tracemalloc
 from datetime import datetime
-from pathlib import Path
 
 from common_library.error_codes import ErrorCodeStr
 from typing_extensions import (  # https://docs.pydantic.dev/latest/api/standard_library_types/#typeddict
     TypedDict,
 )
 
-_CURRENT_DIR = (
-    Path(sys.argv[0] if __name__ == "__main__" else __file__).resolve().parent
-)
 _logger = logging.getLogger(__name__)
 
-
-def is_osparc_repo_dir(path: Path) -> bool:
-    return all(
-        any(path.glob(expression)) for expression in [".github", "packages", "services"]
-    )
-
-
-def search_osparc_repo_dir(max_iter=8):
-    """Returns path to root repo dir or None
-
-    NOTE: assumes this file within repo, i.e. only happens in edit mode!
-    """
-    root_dir = _CURRENT_DIR
-    if "services/web/server" in str(root_dir):
-        it = 1
-        while not is_osparc_repo_dir(root_dir) and it < max_iter:
-            root_dir = root_dir.parent
-            it += 1
-
-        if is_osparc_repo_dir(root_dir):
-            return root_dir
-    return None
-
-
-def gravatar_hash(email: str) -> str:
-    return hashlib.md5(email.lower().encode("utf-8")).hexdigest()  # nosec
-
-
-# -----------------------------------------------
-#
-# DATE/TIME
-#
-#
-
 DATETIME_FORMAT = "%Y-%m-%dT%H:%M:%S.%fZ"
 
 SECOND: int = 1
@@ -69,8 +28,6 @@ def now() -> datetime:
 
 
 def format_datetime(snapshot: datetime) -> str:
-    # TODO: this fullfills datetime schema!!!
-
     # FIXME: ensure snapshot is ZULU time!
     return "{}Z".format(snapshot.isoformat(timespec="milliseconds"))
 
@@ -163,13 +120,3 @@ def compose_support_error_msg(
     )
 
     return ". ".join(sentences)
-
-
-# -----------------------------------------------
-#
-# FORMATTING
-#
-
-
-def get_traceback_string(exception: BaseException) -> str:
-    return "".join(traceback.format_exception(exception))