Initial rollout of Sentry integration with 404/500’s

This adds a new Error Page promo type,
and adds the data into the error page rendering.
It also adds the Sentry “User Feedback” UI to our 500 pages.
I’m not 100% sold on this UI,
but it’s pretty neat to get user feedback.
I wish it was a bit more configurable. 

This isn’t using the JS library currently,
so it is hard-coding the promo text.
I should probably enable injecting dynamic copy for this over time,
but this seems fine for now.

Author: ericholscher

readthedocs/core/urls/__init__.py

@@ -45,6 +45,9 @@
         views.random_page,
         name='random_page'),
     url(r'^random/$', views.random_page, name='random_page'),
+    url(r'^404/$', 'readthedocs.core.views.server_error_404'),
+    # For testing the 500's with DEBUG on.
+    # url(r'^500/$', 'readthedocs.core.views.server_error'),
     url(r'^500/$', views.divide_by_zero, name='divide_by_zero'),
     url((r'^wipe/(?P<project_slug>{project_slug})/'
          r'(?P<version_slug>{version_slug})/$'.format(**pattern_opts)),

readthedocs/core/views/__init__.py

@@ -18,6 +18,8 @@
 from readthedocs.builds.models import Build
 from readthedocs.builds.models import Version
 from readthedocs.core.utils import broadcast
+from readthedocs.donate.models import SupporterPromo
+from readthedocs.donate.utils import offer_promo
 from readthedocs.projects import constants
 from readthedocs.projects.models import Project, ImportedFile
 from readthedocs.projects.tasks import remove_dir
@@ -104,20 +106,38 @@ def divide_by_zero(request):
     return 1 / 0
 
 
-def server_error(request, exception, template_name='500.html'):
+def add_promo_data(display_type):
+    promo_queryset = SupporterPromo.objects.filter(live=True, display_type=display_type)
+    promo_obj = promo_queryset.order_by('?').first()
+    if promo_obj:
+        promo_dict = offer_promo(promo_obj=promo_obj, project=None)
+    else:
+        promo_dict = None
+    return promo_dict
+
+
+def server_error(request, template_name='500.html', **kwargs):
     """A simple 500 handler so we get media"""
+    promo_dict = add_promo_data(display_type='error')
     r = render_to_response(template_name,
-                           context_instance=RequestContext(request))
+                           context_instance=RequestContext(request),
+                           context={
+                               'promo_data': promo_dict,
+                           })
     r.status_code = 500
     return r
 
 
-def server_error_404(request, exception, template_name='404.html'):
+def server_error_404(request, template_name='404.html', **kwargs):
     """A simple 404 handler so we get media"""
+    promo_dict = add_promo_data(display_type='error')
     response = get_redirect_response(request, path=request.get_full_path())
     if response:
         return response
     r = render_to_response(template_name,
-                           context_instance=RequestContext(request))
+                           context_instance=RequestContext(request),
+                           context={
+                               'promo_data': promo_dict,
+                           })
     r.status_code = 404
     return r

readthedocs/donate/models.py

@@ -15,6 +15,7 @@
     ('doc', 'Documentation Pages'),
     ('site-footer', 'Site Footer'),
     ('search', 'Search Pages'),
+    ('error', 'Error Pages'),
 )
 
 INCLUDE = 'include'

readthedocs/donate/signals.py

@@ -2,10 +2,10 @@
 
 from django.dispatch import receiver
 from django.conf import settings
-from django.core.cache import cache
 
 from readthedocs.restapi.signals import footer_response
-from readthedocs.donate.models import SupporterPromo, VIEWS, CLICKS, OFFERS, INCLUDE, EXCLUDE
+from readthedocs.donate.models import SupporterPromo, INCLUDE, EXCLUDE
+from readthedocs.donate.utils import offer_promo
 
 
 PROMO_GEO_PATH = getattr(settings, 'PROMO_GEO_PATH', None)
@@ -189,23 +189,8 @@ def attach_promo_data(sender, **kwargs):
         show_promo = False
 
     if show_promo:
-        promo_dict = promo_obj.as_dict()
+        promo_dict = offer_promo(promo_obj=promo_obj, project=project)
         resp_data['promo_data'] = promo_dict
