Merge remote-tracking branch 'upstream/master' into pr-osparc-migrate-dy-scheduler-part-1

Author: Andrei Neagu

.github/prompts/update-user-messages.prompt.md

@@ -1,6 +1,7 @@
 ---
 mode: 'edit'
 description: 'Update user messages'
+model: Claude Sonnet 3.5
 ---
 
 This prompt guide is for updating user-facing messages in ${file} or ${selection}
@@ -43,7 +44,17 @@ When modifying user messages, follow **as close as possible** these rules:
    user_message("Unable to load project.", _version=1)
    ```
 
-3. **Message Style**: Follow **strictly** the guidelines in `${workspaceFolder}/docs/user-messages-guidelines.md`
+3. **Message Style**: Follow **STRICTLY ALL 10 GUIDELINES** in `${workspaceFolder}/docs/user-messages-guidelines.md`:
+   - Be Clear and Concise
+   - Provide Specific and Actionable Information
+   - Avoid Technical Jargon
+   - Use a Polite and Non-Blaming Tone
+   - Avoid Negative Words and Phrases
+   - Place Messages Appropriately
+   - Use Inline Validation When Possible
+   - Avoid Using All-Caps and Excessive Punctuation
+   - **Use Humor Sparingly** - Avoid casual phrases like "Oops!", "Whoops!", or overly informal language
+   - Offer Alternative Solutions or Support
 
 4. **Preserve Context**: Ensure the modified message conveys the same meaning and context as the original.
 
@@ -56,8 +67,10 @@ When modifying user messages, follow **as close as possible** these rules:
    # After
    user_message("Your session has expired. Please log in again.", _version=3)
    ```
+
 6. **Replace 'Study' by 'Project'**: If the message contains the word 'Study', replace it with 'Project' to align with our terminology.
 
+7. **Professional Tone**: Maintain a professional, helpful tone. Avoid humor, casual expressions, or overly informal language that might not be appropriate for all users or situations.
 
 ## Examples
 
