Merge remote-tracking branch 'upstream/master' into pr-osparc-s3-zip-stream-worker-code

Author: Andrei Neagu

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

@@ -1,6 +1,6 @@
-""" Helpers for json serialization
-    - built-in json-like API
-    - implemented using orjson, which  performs better. SEE https://github.com/ijl/orjson?tab=readme-ov-file#performance
+"""Helpers for json serialization
+- built-in json-like API
+- implemented using orjson, which  performs better. SEE https://github.com/ijl/orjson?tab=readme-ov-file#performance
 """
 
 import datetime
@@ -118,6 +118,28 @@ def pydantic_encoder(obj: Any) -> Any:
     raise TypeError(msg)
 
 
+def representation_encoder(obj: Any):
+    """
+    A fallback encoder that uses `pydantic_encoder` to serialize objects.
+    If serialization fails, it falls back to using `str(obj)`.
+
+    This is practical for representation purposes, such as logging or debugging.
+
+    Example:
+        >>> from common_library.json_serialization import json_dumps, representation_encoder
+        >>> class CustomObject:
+        ...     def __str__(self):
+        ...         return "CustomObjectRepresentation"
+        >>> obj = CustomObject()
+        >>> json_dumps(obj, default=representation_encoder)
+        '"CustomObjectRepresentation"'
+    """
+    try:
+        return pydantic_encoder(obj)
+    except TypeError:
+        return str(obj)
+
+
 def json_dumps(
     obj: Any,
     *,

packages/common-library/tests/test_json_serialization.py

@@ -13,6 +13,7 @@
     SeparatorTuple,
     json_dumps,
     json_loads,
+    representation_encoder,
 )
 from faker import Faker
 from pydantic import AnyHttpUrl, AnyUrl, BaseModel, Field, HttpUrl, TypeAdapter
@@ -110,3 +111,25 @@ class M(BaseModel):
         http_url=faker.url(),
     )
     json_dumps(obj)
+
+
+def test_json_dumps_with_representation_encoder():
+    class CustomObject:
+        def __str__(self):
+            return "CustomObjectRepresentation"
+
+    class SomeModel(BaseModel):
+        x: int
+
+    obj = {
+        "custom": CustomObject(),
+        "some": SomeModel(x=42),
+    }
+
+    # Using representation_encoder as the default encoder
+    result = json_dumps(obj, default=representation_encoder, indent=1)
+
+    assert (
+        result
+        == '{\n  "custom": "CustomObjectRepresentation",\n  "some": {\n    "x": 42\n  }\n}'
+    )

packages/notifications-library/src/notifications_library/_email_render.py

@@ -11,7 +11,7 @@
 
 
 class EmailPartsTuple(NamedTuple):
-    suject: str
+    subject: str
     text_content: str
     html_content: str | None
 
@@ -58,5 +58,5 @@ def render_email_parts(
         html_content = None
 
     return EmailPartsTuple(
-        suject=subject, text_content=text_content, html_content=html_content
+        subject=subject, text_content=text_content, html_content=html_content
     )

packages/notifications-library/src/notifications_library/_models.py

@@ -16,15 +16,23 @@ class JinjaTemplateDbGet:
 
 @dataclass(frozen=True)
 class UserData:
+    user_name: str
     first_name: str
     last_name: str
     email: str
 
 
+@dataclass(frozen=True)
+class SharerData:
+    user_name: str
+    message: str
+
+
 @dataclass(frozen=True)
 class ProductUIData:
     logo_url: str
     strong_color: str
+    project_alias: str
 
 
 @dataclass(frozen=True)

packages/notifications-library/src/notifications_library/_repository.py

@@ -25,6 +25,7 @@ class UsersRepo(_BaseRepo):
     async def get_user_data(self, user_id: UserID) -> UserData:
         query = sa.select(
             # NOTE: careful! privacy applies here!
+            users.c.name,
             users.c.first_name,
             users.c.last_name,
             users.c.email,
@@ -38,7 +39,10 @@ async def get_user_data(self, user_id: UserID) -> UserData:
             raise ValueError(msg)
 
         return UserData(
-            first_name=row.first_name, last_name=row.last_name, email=row.email
+            user_name=row.name,
+            first_name=row.first_name,
+            last_name=row.last_name,
+            email=row.email,
         )
 
 

packages/notifications-library/src/notifications_library/templates/on_change_email.email.content.html

@@ -1,7 +1,7 @@
 {% extends 'base.html' %}
 {% block title %} {% include 'on_change_email.email.subject.txt' %} {% endblock %}
 {% block content %}
-<p>Dear {{ user.first_name }},</p>
+<p>Dear {{ user.first_name or user.user_name }},</p>
 <p>
   You have requested to change the email address linked to your {{ product.display_name }} account.
   Please follow the on-screen information in the link below:

packages/notifications-library/src/notifications_library/templates/on_change_email.email.content.txt

@@ -1,4 +1,4 @@
-Dear {{ user.first_name }},
+Dear {{ user.first_name or user.user_name }},
 
 You have requested to change the email address linked to your {{ product.display_name }} account. Please follow the on-screen information in the link below:
 

packages/notifications-library/src/notifications_library/templates/on_new_code.email.content.html

@@ -1,7 +1,7 @@
 {% extends 'base.html' %}
 {% block title %} {% include 'on_new_code.email.subject.txt' %} {% endblock %}
 {% block content %}
-<p>Dear {{ user.first_name }},</p>
+<p>Dear {{ user.first_name or user.user_name }},</p>
 <p>Please find below the Two-factor Authentication sign-in code for your {{ host }} account.</p>
 
 <p>

packages/notifications-library/src/notifications_library/templates/on_new_code.email.content.txt

@@ -1,4 +1,4 @@
-Dear {{ user.first_name }},
+Dear {{ user.first_name or user.user_name }},
 
 Please find below the Two-factor Authentication sign-in code for your {{ host }} account.
 

packages/notifications-library/src/notifications_library/templates/on_new_invitation.email.content.html

@@ -1,7 +1,7 @@
 {% extends 'base.html' %}
 {% block title %} {% include 'on_new_invitation.email.subject.txt' %} {% endblock %}
 {% block content %}
-<p>Dear {{ user.first_name }},</p>
+<p>Dear {{ user.first_name or user.user_name }},</p>
 <p>Thank you for your interest in {{ product.display_name }}. We are pleased to provide you with a one-time invitation link to register on the platform.</p>
 <p>
   <!-- Many email clients strip or ignore certain CSS properties, including them inline -->