✨ api-server: listing of all solver jobs (#7566)

Author: pcrespov

packages/models-library/src/models_library/rpc/webserver/projects.py

@@ -29,7 +29,7 @@ class ProjectJobRpcGet(BaseModel):
     workbench: NodesDict
 
     # timestamps
-    creation_at: datetime
+    created_at: datetime
     modified_at: datetime
 
     # Specific to jobs
@@ -43,12 +43,30 @@ def _update_json_schema_extra(schema: JsonDict) -> None:
                 "examples": [
                     {
                         "uuid": "12345678-1234-5678-1234-123456789012",
-                        "name": "My project",
-                        "description": "My project description",
+                        "name": "A solver job",
+                        "description": "A description of a solver job with a single node",
                         "workbench": {f"{uuid4()}": n for n in nodes_examples[2:3]},
-                        "creation_at": "2023-01-01T00:00:00Z",
+                        "created_at": "2023-01-01T00:00:00Z",
                         "modified_at": "2023-01-01T00:00:00Z",
-                        "job_parent_resource_name": "solvers/foo/release/1.2.3",
+                        "job_parent_resource_name": "solvers/simcore%2Fservices%2Fcomp%2Fitis%2Fsleeper/releases/2.0.2",
+                    },
+                    {
+                        "uuid": "00000000-1234-5678-1234-123456789012",
+                        "name": "A study job",
+                        "description": "A description of a study job with many node",
+                        "workbench": {f"{uuid4()}": n for n in nodes_examples},
+                        "created_at": "2023-02-01T00:00:00Z",
+                        "modified_at": "2023-02-01T00:00:00Z",
+                        "job_parent_resource_name": "studies/96642f2a-a72c-11ef-8776-02420a00087d",
+                    },
+                    {
+                        "uuid": "00000000-0000-5678-1234-123456789012",
+                        "name": "A program job",
+                        "description": "A program of a solver job with a single node",
+                        "workbench": {f"{uuid4()}": n for n in nodes_examples[2:3]},
+                        "created_at": "2023-03-01T00:00:00Z",
+                        "modified_at": "2023-03-01T00:00:00Z",
+                        "job_parent_resource_name": "program/simcore%2Fservices%2Fdynamic%2Fjupyter/releases/5.0.2",
                     },
                 ]
             }

packages/models-library/src/models_library/utils/common_validators.py

@@ -1,4 +1,4 @@
-""" Reusable validators
+"""Reusable validators
 
     Example:
 
@@ -22,10 +22,19 @@ class MyModel(BaseModel):
 
 from common_library.json_serialization import json_loads
 from orjson import JSONDecodeError
-from pydantic import BaseModel
+from pydantic import BaseModel, BeforeValidator
 from pydantic.alias_generators import to_camel
 
 
+def trim_string_before(max_length: int) -> BeforeValidator:
+    def _trim(value: str):
+        if isinstance(value, str):
+            return value[:max_length]
+        return value
+
+    return BeforeValidator(_trim)
+
+
 def empty_str_to_none_pre_validator(value: Any):
     if isinstance(value, str) and value.strip() == "":
         return None

packages/models-library/tests/test_utils_common_validators.py

@@ -1,13 +1,15 @@
 from enum import Enum
+from typing import Annotated
 
 import pytest
 from models_library.utils.common_validators import (
     create_enums_pre_validator,
     empty_str_to_none_pre_validator,
     none_to_empty_str_pre_validator,
     null_or_none_str_to_none_validator,
+    trim_string_before,
 )
-from pydantic import BaseModel, ValidationError, field_validator
+from pydantic import BaseModel, StringConstraints, ValidationError, field_validator
 
 
 def test_enums_pre_validator():
@@ -89,3 +91,67 @@ class Model(BaseModel):
 
     model = Model.model_validate({"message": ""})
     assert model == Model.model_validate({"message": ""})
