🎨 Services metadata include an icon 🗃️ (#7174)

Author: pcrespov

packages/models-library/src/models_library/api_schemas_catalog/_base.py

@@ -0,0 +1,9 @@
+from pydantic import BaseModel
+
+
+class CatalogInputSchema(BaseModel):
+    ...
+
+
+class CatalogOutputSchema(BaseModel):
+    ...

packages/models-library/src/models_library/api_schemas_catalog/services.py

@@ -2,7 +2,7 @@
 from typing import Any, TypeAlias
 
 from models_library.rpc_pagination import PageRpc
-from pydantic import BaseModel, ConfigDict, Field, HttpUrl, NonNegativeInt
+from pydantic import ConfigDict, Field, HttpUrl, NonNegativeInt
 from pydantic.config import JsonDict
 
 from ..boot_options import BootOptions
@@ -21,6 +21,7 @@
 from ..services_resources import ServiceResourcesDict
 from ..services_types import ServiceKey, ServiceVersion
 from ..utils.change_case import snake_to_camel
+from ._base import CatalogInputSchema, CatalogOutputSchema
 
 _EXAMPLE_FILEPICKER: dict[str, Any] = {
     "name": "File Picker",
@@ -71,6 +72,7 @@
     "thumbnail": None,
     "description": "A service which awaits for time to pass, two times.",
     "description_ui": True,
+    "icon": "https://cdn-icons-png.flaticon.com/512/25/25231.png",
     "classifiers": [],
     "quality": {},
     "accessRights": {"1": {"execute": True, "write": False}},
@@ -167,12 +169,14 @@ def _update_json_schema_extra(schema: JsonDict) -> None:
     )
 
 
-class ServiceGetV2(BaseModel):
+class ServiceGetV2(CatalogOutputSchema):
+    # Model used in catalog's rpc and rest interfaces
     key: ServiceKey
     version: ServiceVersion
 
     name: str
     thumbnail: HttpUrl | None = None
+    icon: HttpUrl | None = None
     description: str
 
     description_ui: bool = False
@@ -280,9 +284,10 @@ def _update_json_schema_extra(schema: JsonDict) -> None:
 ServiceResourcesGet: TypeAlias = ServiceResourcesDict
 
 
-class ServiceUpdateV2(BaseModel):
+class ServiceUpdateV2(CatalogInputSchema):
     name: str | None = None
     thumbnail: HttpUrl | None = None
+    icon: HttpUrl | None = None
 
     description: str | None = None
     description_ui: bool = False

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

@@ -1,6 +1,6 @@
 from typing import Annotated
 
-from pydantic import BaseModel, ConfigDict, Field, field_validator
+from pydantic import BaseModel, ConfigDict, Field, HttpUrl, field_validator
 
 from .services_types import ServiceKey, ServiceVersion
 from .utils.common_validators import empty_str_to_none_pre_validator
@@ -41,6 +41,7 @@ class ServiceBaseDisplay(BaseModel):
             validate_default=True,
         ),
     ] = None
