refactor common code in programs and solvers

Author: bisgaard-itis

services/api-server/src/simcore_service_api_server/models/schemas/programs.py

@@ -5,7 +5,7 @@
 from models_library.services import ServiceMetaDataPublished
 from models_library.services_regex import DYNAMIC_SERVICE_KEY_RE
 from packaging.version import Version
-from pydantic import ConfigDict, Field, HttpUrl, StringConstraints
+from pydantic import BaseModel, ConfigDict, Field, HttpUrl, StringConstraints
 from simcore_service_api_server.models.schemas._utils import ApiServerOutputSchema
 
 from ...models._utils_pydantic import UriSchema
@@ -27,12 +27,10 @@
 ]
 
 
-class Program(ApiServerOutputSchema):
-    """A released solver with a specific version"""
-
-    id: Annotated[ProgramKeyId, Field(..., description="Program identifier")]
+class BaseResource(BaseModel):
+    id: Annotated[str, Field(..., description="Resource identifier")]
     version: Annotated[
-        VersionStr, Field(..., description="semantic version number of the node")
+        VersionStr, Field(..., description="Semantic version number of the resource")
     ]
     title: Annotated[
         str,
@@ -42,12 +40,40 @@ class Program(ApiServerOutputSchema):
     description: Annotated[
         str | None,
         StringConstraints(max_length=500),
-        Field(None, description="Description of the program"),
+        Field(default=None, description="Description of the resource"),
     ]
     url: Annotated[
         HttpUrl | None, UriSchema(), Field(..., description="Link to get this resource")
     ]
 
+    @property
+    def pep404_version(self) -> Version:
+        """Rich version type that can be used e.g. to compare"""
+        return packaging.version.parse(self.version)
+
+    @property
+    def url_friendly_id(self) -> str:
+        """Use to pass id as parameter in URLs"""
+        return urllib.parse.quote_plus(self.id)
+
+    @property
+    def resource_name(self) -> str:
+        """Relative resource name"""
+        return self.compose_resource_name(self.id, self.version)
+
+    @property
+    def name(self) -> str:
+        """API standards notation (see api_resources.py)"""
+        return self.resource_name
+
+    @classmethod
+    def compose_resource_name(cls, key: str, version: str) -> str:
+        raise NotImplementedError("Subclasses must implement this method")
+
+
+class Program(BaseResource, ApiServerOutputSchema):
+    """A released program with a specific version"""
+
     model_config = ConfigDict(
         extra="ignore",
         json_schema_extra={
@@ -67,7 +93,6 @@ def create_from_image(cls, image_meta: ServiceMetaDataPublished) -> "Program":
         data = image_meta.model_dump(
             include={"name", "key", "version", "description", "contact"},
         )
-
         return cls(
             id=data.pop("key"),
             version=data.pop("version"),
@@ -76,26 +101,6 @@ def create_from_image(cls, image_meta: ServiceMetaDataPublished) -> "Program":
             **data,
         )
 
-    @property
-    def pep404_version(self) -> Version:
-        """Rich version type that can be used e.g. to compare"""
-        return packaging.version.parse(self.version)
-
-    @property
-    def url_friendly_id(self) -> str:
-        """Use to pass id as parameter in urls"""
-        return urllib.parse.quote_plus(self.id)
-
-    @property
-    def resource_name(self) -> str:
-        """Relative resource name"""
-        return self.compose_resource_name(self.id, self.version)
-
-    @property
-    def name(self) -> str:
-        """API standards notation (see api_resources.py)"""
-        return self.resource_name
-
     @classmethod
     def compose_resource_name(
         cls, program_key: ProgramKeyId, program_version: VersionStr

services/api-server/src/simcore_service_api_server/models/schemas/solvers.py

@@ -1,16 +1,12 @@
-import urllib.parse
 from typing import Annotated, Any, Literal
 
-import packaging.version
 from models_library.basic_regex import PUBLIC_VARIABLE_NAME_RE
 from models_library.services import ServiceMetaDataPublished
 from models_library.services_regex import COMPUTATIONAL_SERVICE_KEY_RE
-from packaging.version import Version
-from pydantic import BaseModel, ConfigDict, Field, HttpUrl, StringConstraints
+from pydantic import BaseModel, ConfigDict, Field, StringConstraints
 
-from ...models._utils_pydantic import UriSchema
+from ...models.schemas.programs import BaseResource
 from ..api_resources import compose_resource_name
-from ..basic_types import VersionStr
 
 # NOTE:
 # - API does NOT impose prefix (simcore)/(services)/comp because does not know anything about registry deployed. This constraint
@@ -36,27 +32,10 @@
 ]
 
 
-class Solver(BaseModel):
+class Solver(BaseResource):
     """A released solver with a specific version"""
 
-    id: SolverKeyId = Field(..., description="Solver identifier")
-    version: VersionStr = Field(
-        ...,
-        description="semantic version number of the node",
-    )
-
-    # Human readables Identifiers
-    title: str = Field(..., description="Human readable name")
-    description: str | None = None
-    maintainer: str
-    # TODO: consider released: Optional[datetime]   required?
-    # TODO: consider version_aliases: list[str] = []  # remaining tags
-
-    # Get links to other resources
-    url: Annotated[
-        Annotated[HttpUrl, UriSchema()] | None,
-        Field(..., description="Link to get this resource"),
-    ]
+    maintainer: str = Field(..., description="Maintainer of the solver")
 
     model_config = ConfigDict(
         extra="ignore",
@@ -77,7 +56,6 @@ def create_from_image(cls, image_meta: ServiceMetaDataPublished) -> "Solver":
         data = image_meta.model_dump(
             include={"name", "key", "version", "description", "contact"},
         )
-
         return cls(
             id=data.pop("key"),
             version=data.pop("version"),
@@ -87,28 +65,8 @@ def create_from_image(cls, image_meta: ServiceMetaDataPublished) -> "Solver":
             **data,
         )
 
-    @property
-    def pep404_version(self) -> Version:
-        """Rich version type that can be used e.g. to compare"""
-        return packaging.version.parse(self.version)
-
-    @property
-    def url_friendly_id(self) -> str:
-        """Use to pass id as parameter in urls"""
-        return urllib.parse.quote_plus(self.id)
-
-    @property
-    def resource_name(self) -> str:
-        """Relative resource name"""
-        return self.compose_resource_name(self.id, self.version)
-
-    @property
-    def name(self) -> str:
-        """API standards notation (see api_resources.py)"""
-        return self.resource_name
-
     @classmethod
-    def compose_resource_name(cls, solver_key, solver_version) -> str:
+    def compose_resource_name(cls, solver_key: str, solver_version: str) -> str:
         return compose_resource_name("solvers", solver_key, "releases", solver_version)
 
 

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

@@ -205,8 +205,9 @@ def fake_url_for(*args, **kwargs) -> HttpUrl:
     solver = Solver(
         id=solver_key,
         version=solver_version,
-        title=faker.text(),
+        title=faker.text(max_nb_chars=20),
         maintainer=faker.name(),
+        description=faker.text(max_nb_chars=100),
         url=None,
     )