+
+
+def test_trim_string_before():
+    max_length = 10
+
+    class ModelWithTrim(BaseModel):
+        text: Annotated[str, trim_string_before(max_length=max_length)]
+
+    # Test with string shorter than max_length
+    short_text = "Short"
+    model = ModelWithTrim(text=short_text)
+    assert model.text == short_text
+
+    # Test with string equal to max_length
+    exact_text = "1234567890"  # 10 characters
+    model = ModelWithTrim(text=exact_text)
+    assert model.text == exact_text
+
+    # Test with string longer than max_length
+    long_text = "This is a very long text that should be trimmed"
+    model = ModelWithTrim(text=long_text)
+    assert model.text == long_text[:max_length]
+    assert len(model.text) == max_length
+
+    # Test with non-string value (should be left unchanged)
+    class ModelWithTrimOptional(BaseModel):
+        text: Annotated[str | None, trim_string_before(max_length=max_length)]
+
+    model = ModelWithTrimOptional(text=None)
+    assert model.text is None
+
+
+def test_trim_string_before_with_string_constraints():
+    max_length = 10
+
+    class ModelWithTrimAndConstraints(BaseModel):
+        text: Annotated[
+            str | None,
+            StringConstraints(
+                max_length=max_length
+            ),  # NOTE: order does not matter for validation but has an effect in the openapi schema
+            trim_string_before(max_length=max_length),
+        ]
+
+    # Check that the OpenAPI schema contains the string constraint
+    schema = ModelWithTrimAndConstraints.model_json_schema()
+    assert schema["properties"]["text"] == {
+        "anyOf": [{"maxLength": max_length, "type": "string"}, {"type": "null"}],
+        "title": "Text",
+    }
+
+    # Test with string longer than max_length
+    # This should pass because trim_string_before runs first and trims the input
+    # before StringConstraints validation happens
+    long_text = "This is a very long text that should be trimmed"
+    model = ModelWithTrimAndConstraints(text=long_text)
+    assert model.text is not None
+    assert model.text == long_text[:max_length]
+    assert len(model.text) == max_length
+
+    # Test with string exactly at max_length
+    exact_text = "1234567890"  # 10 characters
+    model = ModelWithTrimAndConstraints(text=exact_text)
+    assert model.text == exact_text

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

@@ -8,7 +8,10 @@
 from models_library.products import ProductName
 from models_library.projects import ProjectID
 from models_library.rest_pagination import PageOffsetInt
-from models_library.rpc.webserver.projects import PageRpcProjectJobRpcGet
+from models_library.rpc.webserver.projects import (
+    PageRpcProjectJobRpcGet,
+    ProjectJobRpcGet,
+)
 from models_library.rpc_pagination import (
     DEFAULT_NUMBER_OF_ITEMS_PER_PAGE,
     PageLimitInt,
@@ -54,19 +57,28 @@ async def list_projects_marked_as_jobs(
         offset: PageOffsetInt = 0,
         limit: PageLimitInt = DEFAULT_NUMBER_OF_ITEMS_PER_PAGE,
         # filters
-        job_parent_resource_name_filter: str | None = None,
+        job_parent_resource_name_prefix: str | None = None,
     ) -> PageRpcProjectJobRpcGet:
         assert rpc_client
         assert product_name
         assert user_id
 
-        if job_parent_resource_name_filter:
-            assert not job_parent_resource_name_filter.startswith("/")
+        if job_parent_resource_name_prefix:
+            assert not job_parent_resource_name_prefix.startswith("/")
+            assert not job_parent_resource_name_prefix.endswith("%")
+            assert not job_parent_resource_name_prefix.startswith("%")
 
-        items = PageRpcProjectJobRpcGet.model_json_schema()["examples"]
+        items = [
+            item
+            for item in ProjectJobRpcGet.model_json_schema()["examples"]
+            if job_parent_resource_name_prefix is None
+            or item.get("job_parent_resource_name").startswith(
+                job_parent_resource_name_prefix
+            )
+        ]
 
         return PageRpcProjectJobRpcGet.create(
-            items[offset, : offset + limit],
+            items[offset : offset + limit],
             total=len(items),
             limit=limit,
             offset=offset,

packages/service-library/src/servicelib/rabbitmq/rpc_interfaces/webserver/projects.py

@@ -52,7 +52,7 @@ async def list_projects_marked_as_jobs(
     offset: PageOffsetInt = 0,
     limit: PageLimitInt = DEFAULT_NUMBER_OF_ITEMS_PER_PAGE,
     # filters
-    job_parent_resource_name_filter: str | None = None,
+    job_parent_resource_name_prefix: str | None = None,
 ) -> PageRpcProjectJobRpcGet:
     result = await rpc_client.request(
         WEBSERVER_RPC_NAMESPACE,
@@ -61,7 +61,7 @@ async def list_projects_marked_as_jobs(
         user_id=user_id,
         offset=offset,
         limit=limit,
-        job_parent_resource_name_filter=job_parent_resource_name_filter,
+        job_parent_resource_name_prefix=job_parent_resource_name_prefix,
     )
     assert TypeAdapter(PageRpcProjectJobRpcGet).validate_python(result)  # nosec
     return cast(PageRpcProjectJobRpcGet, result)