+    icon: Annotated[HttpUrl | None, Field(description="URL to the service icon")] = None
     description: Annotated[
         str,
         Field(

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

@@ -3,7 +3,7 @@
 from typing import Annotated, Any
 
 from common_library.basic_types import DEFAULT_FACTORY
-from pydantic import ConfigDict, Field
+from pydantic import ConfigDict, Field, HttpUrl
 from pydantic.config import JsonDict
 
 from .services_base import ServiceBaseDisplay
@@ -22,18 +22,21 @@ class ServiceMetaDataEditable(ServiceBaseDisplay):
     # Overrides ServiceBaseDisplay fields to Optional for a partial update
     name: str | None  # type: ignore[assignment]
     thumbnail: str | None
+    icon: HttpUrl | None
     description: str | None  # type: ignore[assignment]
     description_ui: bool = False
     version_display: str | None = None
 
     # Below fields only in the database ----
-    deprecated: datetime | None = Field(
-        default=None,
-        description="Owner can set the date to retire the service. Three possibilities:"
-        "If None, the service is marked as `published`;"
-        "If now<deprecated the service is marked as deprecated;"
-        "If now>=deprecated, the service is retired",
-    )
+    deprecated: Annotated[
+        datetime | None,
+        Field(
+            description="Owner can set the date to retire the service. Three possibilities:"
+            "If None, the service is marked as `published`;"
+            "If now<deprecated the service is marked as deprecated;"
+            "If now>=deprecated, the service is retired",
+        ),
+    ] = None
     classifiers: list[str] | None
     quality: Annotated[
         dict[str, Any], Field(default_factory=dict, json_schema_extra={"default": {}})
@@ -49,6 +52,7 @@ def _update_json_schema_extra(schema: JsonDict) -> None:
                     "name": "sim4life",
                     "description": "s4l web",
                     "thumbnail": "https://thumbnailit.org/image",
+                    "icon": "https://cdn-icons-png.flaticon.com/512/25/25231.png",
                     "quality": {
                         "enabled": True,
                         "tsr_target": {

packages/postgres-database/src/simcore_postgres_database/migration/versions/3fe27ff48f73_new_icon_table.py

@@ -0,0 +1,27 @@
+"""new icon table
+
+Revision ID: 3fe27ff48f73
+Revises: 611f956aa3e3
+Create Date: 2025-02-05 16:50:02.419293+00:00
+
+"""
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = "3fe27ff48f73"
+down_revision = "611f956aa3e3"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column("services_meta_data", sa.Column("icon", sa.String(), nullable=True))
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column("services_meta_data", "icon")
+    # ### end Alembic commands ###

packages/postgres-database/src/simcore_postgres_database/models/services.py

@@ -68,6 +68,12 @@
         nullable=True,
         doc="Link to image to us as service thumbnail (editable)",
     ),
+    sa.Column(
+        "icon",
+        sa.String,
+        nullable=True,
+        doc="Link to icon (editable)",
+    ),
     sa.Column(
         "version_display",
         sa.String,

packages/pytest-simcore/src/pytest_simcore/helpers/faker_factories.py

@@ -27,6 +27,14 @@
 DEFAULT_FAKER: Final = faker.Faker()
 
 
+def random_icon_url(fake: Faker):
+    return fake.image_url(width=16, height=16)
+
+
+def random_thumbnail_url(fake: Faker):
+    return fake.image_url(width=32, height=32)
+
+
 def _compute_hash(password: str) -> str:
     try:
         # 'passlib' will be used only if already installed.
@@ -396,7 +404,8 @@ def random_service_meta_data(
         # optional
         "description_ui": fake.pybool(),
         "owner": owner_primary_gid,
-        "thumbnail": _pick_from([fake.image_url(), None]),  # nullable
+        "thumbnail": _pick_from([random_thumbnail_url(fake), None]),  # nullable
+        "icon": _pick_from([random_icon_url(fake), None]),  # nullable
         "version_display": _pick_from([f"v{_version}", None]),  # nullable
         "classifiers": [],  # has default
         "quality": {},  # has default

services/catalog/VERSION

@@ -1 +1 @@
-0.7.0
+0.8.0

services/catalog/openapi.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "simcore-service-catalog",
     "description": "Manages and maintains a catalog of all published components (e.g. macro-algorithms, scripts, etc)",
-    "version": "0.7.0"
+    "version": "0.8.0"
   },
   "paths": {
     "/": {
@@ -2618,6 +2618,21 @@
             "title": "Thumbnail",
             "description": "URL to the service thumbnail"
           },
+          "icon": {
+            "anyOf": [
+              {
+                "type": "string",
+                "maxLength": 2083,
+                "minLength": 1,
+                "format": "uri"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Icon",
+            "description": "URL to the service icon"
+          },
           "description": {
             "type": "string",
             "title": "Description",

services/catalog/setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.7.0
+current_version = 0.8.0
 commit = True
 message = services/catalog version: {current_version} → {new_version}
 tag = False