-        promo_obj.incr(OFFERS)
-        promo_obj.incr(OFFERS, project=project)
-        # Set validation cache
-        for type in [VIEWS, CLICKS]:
-            cache.set(
-                promo_obj.cache_key(type=type, hash=promo_dict['hash']),
-                0,  # Number of times used. Make this an int so we can detect multiple uses
-                60 * 60  # hour
-            )
-            # Set project for hash key, so we can count it later.
-            cache.set(
-                promo_obj.cache_key(type='project', hash=promo_dict['hash']),
-                project.slug,
-                60 * 60  # hour
-            )
 
     # Set promo object on return JSON
     resp_data['promo'] = show_promo

readthedocs/donate/utils.py

@@ -1,6 +1,12 @@
 import pytz
 import datetime
 
+from django.core.cache import cache
+
+OFFERS = 'offers'
+VIEWS = 'views'
+CLICKS = 'clicks'
+
 
 def get_ad_day():
     date = pytz.utc.localize(datetime.datetime.utcnow())
@@ -11,3 +17,32 @@ def get_ad_day():
         tzinfo=pytz.utc,
     )
     return day
+
+
+def offer_promo(promo_obj, project=None):
+    """
+    Do the book keeping required to track promo offers.
+
+    This generated a hash as part of the return dict,
+    so that must be used throughout the processing pipeline in order to dedupe clicks.
+    """
+
+    promo_dict = promo_obj.as_dict()
+    promo_obj.incr(OFFERS)
+    # Set validation cache
+    for promo_type in [VIEWS, CLICKS]:
+        cache.set(
+            promo_obj.cache_key(type=promo_type, hash=promo_dict['hash']),
+            0,  # Number of times used. Make this an int so we can detect multiple uses
+            60 * 60  # hour
+        )
+
+    if project:
+        # Set project for hash key, so we can count it later.
+        promo_obj.incr(OFFERS, project=project)
+        cache.set(
+            promo_obj.cache_key(type='project', hash=promo_dict['hash']),
+            project.slug,
+            60 * 60  # hour
+        )
+    return promo_dict

readthedocs/templates/404.html

@@ -29,29 +29,16 @@ <h1>You've found something that doesn't exist.</h1>
           {% endifequal %}
       </div>
     {% endif %}
-<pre style="line-height: 1.25; white-space: pre;">
 
-        \          SORRY            /
-         \                         /
-          \    This page does     /
-           ]   not exist yet.    [    ,'|
-           ]                     [   /  |
-           ]___               ___[ ,'   |
-           ]  ]\             /[  [ |:   |
-           ]  ] \           / [  [ |:   |
-           ]  ]  ]         [  [  [ |:   |
-           ]  ]  ]__     __[  [  [ |:   |
-           ]  ]  ] ]\ _ /[ [  [  [ |:   |
-           ]  ]  ] ] (#) [ [  [  [ :===='
-           ]  ]  ]_].nHn.[_[  [  [
-           ]  ]  ]  HHHHH. [  [  [
-           ]  ] /   `HH("N  \ [  [
-           ]__]/     HHH  "  \[__[
-           ]         NNN         [
-           ]         N/"         [
-           ]         N H         [
-          /          N            \
-         /           q,            \
-        /                           \
-</pre>
+<h1>
+Page Not Found!
+</h1>
+
+<a href="{{ promo_data.link }}">
+  <img src="{{ promo_data.image }}" width="75%" />
+</a>
+
+<p>
+Read the Docs is sponsored by <a href="{{ promo_data.link }}">Sentry</a>, which gives developers the tools to keep calm when things catch fire.
+</p>
 {% endblock %}

readthedocs/templates/500.html

@@ -10,6 +10,10 @@
     {% endblock %}
 
 {% block content %}
+<h3>
+Server Error
+</h3>
+
 <pre style="line-height: 1.25; white-space: pre;">
           .
          ":"
@@ -21,4 +25,23 @@
    Fail.  Check back in a bit!
 
   </pre>
+
+<!-- Sentry JS SDK 2.1.+ required -->
+<script src="https://cdn.ravenjs.com/2.3.0/raven.min.js"></script>
+
+{% if request.sentry.id %}
+  <script>
+  Raven.showReportDialog({
+    eventId: '{{ request.sentry.id }}',
+
+    // use the public DSN (dont include your secret!)
+    dsn: 'https://[email protected]/148442'
+  });
+  </script>
+{% endif %}
+
+<p>
+Read the Docs is sponsored by <a href="{{ promo_data.link }}">Sentry</a>, which gives developers the tools to keep calm when things catch fire.
+</p>
+
 {% endblock %}