diff --git a/swh/web/api/apiresponse.py b/swh/web/api/apiresponse.py index 783c857d..69b38970 100644 --- a/swh/web/api/apiresponse.py +++ b/swh/web/api/apiresponse.py @@ -1,191 +1,200 @@ # Copyright (C) 2017-2019 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU Affero General Public License version 3, or any later version # See top-level LICENSE file for more information import json import traceback +from typing import Any, Dict, Optional from django.utils.html import escape +from rest_framework.request import Request from rest_framework.response import Response from rest_framework.utils.encoders import JSONEncoder from swh.storage.exc import StorageAPIError, StorageDBError from swh.web.api import utils from swh.web.common.exc import BadInputExc, ForbiddenExc, LargePayloadExc, NotFoundExc from swh.web.common.utils import gen_path_info, shorten_path from swh.web.config import get_config -def compute_link_header(rv, options): +def compute_link_header(rv: Dict[str, Any], options: Dict[str, Any]) -> Dict[str, Any]: """Add Link header in returned value results. Args: request: a DRF Request object rv (dict): dictionary with keys: - headers: potential headers with 'link-next' and 'link-prev' keys - results: containing the result to return options (dict): the initial dict to update with result if any Returns: dict: dictionary with optional keys 'link-next' and 'link-prev' """ link_headers = [] if "headers" not in rv: return {} rv_headers = rv["headers"] if "link-next" in rv_headers: link_headers.append('<%s>; rel="next"' % rv_headers["link-next"]) if "link-prev" in rv_headers: link_headers.append('<%s>; rel="previous"' % rv_headers["link-prev"]) if link_headers: link_header_str = ",".join(link_headers) headers = options.get("headers", {}) headers.update({"Link": link_header_str}) return headers return {} -def filter_by_fields(request, data): +def filter_by_fields(request: Request, data: Dict[str, Any]) -> Dict[str, Any]: """Extract a request parameter 'fields' if it exists to permit the filtering on the data dict's keys. If such field is not provided, returns the data as is. """ fields = request.query_params.get("fields") if fields: - fields = set(fields.split(",")) - data = utils.filter_field_keys(data, fields) + data = utils.filter_field_keys(data, set(fields.split(","))) return data -def transform(rv): +def transform(rv: Dict[str, Any]) -> Dict[str, Any]: """Transform an eventual returned value with multiple layer of information with only what's necessary. If the returned value rv contains the 'results' key, this is the associated value which is returned. Otherwise, return the initial dict without the potential 'headers' key. """ if "results" in rv: return rv["results"] if "headers" in rv: rv.pop("headers") return rv -def make_api_response(request, data, doc_data={}, options={}): +def make_api_response( + request: Request, + data: Dict[str, Any], + doc_data: Optional[Dict[str, Any]] = None, + options: Optional[Dict[str, Any]] = None, +) -> Response: """Generates an API response based on the requested mimetype. Args: request: a DRF Request object data: raw data to return in the API response doc_data: documentation data for HTML response options: optional data that can be used to generate the response Returns: a DRF Response a object """ + options = options or {} if data: options["headers"] = compute_link_header(data, options) data = transform(data) data = filter_by_fields(request, data) - doc_env = doc_data + doc_data = doc_data or {} headers = {} if "headers" in options: - doc_env["headers_data"] = options["headers"] + doc_data["headers_data"] = options["headers"] headers = options["headers"] # get request status code - doc_env["status_code"] = options.get("status", 200) + doc_data["status_code"] = options.get("status", 200) response_args = { - "status": doc_env["status_code"], + "status": doc_data["status_code"], "headers": headers, "content_type": request.accepted_media_type, } # when requesting HTML, typically when browsing the API through its # documented views, we need to enrich the input data with documentation # related ones and inform DRF that we request HTML template rendering if request.accepted_media_type == "text/html": - + doc_data["response_data"] = data if data: - data = json.dumps( + doc_data["response_data"] = json.dumps( data, cls=JSONEncoder, sort_keys=True, indent=4, separators=(",", ": ") ) - doc_env["response_data"] = data - doc_env["heading"] = shorten_path(str(request.path)) + + doc_data["heading"] = shorten_path(str(request.path)) # generate breadcrumbs data - if "route" in doc_env: - doc_env["endpoint_path"] = gen_path_info(doc_env["route"]) - for i in range(len(doc_env["endpoint_path"]) - 1): - doc_env["endpoint_path"][i]["path"] += "/doc/" - if not doc_env["noargs"]: - doc_env["endpoint_path"][-1]["path"] += "/doc/" - - response_args["data"] = doc_env + if "route" in doc_data: + doc_data["endpoint_path"] = gen_path_info(doc_data["route"]) + for i in range(len(doc_data["endpoint_path"]) - 1): + doc_data["endpoint_path"][i]["path"] += "/doc/" + if not doc_data["noargs"]: + doc_data["endpoint_path"][-1]["path"] += "/doc/" + + response_args["data"] = doc_data response_args["template_name"] = "api/apidoc.html" # otherwise simply return the raw data and let DRF picks # the correct renderer (JSON or YAML) else: response_args["data"] = data return Response(**response_args) -def error_response(request, error, doc_data): +def error_response( + request: Request, error: Exception, doc_data: Dict[str, Any] +) -> Response: """Private function to create a custom error response. Args: request: a DRF Request object error: the exception that caused the error doc_data: documentation data for HTML response """ error_code = 500 if isinstance(error, BadInputExc): error_code = 400 elif isinstance(error, NotFoundExc): error_code = 404 elif isinstance(error, ForbiddenExc): error_code = 403 elif isinstance(error, LargePayloadExc): error_code = 413 elif isinstance(error, StorageDBError): error_code = 503 elif isinstance(error, StorageAPIError): error_code = 503 error_opts = {"status": error_code} error_data = { "exception": error.__class__.__name__, "reason": str(error), } if request.accepted_media_type == "text/html": error_data["reason"] = escape(error_data["reason"]) if get_config()["debug"]: error_data["traceback"] = traceback.format_exc() return make_api_response(request, error_data, doc_data, options=error_opts)