🔨 Maintenance: Exclude api folder from Codecov, clean up unused utils, and improve web-server test coverage (#8050)

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/**
@@ -133,6 +130,7 @@ comment:
 
 
 ignore:
+  - "api/tests"
   - "test_*.py"
   - "**/generated_models/*.py"
   - "**/generated_code/*.py"

services/web/server/VERSION

@@ -1 +1 @@
-0.70.0
+0.71.0

services/web/server/setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.70.0
+current_version = 0.71.0
 commit = True
 message = services/webserver api version: {current_version} → {new_version}
 tag = False

services/web/server/src/simcore_service_webserver/api/v0/openapi.yaml

@@ -2,7 +2,7 @@ openapi: 3.1.0
 info:
   title: simcore-service-webserver
   description: Main service with an interface (http-API & websockets) to the web front-end
-  version: 0.70.0
+  version: 0.71.0
 servers:
 - url: ''
   description: webserver
@@ -9951,21 +9951,18 @@ components:
         test_name:
           type: string
           title: Test Name
-        error_type:
-          type: string
-          title: Error Type
-        error_message:
-          type: string
-          title: Error Message
-        traceback:
+        error_code:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: Error Code
+        user_message:
           type: string
-          title: Traceback
+          title: User Message
+          default: Email test failed
       type: object
       required:
       - test_name
-      - error_type
-      - error_message
-      - traceback
       title: EmailTestFailed
     EmailTestPassed:
       properties:

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

@@ -54,7 +54,10 @@ def _setup_app_from_settings(
 
 
 async def app_factory() -> web.Application:
-    """Created to launch app from gunicorn (see docker/boot.sh)"""
+    """WARNING: this is called in the entrypoint of the service. DO NOT CHAGE THE NAME!
+
+    Created to launch app from gunicorn (see docker/boot.sh)
+    """
     from .application import create_application_auth
     from .log import setup_logging
 

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"))
 
@@ -108,7 +65,7 @@ class TaskInfoDict(TypedDict):
 
 def get_task_info(task: asyncio.Task) -> TaskInfoDict:
     def _format_frame(f):
-        return StackInfoDict(f_code=f.f_code, f_lineno=f.f_lineno)
+        return StackInfoDict(f_code=str(f.f_code), f_lineno=str(f.f_lineno))
 
     info = TaskInfoDict(
         txt=str(task),
@@ -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))

services/web/server/tests/unit/isolated/test_utils.py

@@ -1,10 +1,13 @@
+import asyncio
+import contextlib
 import time
 import urllib.parse
 from datetime import datetime
 
 from simcore_service_webserver.utils import (
     DATETIME_FORMAT,
     compose_support_error_msg,
+    get_task_info,
     now_str,
     to_datetime,
 )
@@ -70,3 +73,74 @@ def test_compose_support_error_msg():
         msg == "First sentence for Mr.X. Second sentence."
         " For more information please forward this message to [email protected] (supportID=OEC:139641204989600)"
     )
+
+
+async def test_get_task_info():
+    """Test get_task_info function with asyncio tasks"""
+
+    async def dummy_task():
+        await asyncio.sleep(0.1)
+        return "task_result"
+
+    # Create a named task
+    task = asyncio.create_task(dummy_task(), name="test_task")
+
+    task_info = get_task_info(task)
+
+    # Check that task_info is a dictionary
+    assert isinstance(task_info, dict)
+
+    # Check that it contains expected keys from TaskInfoDict
+    expected_keys = {"txt", "type", "done", "cancelled", "stack", "exception"}
+    assert all(key in task_info for key in expected_keys)
+
+    # Check basic types
+    assert isinstance(task_info["txt"], str)
+    assert isinstance(task_info["type"], str)
+    assert isinstance(task_info["done"], bool)
+    assert isinstance(task_info["cancelled"], bool)
+    assert isinstance(task_info["stack"], list)
+
+    # Check that task name is in the txt representation
+    assert "test_task" in task_info["txt"]
+
+    # Check that stack contains frame info when task is running
+    if not task_info["done"]:
+        assert len(task_info["stack"]) > 0
+        # Check stack frame structure
+        for frame_info in task_info["stack"]:
+            assert "f_code" in frame_info
+            assert "f_lineno" in frame_info
+            assert isinstance(frame_info["f_code"], str)
+            assert isinstance(frame_info["f_lineno"], str)
+
+    # Clean up
+    task.cancel()
+    with contextlib.suppress(asyncio.CancelledError):
+        await task
+
+
+async def test_get_task_info_unnamed_task():
+    """Test get_task_info function with unnamed tasks"""
+
+    async def dummy_task():
+        await asyncio.sleep(0.1)
+
+    # Create an unnamed task
+    task = asyncio.create_task(dummy_task())
+
+    task_info = get_task_info(task)
+
+    # Check basic structure
+    assert isinstance(task_info, dict)
+    expected_keys = {"txt", "type", "done", "cancelled", "stack", "exception"}
+    assert all(key in task_info for key in expected_keys)
+
+    # Check that txt contains task representation
+    assert isinstance(task_info["txt"], str)
+    assert "Task" in task_info["txt"]
+
+    # Clean up
+    task.cancel()
+    with contextlib.suppress(asyncio.CancelledError):
+        await task