@matusdrobuliak66 review: adds map

Author: pcrespov

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

@@ -40,11 +40,28 @@ def create_ordering_query_model_classes(
     *,
     ordering_fields: set[str],
     default: OrderBy,
+    ordering_fields_api_to_column_map: dict[str, str] | None = None,
 ) -> type[_BaseOrderQueryParams]:
+    """Factory to create an uniform model used as ordering parameters in a query
+
+    Arguments:
+        ordering_fields -- A set of valid fields that can be used for ordering.
+            These should correspond to API field names.
+        default -- The default ordering configuration to be applied if no explicit
+            ordering is provided
+
+    Keyword Arguments:
+        ordering_fields_api_to_column_map -- A mapping of API field names to
+            database column names. If provided, fields specified in the API
+            will be automatically translated to their corresponding database
+            column names for seamless integration with database queries.
     """
-    Factory to create an uniform model used as ordering parameters in a query
+    ordering_fields_api_to_column_map = ordering_fields_api_to_column_map or {}
+
+    assert set(ordering_fields_api_to_column_map.keys()).issubset(  # nosec
+        ordering_fields
+    )
 
-    """
     assert default.field in ordering_fields  # nosec
 
     msg_field_options = "|".join(sorted(ordering_fields))
@@ -60,7 +77,12 @@ def _check_if_ordering_field(cls, v):
                     f"Fields supported are {msg_field_options}."
                 )
                 raise ValueError(msg)
-            return v
+
+        @validator("field", allow_reuse=True, always=True)
+        @classmethod
+        def _post_rename_order_by_field_as_db_column(cls, v):
+            # API field name -> DB column_name
+            return ordering_fields_api_to_column_map.get(v, v)
 
     order_by_example: dict[str, Any] = OrderBy.Config.schema_extra["example"]
     order_by_example_json = json_dumps(order_by_example)

services/web/server/src/simcore_service_webserver/folders/_models.py

@@ -46,6 +46,7 @@ class FolderFilters(Filters):
         "name",
     },
     default=OrderBy(field=IDStr("modified_at"), direction=OrderDirection.DESC),
+    ordering_fields_api_to_column_map={"modified_at": "modified"},
 )
 
 
@@ -73,13 +74,6 @@ class Config:
         "workspace_id", allow_reuse=True, pre=True
     )(null_or_none_str_to_none_validator)
 
-    @validator("order_by", always=True)
-    @classmethod
-    def _post_rename_order_by_field_as_db_column(cls, v):
-        if v.field == "modified_at":  # API field
-            v.field = "modified"  # DB column
-        return v
-
 
 class FolderSearchQueryParams(
     PageQueryParameters, _FolderOrderQueryParams, FiltersQueryParameters[FolderFilters]  # type: ignore[misc, valid-type]

services/web/server/src/simcore_service_webserver/resource_usage/_service_runs_handlers.py

@@ -21,7 +21,7 @@
 from models_library.rest_pagination import Page, PageQueryParameters
 from models_library.rest_pagination_utils import paginate_data
 from models_library.wallets import WalletID
-from pydantic import Extra, Field, Json, parse_obj_as, validator
+from pydantic import Extra, Field, Json, parse_obj_as
 from servicelib.aiohttp.requests_validation import parse_request_query_parameters_as
 from servicelib.aiohttp.typing_extension import Handler
 from servicelib.mimetype_constants import MIMETYPE_APPLICATION_JSON
@@ -75,6 +75,9 @@ async def wrapper(request: web.Request) -> web.StreamResponse:
         "transaction_status",
     },
     default=OrderBy(field=IDStr("started_at"), direction=OrderDirection.DESC),
+    ordering_fields_api_to_column_map={
+        "credit_cost": "osparc_credits",
+    },
 )
 
 
@@ -91,13 +94,6 @@ class ServicesResourceUsagesReportQueryParams(
         example='{"started_at": {"from": "yyyy-mm-dd", "until": "yyyy-mm-dd"}}',
     )
 
-    @validator("order_by", always=True)
-    @classmethod
-    def _post_rename_order_by_field_as_db_column(cls, v):
-        if v.field == "credit_cost":  # API field
-            v.field = "osparc_credits"  # DB column
-        return v
-
     class Config:
         extra = Extra.forbid
 

services/web/server/src/simcore_service_webserver/workspaces/_workspaces_handlers.py

@@ -19,7 +19,7 @@
 from models_library.rest_pagination_utils import paginate_data
 from models_library.users import UserID
 from models_library.workspaces import WorkspaceID
-from pydantic import Field, parse_obj_as, validator
+from pydantic import Field, parse_obj_as
 from servicelib.aiohttp import status
 from servicelib.aiohttp.requests_validation import (
     parse_request_body_as,
@@ -81,21 +81,15 @@ class WorkspacesPathParams(StrictRequestParameters):
         "name",
     },
     default=OrderBy(field=IDStr("modified_at"), direction=OrderDirection.DESC),
+    ordering_fields_api_to_column_map={"modified_at": "modified"},
 )
 
 
 class WorkspacesListQueryParams(
     PageQueryParameters,
     WorkspacesListOrderQueryParams,  # type: ignore[misc, valid-type]
 ):
-    @validator("order_by", always=True)
-    @classmethod
-    def _post_rename_order_by_field_as_db_column(cls, v):
-        # NOTE: PC->MD this is very error-prone (e.g. w/ defaults).
-        # Rather create a map to a db interface
-        if v.field == "modified_at":  # API field
-            v.field = "modified"  # DB column
-        return v
+    ...
 
 
 @routes.post(f"/{VTAG}/workspaces", name="create_workspace")