Merge branch 'master' into is7395/test-settings

Author: pcrespov

.github/copilot-instructions.md

@@ -51,5 +51,5 @@ This document provides guidelines and best practices for using GitHub Copilot in
 
 - [Python Coding Conventions](../docs/coding-conventions.md)
 - [Environment Variables Guide](../docs/env-vars.md)
-- [Steps to Upgrade Python](../docs/steps-to-upgrade-python.md)
 - [Pydantic Annotated fields](../docs/llm-prompts/pydantic-annotated-fields.md)
+- [Steps to Upgrade Python](../docs/steps-to-upgrade-python.md)

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

@@ -0,0 +1,92 @@
+---
+mode: 'edit'
+description: 'Update user messages'
+---
+
+This prompt guide is for updating user-facing messages in ${file} or ${selection}
+
+## What is a User Message?
+
+A user message is any string that will be displayed to end-users of the application.
+In our codebase, these messages are marked with the `user_message` function:
+
+```python
+from common_library.user_messages import user_message
+
+error_msg = user_message("Operation failed. Please try again later.")
+```
+
+## Guidelines for Updating User Messages
+
+When modifying user messages, follow these rules:
+
+1. **Version Tracking**: Every modification to a user message must include an incremented `_version` parameter:
+
+   ```python
+   # Before modification
+   user_message("Error: Unable to connect to the server.")
+
+   # After modification, add _version or increment it if it already exists
+   user_message("Currently unable to establish connection to the server.", _version=1)
+   ```
+
+2. **F-String Preservation**: When modifying messages that use f-strings, preserve all parameters and their formatting:
+
+   ```python
+   # Before
+   user_message(f"Project {project_name} could not be loaded.")
+
+   # After (correct)
+   user_message(f"Unable to load project {project_name}.", _version=1)
+
+   # After (incorrect - lost the parameter)
+   user_message("Unable to load project.", _version=1)
+   ```
+
+3. **Message Style**: Follow *strictly* the guidelines in `${workspaceFolder}/docs/user-messages-guidelines.md`
+
+4. **Preserve Context**: Ensure the modified message conveys the same meaning and context as the original.
+
+5. **Incremental Versioning**: If a message already has a version, increment it by 1:
+
+   ```python
+   # Before
+   user_message("Session expired.", _version=2)
+
+   # After
+   user_message("Your session has expired. Please log in again.", _version=3)
+   ```
+
+## Examples
+
+### Example 1: Simple Message Update
+
+```python
+# Before
+error_dialog(user_message("Failed to save changes."))
+
+# After
+error_dialog(user_message("Unable to save your changes. Please try again.", _version=1))
+```
+
+### Example 2: F-string Message Update
+
+```python
+# Before
+raise ValueError(user_message(f"Invalid input parameter: {param_name}"))
+
+# After
+raise ValueError(user_message(f"The parameter '{param_name}' contains a value that is not allowed.", _version=1))
+```
+
+### Example 3: Already Versioned Message
+
+```python
+# Before
+return HttpErrorInfo(status.HTTP_404_NOT_FOUND, user_message("User not found.", _version=1))
+
+# After
+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.

docs/messages-guidelines.md renamed to docs/user-messages-guidelines.md

@@ -1,6 +1,6 @@
-# Error and Warning Message Guidelines
+# User Message Guidelines
 
-These guidelines ensure that messages are user-friendly, clear, and helpful while maintaining a professional tone. 🚀
+These guidelines ensure that error and warnings user-facing messages are user-friendly, clear, and helpful while maintaining a professional tone. 🚀
 
 Some details:
 

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

@@ -0,0 +1,11 @@
+def user_message(msg: str, *, _version: int | None = None) -> str:
+    """Marks a message as user-facing
+
+    Arguments:
+        msg -- human-friendly string that follows docs/user-messages-guidelines.md
+        _version -- version number to track changes to messages; increment when modifying an existing message
+
+    Returns:
+        The original message string, allowing it to be used inline in code
+    """
+    return msg

packages/common-library/tests/test_user_messages.py

@@ -0,0 +1,6 @@
+from common_library.user_messages import user_message
+
+
+def test_user_message() -> None:
+
+    assert user_message("This is a user message") == "This is a user message"

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

@@ -13,6 +13,7 @@
 from aiohttp.web_response import StreamResponse
 from common_library.error_codes import create_error_code
 from common_library.json_serialization import json_dumps, json_loads
+from common_library.user_messages import user_message
 from models_library.rest_error import ErrorGet, ErrorItemType, LogMessageType
 
 from ..logging_errors import create_troubleshotting_log_kwargs
@@ -31,7 +32,7 @@
 from .web_exceptions_extension import get_http_error_class_or_none
 
 DEFAULT_API_VERSION = "v0"
-_FMSG_INTERNAL_ERROR_USER_FRIENDLY = (
+_FMSG_INTERNAL_ERROR_USER_FRIENDLY = user_message(
     "We apologize for the inconvenience. "
     "The issue has been recorded, please report it if it persists."
 )

services/api-server/src/simcore_service_api_server/api/routes/studies.py

@@ -111,8 +111,9 @@ async def clone_study(
             description=description,
         )
         await webserver_api.patch_project(
-            project_id=study_id, patch_params=patch_params
+            project_id=project.uuid, patch_params=patch_params
         )
+        project = await webserver_api.get_project(project_id=project.uuid)
     return _create_study_from_project(project)
 
 

services/api-server/tests/unit/api_studies/test_api_routes_studies.py

@@ -1,6 +1,8 @@
 # pylint: disable=redefined-outer-name
 # pylint: disable=unused-argument
 # pylint: disable=unused-variable
+# pylint: disable=too-many-arguments
+# pylint: disable=too-many-statements
 
 
 import json
@@ -13,6 +15,8 @@
 import pytest
 from faker import Faker
 from fastapi import status
+from models_library.api_schemas_webserver.projects import ProjectGet
+from models_library.generics import Envelope
 from pydantic import TypeAdapter
 from pytest_mock import MockType
 from pytest_simcore.helpers.httpx_calls_capture_models import HttpApiCallCaptureModel
@@ -224,12 +228,8 @@ async def test_clone_study_with_title(
     study_id: StudyID,
     mocked_webserver_rest_api_base: MockRouter,
     patch_webserver_long_running_project_tasks: Callable[[MockRouter], MockRouter],
-    mock_webserver_patch_project: Callable[
-        [
-            MockRouter,
-        ],
-        MockRouter,
-    ],
+    mock_webserver_patch_project: Callable[[MockRouter], MockRouter],
+    mock_webserver_get_project: Callable[[MockRouter], MockRouter],
     hidden: bool | None,
     title: str | None,
     description: str | None,
@@ -238,11 +238,14 @@ async def test_clone_study_with_title(
     # Mocks /projects
     patch_webserver_long_running_project_tasks(mocked_webserver_rest_api_base)
     mock_webserver_patch_project(mocked_webserver_rest_api_base)
+    mock_webserver_get_project(mocked_webserver_rest_api_base)
 
     create_callback = mocked_webserver_rest_api_base["create_projects"].side_effect
     assert create_callback is not None
     patch_callback = mocked_webserver_rest_api_base["project_patch"].side_effect
     assert patch_callback is not None
+    get_callback = mocked_webserver_rest_api_base["project_get"].side_effect
+    assert get_callback is not None
 
     def clone_project_side_effect(request: httpx.Request):
         if hidden is not None:
@@ -260,12 +263,28 @@ def patch_project_side_effect(request: httpx.Request, *args, **kwargs):
             assert _description is not None and _description in description
         return patch_callback(request, *args, **kwargs)
 
+    def get_project_side_effect(request: httpx.Request, *args, **kwargs):
+        # this is needed to return the patched project
+        _project_id = kwargs.get("project_id")
+        assert _project_id is not None
+        result = Envelope[ProjectGet].model_validate(
+            {"data": ProjectGet.model_json_schema()["examples"][0]}
+        )
+        assert result.data is not None
+        if title is not None:
+            result.data.name = title
+        if description is not None:
+            result.data.description = description
+        result.data.uuid = UUID(_project_id)
+        return httpx.Response(status.HTTP_200_OK, content=result.model_dump_json())
+
     mocked_webserver_rest_api_base["create_projects"].side_effect = (
         clone_project_side_effect
     )
     mocked_webserver_rest_api_base["project_patch"].side_effect = (
         patch_project_side_effect
     )
+    mocked_webserver_rest_api_base["project_get"].side_effect = get_project_side_effect
 
     query = dict()
     if hidden is not None:
@@ -286,8 +305,14 @@ def patch_project_side_effect(request: httpx.Request, *args, **kwargs):
     assert mocked_webserver_rest_api_base["create_projects"].called
     if title or description:
         assert mocked_webserver_rest_api_base["project_patch"].called
+        assert mocked_webserver_rest_api_base["project_get"].called
 
     assert resp.status_code == expected_status_code
+    study = Study.model_validate(resp.json())
+    if title is not None:
+        assert study.title == title
+    if description is not None:
+        assert study.description == description
 
 
 async def test_clone_study_not_found(

services/api-server/tests/unit/conftest.py

@@ -717,7 +717,7 @@ def _mock(webserver_mock_router: MockRouter) -> MockRouter:
 
 @pytest.fixture
 def mock_webserver_patch_project(
-    app: FastAPI, faker: Faker, services_mocks_enabled: bool
+    app: FastAPI, services_mocks_enabled: bool
 ) -> Callable[[MockRouter], MockRouter]:
     settings: ApplicationSettings = app.state.settings
     assert settings.API_SERVER_WEBSERVER is not None
@@ -736,6 +736,30 @@ def _patch_project(request: httpx.Request, *args, **kwargs):
     return _mock
 
 
+@pytest.fixture
+def mock_webserver_get_project(
+    app: FastAPI, services_mocks_enabled: bool
+) -> Callable[[MockRouter], MockRouter]:
+    settings: ApplicationSettings = app.state.settings
+    assert settings.API_SERVER_WEBSERVER is not None
+
+    def _mock(webserver_mock_router: MockRouter) -> MockRouter:
+        def _get_project(request: httpx.Request, *args, **kwargs):
+            result = Envelope[ProjectGet].model_validate(
+                {"data": ProjectGet.model_json_schema()["examples"][0]}
+            )
+            return httpx.Response(status.HTTP_200_OK, json=result.model_dump())
+
+        if services_mocks_enabled:
+            webserver_mock_router.get(
+                path__regex=r"/projects/(?P<project_id>[\w-]+)$",
+                name="project_get",
+            ).mock(side_effect=_get_project)
+        return webserver_mock_router
+
+    return _mock
+
+
 @pytest.fixture
 def openapi_dev_specs(project_slug_dir: Path) -> dict[str, Any]:
     openapi_file = (project_slug_dir / "openapi-dev.json").resolve()

services/director-v2/src/simcore_service_director_v2/modules/comp_scheduler/_scheduler_base.py

@@ -590,9 +590,7 @@ async def _process_executing_tasks(
         """process executing tasks from the 3rd party backend"""
 
     @abstractmethod
-    async def _release_resources(
-        self, user_id: UserID, project_id: ProjectID, comp_run: CompRunsAtDB
-    ) -> None:
+    async def _release_resources(self, comp_run: CompRunsAtDB) -> None:
         """release resources used by the scheduler for a given user and project"""
 
     async def apply(
@@ -660,7 +658,7 @@ async def apply(
 
                 # 7. Are we done scheduling that pipeline?
                 if not dag.nodes() or pipeline_result in COMPLETED_STATES:
-                    await self._release_resources(user_id, project_id, comp_run)
+                    await self._release_resources(comp_run)
                     # there is nothing left, the run is completed, we're done here
                     _logger.info(
                         "pipeline %s scheduling completed with result %s",