Add a function_job_list_with_status endpoint 🎨 (#8278)

Author: wvangeit

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

@@ -190,21 +190,12 @@ class FunctionJobBase(BaseModel):
     function_class: FunctionClass
 
 
-class RegisteredFunctionJobBase(FunctionJobBase):
-    uid: FunctionJobID
-    created_at: datetime.datetime
-
-
 class ProjectFunctionJob(FunctionJobBase):
     function_class: Literal[FunctionClass.PROJECT] = FunctionClass.PROJECT
     project_job_id: ProjectID | None
     job_creation_task_id: TaskID | None
 
 
-class RegisteredProjectFunctionJob(ProjectFunctionJob, RegisteredFunctionJobBase):
-    pass
-
-
 class RegisteredProjectFunctionJobPatch(BaseModel):
     function_class: Literal[FunctionClass.PROJECT] = FunctionClass.PROJECT
     title: str | None
@@ -221,10 +212,6 @@ class SolverFunctionJob(FunctionJobBase):
     job_creation_task_id: TaskID | None
 
 
-class RegisteredSolverFunctionJob(SolverFunctionJob, RegisteredFunctionJobBase):
-    pass
-
-
 class RegisteredSolverFunctionJobPatch(BaseModel):
     function_class: Literal[FunctionClass.SOLVER] = FunctionClass.SOLVER
     title: str | None
@@ -239,10 +226,6 @@ class PythonCodeFunctionJob(FunctionJobBase):
     function_class: Literal[FunctionClass.PYTHON_CODE] = FunctionClass.PYTHON_CODE
 
 
-class RegisteredPythonCodeFunctionJob(PythonCodeFunctionJob, RegisteredFunctionJobBase):
-    pass
-
-
 class RegisteredPythonCodeFunctionJobPatch(BaseModel):
     function_class: Literal[FunctionClass.PYTHON_CODE] = FunctionClass.PYTHON_CODE
     title: str | None
@@ -256,6 +239,24 @@ class RegisteredPythonCodeFunctionJobPatch(BaseModel):
     Field(discriminator="function_class"),
 ]
 
+
+class RegisteredFunctionJobBase(FunctionJobBase):
+    uid: FunctionJobID
+    created_at: datetime.datetime
+
+
+class RegisteredProjectFunctionJob(ProjectFunctionJob, RegisteredFunctionJobBase):
+    pass
+
+
+class RegisteredSolverFunctionJob(SolverFunctionJob, RegisteredFunctionJobBase):
+    pass
+
+
+class RegisteredPythonCodeFunctionJob(PythonCodeFunctionJob, RegisteredFunctionJobBase):
+    pass
+
+
 RegisteredFunctionJob: TypeAlias = Annotated[
     RegisteredProjectFunctionJob
     | RegisteredPythonCodeFunctionJob
@@ -275,6 +276,36 @@ class FunctionJobStatus(BaseModel):
     status: str
 
 
+class RegisteredFunctionJobWithStatusBase(RegisteredFunctionJobBase, FunctionJobBase):
+    status: FunctionJobStatus
+
+
+class RegisteredProjectFunctionJobWithStatus(
+    RegisteredProjectFunctionJob, RegisteredFunctionJobWithStatusBase
+):
+    pass
+
+
+class RegisteredSolverFunctionJobWithStatus(
+    RegisteredSolverFunctionJob, RegisteredFunctionJobWithStatusBase
+):
+    pass
+
+
+class RegisteredPythonCodeFunctionJobWithStatus(
+    RegisteredPythonCodeFunctionJob, RegisteredFunctionJobWithStatusBase
+):
+    pass
+
+
+RegisteredFunctionJobWithStatus: TypeAlias = Annotated[
+    RegisteredProjectFunctionJobWithStatus
+    | RegisteredPythonCodeFunctionJobWithStatus
+    | RegisteredSolverFunctionJobWithStatus,
+    Field(discriminator="function_class"),
+]
+
+
 class FunctionJobCollection(BaseModel):
     """Model for a collection of function jobs"""
 
@@ -309,6 +340,12 @@ class RegisteredFunctionJobDB(FunctionJobDB):
     created: datetime.datetime
 
 
+class RegisteredFunctionJobWithStatusDB(FunctionJobDB):
+    uuid: FunctionJobID
+    created: datetime.datetime
+    status: str
+
+
 class FunctionDB(BaseModel):
     function_class: FunctionClass
     title: str = ""

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

@@ -23,6 +23,7 @@
     FunctionUserAccessRights,
     FunctionUserApiAccessRights,
     RegisteredFunctionJobPatch,
+    RegisteredFunctionJobWithStatus,
 )
 from models_library.products import ProductName
 from models_library.rabbitmq_basic_types import RPCMethodName
@@ -192,6 +193,40 @@ async def list_function_jobs(
     ).validate_python(result)
 
 
+@log_decorator(_logger, level=logging.DEBUG)
+async def list_function_jobs_with_status(
+    rabbitmq_rpc_client: RabbitMQRPCClient,
+    *,
+    user_id: UserID,
+    product_name: ProductName,
+    pagination_offset: int,
+    pagination_limit: int,
+    filter_by_function_id: FunctionID | None = None,
+    filter_by_function_job_ids: list[FunctionJobID] | None = None,
+    filter_by_function_job_collection_id: FunctionJobCollectionID | None = None,
+) -> tuple[
+    list[RegisteredFunctionJobWithStatus],
+    PageMetaInfoLimitOffset,
+]:
+    result = await rabbitmq_rpc_client.request(
+        WEBSERVER_RPC_NAMESPACE,
+        TypeAdapter(RPCMethodName).validate_python("list_function_jobs_with_status"),
+        user_id=user_id,
+        product_name=product_name,
+        pagination_offset=pagination_offset,
+        pagination_limit=pagination_limit,
+        filter_by_function_id=filter_by_function_id,
+        filter_by_function_job_ids=filter_by_function_job_ids,
+        filter_by_function_job_collection_id=filter_by_function_job_collection_id,
+    )
+    return TypeAdapter(
+        tuple[
+            list[RegisteredFunctionJobWithStatus],
+            PageMetaInfoLimitOffset,
+        ]
+    ).validate_python(result)
+
+
 @log_decorator(_logger, level=logging.DEBUG)
 async def list_function_job_collections(
     rabbitmq_rpc_client: RabbitMQRPCClient,

packages/simcore-sdk/src/simcore_sdk/node_ports_v2/__init__.py

@@ -41,9 +41,9 @@ async def ports(
 
 __all__ = (
     "DBManager",
-    "exceptions",
     "FileLinkType",
     "Nodeports",
     "Port",
+    "exceptions",
     "ports",
 )

services/api-server/VERSION

@@ -1 +1 @@
-0.12.0
+0.13.0