use batch models/schemas in register function job rpc endpoints

Author: bisgaard-itis

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

@@ -85,3 +85,20 @@ class BatchGetEnvelope(BaseModel, Generic[ResourceT, IdentifierT]):
             description="List of identifiers for items that were not found",
         ),
     ] = DEFAULT_FACTORY
+
+
+class BatchCreateEnvelope(BaseModel, Generic[SchemaT]):
+    """Generic envelope model for batch-create operations.
+
+    This model represents the result of a strict batch create operation,
+    containing the list of created items. The operation is expected to be "strict"
+    in the sense that it either creates all requested items or fails entirely.
+    """
+
+    created_items: Annotated[
+        list[SchemaT],
+        Field(
+            min_length=1,
+            description="List of successfully created items",
+        ),
+    ]

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

@@ -7,6 +7,7 @@
 from models_library import projects
 from models_library.basic_regex import UUID_RE_BASE
 from models_library.basic_types import ConstrainedStr
+from models_library.batch_operations import BatchCreateEnvelope
 from models_library.groups import GroupID
 from models_library.products import ProductName
 from models_library.services_types import ServiceKey, ServiceVersion
@@ -269,10 +270,12 @@ class RegisteredPythonCodeFunctionJob(PythonCodeFunctionJob, RegisteredFunctionJ
     | RegisteredSolverFunctionJob,
     Field(discriminator="function_class"),
 ]
-RegisteredFunctionJobList: TypeAlias = Annotated[
-    list[RegisteredFunctionJob],
-    Field(max_length=_MAX_LIST_LENGTH, min_length=_MIN_LIST_LENGTH),
-]
+
+
+class BatchCreateRegisteredFunctionJobs(BatchCreateEnvelope[RegisteredFunctionJob]):
+    """Envelope model for batch registering function jobs"""
+
+    pass
 
 
 RegisteredFunctionJobPatch = Annotated[
@@ -373,6 +376,10 @@ class RegisteredFunctionJobDB(FunctionJobDB):
     created: datetime.datetime
 
 
+class BatchCreateRegisteredFunctionJobsDB(BatchCreateEnvelope[RegisteredFunctionJobDB]):
+    pass
+
+
 class RegisteredFunctionJobWithStatusDB(FunctionJobDB):
     uuid: FunctionJobID
     created: datetime.datetime

services/web/server/src/simcore_service_webserver/functions/_function_jobs_repository.py

@@ -6,6 +6,7 @@
 import sqlalchemy
 from aiohttp import web
 from models_library.functions import (
+    BatchCreateRegisteredFunctionJobsDB,
     FunctionClass,
     FunctionClassSpecificData,
     FunctionID,
@@ -69,7 +70,7 @@ async def create_function_jobs(  # noqa: PLR0913
     user_id: UserID,
     product_name: ProductName,
     function_jobs: list[FunctionJobDB],
-) -> list[RegisteredFunctionJobDB]:
+) -> BatchCreateRegisteredFunctionJobsDB:
     async with transaction_context(get_asyncpg_engine(app), connection) as transaction:
         await check_user_api_access_rights(
             app,
@@ -126,7 +127,7 @@ async def create_function_jobs(  # noqa: PLR0913
             execute=True,
         )
 
-    return created_jobs
+    return BatchCreateRegisteredFunctionJobsDB(created_items=created_jobs)
 
 
 async def patch_function_job(

services/web/server/src/simcore_service_webserver/functions/_functions_service.py

@@ -3,6 +3,7 @@
 from aiohttp import web
 from models_library.basic_types import IDStr
 from models_library.functions import (
+    BatchCreateRegisteredFunctionJobs,
     Function,
     FunctionClass,
     FunctionClassSpecificData,
@@ -30,7 +31,6 @@
     RegisteredFunctionJob,
     RegisteredFunctionJobCollection,
     RegisteredFunctionJobDB,
-    RegisteredFunctionJobList,
     RegisteredFunctionJobWithStatus,
     RegisteredFunctionJobWithStatusDB,
     RegisteredProjectFunction,
@@ -102,8 +102,9 @@ async def register_function_job(
         product_name=product_name,
         function_jobs=[encoded_function_jobs],
     )
-    assert len(created_function_jobs_db) == 1  # nosec
-    return _decode_functionjob(created_function_jobs_db[0])
+    created_items = created_function_jobs_db.created_items
+    assert len(created_items) == 1  # nosec
+    return _decode_functionjob(created_items[0])
 
 
 async def register_function_job_batch(
@@ -112,7 +113,7 @@ async def register_function_job_batch(
     user_id: UserID,
     product_name: ProductName,
     function_jobs: FunctionJobList,
-) -> RegisteredFunctionJobList:
+) -> BatchCreateRegisteredFunctionJobs:
     TypeAdapter(FunctionJobList).validate_python(function_jobs)
     encoded_function_jobs = [_encode_functionjob(job) for job in function_jobs]
     created_function_jobs_db = await _function_jobs_repository.create_function_jobs(
@@ -121,7 +122,11 @@ async def register_function_job_batch(
         product_name=product_name,
         function_jobs=encoded_function_jobs,
     )
-    return [_decode_functionjob(job) for job in created_function_jobs_db]
+    return BatchCreateRegisteredFunctionJobs(
+        created_items=[
+            _decode_functionjob(job) for job in created_function_jobs_db.created_items
+        ]
+    )
 
 
 async def patch_registered_function_job(