merge master into introduce-links-for-webserver-async-jobs

Author: bisgaard-itis

api/specs/web-server/_auth.py

@@ -47,8 +47,7 @@
     operation_id="request_product_account",
     status_code=status.HTTP_204_NO_CONTENT,
 )
-async def request_product_account(_body: AccountRequestInfo):
-    ...
+async def request_product_account(_body: AccountRequestInfo): ...
 
 
 @router.post(
@@ -75,8 +74,7 @@ async def register(_body: RegisterBody):
     status_code=status.HTTP_200_OK,
     responses={status.HTTP_409_CONFLICT: {"model": EnvelopedError}},
 )
-async def unregister_account(_body: UnregisterCheck):
-    ...
+async def unregister_account(_body: UnregisterCheck): ...
 
 
 @router.post(
@@ -171,26 +169,24 @@ async def check_auth():
 @router.post(
     "/auth/reset-password",
     response_model=Envelope[Log],
-    operation_id="auth_reset_password",
+    operation_id="initiate_reset_password",
     responses={status.HTTP_503_SERVICE_UNAVAILABLE: {"model": EnvelopedError}},
 )
-async def reset_password(_body: ResetPasswordBody):
-    """a non logged-in user requests a password reset"""
+async def initiate_reset_password(_body: ResetPasswordBody): ...
 
 
 @router.post(
     "/auth/reset-password/{code}",
     response_model=Envelope[Log],
-    operation_id="auth_reset_password_allowed",
+    operation_id="complete_reset_password",
     responses={
         status.HTTP_401_UNAUTHORIZED: {
             "model": EnvelopedError,
-            "description": "unauthorized reset due to invalid token code",
+            "description": "Invalid token code",
         }
     },
 )
-async def reset_password_allowed(code: str, _body: ResetPasswordConfirmation):
-    """changes password using a token code without being logged in"""
+async def complete_reset_password(code: str, _body: ResetPasswordConfirmation): ...
 
 
 @router.post(
@@ -268,5 +264,4 @@ async def email_confirmation(code: str):
     status_code=status.HTTP_200_OK,
     responses={status.HTTP_200_OK: {"content": {"image/png": {}}}},
 )
-async def request_captcha():
-    ...
+async def request_captcha(): ...

packages/common-library/src/common_library/error_codes.py

@@ -1,4 +1,4 @@
-""" osparc ERROR CODES (OEC)
+"""osparc ERROR CODES (OEC)
   Unique identifier of an exception instance
   Intended to report a user about unexpected errors.
     Unexpected exceptions can be traced by matching the
@@ -7,25 +7,79 @@
 SEE test_error_codes for some use cases
 """
 
+import hashlib
 import re
-from typing import TYPE_CHECKING, Annotated
+import traceback
+from datetime import UTC, datetime
+from typing import Annotated, Final, TypeAlias
 
 from pydantic import StringConstraints, TypeAdapter
 
-_LABEL = "OEC:{}"
-_PATTERN = r"OEC:\d+"
+_LABEL = "OEC:{fingerprint}-{timestamp}"
 
-if TYPE_CHECKING:
-    ErrorCodeStr = str
-else:
-    ErrorCodeStr = Annotated[
-        str, StringConstraints(strip_whitespace=True, pattern=_PATTERN)
-    ]
+_LEN = 12  # chars (~48 bits)
+_NAMED_PATTERN = re.compile(
+    r"OEC:(?P<fingerprint>[a-fA-F0-9]{12})-(?P<timestamp>\d{13,14})"
+    # NOTE: timestamp limits: 13 digits (from 2001), 14 digits (good for ~500+ years)
+)
+_PATTERN = re.compile(r"OEC:[a-fA-F0-9]{12}-\d{13,14}")
+
+
+ErrorCodeStr: TypeAlias = Annotated[
+    str, StringConstraints(strip_whitespace=True, pattern=_NAMED_PATTERN)
+]
+
+
+def _create_fingerprint(exc: BaseException) -> str:
+    """
+    Unique error fingerprint of the **traceback** for deduplication purposes
+    """
+    tb = traceback.extract_tb(exc.__traceback__)
+    frame_sigs = [f"{frame.name}:{frame.lineno}" for frame in tb]
+    fingerprint = f"{type(exc).__name__}|" + "|".join(frame_sigs)
+    # E.g. ZeroDivisionError|foo:23|main:10
+    return hashlib.sha256(fingerprint.encode()).hexdigest()[:_LEN]
+
+
+_SECS_TO_MILISECS: Final[int] = 1000  # ms
+
+
+def _create_timestamp() -> int:
+    """Timestamp as milliseconds since epoch
+    NOTE: this reduces the precission to milliseconds but it is good enough for our purpose
+    """
+    ts = datetime.now(UTC).timestamp() * _SECS_TO_MILISECS
+    return int(ts)
 
 
 def create_error_code(exception: BaseException) -> ErrorCodeStr:
-    return TypeAdapter(ErrorCodeStr).validate_python(_LABEL.format(id(exception)))
+    """
+    Generates a unique error code for the given exception.
+
+    The error code follows the format: `OEC:{traceback}-{timestamp}`.
+    This code is intended to be shared with the front-end as a `SupportID`
+    for debugging and support purposes.
+    """
+    return TypeAdapter(ErrorCodeStr).validate_python(
+        _LABEL.format(
+            fingerprint=_create_fingerprint(exception),
+            timestamp=_create_timestamp(),
+        )
+    )
+
+
+def parse_error_codes(obj) -> list[ErrorCodeStr]:
+    return TypeAdapter(list[ErrorCodeStr]).validate_python(_PATTERN.findall(f"{obj}"))
 
 
-def parse_error_code(obj) -> set[ErrorCodeStr]:
-    return set(re.findall(_PATTERN, f"{obj}"))
+def parse_error_code_parts(oec: ErrorCodeStr) -> tuple[str, datetime]:
+    """Returns traceback-fingerprint and timestamp from `OEC:{traceback}-{timestamp}`"""
+    match = _NAMED_PATTERN.match(oec)
+    if not match:
+        msg = f"Invalid error code format: {oec}"
+        raise ValueError(msg)
+    fingerprint = match.group("fingerprint")
+    timestamp = datetime.fromtimestamp(
+        float(match.group("timestamp")) / _SECS_TO_MILISECS, tz=UTC
+    )
+    return fingerprint, timestamp

packages/common-library/tests/test_error_codes.py

@@ -4,17 +4,68 @@
 # pylint: disable=unused-variable
 
 import logging
+import time
 
 import pytest
-from common_library.error_codes import create_error_code, parse_error_code
+from common_library.error_codes import (
+    create_error_code,
+    parse_error_code_parts,
+    parse_error_codes,
+)
 
 logger = logging.getLogger(__name__)
 
 
-def test_error_code_use_case(caplog: pytest.LogCaptureFixture):
-    """use case for error-codes"""
+def _level_three(v):
+    msg = f"An error occurred in level three with {v}"
+    raise RuntimeError(msg)
+
+
+def _level_two(v):
+    _level_three(v)
+
+
+def _level_one(v=None):
+    _level_two(v)
+
+
+def test_exception_fingerprint_consistency():
+    error_codes = []
+
+    for v in range(2):
+        # emulates different runs of the same function (e.g. different sessions)
+        try:
+            _level_one(v)  # same even if different value!
+        except Exception as err:
+            time.sleep(1)
+            error_code = create_error_code(err)
+            error_codes.append(error_code)
+
+    fingerprints, timestamps = list(
+        zip(
+            *[parse_error_code_parts(error_code) for error_code in error_codes],
+            strict=True,
+        )
+    )
+
+    assert fingerprints[0] == fingerprints[1]
+    assert timestamps[0] < timestamps[1]
+
+    try:
+        # Same function but different location
+        _level_one(0)
+    except Exception as e2:
+        time.sleep(1)
+        error_code_2 = create_error_code(e2)
+        fingerprint_2, timestamp_2 = parse_error_code_parts(error_code_2)
+
+        assert fingerprints[0] != fingerprint_2
+        assert timestamps[1] < timestamp_2
+
+
+def test_create_log_and_parse_error_code(caplog: pytest.LogCaptureFixture):
     with pytest.raises(RuntimeError) as exc_info:
-        raise RuntimeError("Something unexpected went wrong")
+        _level_one()
 
     # 1. Unexpected ERROR
     err = exc_info.value
@@ -33,11 +84,11 @@ def test_error_code_use_case(caplog: pytest.LogCaptureFixture):
     logger.exception("Fake Unexpected error", extra={"error_code": error_code})
 
     # logs something like E.g. 2022-07-06 14:31:13,432 OEC:140350117529856 : Fake Unexpected error
-    assert parse_error_code(
+    assert parse_error_codes(
         f"2022-07-06 14:31:13,432 {error_code} : Fake Unexpected error"
-    ) == {
+    ) == [
         error_code,
-    }
+    ]
 
     assert caplog.records[0].error_code == error_code
     assert caplog.records[0]
@@ -49,6 +100,6 @@ def test_error_code_use_case(caplog: pytest.LogCaptureFixture):
         f"This is a user-friendly message to inform about an error. [{error_code}]"
     )
 
-    assert parse_error_code(user_message) == {
+    assert parse_error_codes(user_message) == [
         error_code,
-    }
+    ]

packages/models-library/src/models_library/rest_error.py

@@ -1,6 +1,7 @@
 from dataclasses import dataclass
 from typing import Annotated
 
+from common_library.basic_types import DEFAULT_FACTORY
 from models_library.generics import Envelope
 from pydantic import BaseModel, ConfigDict, Field
 
@@ -81,11 +82,11 @@ class ErrorGet(BaseModel):
     errors: Annotated[
         list[ErrorItemType],
         Field(deprecated=True, default_factory=list, json_schema_extra={"default": []}),
-    ]
+    ] = DEFAULT_FACTORY
     logs: Annotated[
         list[LogMessageType],
         Field(deprecated=True, default_factory=list, json_schema_extra={"default": []}),
-    ]
+    ] = DEFAULT_FACTORY
 
     model_config = ConfigDict(
         populate_by_name=True,

packages/service-library/tests/aiohttp/test_rest_middlewares.py

@@ -13,7 +13,7 @@
 import pytest
 from aiohttp import web
 from aiohttp.test_utils import TestClient
-from common_library.error_codes import parse_error_code
+from common_library.error_codes import parse_error_codes
 from common_library.json_serialization import json_dumps
 from servicelib.aiohttp import status
 from servicelib.aiohttp.rest_middlewares import (
@@ -30,8 +30,7 @@ class Data:
     y: str = "foo"
 
 
-class SomeUnexpectedError(Exception):
-    ...
+class SomeUnexpectedError(Exception): ...
 
 
 class Handlers:
@@ -237,7 +236,7 @@ async def test_raised_unhandled_exception(
 
         # user friendly message with OEC reference
         assert "OEC" in error["message"]
-        parsed_oec = parse_error_code(error["message"]).pop()
+        parsed_oec = parse_error_codes(error["message"]).pop()
         assert (
             _FMSG_INTERNAL_ERROR_USER_FRIENDLY_WITH_OEC.format(error_code=parsed_oec)
             == error["message"]

services/dynamic-sidecar/src/simcore_service_dynamic_sidecar/modules/long_running_tasks.py

@@ -315,8 +315,9 @@ async def _send_resource_tracking_stop(platform_status: SimcorePlatformStatus):
         # NOTE: https://github.com/ITISFoundation/osparc-simcore/issues/4952
         await _send_resource_tracking_stop(SimcorePlatformStatus.OK)
         raise
-
-    await ensure_read_permissions_on_user_service_data(mounted_volumes)
+    finally:
+        with log_context(_logger, logging.INFO, "ensure read permissions"):
+            await ensure_read_permissions_on_user_service_data(mounted_volumes)
 
     await _send_resource_tracking_stop(SimcorePlatformStatus.OK)
 

services/static-webserver/client/source/class/osparc/data/Resources.js

@@ -1490,7 +1490,10 @@ qx.Class.define("osparc.data.Resources", {
           }
 
           if ([404, 503].includes(status)) {
-            message += "<br>Please try again later and/or contact support";
+            // NOTE: a temporary solution to avoid duplicate information
+            if (!message.includes("contact") && !message.includes("try")) {
+              message += "<br>Please try again later and/or contact support";
+            }
           }
           const err = Error(message ? message : `Error while trying to fetch ${endpoint} ${resource}`);
           if (status) {

services/web/server/VERSION

@@ -1 +1 @@
-0.61.0
+0.61.1

services/web/server/setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.61.0
+current_version = 0.61.1
 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.61.0
+  version: 0.61.1
 servers:
 - url: ''
   description: webserver
@@ -253,9 +253,8 @@ paths:
     post:
       tags:
       - auth
-      summary: Reset Password
-      description: a non logged-in user requests a password reset
-      operationId: auth_reset_password
+      summary: Initiate Reset Password
+      operationId: initiate_reset_password
       requestBody:
         content:
           application/json:
@@ -279,9 +278,8 @@ paths:
     post:
       tags:
       - auth
-      summary: Reset Password Allowed
-      description: changes password using a token code without being logged in
-      operationId: auth_reset_password_allowed
+      summary: Complete Reset Password
+      operationId: complete_reset_password
       parameters:
       - name: code
         in: path
@@ -303,7 +301,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/Envelope_Log_'
         '401':
-          description: unauthorized reset due to invalid token code
+          description: Invalid token code
           content:
             application/json:
               schema:
@@ -14153,6 +14151,7 @@ components:
       properties:
         email:
           type: string
+          format: email
           title: Email
       additionalProperties: false
       type: object
@@ -15290,7 +15289,6 @@ components:
           - change_email_email.jinja2
           - new_2fa_code.jinja2
           - registration_email.jinja2
-          - reset_password_email_failed.jinja2
           - reset_password_email.jinja2
           - service_submission.jinja2
           title: Template Name