@sanderegg review: improve names and drop comments

Author: pcrespov

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

@@ -38,22 +38,22 @@ class JobService:
     user_id: UserID
     product_name: ProductName
 
-    async def list_jobs_by_resource_prefix(
+    async def list_jobs(
         self,
         *,
-        job_parent_resource_name_prefix: str,
-        offset: PageOffsetInt = 0,
-        limit: PageLimitInt = MAXIMUM_NUMBER_OF_ITEMS_PER_PAGE - 1,
+        filter_by_job_parent_resource_name_prefix: str,
+        pagination_offset: PageOffsetInt = 0,
+        pagination_limit: PageLimitInt = MAXIMUM_NUMBER_OF_ITEMS_PER_PAGE - 1,
     ) -> tuple[list[Job], PageMetaInfoLimitOffset]:
         """Lists all jobs for a user with pagination based on resource name prefix"""
 
         # 1. List projects marked as jobs
         projects_page = await self.web_rpc_client.list_projects_marked_as_jobs(
             product_name=self.product_name,
             user_id=self.user_id,
-            offset=offset,
-            limit=limit,
-            job_parent_resource_name_prefix=job_parent_resource_name_prefix,
+            offset=pagination_offset,
+            limit=pagination_limit,
+            job_parent_resource_name_prefix=filter_by_job_parent_resource_name_prefix,
         )
 
         # 2. Convert projects to jobs

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

@@ -31,12 +31,12 @@ async def get_program(
     async def list_latest_programs(
         self,
         *,
-        offset: NonNegativeInt,
-        limit: PositiveInt,
+        pagination_offset: NonNegativeInt,
+        pagination_limit: PositiveInt,
     ) -> tuple[list[Program], PageMetaInfoLimitOffset]:
         page, page_meta = await self.catalog_service.list_latest_releases(
-            offset=offset,
-            limit=limit,
+            offset=pagination_offset,
+            limit=pagination_limit,
             filters=ServiceListFilters(service_type=ServiceType.DYNAMIC),
         )
 

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

@@ -83,34 +83,32 @@ async def get_latest_release(
     async def list_jobs(
         self,
         *,
-        # filters
-        solver_key: SolverKeyId | None = None,
-        solver_version: VersionStr | None = None,
-        # pagination
-        offset: PageOffsetInt = 0,
-        limit: PageLimitInt = DEFAULT_PAGINATION_LIMIT,
+        filter_by_solver_key: SolverKeyId | None = None,
+        filter_by_solver_version: VersionStr | None = None,
+        pagination_offset: PageOffsetInt = 0,
+        pagination_limit: PageLimitInt = DEFAULT_PAGINATION_LIMIT,
     ) -> tuple[list[Job], PageMetaInfoLimitOffset]:
         """Lists all solver jobs for a user with pagination"""
 
         # 1. Compose job parent resource name prefix
         collection_or_resource_ids = [
             "solvers",  # solver_id, "releases", solver_version, "jobs",
         ]
-        if solver_key:
-            collection_or_resource_ids.append(solver_key)
-            if solver_version:
+        if filter_by_solver_key:
+            collection_or_resource_ids.append(filter_by_solver_key)
+            if filter_by_solver_version:
                 collection_or_resource_ids.append("releases")
-                collection_or_resource_ids.append(solver_version)
-        elif solver_version:
+                collection_or_resource_ids.append(filter_by_solver_version)
+        elif filter_by_solver_version:
             raise SolverServiceListJobsFiltersError
 
         job_parent_resource_name = compose_resource_name(*collection_or_resource_ids)
 
         # 2. list jobs under job_parent_resource_name
-        return await self.job_service.list_jobs_by_resource_prefix(
-            offset=offset,
-            limit=limit,
-            job_parent_resource_name_prefix=job_parent_resource_name,
+        return await self.job_service.list_jobs(
+            pagination_offset=pagination_offset,
+            pagination_limit=pagination_limit,
+            filter_by_job_parent_resource_name_prefix=job_parent_resource_name,
         )
 
     async def solver_release_history(

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

@@ -51,8 +51,8 @@ async def list_jobs(
         job_parent_resource_name = compose_resource_name(*collection_or_resource_ids)
 
         # 2. list jobs under job_parent_resource_name
-        return await self.job_service.list_jobs_by_resource_prefix(
-            offset=pagination_offset,
-            limit=pagination_limit,
-            job_parent_resource_name_prefix=job_parent_resource_name,
+        return await self.job_service.list_jobs(
+            pagination_offset=pagination_offset,
+            pagination_limit=pagination_limit,
+            filter_by_job_parent_resource_name_prefix=job_parent_resource_name,
         )

services/api-server/src/simcore_service_api_server/api/routes/programs.py

@@ -55,8 +55,8 @@ async def list_programs(
     page_params: Annotated[PaginationParams, Depends()],
 ):
     programs, page_meta = await program_service.list_latest_programs(
-        offset=page_params.offset,
-        limit=page_params.limit,
+        pagination_offset=page_params.offset,
+        pagination_limit=page_params.limit,
     )
     page_params.limit = page_meta.limit
     page_params.offset = page_meta.offset

services/api-server/src/simcore_service_api_server/api/routes/solvers_jobs_getters.py

@@ -139,8 +139,8 @@ async def list_all_solvers_jobs(
 ):
 
     jobs, meta = await solver_service.list_jobs(
-        offset=page_params.offset,
-        limit=page_params.limit,
+        pagination_offset=page_params.offset,
+        pagination_limit=page_params.limit,
     )
 
     for job in jobs:

services/api-server/tests/unit/service/test_service_jobs.py

@@ -15,8 +15,8 @@ async def test_list_jobs_by_resource_prefix(
     job_service: JobService,
 ):
     # Test with default pagination parameters
-    jobs, page_meta = await job_service.list_jobs_by_resource_prefix(
-        job_parent_resource_name_prefix="solvers/some-solver"
+    jobs, page_meta = await job_service.list_jobs(
+        filter_by_job_parent_resource_name_prefix="solvers/some-solver"
     )
 
     assert isinstance(jobs, list)