Skip to content

Instantly share code, notes, and snippets.

@superfeedr

superfeedr/notifier.js

Created August 18, 2011 21:50
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save superfeedr/1155334 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save superfeedr/1155334 to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. Superfeedr.com revised this gist Aug 22, 2011. 1 changed file with 41 additions and 37 deletions.
    78 changes: 41 additions & 37 deletions notifier.js
    View file
    Original file line number Diff line number Diff line change
    @@ -37,16 +37,16 @@
    */

    var AirbrakeNotifier = {
    AIRBRAKE_KEY : '',
    APP_VERSION : '1.0',
    SESSION_VARS : [],
    PARAMS_VARS : [],
    REQUEST_COMPONENT : "",
    APP_ENVIRONMENT : 'development',
    HOST : 'hoptoadapp.com',
    NOTICE_XML : '<?xml version="1.0" encoding="UTF-8"?><notice version="2.1"><api-key>AIRBRAKE_KEY</api-key><notifier><name>chrome_app_airbrake_notifier</name><version>0.1.0</version><url>https://gist.github.com/1155334</url></notifier><error><class>EXCEPTION_CLASS</class><message>EXCEPTION_MESSAGE</message><backtrace>BACKTRACE_LINES</backtrace></error><request><url>REQUEST_URL</url><component>REQUEST_COMPONENT</component><action>REQUEST_ACTION</action></request><server-environment><project-root>PROJECT_ROOT</project-root><environment-name>APP_ENVIRONMENT</environment-name><app-version>APP_VERSION</app-version></server-environment></notice>',
    ROOT : window.location.protocol + '//' + window.location.host,
    BACKTRACE_MATCHER : /^(.*) \((.*):(.*):(.*)\)$/,
    airbrake_key : '',
    app_version : '1.0',
    session_vars : [],
    params_vars : [],
    request_component : "",
    app_environment : 'development',
    host : 'hoptoadapp.com',
    notice_xml : '<?xml version="1.0" encoding="UTF-8"?><notice version="2.1"><api-key>airbrake_key</api-key><notifier><name>chrome_app_airbrake_notifier</name><version>0.1.0</version><url>https://gist.github.com/1155334</url></notifier><error><class>exception_class</class><message>exception_message</message><backtrace>backtrace_lines</backtrace></error><request><url>request_url</url><component>request_component</component><action>request_action</action></request><server-environment><project-root>project_root</project-root><environment-name>app_environment</environment-name><app-version>app_version</app-version></server-environment></notice>',
    root : window.location.protocol + '//' + window.location.host,
    backtrace_matcher : /^(.*) \((.*):(.*):(.*)\)$/,

    // Generates the error XML and sends it to Airbrake's servers thru the inclusion of an iframe element.
    notify: function (error) {
    @@ -63,27 +63,27 @@ var AirbrakeNotifier = {

    // Sets the environment
    setEnvironment: function (value) {
    AirbrakeNotifier.APP_ENVIRONMENT = value;
    AirbrakeNotifier.app_environment = value;
    },

    // Sets the host
    setHost: function (value) {
    AirbrakeNotifier.HOST = value;
    sethost: function (value) {
    AirbrakeNotifier.host = value;
    },

    // Sets the session variables
    setSessionVars: function (value) {
    AirbrakeNotifier.SESSION_VARS = value;
    AirbrakeNotifier.session_vars = value;
    },

    // Sets the params
    setParams: function (value) {
    AirbrakeNotifier.PARAMS_VARS = value;
    AirbrakeNotifier.params_vars = value;
    },

    // Sets the API Key
    setKey: function (value) {
    AirbrakeNotifier.AIRBRAKE_KEY = value;
    AirbrakeNotifier.airbrake_key = value;
    },

    // Sets the defaults for the error
    @@ -93,15 +93,15 @@ var AirbrakeNotifier = {

    // Sets the app version
    setAppVersion: function (value) {
    AirbrakeNotifier.APP_VERSION = value;
    AirbrakeNotifier.app_version = value;
    },

    // Generates XML
    generateXML: function (errorWithoutDefaults) {
    errorWithoutDefaults.url = window.location.href;
    var error = AirbrakeNotifier.mergeDefault(AirbrakeNotifier.errorDefaults, errorWithoutDefaults);

    var xml = AirbrakeNotifier.NOTICE_XML;
    var xml = AirbrakeNotifier.notice_xml;
    var baseUrl = error.url || '';
    var hash = location.hash || '';
    var url = AirbrakeNotifier.escapeText((baseUrl + hash) || '');
    @@ -121,27 +121,31 @@ var AirbrakeNotifier = {
    data += AirbrakeNotifier.generateVariables(cgi_data);
    data += '</cgi-data>';

    data += '<session>';
    data += AirbrakeNotifier.generateVariables(AirbrakeNotifier.SESSION_VARS);
    data += '</session>';

    data += '<params>';
    data += AirbrakeNotifier.generateVariables(AirbrakeNotifier.PARAMS_VARS);
    data += '</params>';
    if(AirbrakeNotifier.session_vars.length > 0) {
    data += '<session>';
    data += AirbrakeNotifier.generateVariables(AirbrakeNotifier.session_vars);
    data += '</session>';
    }

    if(AirbrakeNotifier.params_vars.length > 0) {
    data += '<params>';
    data += AirbrakeNotifier.generateVariables(AirbrakeNotifier.params_vars);
    data += '</params>';
    }

    xml = xml.replace('</request>', data + '</request>');
    xml = xml.replace('REQUEST_URL', url);
    xml = xml.replace('REQUEST_COMPONENT', component);
    xml = xml.replace('REQUEST_ACTION', ""); // Not applicable to Chrome Applications
    xml = xml.replace('request_url', url);
    xml = xml.replace('request_component', component);
    xml = xml.replace('request_action', ""); // Not applicable to Chrome Applications
    }

    xml = xml.replace('PROJECT_ROOT', AirbrakeNotifier.escapeText(AirbrakeNotifier.ROOT));
    xml = xml.replace('EXCEPTION_CLASS', type);
    xml = xml.replace('APP_VERSION', AirbrakeNotifier.APP_VERSION);
    xml = xml.replace('EXCEPTION_MESSAGE', message);
    xml = xml.replace('BACKTRACE_LINES', backtrace.join(''));
    xml = xml.replace('AIRBRAKE_KEY', AirbrakeNotifier.escapeText(AirbrakeNotifier.AIRBRAKE_KEY));
    xml = xml.replace('APP_ENVIRONMENT', AirbrakeNotifier.escapeText(AirbrakeNotifier.APP_ENVIRONMENT));
    xml = xml.replace('project_root', AirbrakeNotifier.escapeText(AirbrakeNotifier.root));
    xml = xml.replace('exception_class', type);
    xml = xml.replace('app_version', AirbrakeNotifier.app_version);
    xml = xml.replace('exception_message', message);
    xml = xml.replace('backtrace_lines', backtrace.join(''));
    xml = xml.replace('airbrake_key', AirbrakeNotifier.escapeText(AirbrakeNotifier.airbrake_key));
    xml = xml.replace('app_environment', AirbrakeNotifier.escapeText(AirbrakeNotifier.app_environment));
    return xml;
    },

    @@ -157,9 +161,9 @@ var AirbrakeNotifier = {

    for (var i = 0, l = stacktrace.length; i < l; i++) {
    var line = stacktrace[i];
    var matches = line.match(AirbrakeNotifier.BACKTRACE_MATCHER);
    var matches = line.match(AirbrakeNotifier.backtrace_matcher);
    if (matches) {
    var file = matches[2].replace(AirbrakeNotifier.ROOT, '[PROJECT_ROOT]');
    var file = matches[2].replace(AirbrakeNotifier.root, '[project_root]');
    backtrace.push('<line method="' + AirbrakeNotifier.escapeText(matches[1]) + '" file="' + AirbrakeNotifier.escapeText(file) + '" number="' + matches[3] + '" />');
    }
    }
  2. Superfeedr.com revised this gist Aug 18, 2011. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion notifier.js
    View file
    Original file line number Diff line number Diff line change
    @@ -44,7 +44,7 @@ var AirbrakeNotifier = {
    REQUEST_COMPONENT : "",
    APP_ENVIRONMENT : 'development',
    HOST : 'hoptoadapp.com',
    NOTICE_XML : '<?xml version="1.0" encoding="UTF-8"?><notice version="2.1"><api-key>AIRBRAKE_KEY</api-key><notifier><name>chrome_app_airbrake_notifier</name><version>0.1.0</version><url></url></notifier><error><class>EXCEPTION_CLASS</class><message>EXCEPTION_MESSAGE</message><backtrace>BACKTRACE_LINES</backtrace></error><request><url>REQUEST_URL</url><component>REQUEST_COMPONENT</component><action>REQUEST_ACTION</action></request><server-environment><project-root>PROJECT_ROOT</project-root><environment-name>APP_ENVIRONMENT</environment-name><app-version>APP_VERSION</app-version></server-environment></notice>',
    NOTICE_XML : '<?xml version="1.0" encoding="UTF-8"?><notice version="2.1"><api-key>AIRBRAKE_KEY</api-key><notifier><name>chrome_app_airbrake_notifier</name><version>0.1.0</version><url>https://gist.github.com/1155334</url></notifier><error><class>EXCEPTION_CLASS</class><message>EXCEPTION_MESSAGE</message><backtrace>BACKTRACE_LINES</backtrace></error><request><url>REQUEST_URL</url><component>REQUEST_COMPONENT</component><action>REQUEST_ACTION</action></request><server-environment><project-root>PROJECT_ROOT</project-root><environment-name>APP_ENVIRONMENT</environment-name><app-version>APP_VERSION</app-version></server-environment></notice>',
    ROOT : window.location.protocol + '//' + window.location.host,
    BACKTRACE_MATCHER : /^(.*) \((.*):(.*):(.*)\)$/,

  3. Superfeedr.com created this gist Aug 18, 2011.
    219 changes: 219 additions & 0 deletions notifier.js
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,219 @@
    /**
    CONFIGURATION:
    // Set your Airbrake API key here [REQ]
    AirbrakeNotifier.setKey("XXXX");
    // Set the environment. [OPT]
    AirbrakeNotifier.setEnvironment("development");
    // Set the app version [OPT]
    AirbrakeNotifier.setAppVersion("1.3.3.7");
    // Set the session variables [OPT]
    AirbrakeNotifier.setSessionVars({hello: "world"});
    // Set the Params [OPT]
    AirbrakeNotifier.setParams({page: 1});
    USAGE
    1. You can just catch errors and then do :
    try {
    ... die ...
    } catch(e) {
    AirbrakeNotifier.notify(e));
    }
    2. You can also use the window.onerror call, however, this call 'lost' the error object, so you have to create a new one (feel free to customize it)
    window.onerror = function (message, file, line) {
    var error = {
    arguments: [],
    message : message.match(/Uncaught (.*): (.*)/)[2],
    stack : ["-" + " (" + file + ":" + line + ":0)"],
    type : message.match(/Uncaught (.*): (.*)/)[1]
    }
    AirbrakeNotifier.notify(e));
    };
    */

    var AirbrakeNotifier = {
    AIRBRAKE_KEY : '',
    APP_VERSION : '1.0',
    SESSION_VARS : [],
    PARAMS_VARS : [],
    REQUEST_COMPONENT : "",
    APP_ENVIRONMENT : 'development',
    HOST : 'hoptoadapp.com',
    NOTICE_XML : '<?xml version="1.0" encoding="UTF-8"?><notice version="2.1"><api-key>AIRBRAKE_KEY</api-key><notifier><name>chrome_app_airbrake_notifier</name><version>0.1.0</version><url></url></notifier><error><class>EXCEPTION_CLASS</class><message>EXCEPTION_MESSAGE</message><backtrace>BACKTRACE_LINES</backtrace></error><request><url>REQUEST_URL</url><component>REQUEST_COMPONENT</component><action>REQUEST_ACTION</action></request><server-environment><project-root>PROJECT_ROOT</project-root><environment-name>APP_ENVIRONMENT</environment-name><app-version>APP_VERSION</app-version></server-environment></notice>',
    ROOT : window.location.protocol + '//' + window.location.host,
    BACKTRACE_MATCHER : /^(.*) \((.*):(.*):(.*)\)$/,

    // Generates the error XML and sends it to Airbrake's servers thru the inclusion of an iframe element.
    notify: function (error) {
    var xml = escape(AirbrakeNotifier.generateXML(error));
    var host = AirbrakeNotifier.host;
    var url = '//' + host + '/notifier_api/v2/notices?data=' + xml;
    var request = document.createElement('iframe');
    request.style.width = '1px';
    request.style.height = '1px';
    request.style.display = 'none';
    request.src = "http:" + url; /* Adding http: to avoid using the default scheme. */
    document.getElementsByTagName('head')[0].appendChild(request);
    },

    // Sets the environment
    setEnvironment: function (value) {
    AirbrakeNotifier.APP_ENVIRONMENT = value;
    },

    // Sets the host
    setHost: function (value) {
    AirbrakeNotifier.HOST = value;
    },

    // Sets the session variables
    setSessionVars: function (value) {
    AirbrakeNotifier.SESSION_VARS = value;
    },

    // Sets the params
    setParams: function (value) {
    AirbrakeNotifier.PARAMS_VARS = value;
    },

    // Sets the API Key
    setKey: function (value) {
    AirbrakeNotifier.AIRBRAKE_KEY = value;
    },

    // Sets the defaults for the error
    setErrorDefaults: function (value) {
    AirbrakeNotifier.errorDefaults = value;
    },

    // Sets the app version
    setAppVersion: function (value) {
    AirbrakeNotifier.APP_VERSION = value;
    },

    // Generates XML
    generateXML: function (errorWithoutDefaults) {
    errorWithoutDefaults.url = window.location.href;
    var error = AirbrakeNotifier.mergeDefault(AirbrakeNotifier.errorDefaults, errorWithoutDefaults);

    var xml = AirbrakeNotifier.NOTICE_XML;
    var baseUrl = error.url || '';
    var hash = location.hash || '';
    var url = AirbrakeNotifier.escapeText((baseUrl + hash) || '');
    var component = AirbrakeNotifier.escapeText(error.component || '');
    var type = AirbrakeNotifier.escapeText(error.type || 'Error');
    var message = AirbrakeNotifier.escapeText(error.message || 'Unknown error.');

    var backtrace = AirbrakeNotifier.generateBacktrace(error);

    if (AirbrakeNotifier.trim(url) === '' && AirbrakeNotifier.trim(component) === '') {
    xml = xml.replace(/<request>.*<\/request>/, '');
    } else {
    var data = '';
    var cgi_data = error['cgi-data'] || {};
    cgi_data.HTTP_USER_AGENT = navigator.userAgent;
    data += '<cgi-data>';
    data += AirbrakeNotifier.generateVariables(cgi_data);
    data += '</cgi-data>';

    data += '<session>';
    data += AirbrakeNotifier.generateVariables(AirbrakeNotifier.SESSION_VARS);
    data += '</session>';

    data += '<params>';
    data += AirbrakeNotifier.generateVariables(AirbrakeNotifier.PARAMS_VARS);
    data += '</params>';

    xml = xml.replace('</request>', data + '</request>');
    xml = xml.replace('REQUEST_URL', url);
    xml = xml.replace('REQUEST_COMPONENT', component);
    xml = xml.replace('REQUEST_ACTION', ""); // Not applicable to Chrome Applications
    }

    xml = xml.replace('PROJECT_ROOT', AirbrakeNotifier.escapeText(AirbrakeNotifier.ROOT));
    xml = xml.replace('EXCEPTION_CLASS', type);
    xml = xml.replace('APP_VERSION', AirbrakeNotifier.APP_VERSION);
    xml = xml.replace('EXCEPTION_MESSAGE', message);
    xml = xml.replace('BACKTRACE_LINES', backtrace.join(''));
    xml = xml.replace('AIRBRAKE_KEY', AirbrakeNotifier.escapeText(AirbrakeNotifier.AIRBRAKE_KEY));
    xml = xml.replace('APP_ENVIRONMENT', AirbrakeNotifier.escapeText(AirbrakeNotifier.APP_ENVIRONMENT));
    return xml;
    },

    // Generates the XML backtrace to be sent.
    generateBacktrace: function (error) {
    error = error || {};
    var backtrace = [];
    var stacktrace = error.stack;

    if (error.stack.length === 0) {
    stacktrace = AirbrakeNotifier.getStackTrace();
    }

    for (var i = 0, l = stacktrace.length; i < l; i++) {
    var line = stacktrace[i];
    var matches = line.match(AirbrakeNotifier.BACKTRACE_MATCHER);
    if (matches) {
    var file = matches[2].replace(AirbrakeNotifier.ROOT, '[PROJECT_ROOT]');
    backtrace.push('<line method="' + AirbrakeNotifier.escapeText(matches[1]) + '" file="' + AirbrakeNotifier.escapeText(file) + '" number="' + matches[3] + '" />');
    }
    }
    return backtrace;
    },


    // Generate the XML variables
    generateVariables: function (parameters) {
    var key;
    var result = '';

    for (key in parameters) {
    result += '<var key="' + AirbrakeNotifier.escapeText(key) + '">' +
    AirbrakeNotifier.escapeText(parameters[key]) +
    '</var>';
    }
    return result;
    },

    // Escape Text for XML
    escapeText: function (text) {
    return text.replace(/&/g, '&#38;').replace(/</g, '&#60;').replace(/>/g, '&#62;').replace(/'/g, '&#39;').replace(/"/g, '&#34;');
    },

    // Deletes trainling whitespaces
    trim: function (text) {
    return text.toString().replace(/^\s+/, '').replace(/\s+$/, '');
    },

    // Mergeing defaults.
    mergeDefault: function (defaults, hash) {
    var cloned = {};
    var key;
    for (key in hash) {
    cloned[key] = hash[key];
    }
    for (key in defaults) {
    if (!cloned.hasOwnProperty(key)) {
    cloned[key] = defaults[key];
    }
    }
    return cloned;
    },

    // Returns a stack Trace
    getStackTrace: function () {
    var obj = {};
    Error.captureStackTrace(obj, AirbrakeNotifier.getStackTrace);
    var lines = obj.stack.split("\n");
    var stack = [];
    for (var line in lines) {
    stack.push(lines[line].trim().replace("at", "").trim());
    }
    return stack;
    }
    };