Add more function job filters 🎨

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

@@ -160,6 +160,8 @@ async def list_function_jobs(
     pagination_limit: int,
     pagination_offset: 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[RegisteredFunctionJob], PageMetaInfoLimitOffset]:
     result: tuple[list[RegisteredFunctionJob], PageMetaInfoLimitOffset] = (
         await rabbitmq_rpc_client.request(
@@ -170,6 +172,8 @@ async def list_function_jobs(
             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(

services/api-server/openapi.json

@@ -5305,7 +5305,7 @@
           "function_jobs"
         ],
         "summary": "List Function Jobs",
-        "description": "List function jobs\n\nNew in *version 0.8.0*\n\nAdded in *version 0.9.0*: add `created_at` field in the registered function-related objects",
+        "description": "List function jobs\n\nNew in *version 0.8.0*\n\nAdded in *version 0.9.0*: add `created_at` field in the registered function-related objects\n\nAdded in *version 0.10*: add filter by `function_id`, `function_job_ids` and `function_job_collection_id`",
         "operationId": "list_function_jobs",
         "security": [
           {
@@ -5335,6 +5335,66 @@
               "default": 0,
               "title": "Offset"
             }
+          },
+          {
+            "name": "function_id",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "anyOf": [
+                {
+                  "type": "string",
+                  "format": "uuid"
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "description": "Filter by function ID pattern",
+              "title": "Function Id"
+            },
+            "description": "Filter by function ID pattern"
+          },
+          {
+            "name": "function_job_ids",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "anyOf": [
+                {
+                  "type": "array",
+                  "items": {
+                    "type": "string",
+                    "format": "uuid"
+                  }
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "description": "Filter by function job IDs",
+              "title": "Function Job Ids"
+            },
+            "description": "Filter by function job IDs"
+          },
+          {
+            "name": "function_job_collection_id",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "anyOf": [
+                {
+                  "type": "string",
+                  "format": "uuid"
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "description": "Filter by function job collection ID",
+              "title": "Function Job Collection Id"
+            },
+            "description": "Filter by function job collection ID"
           }
         ],
         "responses": {
@@ -6082,6 +6142,169 @@
         }
       }
     },
+    "/v0/function_job_collections/{function_job_collection_id}/function_jobs/page": {
+      "get": {
+        "tags": [
+          "function_job_collections"
+        ],
+        "summary": "Function Job Collection List Function Jobs Page",
+        "description": "Get the function jobs in function job collection\n\nNew in *version 0.10*",
+        "operationId": "function_job_collection_list_function_jobs_page",
+        "security": [
+          {
+            "HTTPBasic": []
+          }
+        ],
+        "parameters": [
+          {
+            "name": "function_job_collection_id",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "format": "uuid",
+              "title": "Function Job Collection Id"
+            }
+          },
+          {
+            "name": "limit",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "integer",
+              "maximum": 50,
+              "minimum": 1,
+              "default": 20,
+              "title": "Limit"
+            }
+          },
+          {
+            "name": "offset",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "integer",
+              "minimum": 0,
+              "default": 0,
+              "title": "Offset"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Page_Annotated_Union_RegisteredProjectFunctionJob__RegisteredPythonCodeFunctionJob__RegisteredSolverFunctionJob___FieldInfo_annotation_NoneType__required_True__discriminator__function_class____"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Function job collection not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorGet"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Validation Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPValidationError"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v0/function_job_collections/{function_job_collection_id}/function_jobs/list": {
+      "get": {
+        "tags": [
+          "function_job_collections"
+        ],
+        "summary": "Function Job Collection List Function Jobs List",
+        "description": "Get the function jobs in function job collection\n\nNew in *version 0.8.0*",
+        "operationId": "function_job_collection_list_function_jobs_list",
+        "security": [
+          {
+            "HTTPBasic": []
+          }
+        ],
+        "parameters": [
+          {
+            "name": "function_job_collection_id",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "format": "uuid",
+              "title": "Function Job Collection Id"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "oneOf": [
+                      {
+                        "$ref": "#/components/schemas/RegisteredProjectFunctionJob"
+                      },
+                      {
+                        "$ref": "#/components/schemas/RegisteredPythonCodeFunctionJob"
+                      },
+                      {
+                        "$ref": "#/components/schemas/RegisteredSolverFunctionJob"
+                      }
+                    ],
+                    "discriminator": {
+                      "propertyName": "function_class",
+                      "mapping": {
+                        "PROJECT": "#/components/schemas/RegisteredProjectFunctionJob",
+                        "PYTHON_CODE": "#/components/schemas/RegisteredPythonCodeFunctionJob",
+                        "SOLVER": "#/components/schemas/RegisteredSolverFunctionJob"
+                      }
+                    }
+                  },
+                  "title": "Response Function Job Collection List Function Jobs List V0 Function Job Collections  Function Job Collection Id  Function Jobs List Get"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Function job collection not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorGet"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Validation Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPValidationError"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/v0/function_job_collections/{function_job_collection_id}/status": {
       "get": {
         "tags": [

services/api-server/src/simcore_service_api_server/_service_function_jobs.py

@@ -0,0 +1,45 @@
+from dataclasses import dataclass
+
+from common_library.exclude import as_dict_exclude_none
+from models_library.functions import (
+    FunctionID,
+    FunctionJobCollectionID,
+    FunctionJobID,
+    RegisteredFunctionJob,
+)
+from models_library.products import ProductName
+from models_library.rest_pagination import PageMetaInfoLimitOffset, PageOffsetInt
+from models_library.rpc_pagination import PageLimitInt
+from models_library.users import UserID
+from simcore_service_api_server.services_rpc.wb_api_server import WbApiRpcClient
+
+
+@dataclass(frozen=True, kw_only=True)
+class FunctionJobService:
+    user_id: UserID
+    product_name: ProductName
+    _web_rpc_client: WbApiRpcClient
+
+    async def list_function_jobs(
+        self,
+        *,
+        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,
+        pagination_offset: PageOffsetInt | None = None,
+        pagination_limit: PageLimitInt | None = None,
+    ) -> tuple[list[RegisteredFunctionJob], PageMetaInfoLimitOffset]:
+        """Lists all function jobs for a user with pagination"""
+
+        pagination_kwargs = as_dict_exclude_none(
+            pagination_offset=pagination_offset, pagination_limit=pagination_limit
+        )
+
+        return await self._web_rpc_client.list_function_jobs(
+            user_id=self.user_id,
+            product_name=self.product_name,
+            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,
+            **pagination_kwargs,
+        )

services/api-server/src/simcore_service_api_server/_service_functions.py

@@ -0,0 +1,40 @@
+from dataclasses import dataclass
+
+from common_library.exclude import as_dict_exclude_none
+from models_library.functions import RegisteredFunction
+from models_library.products import ProductName
+from models_library.rest_pagination import (
+    MAXIMUM_NUMBER_OF_ITEMS_PER_PAGE,
+    PageMetaInfoLimitOffset,
+    PageOffsetInt,
+)
+from models_library.rpc_pagination import PageLimitInt
+from models_library.users import UserID
+from simcore_service_api_server.services_rpc.wb_api_server import WbApiRpcClient
+
+DEFAULT_PAGINATION_LIMIT = MAXIMUM_NUMBER_OF_ITEMS_PER_PAGE - 1
+
+
+@dataclass(frozen=True, kw_only=True)
+class FunctionService:
+    user_id: UserID
+    product_name: ProductName
+    _web_rpc_client: WbApiRpcClient
+
+    async def list_functions(
+        self,
+        *,
+        pagination_offset: PageOffsetInt | None = None,
+        pagination_limit: PageLimitInt | None = None,
+    ) -> tuple[list[RegisteredFunction], PageMetaInfoLimitOffset]:
+        """Lists all functions for a user with pagination"""
+
+        pagination_kwargs = as_dict_exclude_none(
+            pagination_offset=pagination_offset, pagination_limit=pagination_limit
+        )
+
+        return await self._web_rpc_client.list_functions(
+            user_id=self.user_id,
+            product_name=self.product_name,
+            **pagination_kwargs,
+        )