Integrate Raven-JS for error logging to sentry

media/js/lib/raven-proxy.js

@@ -0,0 +1,11 @@
+define('raven_proxy', ['settings'], function(settings) {
+    // Define a wrapper which will only send a message to Raven
+    // if it's configured
+    return function (message, options) {
+        if((typeof(Raven) != 'undefined') && (settings.zamboni_raven_url)) {
+            console.log('[raven] logging to Raven ' + message);
+
+            Raven.captureMessage(message, options);
+        }
+    };
+});

media/js/raven-init.js

@@ -0,0 +1,22 @@
+require(['settings', 'raven_proxy'], function(settings, ravenProxy) {
+    // Test for the presence of Zamboni Raven configuration
+    if(settings.zamboni_raven_url) {
+        console.log('[raven] configuring raven proxy');
+
+        // Initialize RavenJS
+        Raven.config(settings.zamboni_raven_url, {}).install();
+
+        // Bind our handler to the global error handler
+        window.onerror = function(errorMsg, url, lineNumber) {
+            ravenProxy(errorMsg, {
+                tags: {
+                    file: url,
+                    line: lineNumber
+                }
+            });
+
+            // Ensure default behaviour
+            return false;
+        };
+    }
+});

webpay/settings/base.py

@@ -75,9 +75,12 @@
             'js/lib/format.js',
             'js/lib/longtext.js',
             'js/lib/tracking.js',
+            'js/lib/raven.min.js',
+            'js/lib/raven-proxy.js',
 
             # These are modules used by others.
             # The order is important, do not alphabetize.
+            'js/raven-init.js',
             'js/cli.js',
             'js/id.js',
             'js/auth.js',
@@ -498,6 +501,12 @@
     'ajax_timeout': 45000,
     # Wait timeout (Default 60s).
     'wait_timeout': 60000,
+    # Raven error logging
+    # ex: http://none@zamboni.localhost/api/v1/fireplace/report_error/12345
+    # Please note that the leading 'none@' is required
+    # The trailing integer '12345' is the sentry account id which is found in a sentry DSN
+    # ex: https://<user>:<pass>@app.getsentry.com/<sentry_account_id>
+    'zamboni_raven_url': '',
 }
 
 # New Relic is configured here.

webpay/settings/sites/dev/settings_base.py

@@ -119,5 +119,6 @@
 ALLOW_ADMIN_SIMULATIONS = True
 
 base.JS_SETTINGS['tracking_enabled'] = True
+base.JS_SETTINGS['zamboni_raven_url'] = ''
 
 NEWRELIC_INI = '/etc/newrelic.d/marketplace-dev.allizom.org-webpay.ini'

webpay/settings/sites/identitystage/settings_base.py

@@ -116,3 +116,4 @@
 BROWSERID_JS_URL = 'https://%s/include.js' % BROWSERID_DOMAIN
 
 base.JS_SETTINGS['tracking_enabled'] = True
+base.JS_SETTINGS['zamboni_raven_url'] = ''

webpay/settings/sites/prod/settings_base.py

@@ -109,3 +109,4 @@
 ENCRYPTED_COOKIE_KEY = private.ENCRYPTED_COOKIE_KEY
 
 base.JS_SETTINGS['tracking_enabled'] = True
+base.JS_SETTINGS['zamboni_raven_url'] = ''

webpay/settings/sites/stage/settings_base.py

@@ -112,6 +112,8 @@
 ALLOW_ADMIN_SIMULATIONS = True
 
 base.JS_SETTINGS['tracking_enabled'] = True
+base.JS_SETTINGS['zamboni_raven_url'] = ''
+
 NEWRELIC_INI = '/etc/newrelic.d/marketplace.allizom.org-webpay.ini'
 
 USAGE_WARNING = True