@@ -91,4 +104,14 @@ return HttpErrorInfo(status.HTTP_404_NOT_FOUND, user_message("User not found.",
 return HttpErrorInfo(status.HTTP_404_NOT_FOUND, user_message("The requested user could not be found.", _version=2))
 ```
 
-Remember: The goal is to improve clarity and helpfulness for end-users while maintaining accurate versioning for tracking changes.
+### Example 4: Removing Humor (Guideline 9)
+
+```python
+# Before
+user_message("Oops! Something went wrong, but we've noted it down and we'll sort it out ASAP. Thanks for your patience!")
+
+# After
+user_message("Something went wrong on our end. We've been notified and will resolve this issue as soon as possible. Thank you for your patience.", _version=1)
+```
+
+Remember: The goal is to improve clarity and helpfulness for end-users while maintaining accurate versioning for tracking changes. **Always check that your updated messages comply with ALL 10 guidelines, especially avoiding humor and maintaining a professional tone.**

packages/celery-library/tests/unit/test_tasks.py

@@ -11,8 +11,8 @@
 from random import randint
 
 import pytest
-from celery import Celery, Task
-from celery.contrib.abortable import AbortableTask
+from celery import Celery, Task  # pylint: disable=no-name-in-module
+from celery.contrib.abortable import AbortableTask  # pylint: disable=no-name-in-module
 from celery_library.errors import TransferrableCeleryError
 from celery_library.task import register_task
 from celery_library.task_manager import CeleryTaskManager

packages/models-library/src/models_library/api_schemas_long_running_tasks/base.py

@@ -2,7 +2,8 @@
 from collections.abc import Awaitable, Callable
 from typing import Annotated, TypeAlias
 
-from pydantic import BaseModel, Field, field_validator, validate_call
+from pydantic import BaseModel, ConfigDict, Field, field_validator, validate_call
+from pydantic.config import JsonDict
 
 _logger = logging.getLogger(__name__)
 
@@ -23,6 +24,22 @@ class TaskProgress(BaseModel):
     message: ProgressMessage = ""
     percent: ProgressPercent = 0.0
 
+    @staticmethod
+    def _update_json_schema_extra(schema: JsonDict) -> None:
+        schema.update(
+            {
+                "examples": [
+                    {
+                        "task_id": "3ac48b54-a48d-4c5e-a6ac-dcaddb9eaa59",
+                        "message": "Halfway done",
+                        "percent": 0.5,
+                    }
+                ]
+            }
+        )
+
+    model_config = ConfigDict(json_schema_extra=_update_json_schema_extra)
+
     # used to propagate progress updates internally
     _update_callback: Callable[["TaskProgress"], Awaitable[None]] | None = None
 

packages/models-library/src/models_library/api_schemas_webserver/functions.py

@@ -1,7 +1,7 @@
 import datetime
 from typing import Annotated, TypeAlias
 
-from pydantic import Field, HttpUrl
+from pydantic import ConfigDict, Field, HttpUrl
 
 from ..functions import (
     Function,
@@ -141,6 +141,45 @@ class RegisteredProjectFunctionGet(RegisteredProjectFunction, OutputSchema):
     modified_at: Annotated[datetime.datetime, Field(alias="lastChangeDate")]
     access_rights: dict[GroupID, FunctionGroupAccessRightsGet]
     thumbnail: HttpUrl | None = None
+    model_config = ConfigDict(
+        populate_by_name=True,
+        json_schema_extra={
+            "examples": [
+                {
+                    "function_class": "PROJECT",
+                    "title": "Example Project Function",
+                    "description": "This is an example project function.",
+                    "input_schema": {
+                        "schema_content": {
+                            "type": "object",
+                            "properties": {"input1": {"type": "integer"}},
+                        },
+                        "schema_class": "application/schema+json",
+                    },
+                    "output_schema": {
+                        "schema_content": {
+                            "type": "object",
+                            "properties": {"output1": {"type": "string"}},
+                        },
+                        "schema_class": "application/schema+json",
+                    },
+                    "default_inputs": None,
+                    "project_id": "11111111-1111-1111-1111-111111111111",
+                    "uid": "22222222-2222-2222-2222-222222222222",
+                    "created_at": "2024-01-01T12:00:00",
+                    "modified_at": "2024-01-02T12:00:00",
+                    "access_rights": {
+                        "5": {
+                            "read": True,
+                            "write": False,
+                            "execute": True,
+                        }
+                    },
+                    "thumbnail": None,
+                },
+            ]
+        },
+    )
 
 
 class SolverFunctionToRegister(SolverFunction, InputSchema): ...

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

@@ -114,7 +114,37 @@ class ProjectFunction(FunctionBase):
 
 
 class RegisteredProjectFunction(ProjectFunction, RegisteredFunctionBase):
-    pass
+    model_config = ConfigDict(
+        populate_by_name=True,
+        json_schema_extra={
+            "examples": [
+                {
+                    "function_class": "PROJECT",
+                    "title": "Example Project Function",
+                    "description": "This is an example project function.",
+                    "input_schema": {
+                        "schema_content": {
+                            "type": "object",
+                            "properties": {"input1": {"type": "integer"}},
+                        },
+                        "schema_class": "application/schema+json",
+                    },
+                    "output_schema": {
+                        "schema_content": {
+                            "type": "object",
+                            "properties": {"output1": {"type": "string"}},
+                        },
+                        "schema_class": "application/schema+json",
+                    },
+                    "default_inputs": None,
+                    "project_id": "11111111-1111-1111-1111-111111111111",
+                    "uid": "22222222-2222-2222-2222-222222222222",
+                    "created_at": "2024-01-01T12:00:00",
+                    "modified_at": "2024-01-02T12:00:00",
+                },
+            ]
+        },
+    )
 
 
 SolverJobID: TypeAlias = UUID
@@ -160,21 +190,12 @@ class FunctionJobBase(BaseModel):
     function_class: FunctionClass
 
 
-class RegisteredFunctionJobBase(FunctionJobBase):
-    uid: FunctionJobID
-    created_at: datetime.datetime
-
-
 class ProjectFunctionJob(FunctionJobBase):
     function_class: Literal[FunctionClass.PROJECT] = FunctionClass.PROJECT
     project_job_id: ProjectID | None
     job_creation_task_id: TaskID | None
 
 
-class RegisteredProjectFunctionJob(ProjectFunctionJob, RegisteredFunctionJobBase):
-    pass
-
-
 class RegisteredProjectFunctionJobPatch(BaseModel):
     function_class: Literal[FunctionClass.PROJECT] = FunctionClass.PROJECT
     title: str | None
@@ -191,10 +212,6 @@ class SolverFunctionJob(FunctionJobBase):
     job_creation_task_id: TaskID | None
 
 
-class RegisteredSolverFunctionJob(SolverFunctionJob, RegisteredFunctionJobBase):
-    pass
-
-
 class RegisteredSolverFunctionJobPatch(BaseModel):
     function_class: Literal[FunctionClass.SOLVER] = FunctionClass.SOLVER
     title: str | None
@@ -209,10 +226,6 @@ class PythonCodeFunctionJob(FunctionJobBase):
     function_class: Literal[FunctionClass.PYTHON_CODE] = FunctionClass.PYTHON_CODE
 
 
-class RegisteredPythonCodeFunctionJob(PythonCodeFunctionJob, RegisteredFunctionJobBase):
-    pass
-
-
 class RegisteredPythonCodeFunctionJobPatch(BaseModel):
     function_class: Literal[FunctionClass.PYTHON_CODE] = FunctionClass.PYTHON_CODE
     title: str | None
@@ -226,6 +239,24 @@ class RegisteredPythonCodeFunctionJobPatch(BaseModel):
     Field(discriminator="function_class"),
 ]
 
+
+class RegisteredFunctionJobBase(FunctionJobBase):
+    uid: FunctionJobID
+    created_at: datetime.datetime
+
+
+class RegisteredProjectFunctionJob(ProjectFunctionJob, RegisteredFunctionJobBase):
+    pass
+
+
+class RegisteredSolverFunctionJob(SolverFunctionJob, RegisteredFunctionJobBase):
+    pass
+
+
+class RegisteredPythonCodeFunctionJob(PythonCodeFunctionJob, RegisteredFunctionJobBase):
+    pass
+
+
 RegisteredFunctionJob: TypeAlias = Annotated[
     RegisteredProjectFunctionJob
     | RegisteredPythonCodeFunctionJob
@@ -245,6 +276,36 @@ class FunctionJobStatus(BaseModel):
     status: str
 
 
+class RegisteredFunctionJobWithStatusBase(RegisteredFunctionJobBase, FunctionJobBase):
+    status: FunctionJobStatus
+
+
+class RegisteredProjectFunctionJobWithStatus(
+    RegisteredProjectFunctionJob, RegisteredFunctionJobWithStatusBase
+):
+    pass
+
+
+class RegisteredSolverFunctionJobWithStatus(
+    RegisteredSolverFunctionJob, RegisteredFunctionJobWithStatusBase
+):
+    pass
+
+
+class RegisteredPythonCodeFunctionJobWithStatus(
+    RegisteredPythonCodeFunctionJob, RegisteredFunctionJobWithStatusBase
+):
+    pass
+
+
+RegisteredFunctionJobWithStatus: TypeAlias = Annotated[
+    RegisteredProjectFunctionJobWithStatus
+    | RegisteredPythonCodeFunctionJobWithStatus
+    | RegisteredSolverFunctionJobWithStatus,
+    Field(discriminator="function_class"),
+]
+
+
 class FunctionJobCollection(BaseModel):
     """Model for a collection of function jobs"""
 
@@ -279,6 +340,12 @@ class RegisteredFunctionJobDB(FunctionJobDB):
     created: datetime.datetime
 
 
+class RegisteredFunctionJobWithStatusDB(FunctionJobDB):
+    uuid: FunctionJobID
+    created: datetime.datetime
+    status: str
+
+
 class FunctionDB(BaseModel):
     function_class: FunctionClass
     title: str = ""

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

@@ -1,6 +1,7 @@
 from typing import Literal, TypeAlias
 
 from pydantic import BaseModel, ConfigDict
+from pydantic.config import JsonDict
 
 # NOTE: keep a list of possible unit, and please use correct official unit names
 ProgressUnit: TypeAlias = Literal["Byte"]
@@ -13,9 +14,10 @@ class ProgressStructuredMessage(BaseModel):
     unit: str | None = None
     sub: "ProgressStructuredMessage | None" = None
 
-    model_config = ConfigDict(
-        json_schema_extra={
-            "examples": [
+    @staticmethod
+    def _update_json_schema_extra(schema: JsonDict) -> None:
+        schema.update(
+            examples=[
                 {
                     "description": "some description",
                     "current": 12.2,
@@ -39,8 +41,9 @@ class ProgressStructuredMessage(BaseModel):
                     },
                 },
             ]
-        }
-    )
+        )
+
+    model_config = ConfigDict(json_schema_extra=_update_json_schema_extra)
 
 
 UNITLESS = None
@@ -96,7 +99,17 @@ def composed_message(self) -> str:
                 {
                     "actual_value": 0.3,
                     "total": 1.0,
-                    "message": ProgressStructuredMessage.model_config["json_schema_extra"]["examples"][2],  # type: ignore [index]
+                    "message": {
+                        "description": "downloading",
+                        "current": 2.0,
+                        "total": 5,
+                        "sub": {
+                            "description": "port 2",
+                            "current": 12.2,
+                            "total": 123,
+                            "unit": "Byte",
+                        },
+                    },
                 },
             ]
         },

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

@@ -30,7 +30,6 @@ class SharerData:
 
 @dataclass(frozen=True)
 class ProductUIData:
-    project_alias: str
     logo_url: str | None = (
         None  # default_logo = "https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master/services/static-webserver/client/source/resource/osparc/osparc-white.svg" in base.html
     )

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

@@ -3,9 +3,9 @@
 {% block content %}
 <p>Dear {{ user.first_name or user.user_name }},</p>
 
-<p>Great news! {{ sharer.user_name }} has shared a {{ product.ui.project_alias }} with you on {{ product.display_name }}.</p>
+<p>Great news! {{ sharer.user_name }} has shared a project with you on {{ product.display_name }}.</p>
 
-<p>To view the {{ product.ui.project_alias }} and accept the sharing, follow below:</p>
+<p>To view the project and accept the sharing, follow below:</p>
 
 <p>
 {% if sharer.message %}

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

@@ -1,8 +1,8 @@
 Dear {{ user.first_name or user.user_name }},
 
-Great news! {{ sharer.user_name }} has shared a {{ product.ui.project_alias }} with you on {{ product.display_name }}.
+Great news! {{ sharer.user_name }} has shared a project with you on {{ product.display_name }}.
 
-To view the {{ product.ui.project_alias }} and accept the sharing, follow below:
+To view the project and accept the sharing, follow below:
 
 {{ sharer.message }}
 {{ accept_link }}

packages/notifications-library/src/notifications_library/templates/on_share_project.email.subject.txt

@@ -1 +1 @@
-A {{ product.ui.project_alias }} was shared with you on {{ host }}
+A project was shared with you on {{ host }}