Skip to content

Commit b96a36d

Browse files
committed
renames
1 parent e8ced39 commit b96a36d

File tree

13 files changed

+71
-64
lines changed

13 files changed

+71
-64
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,16 @@ class MetadataFilterItem(BaseModel):
1515
pattern: str
1616

1717

18-
class ListProjectsMarkedAsJobRpcFilter(BaseModel):
19-
"""Filter model for the list_projects_marked_as_jobs RPC.
18+
class ListProjectsMarkedAsJobRpcFilters(BaseModel):
19+
"""Filters model for the list_projects_marked_as_jobs RPC.
2020
21-
NOTE: Filter models are used to validate all possible filters in an API early on,
21+
NOTE: Filters models are used to validate all possible filters in an API early on,
2222
particularly to ensure compatibility and prevent conflicts between different filters.
2323
"""
2424

2525
job_parent_resource_name_prefix: str | None = None
2626

27-
any_of_metadata: Annotated[
27+
any_custom_metadata: Annotated[
2828
list[MetadataFilterItem] | None,
2929
Field(description="Searchs for matches of any of the custom metadata fields"),
3030
] = None

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
from models_library.projects import ProjectID
1010
from models_library.rest_pagination import PageOffsetInt
1111
from models_library.rpc.webserver.projects import (
12-
ListProjectsMarkedAsJobRpcFilter,
12+
ListProjectsMarkedAsJobRpcFilters,
1313
PageRpcProjectJobRpcGet,
1414
ProjectJobRpcGet,
1515
)
@@ -57,7 +57,7 @@ async def list_projects_marked_as_jobs(
5757
# pagination
5858
offset: PageOffsetInt = 0,
5959
limit: PageLimitInt = DEFAULT_NUMBER_OF_ITEMS_PER_PAGE,
60-
filters: ListProjectsMarkedAsJobRpcFilter | None = None,
60+
filters: ListProjectsMarkedAsJobRpcFilters | None = None,
6161
) -> PageRpcProjectJobRpcGet:
6262
assert rpc_client
6363
assert product_name

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
from models_library.rabbitmq_basic_types import RPCMethodName
88
from models_library.rest_pagination import PageOffsetInt
99
from models_library.rpc.webserver.projects import (
10-
ListProjectsMarkedAsJobRpcFilter,
10+
ListProjectsMarkedAsJobRpcFilters,
1111
PageRpcProjectJobRpcGet,
1212
)
1313
from models_library.rpc_pagination import (
@@ -54,7 +54,7 @@ async def list_projects_marked_as_jobs(
5454
# pagination
5555
offset: PageOffsetInt = 0,
5656
limit: PageLimitInt = DEFAULT_NUMBER_OF_ITEMS_PER_PAGE,
57-
filters: ListProjectsMarkedAsJobRpcFilter | None = None,
57+
filters: ListProjectsMarkedAsJobRpcFilters | None = None,
5858
) -> PageRpcProjectJobRpcGet:
5959
result = await rpc_client.request(
6060
WEBSERVER_RPC_NAMESPACE,

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ async def list_jobs(
4141
self,
4242
job_parent_resource_name: str,
4343
*,
44-
filter_by_job_custom_metadata: list[dict[str, str]] | None = None,
44+
filter_any_custom_metadata: list[dict[str, str]] | None = None,
4545
pagination_offset: PageOffsetInt = 0,
4646
pagination_limit: PageLimitInt = MAXIMUM_NUMBER_OF_ITEMS_PER_PAGE - 1,
4747
) -> tuple[list[Job], PageMetaInfoLimitOffset]:
@@ -54,7 +54,7 @@ async def list_jobs(
5454
pagination_offset=pagination_offset,
5555
pagination_limit=pagination_limit,
5656
filter_by_job_parent_resource_name_prefix=job_parent_resource_name,
57-
filter_by_any_custom_metadata=filter_by_job_custom_metadata,
57+
filter_any_custom_metadata=filter_any_custom_metadata,
5858
)
5959

6060
# 2. Convert projects to jobs

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ async def list_jobs(
9292
*,
9393
filter_by_solver_key: SolverKeyId | None = None,
9494
filter_by_solver_version: VersionStr | None = None,
95-
filter_by_job_custom_metadata: list[dict[str, str]] | None = None,
95+
filter_any_custom_metadata: list[dict[str, str]] | None = None,
9696
pagination_offset: PageOffsetInt = 0,
9797
pagination_limit: PageLimitInt = DEFAULT_PAGINATION_LIMIT,
9898
) -> tuple[list[Job], PageMetaInfoLimitOffset]:
@@ -115,7 +115,7 @@ async def list_jobs(
115115
# 2. list jobs under job_parent_resource_name
116116
return await self.job_service.list_jobs(
117117
job_parent_resource_name=job_parent_resource_name,
118-
filter_by_job_custom_metadata=filter_by_job_custom_metadata,
118+
filter_any_custom_metadata=filter_any_custom_metadata,
119119
pagination_offset=pagination_offset,
120120
pagination_limit=pagination_limit,
121121
)

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@
134134
FMSG_CHANGELOG_NEW_IN_VERSION.format("0.8"),
135135
],
136136
),
137-
include_in_schema=True, # TO BE RELEASED in 0.8
137+
include_in_schema=False, # TO BE RELEASED in 0.8
138138
)
139139
async def list_all_solvers_jobs(
140140
page_params: Annotated[PaginationParams, Depends()],
@@ -146,7 +146,7 @@ async def list_all_solvers_jobs(
146146
):
147147

148148
jobs, meta = await solver_service.list_jobs(
149-
filter_by_job_custom_metadata=(
149+
filter_any_custom_metadata=(
150150
[
151151
{filter_metadata.name: filter_metadata.pattern}
152152
for filter_metadata in filter_job_metadata_params.any

services/api-server/src/simcore_service_api_server/models/schemas/jobs_filters.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ class JobMetadataFilter(BaseModel):
2222
list[MetadataFilterItem],
2323
Field(description="Matches any custom metadata field (OR logic)"),
2424
]
25+
# NOTE: AND logic shall be implemented as `all: list[MetadataFilterItem] | None = None`
2526

2627
@staticmethod
2728
def _update_json_schema_extra(schema: JsonDict) -> None:

services/api-server/src/simcore_service_api_server/services_rpc/wb_api_server.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
)
3636
from models_library.rpc.webserver.projects import ListProjectsMarkedAsJobRpcFilter
3737
from models_library.rpc.webserver.projects import (
38-
ListProjectsMarkedAsJobRpcFilter,
38+
ListProjectsMarkedAsJobRpcFilters,
3939
MetadataFilterItem,
4040
)
4141
from models_library.services_types import ServiceRunID
@@ -251,16 +251,16 @@ async def list_projects_marked_as_jobs(
251251
pagination_offset: int = 0,
252252
pagination_limit: int = 50,
253253
filter_by_job_parent_resource_name_prefix: str | None,
254-
filter_by_any_custom_metadata: list[dict[str, str]] | None,
254+
filter_any_custom_metadata: list[dict[str, str]] | None,
255255
):
256-
filters = ListProjectsMarkedAsJobRpcFilter(
256+
filters = ListProjectsMarkedAsJobRpcFilters(
257257
job_parent_resource_name_prefix=filter_by_job_parent_resource_name_prefix,
258-
any_of_metadata=(
258+
any_custom_metadata=(
259259
[
260260
MetadataFilterItem(name=key, pattern=value)
261-
for key, value in filter_by_any_custom_metadata
261+
for key, value in filter_any_custom_metadata
262262
]
263-
if filter_by_any_custom_metadata
263+
if filter_any_custom_metadata
264264
else None
265265
),
266266
)

services/web/server/src/simcore_service_webserver/projects/_controller/projects_rpc.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
from models_library.projects import ProjectID
55
from models_library.rest_pagination import PageLimitInt, PageOffsetInt
66
from models_library.rpc.webserver.projects import (
7-
ListProjectsMarkedAsJobRpcFilter,
7+
ListProjectsMarkedAsJobRpcFilters,
88
PageRpcProjectJobRpcGet,
99
ProjectJobRpcGet,
1010
)
@@ -66,24 +66,24 @@ async def list_projects_marked_as_jobs(
6666
# pagination
6767
offset: PageOffsetInt,
6868
limit: PageLimitInt,
69-
filters: ListProjectsMarkedAsJobRpcFilter | None = None,
69+
filters: ListProjectsMarkedAsJobRpcFilters | None = None,
7070
) -> PageRpcProjectJobRpcGet:
7171

7272
total, projects = await _jobs_service.list_my_projects_marked_as_jobs(
7373
app,
7474
product_name=product_name,
7575
user_id=user_id,
76-
offset=offset,
77-
limit=limit,
76+
pagination_offset=offset,
77+
pagination_limit=limit,
7878
filter_by_job_parent_resource_name_prefix=(
7979
filters.job_parent_resource_name_prefix if filters else None
8080
),
81-
filter_by_any_custom_metadata=(
81+
filter_any_custom_metadata=(
8282
[
8383
{custom_metadata.name: custom_metadata.pattern}
84-
for custom_metadata in filters.any_of_metadata
84+
for custom_metadata in filters.any_custom_metadata
8585
]
86-
if filters and filters.any_of_metadata
86+
if filters and filters.any_custom_metadata
8787
else None
8888
),
8989
)

services/web/server/src/simcore_service_webserver/projects/_jobs_repository.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -37,18 +37,18 @@ def _apply_job_parent_resource_name_filter(
3737
return query.where(projects_to_jobs.c.job_parent_resource_name.like(f"{prefix}%"))
3838

3939

40-
def _apply_metadata_filter(
41-
query: sa.sql.Select, any_of_metadata_fields: list[dict[str, str]]
40+
def _apply_custom_metadata_filter(
41+
query: sa.sql.Select, any_metadata_fields: list[dict[str, str]]
4242
) -> sa.sql.Select:
4343
"""Apply metadata filters to query.
4444
4545
For PostgreSQL JSONB fields, we need to extract the text value using ->> operator
4646
before applying string comparison operators like ILIKE.
4747
"""
48-
assert any_of_metadata_fields # nosec
48+
assert any_metadata_fields # nosec
4949

5050
expressions = []
51-
for field in any_of_metadata_fields:
51+
for field in any_metadata_fields:
5252
for key, pattern in field.items():
5353
# Use ->> operator to extract the text value from JSONB
5454
# Then apply ILIKE for case-insensitive pattern matching
@@ -92,10 +92,10 @@ async def list_projects_marked_as_jobs(
9292
*,
9393
product_name: ProductName,
9494
user_id: UserID,
95-
pagination_offset: int = 0,
96-
pagination_limit: int = 10,
95+
pagination_offset: int,
96+
pagination_limit: int,
9797
filter_by_job_parent_resource_name_prefix: str | None = None,
98-
filter_by_any_custom_metadata: list[dict[str, str]] | None = None,
98+
filter_any_custom_metadata: list[dict[str, str]] | None = None,
9999
) -> tuple[int, list[ProjectJobDBGet]]:
100100
"""Lists projects marked as jobs for a specific user and product
101101
@@ -161,9 +161,9 @@ async def list_projects_marked_as_jobs(
161161
access_query, filter_by_job_parent_resource_name_prefix
162162
)
163163

164-
if filter_by_any_custom_metadata:
165-
access_query = _apply_metadata_filter(
166-
access_query, filter_by_any_custom_metadata
164+
if filter_any_custom_metadata:
165+
access_query = _apply_custom_metadata_filter(
166+
access_query, filter_any_custom_metadata
167167
)
168168

169169
# Step 4. Convert access_query to a subquery

0 commit comments

Comments
 (0)