Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve handling of API errors #11343

Merged
merged 2 commits into from
Mar 15, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
canonicalwebteam.flask-base==0.9.3
canonicalwebteam.flask-base==1.0.2
alembic==1.7.5
canonicalwebteam.http==1.0.3
canonicalwebteam.blog==6.4.0
Expand Down Expand Up @@ -27,5 +27,3 @@ macaroonbakery==1.3.1
sortedcontainers==2.4.0
vcrpy-unittest==0.1.7
webargs==7.0.1
markupsafe==2.0.1
itsdangerous==2.0.1
12 changes: 7 additions & 5 deletions templates/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,13 @@
<div class="col-6 u-vertically-center">
<div>
<h1>404: Page not found</h1>
{% if message %}
<p class="p-heading--4">{{ message }}</p>
{% else %}
<p class="p-heading--4">Sorry, we couldn't find that page.</p>
{% endif %}
<p class="p-heading--4">
{% if message %}
{{ message }}
{% else %}
Sorry, we couldn't find that page.
{% endif %}
</p>
</div>
</div>
</div>
Expand Down
29 changes: 13 additions & 16 deletions webapp/app.py
Original file line number Diff line number Diff line change
Expand Up @@ -193,21 +193,23 @@
# Error pages
@app.errorhandler(400)
def bad_request_error(error):
return flask.render_template("400.html"), 400
return flask.render_template("400.html", message=error.description), 400


@app.errorhandler(SecurityAPIError)
def security_api_error(error):
@app.errorhandler(410)
def deleted_error(error):
return flask.render_template("410.html", message=error.description), 410

message = error.response.json().get("message")

if error.response.status_code == 404:
return flask.render_template("404.html", message=message), 404
else:
return (
flask.render_template("security-error-500.html", message=message),
500,
)
@app.errorhandler(SecurityAPIError)
def security_api_error(error):
return (
flask.render_template(
"security-error-500.html",
message=error.response.json().get("message"),
),
500,
)


@app.errorhandler(UAContractsValidationError)
Expand Down Expand Up @@ -265,11 +267,6 @@ def ua_contracts_api_error_view(error):
return flask.render_template("500.html"), 500


@app.errorhandler(410)
def deleted_error(error):
return flask.render_template("410.html"), 410


# Template context
@app.context_processor
def context():
Expand Down
23 changes: 17 additions & 6 deletions webapp/security/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,12 @@ def _get(self, path: str, params={}):
Defines get request set up, returns data if succesful,
raises HTTP errors if not
"""

uri = f"{self.base_url}{path}"

response = self.session.get(uri, params=params)

try:
response.raise_for_status()
except HTTPError as error:
raise SecurityAPIError(error)
response.raise_for_status()

return response

Expand All @@ -40,12 +38,25 @@ def get_cve(
Makes request for specific cve_id,
returns json object if found
"""
return self._get(f"cves/{id.upper()}.json").json()

try:
cve_response = self._get(f"cves/{id.upper()}.json")
except HTTPError as error:
if error.response.status_code == 404:
return None
raise SecurityAPIError(error)

return cve_response.json()

def get_releases(self):
"""
Makes request for all releases with ongoing support,
returns json object if found
"""

return self._get("releases.json").json()
try:
releases_response = self._get("releases.json")
except HTTPError as error:
raise SecurityAPIError(error)

return releases_response.json()
2 changes: 1 addition & 1 deletion webapp/security/views.py
Original file line number Diff line number Diff line change
Expand Up @@ -723,7 +723,7 @@ def cve(cve_id):
cve = security_api.get_cve(cve_id)

if not cve:
flask.abort(404)
flask.abort(404, f"Cannot find a CVE with ID '{cve_id}'")

if cve.get("published"):
cve["published"] = dateutil.parser.parse(cve["published"]).strftime(
Expand Down