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.

Sign up for GitHub

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

Jump to bottom

fix: Wrap weasyprint to catch exceptions #6728

Merged
merged 6 commits into from
Dec 27, 2023
Merged

fix: Wrap weasyprint to catch exceptions #6728

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c9d587f
fix: Wrap weasyprint to catch exceptions (#6324)
pselkirk Dec 3, 2023
353faaa
test: Restore socket function after test
pselkirk Dec 4, 2023
5902168
test: Use mock instead of monkeying with sockets
pselkirk Dec 6, 2023
26cc393
refactor: Log the error
pselkirk Dec 13, 2023
73471ff
fix: Don't catch non-Exception interruptions
pselkirk Dec 18, 2023
3421ea4
Merge branch 'main' into fix-6324
rjsparks Dec 19, 2023
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
3 changes: 3 additions & 0 deletions ietf/doc/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -648,6 +648,9 @@ def pdfized(self):
)
except AssertionError:
pdf = None
except Exception as e:
log.log('weasyprint failed:'+str(e))
raise
if pdf:
cache.set(cache_key, pdf, settings.PDFIZER_CACHE_TIME)
return pdf
Expand Down
3 changes: 2 additions & 1 deletion ietf/doc/tests.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2848,7 +2848,8 @@ def test_pdfized(self):
with mock.patch('ietf.doc.models.DocumentInfo.pdfized', side_effect=URLFetchingError):
url = urlreverse(self.view, kwargs=dict(name=rfc.name))
r = self.client.get(url)
self.assertEqual(r.status_code, 504)
self.assertEqual(r.status_code, 200)
self.assertContains(r, "Error while rendering PDF")

class NotifyValidationTests(TestCase):
def test_notify_validation(self):
Expand Down
12 changes: 2 additions & 10 deletions ietf/doc/views_doc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,6 @@
from django import forms
from django.contrib.staticfiles import finders

from weasyprint.urls import URLFetchingError

import debug # pyflakes:ignore

from ietf.doc.models import ( Document, DocAlias, DocHistory, DocEvent, BallotDocEvent, BallotType,
Expand Down Expand Up @@ -977,14 +975,8 @@ def document_pdfized(request, name, rev=None, ext=None):

try:
pdf = doc.pdfized()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

when this fails, it's after a fairly long timeout - I wonder if two timeouts will take us past the cloudflare timeout window?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add a log to indicate how often a retry occurs? (Assuming that general failures are also logged, this would let us evaluate whether it's worth trying a second time)

Longer term, this would be a candidate to make into an async response and defer to celery.

except URLFetchingError:
# retry once, then give up
try:
pdf = doc.pdfized()
except URLFetchingError as exception:
return render(request, "doc/weasyprint_failed.html",
dict(error=f'{type(exception).__name__}: {exception}'),
status=504)
except:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should probably be except Exception - a bare except catches low-level non-Exception interruptions that shouldn't normally be caught without re-raising.

return render(request, "doc/weasyprint_failed.html")
if pdf:
return HttpResponse(pdf,content_type='application/pdf')
else:
Expand Down
14 changes: 7 additions & 7 deletions ietf/templates/doc/weasyprint_failed.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
{# Copyright The IETF Trust 2023, All Rights Reserved #}
{% extends "base.html" %}
{% load origin %}
{% block title %}Network error while rendering PDF{% endblock %}
{% block title %}Error while rendering PDF{% endblock %}
{% block content %}
{% origin %}
<h1>Network error while rendering PDF</h1>
<h1>Error while rendering PDF</h1>
<p>
A network error was encountered while trying to render your document as PDF.
An error was encountered while trying to render your document as PDF.
In case this was a temporary error, you may want to try again in a
little while.
</p>
<p>
We have retried the operation, and it failed again. You may want to wait a bit, and try again.
</p>
<p>
The error was: <code>{{ error }}</code>
A failure report with details about what happened has been sent to the
server administrators.
</p>
{% endblock %}
Loading