diff --git a/eggs.ini b/eggs.ini index 2e552ad12c7..2fd44e91a41 100644 --- a/eggs.ini +++ b/eggs.ini @@ -66,6 +66,7 @@ Babel = 0.9.4 wchartype = 0.1 Whoosh = 0.3.18 ; fluent_logger = 0.3.3 +raven = 3.1.8 ; extra version information [tags] diff --git a/lib/galaxy/config.py b/lib/galaxy/config.py index 036eba7a01a..a727b92236f 100644 --- a/lib/galaxy/config.py +++ b/lib/galaxy/config.py @@ -2,7 +2,7 @@ Universe configuration builder. """ -import sys, os, tempfile +import sys, os, tempfile, re import logging, logging.config import ConfigParser from datetime import timedelta @@ -261,11 +261,24 @@ class Configuration( object ): self.api_folders = string_as_bool( kwargs.get( 'api_folders', False ) ) # This is for testing new library browsing capabilities. self.new_lib_browse = string_as_bool( kwargs.get( 'new_lib_browse', False ) ) + # Error logging with sentry + self.sentry_dsn = kwargs.get( 'sentry_dsn', None ) # Logging with fluentd self.fluent_log = string_as_bool( kwargs.get( 'fluent_log', False ) ) self.fluent_host = kwargs.get( 'fluent_host', 'localhost' ) self.fluent_port = int( kwargs.get( 'fluent_port', 24224 ) ) + @property + def sentry_dsn_public( self ): + """ + Sentry URL with private key removed for use in client side scripts, + sentry server will need to be configured to accept events + """ + if self.sentry_dsn: + return re.sub( r"^([^:/?#]+:)?//(\w+):(\w+)", r"\1//\2", self.sentry_dsn ) + else: + return None + def __read_tool_job_config( self, global_conf_parser, section, key ): try: tool_runners_config = global_conf_parser.items( section ) @@ -387,8 +400,7 @@ def get_database_engine_options( kwargs ): def configure_logging( config ): """ - Allow some basic logging configuration to be read from the cherrpy - config. + Allow some basic logging configuration to be read from ini file. """ # PasteScript will have already configured the logger if the appropriate # sections were found in the config file, so we do nothing if the @@ -420,3 +432,10 @@ def configure_logging( config ): # Hook everything up handler.setFormatter( formatter ) root.addHandler( handler ) + # If sentry is configured, also log to it + if config.sentry_dsn: + pkg_resources.require( "raven" ) + from raven.handlers.logging import SentryHandler + sentry_handler = SentryHandler( config.sentry_dsn ) + sentry_handler.setLevel( logging.WARN ) + root.addHandler( sentry_handler ) diff --git a/lib/galaxy/web/framework/base.py b/lib/galaxy/web/framework/base.py index 7d24e1b6308..f38c8a44650 100644 --- a/lib/galaxy/web/framework/base.py +++ b/lib/galaxy/web/framework/base.py @@ -9,7 +9,6 @@ import os.path import sys import tarfile import threading -import uuid from Cookie import SimpleCookie @@ -70,9 +69,6 @@ class WebApplication( object ): self.mapper.explicit = False self.api_mapper = routes.Mapper() self.transaction_factory = DefaultWebTransaction - # Each request will have a unique id. Since we are assuming - # a threaded model for the moment we can store that here - self.request_id = threading.local() # Set if trace logging is enabled self.trace_logger = None def add_ui_controller( self, controller_name, controller ): @@ -124,7 +120,7 @@ class WebApplication( object ): and calls it. """ # Immediately create request_id which we will use for logging - self.request_id = request_id = uuid.uuid1().hex + request_id = environ.get( 'request_id', 'unknown' ) if self.trace_logger: self.trace_logger.context_set( "request_id", request_id ) self.trace( message="Starting request" ) @@ -136,6 +132,8 @@ class WebApplication( object ): self.trace_logger.context_remove( "request_id" ) def handle_request( self, environ, start_response ): + # Grab the request_id (should have been set by middleware) + request_id = environ.get( 'request_id', 'unknown' ) # Map url using routes path_info = environ.get( 'PATH_INFO', '' ) map = self.mapper.match( path_info, environ ) @@ -157,6 +155,7 @@ class WebApplication( object ): rc.environ = environ # Setup the transaction trans = self.transaction_factory( environ ) + trans.request_id = request_id rc.redirect = trans.response.send_redirect # Get the controller class controller_name = map.pop( 'controller', None ) diff --git a/lib/galaxy/webapps/galaxy/buildapp.py b/lib/galaxy/webapps/galaxy/buildapp.py index 0890598623f..1311130ea35 100644 --- a/lib/galaxy/webapps/galaxy/buildapp.py +++ b/lib/galaxy/webapps/galaxy/buildapp.py @@ -240,6 +240,14 @@ def wrap_in_middleware( app, global_conf, **local_conf ): from paste import recursive app = recursive.RecursiveMiddleware( app, conf ) log.debug( "Enabling 'recursive' middleware" ) + # If sentry logging is enabled, log here before propogating up to + # the error middleware + sentry_url = conf.get( 'sentry_url', None ) + if sentry_url: + pkg_resources.require( "raven") + from raven import Client + from raven.middleware import Sentry + app = Sentry( app, Client( sentry_url ) ) # Various debug middleware that can only be turned on if the debug # flag is set, either because they are insecure or greatly hurt # performance @@ -254,12 +262,6 @@ def wrap_in_middleware( app, global_conf, **local_conf ): from paste.debug import profile app = profile.ProfileMiddleware( app, conf ) log.debug( "Enabling 'profile' middleware" ) - # Middleware that intercepts print statements and shows them on the - # returned page - if asbool( conf.get( 'use_printdebug', True ) ): - from paste.debug import prints - app = prints.PrintDebugMiddleware( app, conf ) - log.debug( "Enabling 'print debug' middleware" ) if debug and asbool( conf.get( 'use_interactive', False ) ): # Interactive exception debugging, scary dangerous if publicly # accessible, if not enabled we'll use the regular error printing @@ -288,6 +290,10 @@ def wrap_in_middleware( app, global_conf, **local_conf ): from galaxy.web.framework.middleware.xforwardedhost import XForwardedHostMiddleware app = XForwardedHostMiddleware( app ) log.debug( "Enabling 'x-forwarded-host' middleware" ) + # Request ID middleware + from galaxy.web.framework.middleware.request_id import RequestIDMiddleware + app = RequestIDMiddleware( app ) + log.debug( "Enabling 'Request ID' middleware" ) return app def wrap_in_static( app, global_conf, **local_conf ): diff --git a/static/scripts/libs/raven.js b/static/scripts/libs/raven.js new file mode 100644 index 00000000000..f8e45d7e50e --- /dev/null +++ b/static/scripts/libs/raven.js @@ -0,0 +1,438 @@ +(function(){ + +// Raven.js +// +// Originally based on the Arecibo JavaScript client. +// +// Requires: +// * TraceKit (included in the full and minified distribution files) + +'use strict'; + +// First, check for JSON support +// If there is no JSON, we no-op the core features of Raven +// since JSON is required to encode the payload +var _Raven = window.Raven, + hasJSON = !isUndefined(window.JSON), + globalServer, + globalUser, + globalKey, + globalProject, + globalOptions = { + logger: 'javascript', + ignoreErrors: [], + ignoreUrls: [] + }; + +var TK = TraceKit.noConflict(); + +// Disable Tracekit's remote fetching by default +TK.remoteFetching = false; + +/* + * The core Raven object + */ +var Raven = { + VERSION: '@VERSION', + + /* + * Raven.noConflict() + * + * Allow multiple versions of Raven to be installed. + */ + noConflict: function() { + window.Raven = _Raven; + return Raven; + }, + + /* + * Raven.config() + * + * Configure raven with a DSN and extra options + */ + config: function(dsn, options) { + var uri = parseUri(dsn), + lastSlash = uri.path.lastIndexOf('/'), + path = uri.path.substr(1, lastSlash); + + // merge in options + if (options) { + each(options, function(key, value){ + globalOptions[key] = value; + }); + } + + // "Script error." is hard coded into browsers for errors that it can't read. + // this is the result of a script being pulled in from an external domain and CORS. + globalOptions.ignoreErrors.push('Script error.'); + + globalKey = uri.user; + globalProject = ~~uri.path.substr(lastSlash + 1); + + // assemble the endpoint from the uri pieces + globalServer = uri.protocol + '://' + uri.host + + (uri.port ? ':' + uri.port : '') + + '/' + path + 'api/' + globalProject + '/store/'; + + if (globalOptions.fetchContext) { + TK.remoteFetching = true; + } + + // return for chaining + return Raven; + }, + + /* + * Raven.install() + * + * Installs a global window.onerror error handler + * to capture and report uncaught exceptions. + */ + install: function() { + if (!isSetup()) return; + + TK.report.subscribe(handleStackInfo); + + return Raven; + }, + + /* + * Raven.context() + * + * Wrap code within a context so Raven can capture errors + * reliably across domains that is executed immediately. + */ + context: function(options, func, args) { + if (isFunction(options)) { + args = func; + func = options; + options = undefined; + } + + Raven.wrap(options, func).apply(this, args); + }, + + /* Raven.wrap() + * + * Wrap code within a context and returns back a new function to be executed + */ + wrap: function(options, func) { + // options is optional + if (isFunction(options)) { + func = options; + options = undefined; + } + + return function() { + try { + func.apply(this, arguments); + } catch(e) { + Raven.captureException(e, options); + } + }; + }, + + /* + * Raven.uninstall() + * + * Uninstalls the global error handler. + */ + uninstall: function() { + TK.report.unsubscribe(handleStackInfo); + + return Raven; + }, + + /* + * Raven.captureException() + * + * Manually capture an exception and send it over to Sentry + */ + captureException: function(ex, options) { + // TraceKit.report will re-raise any exception passed to it, + // which means you have to wrap it in try/catch. Instead, we + // can wrap it here and only re-raise if TraceKit.report + // raises an exception different from the one we asked to + // report on. + try { + TK.report(ex, options); + } catch(ex1) { + if(ex !== ex1) { + throw ex1; + } + } + + return Raven; + }, + + /* + * Raven.captureMessage() + * + * Manually send a message to Sentry + */ + captureMessage: function(msg, options) { + // Fire away! + send( + arrayMerge({ + message: msg + }, options) + ); + + return Raven; + }, + + /* + * Raven.setUser() + * + * Set/clear a user to be sent along with the payload. + */ + setUser: function(user) { + globalUser = user; + + return Raven; + } +}; + +var uriKeys = 'source protocol authority userInfo user password host port relative path directory file query anchor'.split(' '), + uriPattern = /^(?:(?![^:@]+:[^:@\/]*@)([^:\/?#.]+):)?(?:\/\/)?((?:(([^:@]*)(?::([^:@]*))?)?@)?([^:\/?#]*)(?::(\d*))?)(((\/(?:[^?#](?![^?#\/]*\.[^?#\/.]+(?:[?#]|$)))*\/?)?([^?#\/]*))(?:\?([^#]*))?(?:#(.*))?)/; + +/**** Private functions ****/ +function parseUri(str) { + var m = uriPattern.exec(str), + uri = {}, + i = 14; + + while (i--) uri[uriKeys[i]] = m[i] || ''; + + return uri; +} + +function isUndefined(what) { + return typeof what === 'undefined'; +} + +function isFunction(what) { + return typeof what === 'function'; +} + +function each(obj, callback) { + var i, j; + + if (obj.length === undefined) { + for (i in obj) { + if (obj.hasOwnProperty(i)) { + callback.call(null, i, obj[i]); + } + } + } else { + for (i = 0, j = obj.length; i < j; i++) { + callback.call(null, i, obj[i]); + } + } +} + +var cachedAuth; + +function getAuthQueryString() { + if (cachedAuth) return cachedAuth; + + var qs = [ + 'sentry_version=2.0', + 'sentry_client=raven-js/' + Raven.VERSION + ]; + if (globalKey) { + qs.push('sentry_key=' + globalKey); + } + + cachedAuth = '?' + qs.join('&'); + return cachedAuth; +} + +function handleStackInfo(stackInfo, options) { + var frames = [], i = 0, j = stackInfo.stack && stackInfo.stack.length || 0, frame; + + for (; i < j; i++) { + frame = normalizeFrame(stackInfo.stack[i]); + if (frame) { + frames.push(frame); + } + } + + processException( + stackInfo.name, + stackInfo.message, + stackInfo.url, + stackInfo.lineno, + frames, + options + ); +} + +function normalizeFrame(frame) { + if (!frame.url) return; + + // normalize the frames data + var normalized = { + filename: frame.url, + lineno: frame.line, + colno: frame.column, + 'function': frame.func || '?' + }, context = extractContextFromFrame(frame); + + if (context) { + var i = 3, keys = ['pre_context', 'context_line', 'post_context']; + while (i--) normalized[keys[i]] = context[i]; + } + + normalized.in_app = !/(Raven|TraceKit)\./.test(normalized['function']); + + return normalized; +} + +function extractContextFromFrame(frame) { + // immediately check if we should even attempt to parse a context + if (!frame.context || !globalOptions.fetchContext) return; + + var context = frame.context, + pivot = ~~(context.length / 2), + i = context.length, isMinified = false; + + while (i--) { + // We're making a guess to see if the source is minified or not. + // To do that, we make the assumption if *any* of the lines passed + // in are greater than 300 characters long, we bail. + // Sentry will see that there isn't a context + if (context[i].length > 300) { + isMinified = true; + break; + } + } + + if (isMinified) { + // The source is minified and we don't know which column. Fuck it. + if (isUndefined(frame.column)) return; + + // If the source is minified and has a frame column + // we take a chunk of the offending line to hopefully shed some light + return [ + [], // no pre_context + context[pivot].substr(frame.column, 50), // grab 50 characters, starting at the offending column + [] // no post_context + ]; + } + + return [ + context.slice(0, pivot), // pre_context + context[pivot], // context_line + context.slice(pivot + 1) // post_context + ]; +} + +function processException(type, message, fileurl, lineno, frames, options) { + var stacktrace, label, i; + + // IE8 really doesn't have Array.prototype.indexOf + // Filter out a message that matches our ignore list + i = globalOptions.ignoreErrors.length; + while (i--) { + if (message === globalOptions.ignoreErrors[i]) { + return; + } + } + + if (frames && frames.length) { + stacktrace = {frames: frames}; + fileurl = fileurl || frames[0].filename; + } else if (fileurl) { + stacktrace = { + frames: [{ + filename: fileurl, + lineno: lineno + }] + }; + } + + i = globalOptions.ignoreUrls.length; + while (i--) { + if (globalOptions.ignoreUrls[i].test(fileurl)) { + return; + } + } + + label = lineno ? message + ' at ' + lineno : message; + + // Fire away! + send( + arrayMerge({ + 'sentry.interfaces.Exception': { + type: type, + value: message + }, + 'sentry.interfaces.Stacktrace': stacktrace, + culprit: fileurl, + message: label + }, options) + ); +} + +function arrayMerge(arr1, arr2) { + if (!arr2) { + return arr1; + } + each(arr2, function(key, value){ + arr1[key] = value; + }); + return arr1; +} + +function getHttpData() { + var http = { + url: window.location.href, + headers: { + 'User-Agent': navigator.userAgent + } + }; + + if (window.document.referrer) { + http.headers.Referer = window.document.referrer; + } + + return http; +} + +function send(data) { + if (!isSetup()) return; + + data = arrayMerge({ + project: globalProject, + logger: globalOptions.logger, + site: globalOptions.site, + platform: 'javascript', + 'sentry.interfaces.Http': getHttpData() + }, data ); + + if (globalUser) data['sentry.interfaces.User'] = globalUser; + + if (isFunction(globalOptions.dataCallback)) { + data = globalOptions.dataCallback(data); + } + + makeRequest(data); +} + +function makeRequest(data) { + new Image().src = globalServer + getAuthQueryString() + '&sentry_data=' + encodeURIComponent(JSON.stringify(data)); +} + +function isSetup() { + if (!hasJSON) return false; // needs JSON support + if (!globalServer) { + console.error("Error: Raven has not been configured."); + return false; + } + return true; +} + +window.Raven = Raven; + +})(); diff --git a/static/scripts/libs/tracekit.js b/static/scripts/libs/tracekit.js new file mode 100644 index 00000000000..bf7d18bfd2b --- /dev/null +++ b/static/scripts/libs/tracekit.js @@ -0,0 +1,1210 @@ +/* + TraceKit - Cross brower stack traces - github.com/occ/TraceKit + MIT license +*/ + +;(function(window, undefined) { + + +var TraceKit = {}; +var _oldTraceKit = window.TraceKit; + +/** + * TraceKit.noConflict: Export TraceKit out to another variable + * Example: var TK = TraceKit.noConflict() + */ +TraceKit.noConflict = function noConflict() { + window.TraceKit = _oldTraceKit; + return TraceKit; +}; + +/** + * TraceKit._has, a better form of hasOwnProperty + * Example: TraceKit._has(MainHostObject, property) === true/false + * + * @param {Object} host object to check property + * @param {string} key to check + */ +TraceKit._has = function _has(object, key) { + return Object.prototype.hasOwnProperty.call(object, key); +}; + +/** + * TraceKit.report: cross-browser processing of unhandled exceptions + * + * Syntax: + * TraceKit.report.subscribe(function(stackInfo) { ... }) + * TraceKit.report.unsubscribe(function(stackInfo) { ... }) + * TraceKit.report(exception) + * try { ...code... } catch(ex) { TraceKit.report(ex); } + * + * Supports: + * - Firefox: full stack trace with line numbers, plus column number + * on top frame; column number is not guaranteed + * - Opera: full stack trace with line and column numbers + * - Chrome: full stack trace with line and column numbers + * - Safari: line and column number for the top frame only; some frames + * may be missing, and column number is not guaranteed + * - IE: line and column number for the top frame only; some frames + * may be missing, and column number is not guaranteed + * + * In theory, TraceKit should work on all of the following versions: + * - IE5.5+ (only 8.0 tested) + * - Firefox 0.9+ (only 3.5+ tested) + * - Opera 7+ (only 10.50 tested; versions 9 and earlier may require + * Exceptions Have Stacktrace to be enabled in opera:config) + * - Safari 3+ (only 4+ tested) + * - Chrome 1+ (only 5+ tested) + * - Konqueror 3.5+ (untested) + * + * Requires TraceKit.computeStackTrace. + * + * Tries to catch all unhandled exceptions and report them to the + * subscribed handlers. Please note that TraceKit.report will rethrow the + * exception. This is REQUIRED in order to get a useful stack trace in IE. + * If the exception does not reach the top of the browser, you will only + * get a stack trace from the point where TraceKit.report was called. + * + * Handlers receive a stackInfo object as described in the + * TraceKit.computeStackTrace docs. + */ +TraceKit.report = (function reportModuleWrapper() { + var handlers = [], + lastException = null, + lastExceptionStack = null; + + /** + * Add a crash handler. + * @param {Function} handler + */ + function subscribe(handler) { + handlers.push(handler); + } + + /** + * Remove a crash handler. + * @param {Function} handler + */ + function unsubscribe(handler) { + for (var i = handlers.length - 1; i >= 0; --i) { + if (handlers[i] === handler) { + handlers.splice(i, 1); + } + } + } + + /** + * Dispatch stack information to all handlers. + * @param {Object.} stack + */ + function notifyHandlers(stack, windowError) { + var exception = null; + if (windowError && !TraceKit.collectWindowErrors) { + return; + } + for (var i in handlers) { + if (TraceKit._has(handlers, i)) { + try { + handlers[i].apply(null, [stack].concat(Array.prototype.slice.call(arguments, 2))); + } catch (inner) { + exception = inner; + } + } + } + + if (exception) { + throw exception; + } + } + + var _oldOnerrorHandler = window.onerror; + + /** + * Ensures all global unhandled exceptions are recorded. + * Supported by Gecko and IE. + * @param {string} message Error message. + * @param {string} url URL of script that generated the exception. + * @param {(number|string)} lineNo The line number at which the error + * occurred. + */ + window.onerror = function traceKitWindowOnError(message, url, lineNo) { + var stack = null; + + if (lastExceptionStack) { + TraceKit.computeStackTrace.augmentStackTraceWithInitialElement(lastExceptionStack, url, lineNo, message); + stack = lastExceptionStack; + lastExceptionStack = null; + lastException = null; + } else { + var location = { + 'url': url, + 'line': lineNo + }; + location.func = TraceKit.computeStackTrace.guessFunctionName(location.url, location.line); + location.context = TraceKit.computeStackTrace.gatherContext(location.url, location.line); + stack = { + 'mode': 'onerror', + 'message': message, + 'url': document.location.href, + 'stack': [location], + 'useragent': navigator.userAgent + }; + } + + notifyHandlers(stack, 'from window.onerror'); + + if (_oldOnerrorHandler) { + return _oldOnerrorHandler.apply(this, arguments); + } + + return false; + }; + + /** + * Reports an unhandled Error to TraceKit. + * @param {Error} ex + */ + function report(ex) { + var args = Array.prototype.slice.call(arguments, 1); + if (lastExceptionStack) { + if (lastException === ex) { + return; // already caught by an inner catch block, ignore + } else { + var s = lastExceptionStack; + lastExceptionStack = null; + lastException = null; + notifyHandlers.apply(null, [s, null].concat(args)); + } + } + + var stack = TraceKit.computeStackTrace(ex); + lastExceptionStack = stack; + lastException = ex; + + // If the stack trace is incomplete, wait for 2 seconds for + // slow slow IE to see if onerror occurs or not before reporting + // this exception; otherwise, we will end up with an incomplete + // stack trace + window.setTimeout(function () { + if (lastException === ex) { + lastExceptionStack = null; + lastException = null; + notifyHandlers.apply(null, [stack, null].concat(args)); + } + }, (stack.incomplete ? 2000 : 0)); + + throw ex; // re-throw to propagate to the top level (and cause window.onerror) + } + + report.subscribe = subscribe; + report.unsubscribe = unsubscribe; + return report; +}()); + +/** + * TraceKit.computeStackTrace: cross-browser stack traces in JavaScript + * + * Syntax: + * s = TraceKit.computeStackTrace.ofCaller([depth]) + * s = TraceKit.computeStackTrace(exception) // consider using TraceKit.report instead (see below) + * Returns: + * s.name - exception name + * s.message - exception message + * s.stack[i].url - JavaScript or HTML file URL + * s.stack[i].func - function name, or empty for anonymous functions (if guessing did not work) + * s.stack[i].args - arguments passed to the function, if known + * s.stack[i].line - line number, if known + * s.stack[i].column - column number, if known + * s.stack[i].context - an array of source code lines; the middle element corresponds to the correct line# + * s.mode - 'stack', 'stacktrace', 'multiline', 'callers', 'onerror', or 'failed' -- method used to collect the stack trace + * + * Supports: + * - Firefox: full stack trace with line numbers and unreliable column + * number on top frame + * - Opera 10: full stack trace with line and column numbers + * - Opera 9-: full stack trace with line numbers + * - Chrome: full stack trace with line and column numbers + * - Safari: line and column number for the topmost stacktrace element + * only + * - IE: no line numbers whatsoever + * + * Tries to guess names of anonymous functions by looking for assignments + * in the source code. In IE and Safari, we have to guess source file names + * by searching for function bodies inside all page scripts. This will not + * work for scripts that are loaded cross-domain. + * Here be dragons: some function names may be guessed incorrectly, and + * duplicate functions may be mismatched. + * + * TraceKit.computeStackTrace should only be used for tracing purposes. + * Logging of unhandled exceptions should be done with TraceKit.report, + * which builds on top of TraceKit.computeStackTrace and provides better + * IE support by utilizing the window.onerror event to retrieve information + * about the top of the stack. + * + * Note: In IE and Safari, no stack trace is recorded on the Error object, + * so computeStackTrace instead walks its *own* chain of callers. + * This means that: + * * in Safari, some methods may be missing from the stack trace; + * * in IE, the topmost function in the stack trace will always be the + * caller of computeStackTrace. + * + * This is okay for tracing (because you are likely to be calling + * computeStackTrace from the function you want to be the topmost element + * of the stack trace anyway), but not okay for logging unhandled + * exceptions (because your catch block will likely be far away from the + * inner function that actually caused the exception). + * + * Tracing example: + * function trace(message) { + * var stackInfo = TraceKit.computeStackTrace.ofCaller(); + * var data = message + "\n"; + * for(var i in stackInfo.stack) { + * var item = stackInfo.stack[i]; + * data += (item.func || '[anonymous]') + "() in " + item.url + ":" + (item.line || '0') + "\n"; + * } + * if (window.console) + * console.info(data); + * else + * alert(data); + * } + */ +TraceKit.computeStackTrace = (function computeStackTraceWrapper() { + var debug = false, + sourceCache = {}; + + /** + * Attempts to retrieve source code via XMLHttpRequest, which is used + * to look up anonymous function names. + * @param {string} url URL of source code. + * @return {string} Source contents. + */ + function loadSource(url) { + if (!TraceKit.remoteFetching) { //Only attempt request if remoteFetching is on. + return ''; + } + try { + var XMLHttpRequestWrapper; + + if (typeof (XMLHttpRequest) === 'undefined') { // IE 5.x-6.x: + XMLHttpRequestWrapper = function IEXMLHttpRequestSub() { + try { + return new ActiveXObject('Msxml2.XMLHTTP.6.0'); + } catch (e) {} + try { + return new ActiveXObject('Msxml2.XMLHTTP.3.0'); + } catch (e) {} + try { + return new ActiveXObject('Msxml2.XMLHTTP'); + } catch (e) {} + try { + return new ActiveXObject('Microsoft.XMLHTTP'); + } catch (e) {} + throw new Error('No XHR.'); + }; + } else { + XMLHttpRequestWrapper = XMLHttpRequest; + } + + var request = new XMLHttpRequestWrapper(); + request.open('GET', url, false); + request.send(''); + return request.responseText; + } catch (e) { + return ''; + } + } + + /** + * Retrieves source code from the source code cache. + * @param {string} url URL of source code. + * @return {Array.} Source contents. + */ + function getSource(url) { + if (!TraceKit._has(sourceCache, url)) { + // URL needs to be able to fetched within the acceptable domain. Otherwise, + // cross-domain errors will be triggered. + var source; + if (url.indexOf(document.domain) !== -1) { + source = loadSource(url); + } else { + source = []; + } + sourceCache[url] = source.length ? source.split('\n') : []; + } + + return sourceCache[url]; + } + + /** + * Tries to use an externally loaded copy of source code to determine + * the name of a function by looking at the name of the variable it was + * assigned to, if any. + * @param {string} url URL of source code. + * @param {(string|number)} lineNo Line number in source code. + * @return {string} The function name, if discoverable. + */ + function guessFunctionName(url, lineNo) { + var reFunctionArgNames = /function ([^(]*)\(([^)]*)\)/, + reGuessFunction = /['"]?([0-9A-Za-z$_]+)['"]?\s*[:=]\s*(function|eval|new Function)/, + line = '', + maxLines = 10, + source = getSource(url), + m; + + if (!source.length) { + return '?'; + } + + // Walk backwards from the first line in the function until we find the line which + // matches the pattern above, which is the function definition + for (var i = 0; i < maxLines; ++i) { + line = source[lineNo - i] + line; + + if (line !== undefined) { + if ((m = reGuessFunction.exec(line))) { + return m[1]; + } else if ((m = reFunctionArgNames.exec(line))) { + return m[1]; + } + } + } + + return '?'; + } + + /** + * Retrieves the surrounding lines from where an exception occurred. + * @param {string} url URL of source code. + * @param {(string|number)} line Line number in source code to centre + * around for context. + * @return {?Array.} Lines of source code. + */ + function gatherContext(url, line) { + var source = getSource(url); + + if (!source.length) { + return null; + } + + var context = [], + // linesBefore & linesAfter are inclusive with the offending line. + // if linesOfContext is even, there will be one extra line + // *before* the offending line. + linesBefore = Math.floor(TraceKit.linesOfContext / 2), + // Add one extra line if linesOfContext is odd + linesAfter = linesBefore + (TraceKit.linesOfContext % 2), + start = Math.max(0, line - linesBefore - 1), + end = Math.min(source.length, line + linesAfter - 1); + + line -= 1; // convert to 0-based index + + for (var i = start; i < end; ++i) { + if (typeof (source[i]) !== 'undefined') { + context.push(source[i]); + } + } + + return context.length > 0 ? context : null; + } + + /** + * Escapes special characters, except for whitespace, in a string to be + * used inside a regular expression as a string literal. + * @param {string} text The string. + * @return {string} The escaped string literal. + */ + function escapeRegExp(text) { + return text.replace(/[\-\[\]{}()*+?.,\\\^$|#]/g, '\\$&'); + } + + /** + * Escapes special characters in a string to be used inside a regular + * expression as a string literal. Also ensures that HTML entities will + * be matched the same as their literal friends. + * @param {string} body The string. + * @return {string} The escaped string. + */ + function escapeCodeAsRegExpForMatchingInsideHTML(body) { + return escapeRegExp(body).replace('<', '(?:<|<)').replace('>', '(?:>|>)').replace('&', '(?:&|&)').replace('"', '(?:"|")').replace(/\s+/g, '\\s+'); + } + + /** + * Determines where a code fragment occurs in the source code. + * @param {RegExp} re The function definition. + * @param {Array.} urls A list of URLs to search. + * @return {?Object.} An object containing + * the url, line, and column number of the defined function. + */ + function findSourceInUrls(re, urls) { + var source, m; + for (var i = 0, j = urls.length; i < j; ++i) { + // console.log('searching', urls[i]); + if ((source = getSource(urls[i])).length) { + source = source.join('\n'); + if ((m = re.exec(source))) { + // console.log('Found function in ' + urls[i]); + + return { + 'url': urls[i], + 'line': source.substring(0, m.index).split('\n').length, + 'column': m.index - source.lastIndexOf('\n', m.index) - 1 + }; + } + } + } + + // console.log('no match'); + + return null; + } + + /** + * Determines at which column a code fragment occurs on a line of the + * source code. + * @param {string} fragment The code fragment. + * @param {string} url The URL to search. + * @param {(string|number)} line The line number to examine. + * @return {?number} The column number. + */ + function findSourceInLine(fragment, url, line) { + var source = getSource(url), + re = new RegExp('\\b' + escapeRegExp(fragment) + '\\b'), + m; + + line -= 1; + + if (source && source.length > line && (m = re.exec(source[line]))) { + return m.index; + } + + return null; + } + + /** + * Determines where a function was defined within the source code. + * @param {(Function|string)} func A function reference or serialized + * function definition. + * @return {?Object.} An object containing + * the url, line, and column number of the defined function. + */ + function findSourceByFunctionBody(func) { + var urls = [window.location.href], + scripts = document.getElementsByTagName('script'), + body, + code = '' + func, + codeRE = /^function(?:\s+([\w$]+))?\s*\(([\w\s,]*)\)\s*\{\s*(\S[\s\S]*\S)\s*\}\s*$/, + eventRE = /^function on([\w$]+)\s*\(event\)\s*\{\s*(\S[\s\S]*\S)\s*\}\s*$/, + re, + parts, + result; + + for (var i = 0; i < scripts.length; ++i) { + var script = scripts[i]; + if (script.src) { + urls.push(script.src); + } + } + + if (!(parts = codeRE.exec(code))) { + re = new RegExp(escapeRegExp(code).replace(/\s+/g, '\\s+')); + } + + // not sure if this is really necessary, but I don’t have a test + // corpus large enough to confirm that and it was in the original. + else { + var name = parts[1] ? '\\s+' + parts[1] : '', + args = parts[2].split(',').join('\\s*,\\s*'); + + body = escapeRegExp(parts[3]).replace(/;$/, ';?'); // semicolon is inserted if the function ends with a comment.replace(/\s+/g, '\\s+'); + re = new RegExp('function' + name + '\\s*\\(\\s*' + args + '\\s*\\)\\s*{\\s*' + body + '\\s*}'); + } + + // look for a normal function definition + if ((result = findSourceInUrls(re, urls))) { + return result; + } + + // look for an old-school event handler function + if ((parts = eventRE.exec(code))) { + var event = parts[1]; + body = escapeCodeAsRegExpForMatchingInsideHTML(parts[2]); + + // look for a function defined in HTML as an onXXX handler + re = new RegExp('on' + event + '=[\\\'"]\\s*' + body + '\\s*[\\\'"]', 'i'); + + if ((result = findSourceInUrls(re, urls[0]))) { + return result; + } + + // look for ??? + re = new RegExp(body); + + if ((result = findSourceInUrls(re, urls))) { + return result; + } + } + + return null; + } + + // Contents of Exception in various browsers. + // + // SAFARI: + // ex.message = Can't find variable: qq + // ex.line = 59 + // ex.sourceId = 580238192 + // ex.sourceURL = http://... + // ex.expressionBeginOffset = 96 + // ex.expressionCaretOffset = 98 + // ex.expressionEndOffset = 98 + // ex.name = ReferenceError + // + // FIREFOX: + // ex.message = qq is not defined + // ex.fileName = http://... + // ex.lineNumber = 59 + // ex.stack = ...stack trace... (see the example below) + // ex.name = ReferenceError + // + // CHROME: + // ex.message = qq is not defined + // ex.name = ReferenceError + // ex.type = not_defined + // ex.arguments = ['aa'] + // ex.stack = ...stack trace... + // + // INTERNET EXPLORER: + // ex.message = ... + // ex.name = ReferenceError + // + // OPERA: + // ex.message = ...message... (see the example below) + // ex.name = ReferenceError + // ex.opera#sourceloc = 11 (pretty much useless, duplicates the info in ex.message) + // ex.stacktrace = n/a; see 'opera:config#UserPrefs|Exceptions Have Stacktrace' + + /** + * Computes stack trace information from the stack property. + * Chrome and Gecko use this property. + * @param {Error} ex + * @return {?Object.} Stack trace information. + */ + function computeStackTraceFromStackProp(ex) { + if (!ex.stack) { + return null; + } + + var chrome = /^\s*at (?:((?:\[object object\])?\S+) )?\(?((?:file|http|https):.*?):(\d+)(?::(\d+))?\)?\s*$/i, + gecko = /^\s*(\S*)(?:\((.*?)\))?@((?:file|http|https).*?):(\d+)(?::(\d+))?\s*$/i, + lines = ex.stack.split('\n'), + stack = [], + parts, + element, + reference = /^(.*) is undefined$/.exec(ex.message); + + for (var i = 0, j = lines.length; i < j; ++i) { + if ((parts = gecko.exec(lines[i]))) { + element = { + 'url': parts[3], + 'func': parts[1] || '?', + 'args': parts[2] ? parts[2].split(',') : '', + 'line': +parts[4], + 'column': parts[5] ? +parts[5] : null + }; + } else if ((parts = chrome.exec(lines[i]))) { + element = { + 'url': parts[2], + 'func': parts[1] || '?', + 'line': +parts[3], + 'column': parts[4] ? +parts[4] : null + }; + } else { + continue; + } + + if (!element.func && element.line) { + element.func = guessFunctionName(element.url, element.line); + } + + if (element.line) { + element.context = gatherContext(element.url, element.line); + } + + stack.push(element); + } + + if (stack[0] && stack[0].line && !stack[0].column && reference) { + stack[0].column = findSourceInLine(reference[1], stack[0].url, stack[0].line); + } + + if (!stack.length) { + return null; + } + + return { + 'mode': 'stack', + 'name': ex.name, + 'message': ex.message, + 'url': document.location.href, + 'stack': stack, + 'useragent': navigator.userAgent + }; + } + + /** + * Computes stack trace information from the stacktrace property. + * Opera 10 uses this property. + * @param {Error} ex + * @return {?Object.} Stack trace information. + */ + function computeStackTraceFromStacktraceProp(ex) { + // Access and store the stacktrace property before doing ANYTHING + // else to it because Opera is not very good at providing it + // reliably in other circumstances. + var stacktrace = ex.stacktrace; + + var testRE = / line (\d+), column (\d+) in (?:]+)>|([^\)]+))\((.*)\) in (.*):\s*$/i, + lines = stacktrace.split('\n'), + stack = [], + parts; + + for (var i = 0, j = lines.length; i < j; i += 2) { + if ((parts = testRE.exec(lines[i]))) { + var element = { + 'line': +parts[1], + 'column': +parts[2], + 'func': parts[3] || parts[4], + 'args': parts[5] ? parts[5].split(',') : [], + 'url': parts[6] + }; + + if (!element.func && element.line) { + element.func = guessFunctionName(element.url, element.line); + } + if (element.line) { + try { + element.context = gatherContext(element.url, element.line); + } catch (exc) {} + } + + if (!element.context) { + element.context = [lines[i + 1]]; + } + + stack.push(element); + } + } + + if (!stack.length) { + return null; + } + + return { + 'mode': 'stacktrace', + 'name': ex.name, + 'message': ex.message, + 'url': document.location.href, + 'stack': stack, + 'useragent': navigator.userAgent + }; + } + + /** + * NOT TESTED. + * Computes stack trace information from an error message that includes + * the stack trace. + * Opera 9 and earlier use this method if the option to show stack + * traces is turned on in opera:config. + * @param {Error} ex + * @return {?Object.} Stack information. + */ + function computeStackTraceFromOperaMultiLineMessage(ex) { + // Opera includes a stack trace into the exception message. An example is: + // + // Statement on line 3: Undefined variable: undefinedFunc + // Backtrace: + // Line 3 of linked script file://localhost/Users/andreyvit/Projects/TraceKit/javascript-client/sample.js: In function zzz + // undefinedFunc(a); + // Line 7 of inline#1 script in file://localhost/Users/andreyvit/Projects/TraceKit/javascript-client/sample.html: In function yyy + // zzz(x, y, z); + // Line 3 of inline#1 script in file://localhost/Users/andreyvit/Projects/TraceKit/javascript-client/sample.html: In function xxx + // yyy(a, a, a); + // Line 1 of function script + // try { xxx('hi'); return false; } catch(ex) { TraceKit.report(ex); } + // ... + + var lines = ex.message.split('\n'); + if (lines.length < 4) { + return null; + } + + var lineRE1 = /^\s*Line (\d+) of linked script ((?:file|http|https)\S+)(?:: in function (\S+))?\s*$/i, + lineRE2 = /^\s*Line (\d+) of inline#(\d+) script in ((?:file|http|https)\S+)(?:: in function (\S+))?\s*$/i, + lineRE3 = /^\s*Line (\d+) of function script\s*$/i, + stack = [], + scripts = document.getElementsByTagName('script'), + inlineScriptBlocks = [], + parts, + i, + len, + source; + + for (i in scripts) { + if (TraceKit._has(scripts, i) && !scripts[i].src) { + inlineScriptBlocks.push(scripts[i]); + } + } + + for (i = 2, len = lines.length; i < len; i += 2) { + var item = null; + if ((parts = lineRE1.exec(lines[i]))) { + item = { + 'url': parts[2], + 'func': parts[3], + 'line': +parts[1] + }; + } else if ((parts = lineRE2.exec(lines[i]))) { + item = { + 'url': parts[3], + 'func': parts[4] + }; + var relativeLine = (+parts[1]); // relative to the start of the + %endif + ${h.js( "libs/jquery/jquery", "libs/jquery/select2", @@ -54,7 +65,7 @@ error : function(){}, assert : function(){} }; - + // Set up needed paths. var galaxy_paths = new GalaxyPaths({ root_path: '${h.url_for( "/" )}', diff --git a/templates/base/base_panels.mako b/templates/base/base_panels.mako index c3d2e9261f6..39e0de9ff69 100644 --- a/templates/base/base_panels.mako +++ b/templates/base/base_panels.mako @@ -45,9 +45,18 @@ ## Default javascripts <%def name="javascripts()"> - + + ## Send errors to Sntry server if configured + %if app.config.sentry_dsn: + ${h.js( "libs/tracekit", "libs/raven" )} + + %endif + ${h.js( 'libs/jquery/jquery', 'libs/json2', diff --git a/templates/root/tool_menu.mako b/templates/root/tool_menu.mako index ab7ac944f4a..3e48d3714c7 100644 --- a/templates/root/tool_menu.mako +++ b/templates/root/tool_menu.mako @@ -74,7 +74,7 @@ }); */ - $( '.tooltip' ).tooltip(); + $( '.tooltip' ).tooltip().foasdasdasdoo(); // TODO: is this necessary? $( "a[minsizehint]" ).click( function() {