fixup! fixup! WIP: Enrich UserDefinedProcesses API

Author: soxofaan

openeo_driver/backend.py

@@ -37,6 +37,7 @@
 from openeo_driver.users.oidc import OidcProvider
 from openeo_driver.util.date_math import simple_job_progress_estimation
 from openeo_driver.util.logging import just_log_exceptions
+from openeo_driver.util.pagination import PaginationRequest
 from openeo_driver.utils import read_json, dict_item, EvalEnv, extract_namedtuple_fields_from_dict, \
     get_package_versions
 
@@ -497,6 +498,7 @@ def get_job_info(self, job_id: str, user_id: str) -> BatchJobMetadata:
     def get_user_jobs(
         self,
         user_id: str,
+        #  TODO #377 migrate this to `PaginationRequest`
         limit: Optional[int] = None,
         request_parameters: Optional[dict] = None,
         # TODO #332 settle on returning just `JobListing` and eliminate other options/code paths.
@@ -692,16 +694,15 @@ def get_for_user(self, user_id: str) -> List[UserDefinedProcessMetadata]:
         List user's UDPs
         https://openeo.org/documentation/1.0/developers/api/reference.html#operation/list-custom-processes
         """
-        # TODO remove this deprecated API when unused
+        # TODO remove this deprecated API when unused (replaced by `list_for_user`)
         raise NotImplementedError
 
     def list_for_user(
         self,
         user_id: str,
-        # TODO: encapsulate limit and request_parameters in a pagination object?
-        limit: Optional[int] = None,
-        request_parameters: Optional[dict] = None,
+        pagination: Optional[PaginationRequest] = None,
     ) -> UserDefinedProcessesListing:
+        # TODO: remove this adapter implementation once `get_for_user` is removed
         udps = self.get_for_user(user_id=user_id)
         return UserDefinedProcessesListing(udps=udps)
 

openeo_driver/util/pagination.py

@@ -0,0 +1,29 @@
+import flask
+from typing import Union, Optional
+
+import dataclasses
+
+
+@dataclasses.dataclass(frozen=True)
+class PaginationRequest:
+    """
+    Representation of pagination related request parameters.
+
+    The openEO API just defines a request parameter `limit`
+    as a trigger to enable pagination.
+    Additional request parameters or URL patterns
+    to encode page numbers/offsets are not defined in the API,
+    and open for backends to choose.
+    """
+
+    limit: Union[None, int]
+    request_parameters: dict
+
+    @classmethod
+    def from_request(cls, request: flask.Request):
+        limit = request.args.get("limit", default=None, type=int)
+        request_parameters = flask.request.args.to_dict()
+        return cls(limit=limit, request_parameters=request_parameters)
+
+    def __bool__(self):
+        return self.limit is not None

openeo_driver/views.py

@@ -62,6 +62,7 @@
 from openeo_driver.users.auth import HttpAuthHandler
 from openeo_driver.util.geometry import BoundingBox, reproject_geometry
 from openeo_driver.util.logging import FlaskRequestCorrelationIdLogging, ExtraLoggingFilter
+from openeo_driver.util.pagination import PaginationRequest
 from openeo_driver.utils import EvalEnv, smart_bool, generate_unique_id, filter_supported_kwargs
 
 _log = logging.getLogger(__name__)
@@ -937,7 +938,8 @@ def list_jobs(user: User):
         # TODO: openEO API currently prescribes no pagination by default (unset limit)
         #     This is however not very scalable, so we might want to set a default limit here.
         #     Also see https://github.com/Open-EO/openeo-api/issues/550
-        limit = flask.request.args.get("limit", type=int)
+        #  TODO #377 migrate this to `PaginationRequest`
+        limit = flask.request.args.get("limit", default=None, type=int)
         request_parameters = flask.request.args
 
         # TODO #332 settle on receiving just `JobListing` here and eliminate other options/code paths.
@@ -1762,8 +1764,8 @@ def udp_get(process_graph_id: str, user: User):
     @blueprint.route('/process_graphs', methods=['GET'])
     @auth_handler.requires_bearer_auth
     def udp_list_for_user(user: User):
-        # TODO #377 pagination support
-        udps = backend_implementation.user_defined_processes.list_for_user(user_id=user.user_id)
+        pagination = PaginationRequest.from_request(request=flask.request)
+        udps = backend_implementation.user_defined_processes.list_for_user(user_id=user.user_id, pagination=pagination)
         return jsonify(udps.to_response_dict())
 
     @api_endpoint