Feat/migrate get jobs client methods #1695
Conversation
There was a problem hiding this comment.
Good job! this is nice.
Since I was working in the files migration in parallel, naturally we didn't developed same solution. I have some lines to discuss.
If you have some time, take a look to the PR and review it because you probably have some comments for me :)
gateway/api/repositories/jobs.py
Outdated
| def __init__( # pylint: disable=too-many-positional-arguments | ||
| self, | ||
| user, | ||
| limit: Optional[int], | ||
| offset: int = 0, | ||
| type_filter: Optional[TypeFilter] = None, | ||
| status: Optional[str] = None, | ||
| created_after: Optional[datetime] = None, | ||
| function_name: Optional[str] = None, | ||
| ): | ||
| self.user = user | ||
| self.limit = limit | ||
| self.offset = offset | ||
| self.type_filter = type_filter | ||
| self.status = status | ||
| self.created_after = created_after | ||
| self.function_name = function_name |
There was a problem hiding this comment.
I have two comments here:
- To remove the "too many positional arguments" maybe you can use the
JobRepository>JobFilterdataclass. I think it will also be more readable. - I was migrating the
filesendpoint and I put the args in the execute instead of the init. I think it is good to have consensus on this. In my opinion, most of this parameters are not a "permanent" state, are more related with the action. Also it simplifies the code, we don't have to set object variables, just use them.
What do you think?
| class ProviderNotFoundException(Exception): | ||
| """Provider not found or access denied.""" | ||
|
|
||
|
|
||
| class FunctionNotFoundException(Exception): | ||
| """Function not found or access denied.""" | ||
|
|
There was a problem hiding this comment.
In the files migration i created a generic NotFoundException in the domain folder: https://github.com/Qiskit/qiskit-serverless/pull/1696/files#diff-e6da6866795b4c157d9b9e887eb27622f036a9dc512d30e5097a301df1d5001c
Also I created an additional decorator to quickly manage the possible NotFoundExceptions (and other that can be created later) and create the corresponding Response. The only cons is that you have to set the message when you create the exception to inform about the issue.
| try: | ||
| jobs, total = GetProviderJobsUseCase(**input_data).execute() | ||
| except ProviderNotFoundException: | ||
| return Response( | ||
| {"message": f"Provider {input_data['provider']} doesn't exist."}, | ||
| status=status.HTTP_404_NOT_FOUND, | ||
| ) | ||
| except FunctionNotFoundException: | ||
| return Response( | ||
| { | ||
| "message": f"Qiskit Function {input_data['provider']}/{input_data['function_name']} doesn't exist." # pylint: disable=line-too-long | ||
| }, | ||
| status=status.HTTP_404_NOT_FOUND, | ||
| ) |
There was a problem hiding this comment.
In the files migration i created a generic NotFoundException in the domain folder: https://github.com/Qiskit/qiskit-serverless/pull/1696/files#diff-e6da6866795b4c157d9b9e887eb27622f036a9dc512d30e5097a301df1d5001c
Also I created an additional decorator to quickly manage the possible NotFoundExceptions (and other that can be created later) and create the corresponding Response. The only cons is that you have to set the message when you create the exception to inform about the issue.
| def serialize_input(request): | ||
| """Parse and validate query parameters from the request.""" | ||
| user = request.user | ||
|
|
||
| limit = parse_positive_int( | ||
| request.query_params.get("limit"), settings.REST_FRAMEWORK["PAGE_SIZE"] | ||
| ) | ||
| offset = parse_positive_int(request.query_params.get("offset"), 0) | ||
|
|
||
| type_filter = None | ||
| type_param = request.query_params.get("filter") | ||
| if type_param: | ||
| try: | ||
| type_filter = TypeFilter(type_param) | ||
| except ValueError as exc: | ||
| raise ValueError( | ||
| f"Invalid type filter. Must be one of: {', '.join([e.value for e in TypeFilter])}" | ||
| ) from exc | ||
|
|
||
| status_filter = request.query_params.get("status") | ||
|
|
||
| created_after = None | ||
| created_after_param = request.query_params.get("created_after") | ||
| if created_after_param: | ||
| created_after = parse_datetime(created_after_param) | ||
| if created_after is None: | ||
| raise ValueError( | ||
| "Invalid created_after format. Use ISO 8601 format (e.g., '2024-01-01T00:00:00Z')" | ||
| ) | ||
|
|
||
| function_name = request.query_params.get("function") | ||
|
|
||
| return { | ||
| "user": user, | ||
| "limit": limit, | ||
| "offset": offset, | ||
| "type_filter": type_filter, | ||
| "status": status_filter, | ||
| "created_after": created_after, | ||
| "function_name": function_name, | ||
| } |
There was a problem hiding this comment.
I think this is a bit complex to read. Maybe a Serializer class fits better in here.
| def serialize_input(request): | ||
| """ | ||
| Prepare the input for the end-point with validation | ||
| """ | ||
| user = request.user | ||
|
|
||
| limit = parse_positive_int( | ||
| request.query_params.get("limit"), settings.REST_FRAMEWORK["PAGE_SIZE"] | ||
| ) | ||
| offset = parse_positive_int(request.query_params.get("offset"), 0) | ||
|
|
||
| status_filter = request.query_params.get("status") | ||
|
|
||
| created_after = None | ||
| created_after_param = request.query_params.get("created_after") | ||
| if created_after_param: | ||
| created_after = parse_datetime(created_after_param) | ||
| if created_after is None: | ||
| raise ValueError( | ||
| "Invalid created_after format. Use ISO 8601 format (e.g., '2024-01-01T00:00:00Z')" | ||
| ) | ||
|
|
||
| provider = request.query_params.get("provider") | ||
| function_name = request.query_params.get("function") | ||
| if not provider or not function_name: | ||
| raise ValueError("Qiskit Function title and Provider name are mandatory") | ||
|
|
||
| return { | ||
| "user": user, | ||
| "limit": limit, | ||
| "offset": offset, | ||
| "status": status_filter, | ||
| "created_after": created_after, | ||
| "provider": provider, | ||
| "function_name": function_name, | ||
| } |
There was a problem hiding this comment.
Same here, maybe we can try with a Serlializer class
gateway/api/v1/views/utils.py
Outdated
| @@ -46,4 +46,4 @@ | |||
| basename=v1_views.CatalogViewSet.BASE_NAME, | |||
| ) | |||
|
|
|||
| urlpatterns = router.urls + RouteRegistry.get() | |||
| urlpatterns = RouteRegistry.get() + router.urls | |||
Summary
This PR adds the new jobs and provider_jobs parameters:
Details and comments
I also added docstrings for both methods