Merge branch 'master' into add-conversation-messages-ws-events

Author: giancarloromeo

.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.

.vscode/launch.template.json

@@ -44,6 +44,28 @@
       "justMyCode": false
     },
     {
+      // This test adds --external-envfile and expects a file named ".secrets" in the workspace root.
+      "name": "Python: Test w/ repo.config",
+      "type": "debugpy",
+      "request": "launch",
+      "module": "pytest",
+      "args": [
+        "--ff",
+        "--log-cli-level=INFO",
+        "--external-envfile=${workspaceFolder}/.secrets",
+        "--pdb",
+        "--setup-show",
+        "--durations=5",
+        "-s",
+        "-vv",
+        "${file}"
+      ],
+      "cwd": "${workspaceFolder}",
+      "console": "integratedTerminal",
+      "justMyCode": false
+    },
+    {
+      // This tests enables the httpx spy and dumps captures in a json. Mainly for api-server
       "name": "Python: Test-Httpx-Spy",
       "type": "debugpy",
       "request": "launch",

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/models-library/src/models_library/projects.py

@@ -8,9 +8,6 @@
 from uuid import UUID
 
 from common_library.basic_types import DEFAULT_FACTORY
-from models_library.basic_types import ConstrainedStr
-from models_library.folders import FolderID
-from models_library.workspaces import WorkspaceID
 from pydantic import (
     BaseModel,
     ConfigDict,
@@ -21,8 +18,11 @@
 )
 
 from .basic_regex import DATE_RE, UUID_RE_BASE
+from .basic_types import ConstrainedStr
 from .emails import LowerCaseEmailStr
+from .folders import FolderID
 from .groups import GroupID
+from .products import ProductName
 from .projects_access import AccessRights, GroupIDStr
 from .projects_nodes import Node
 from .projects_nodes_io import NodeIDStr
@@ -33,6 +33,7 @@
     none_to_empty_str_pre_validator,
 )
 from .utils.enums import StrAutoEnum
+from .workspaces import WorkspaceID
 
 ProjectID: TypeAlias = UUID
 CommitID: TypeAlias = int
@@ -147,6 +148,25 @@ def _convert_sql_alchemy_enum(cls, v):
     )
 
 
+class ProjectListAtDB(BaseProjectModel):
+    id: int
+    type: ProjectType
+    template_type: ProjectTemplateType | None
+    prj_owner: int | None
+    ui: dict[str, Any] | None
+    classifiers: list[ClassifierID] | None
+    dev: dict[str, Any] | None
+    quality: dict[str, Any]
+    published: bool | None
+    hidden: bool
+    workspace_id: WorkspaceID | None
+    trashed: datetime | None
+    trashed_by: UserID | None
+    trashed_explicitly: bool
+    product_name: ProductName
+    folder_id: FolderID | None
+
+
 class Project(BaseProjectModel):
     # NOTE: This is the pydantic pendant of project-v0.0.1.json used in the API of the webserver/webclient
     # NOT for usage with DB!!

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

@@ -168,7 +168,7 @@ class Node(BaseModel):
         ),
     ] = None
 
-    thumbnail: Annotated[
+    thumbnail: Annotated[  # <-- (DEPRECATED) Can be removed
         str | HttpUrl | None,
         Field(
             description="url of the latest screenshot of the node",
@@ -232,18 +232,18 @@ class Node(BaseModel):
     ] = DEFAULT_FACTORY
 
     output_node: Annotated[bool | None, Field(deprecated=True, alias="outputNode")] = (
-        None
+        None  # <-- (DEPRECATED) Can be removed
     )
 
-    output_nodes: Annotated[
+    output_nodes: Annotated[  # <-- (DEPRECATED) Can be removed
         list[NodeID] | None,
         Field(
             description="Used in group-nodes. Node IDs of those connected to the output",
             alias="outputNodes",
         ),
     ] = None
 
-    parent: Annotated[
+    parent: Annotated[  # <-- (DEPRECATED) Can be removed
         NodeID | None,
         Field(
             description="Parent's (group-nodes') node ID s. Used to group",

packages/pytest-simcore/src/pytest_simcore/environment_configs.py

@@ -3,6 +3,7 @@
 # pylint: disable=unused-variable
 
 
+import logging
 import re
 from pathlib import Path
 from typing import Any
@@ -12,6 +13,8 @@
 from .helpers.monkeypatch_envs import load_dotenv, setenvs_from_dict
 from .helpers.typing_env import EnvVarsDict
 
+_logger = logging.getLogger(__name__)
+
 
 def pytest_addoption(parser: pytest.Parser):
     simcore_group = parser.getgroup("simcore")
@@ -20,12 +23,17 @@ def pytest_addoption(parser: pytest.Parser):
         action="store",
         type=Path,
         default=None,
-        help="Path to an env file. Consider passing a link to repo configs, i.e. `ln -s /path/to/osparc-ops-config/repo.config`",
+        help="Path to an env file. Replaces .env-devel in the tests by an external envfile."
+        "e.g. consider "
+        " `ln -s /path/to/osparc-ops-config/repo.config .secrets` and then "
+        " `pytest --external-envfile=.secrets --pdb tests/unit/test_core_settings.py`",
     )
 
 
 @pytest.fixture(scope="session")
-def external_envfile_dict(request: pytest.FixtureRequest) -> EnvVarsDict:
+def external_envfile_dict(
+    request: pytest.FixtureRequest, osparc_simcore_root_dir: Path
+) -> EnvVarsDict:
     """
     If a file under test folder prefixed with `.env-secret` is present,
     then this fixture captures it.
@@ -35,19 +43,43 @@ def external_envfile_dict(request: pytest.FixtureRequest) -> EnvVarsDict:
     """
     envs = {}
     if envfile := request.config.getoption("--external-envfile"):
-        print("🚨 EXTERNAL `envfile` option detected. Loading", envfile, "...")
+        _logger.warning(
+            "🚨 EXTERNAL `envfile` option detected. Loading '%s' ...", envfile
+        )
 
         assert isinstance(envfile, Path)
         assert envfile.exists()
         assert envfile.is_file()
 
+        envfile = envfile.resolve()
+        osparc_simcore_root_dir = osparc_simcore_root_dir.resolve()
+
+        if osparc_simcore_root_dir in envfile.parents and not any(
+            term in envfile.name.lower() for term in ("ignore", "secret")
+        ):
+            _logger.warning(
+                "🚨 CAUTION: The external envfile '%s' may contain sensitive data and could be accidentally versioned. "
+                "To prevent this, include the words 'secret' or 'ignore' in the filename.",
+                envfile.name,
+            )
+
         envs = load_dotenv(envfile)
 
+    if envs:
+        response = input(
+            f"🚨 CAUTION: You are about to run tests using environment variables loaded from '{envfile}'.\n"
+            "This may cause tests to interact with or modify real external systems (e.g., production or staging environments).\n"
+            "Proceeding could result in data loss or unintended side effects.\n"
+            "Are you sure you want to continue? [y/N]: "
+        )
+        if response.strip().lower() not in ("y", "yes"):
+            pytest.exit("Aborted by user due to external envfile usage.")
+
     return envs
 
 
 @pytest.fixture(scope="session")
-def skip_if_external_envfile_dict(external_envfile_dict: EnvVarsDict) -> None:
+def skip_if_no_external_envfile(external_envfile_dict: EnvVarsDict) -> None:
     if not external_envfile_dict:
         pytest.skip(reason="Skipping test since external-envfile is not set")