cleanup

Author: pcrespov

packages/service-library/src/servicelib/aiohttp/rest_middlewares.py

@@ -59,20 +59,21 @@ def _process_and_raise_unexpected_error(request: web.BaseRequest, err: Exception
             "request.path": f"{request.path}",
         }
 
-        frontend_msg = _FMSG_INTERNAL_ERROR_USER_FRIENDLY_WITH_OEC.format(
+        user_error_msg = _FMSG_INTERNAL_ERROR_USER_FRIENDLY_WITH_OEC.format(
             error_code=error_code
         )
         http_error = create_http_error(
             err,
-            frontend_msg,
+            user_error_msg,
             web.HTTPInternalServerError,
             skip_internal_error_details=_is_prod,
         )
         _logger.exception(
             **create_troubleshotting_log_kwargs(
-                user_error_msg=frontend_msg,
+                user_error_msg,
                 error=err,
                 error_context=error_context,
+                error_code=error_code,
             )
         )
         raise http_error

packages/service-library/tests/test_logging_errors.py

@@ -27,15 +27,16 @@ class MyError(OsparcErrorMixin, RuntimeError):
 
     log_msg = create_troubleshotting_log_message(
         msg,
-        exc,
+        error=exc,
         error_code=error_code,
         error_context=exc.error_context(),
         tip="This is a test error",
     )
 
     log_kwargs = create_troubleshotting_log_kwargs(
         msg,
-        exc,
+        error=exc,
+        error_code=error_code,
         tip="This is a test error",
     )
 

services/api-server/src/simcore_service_api_server/services/log_streaming.py

@@ -141,6 +141,7 @@ async def log_generator(self) -> AsyncIterable[str]:
                 **create_troubleshotting_log_kwargs(
                     user_error_msg,
                     error=exc,
+                    error_code=error_code,
                 )
             )
             yield ErrorGet(errors=[user_error_msg]).json() + _NEW_LINE

services/director-v2/src/simcore_service_director_v2/modules/dynamic_sidecar/scheduler/_core/_observer.py

@@ -140,7 +140,7 @@ async def observing_single_service(
         logger.debug("completed observation cycle of %s", f"{service_name=}")
     except asyncio.CancelledError:  # pylint: disable=try-except-raise
         raise  # pragma: no cover
-    except Exception as e:  # pylint: disable=broad-except
+    except Exception as exc:  # pylint: disable=broad-except
         service_name = scheduler_data.service_name
 
         # With unhandled errors, let's generate and ID and send it to the end-user
@@ -150,19 +150,20 @@ async def observing_single_service(
             " Our team has recorded the issue and is working to resolve it as quickly as possible."
             " Thank you for your patience."
         )
+        error_code = create_error_code(exc)
 
         logger.exception(
             **create_troubleshotting_log_kwargs(
                 user_error_msg,
-                error=e,
+                error=exc,
                 error_context={
                     "service_name": service_name,
                     "user_id": scheduler_data.user_id,
                 },
+                error_code=error_code,
                 tip=f"Observation of {service_name=} unexpectedly failed",
             )
         )
-        error_code = create_error_code(e)
         scheduler_data.dynamic_sidecar.status.update_failing_status(
             # This message must be human-friendly
             user_error_msg,
@@ -172,5 +173,5 @@ async def observing_single_service(
         if scheduler_data_copy != scheduler_data:
             try:
                 await update_scheduler_data_label(scheduler_data)
-            except GenericDockerError as e:
-                logger.warning("Skipped labels update, please check:\n %s", f"{e}")
+            except GenericDockerError as exc:
+                logger.warning("Skipped labels update, please check:\n %s", f"{exc}")

services/dynamic-sidecar/src/simcore_service_dynamic_sidecar/core/utils.py

@@ -114,6 +114,7 @@ async def async_command(
                 user_error_msg,
                 error=err,
                 error_context={"command": command, "proc.returncode": proc.returncode},
+                error_code=error_code,
                 tip="Process with command failed unexpectily",
             )
         )

services/payments/src/simcore_service_payments/services/notifier_email.py

@@ -240,7 +240,7 @@ async def _create_user_email(
         except Exception as exc:  # pylint: disable=broad-exception-caught
             _logger.exception(
                 **create_troubleshotting_log_kwargs(
-                    "Cannot attach invoice to payment",
+                    "Cannot attach invoice to payment. Email sent w/o attached pdf invoice",
                     error=exc,
                     error_context={
                         "user": user,

services/web/server/src/simcore_service_webserver/login/_registration.py

@@ -222,6 +222,7 @@ def _invitations_request_context(invitation_code: str) -> Iterator[URL]:
             **create_troubleshotting_log_kwargs(
                 user_error_msg,
                 error=err,
+                error_code=error_code,
                 tip="Something went wrong with the invitation",
             )
         )
@@ -238,6 +239,7 @@ def _invitations_request_context(invitation_code: str) -> Iterator[URL]:
             **create_troubleshotting_log_kwargs(
                 user_error_msg,
                 error=err,
+                error_code=error_code,
                 tip="Something went wrong communicating the `invitations` service",
             )
         )

services/web/server/src/simcore_service_webserver/login/errors.py

@@ -31,11 +31,15 @@ async def wrapper(request: web.Request) -> web.StreamResponse:
             return await handler(request)
 
         except (SendingVerificationSmsError, SendingVerificationEmailError) as exc:
-
-            front_end_msg = MSG_2FA_UNAVAILABLE_OEC.format(error_code=exc.error_code())
+            error_code = exc.error_code()
+            front_end_msg = MSG_2FA_UNAVAILABLE_OEC.format(error_code=error_code)
             # in these cases I want to log the cause
             _logger.exception(
-                **create_troubleshotting_log_kwargs(front_end_msg, error=exc)
+                **create_troubleshotting_log_kwargs(
+                    front_end_msg,
+                    error=exc,
+                    error_code=error_code,
+                )
             )
             raise web.HTTPServiceUnavailable(
                 reason=front_end_msg,

services/web/server/src/simcore_service_webserver/login/handlers_confirmation.py

@@ -190,6 +190,7 @@ async def validate_confirmation_and_redirect(request: web.Request):
                 **create_troubleshotting_log_kwargs(
                     user_error_msg,
                     error=err,
+                    error_code=error_code,
                     tip="Failed during email_confirmation",
                 )
             )

services/web/server/src/simcore_service_webserver/login/handlers_registration.py

@@ -273,6 +273,7 @@ async def register(request: web.Request):
                 **create_troubleshotting_log_kwargs(
                     user_error_msg,
                     error=err,
+                    error_code=error_code,
                     error_context={
                         "request": request,
                         "registration": registration,
@@ -414,6 +415,7 @@ async def register_phone(request: web.Request):
             **create_troubleshotting_log_kwargs(
                 user_error_msg,
                 error=err,
+                error_code=error_code,
                 error_context={"request": request, "registration": registration},
                 tip="Phone registration failed",
             )