Webmonkey: reference: handleErrors

SEARCH WEBMONKEY:

JUMP TO A TOPIC:


Powered by Atomz.com

home / reference /

Quick Reference:

• Javascript Code Library
• HTML Cheatsheet
• Special Characters
• Color Codes
• Browser Chart
• Stylesheet Guide
• Unix Guide
• Glossary
• Domain Registries

Reference JavaScript Code Library

JavaScript 1.1 (available in Netscape 3+ and MS IE 4+) adds the ability to modify the browser's default behavior for handling JavaScript errors.

This library module suppresses JavaScript errors so that they can be hidden from view, logged to a server log file for further review, and then displayed in the window.status area if desired.

It requires a CGI on the server side (which can be written in any language you choose) to generate the log. The script passes the error info to the CGI by creating an Image object and setting its source as the call to the CGI. This invokes the CGI script without changing the page or display.

This code contains only one method that can be called directly, and it also contains a number of flags and strings that should be set by the page author upon installation.

Variables:
You should set your own custom values here to suit your particular needs:

trapErrors = true;
Setting this to false will turn off JS error suppression. Useful for debugging during development.
logErrors = true;
Setting this to false will stop errors from being logged. Useful when working offline or without CGI.
showErrorAsStatusMessage = false;
Setting this to true will cause the browser to display the error message as the window.defaultStatus text, resulting in a quieter, but not invisible, error message. Sometimes this can be a more pleasant way to debug JavaScript.
logNumErrors = 3;
Number of JS errors per page to enter into log before calling it quits. Large values aren't recommended ... if you're getting a lot of errors per pageview, then you're probably in an ugly loop.
logScriptLoc = "URL to error log CGI";
This is the location of your CGI script. The script must reside within the htdocs tree or in a server-aliased directory like /cgi-bin, since the error message is sent via HTTP.
scriptName = "JS Err Log";
Optional: This can be any string of text used to identify the script.
logComment = "Testing JS Err Log";
Optional: A short comment may be supplied here.

Usage:
Enabling this code requires three steps:

First, add the code to your HTML page.
Then, create a CGI script to receive the log data (and assign its URL to the logScriptLoc variable). This Perl5 script can serve as an example if you need one. Your script should interpret the data from the JavaScript Image.src call and pass it to ...
... the last component, the logfile, which resides on your server at a location you have designated in your CGI script.

Tip: If your page makes use of the <body onUnload=""> property, then add a call to restoreWindowToPreviousState() at the end of your onUnload call. Failing to do this won't cause grievous harm, but since this code modifies your page's default properties, it's a good idea to reset them before you exit. If you don't make use of <body onUnload=""> then don't worry about it: This script will call it for you.

Requires: JavaScript 1.1 or later.

License: This code is released under the GNU Library General Public License.

Cut, paste, and enjoy!

/*
JavaScript Error Trapping and Logging

This library module enables suppression of
JavaScript errors in a way that allows errors
to be hidden from view, logged to a server
log file for further review, and optionally
displayed in the window.status area if desired.

Source: Webmonkey Code Library
(http://www.hotwired.com/webmonkey/javascript/code_library/)

Author: Patrick Corcoran
Author email: patrick@taylor.org
*/

trapErrors = true;
  // Setting this to false will turn off JS error suppression,
  // setting the browser to its normal behavior.
  // Useful for debugging during development.
  
logErrors = true;
  // Setting this to false will stop errors from being logged.
  // Useful when working offline or without CGI.
  
showErrorAsStatusMessage = false;
  // Setting this to true will cause the browser to display
  // the error message as the window.defaultStatus text,
  // resulting in a quieter, but not invisible, error message.
  // Sometimes this can be a more pleasant way to debug JavaScript.

logNumErrors = 3;
  // Number of JS errors per page to enter into log before calling it quits.
  // Large values aren't recommended ... if you're getting a lot
  // of errors per pageview, then you're probably in a nasty loop.

logScriptLoc = "path to your cgi script goes here";
  // The script must reside within the htdocs tree
  // or in a server-aliased directory like /cgi-bin,
  // since the error message is sent via HTTP.

scriptName = "JS Err Log";
  // Optional: This can be any string of text used to identify the script.

logComment = "Testing";
  // Optional: A short comment may be supplied here.

// You may want to separate the remainder of the script from
// the preceding portion so that you can call the same
// error trapping code with different variable settings from
// different HTML pages without repeating a lot of code.

MSIE = (navigator.userAgent.indexOf('MSIE') > -1) ? ( true ) : ( false );
  // Is this browser a Microsoft Internet Explorer browser?

if (!MSIE) { originalErrorHandler = window.onerror; }
  // Read and store value of current window.onerror property for later restoring.
  // But exclude MSIE because it won't allow us to read the window.onerror property.
  
originalDefaultStatus = window.defaultStatus;
  // Read and store value of current window.defaultStatus property for later restoring.
  
numErrorEvents = 0;
  // Number of Errors we've experienced so far for this pageview.

function handleErrors(msg, errUrl, line) {

if (logErrors || showErrorAsStatusMessage) {
    
    if (numErrorEvents < logNumErrors) {
      
      errImage = new Array(logNumErrors);
        // This will hold all of our Image() objects we will create
        // to pass error data to the server.
      
      d = new Date();
        // We append a new Date() object to the end of every GET string
        // to ensure that the URL is always unique, and therefore not
        // subject to the disk cache frustrations of MSIE.
      
      sn = (scriptName) ? ('&scr=' + escape(scriptName)) : ('');
      lc = (logComment) ? ('&comm=' + escape(logComment)) : ('');
        // Escape the data from the optional scriptName and logComment variables if necessary.
              
      if (MSIE) {
        // window.onerror in MSIE doesn't pass msg, errUrl, line values
        // automatically like Netscape does, so we must approximate them.
        errUrl = this.location;    
        msg = 'Unspecified JS Error';  
        line = 'MSIE';          
      } else {
        line = 'line ' + line;
      }
      
      if (logErrors) {
        
        errLogEntry = logScriptLoc + '?url=' + escape(errUrl) + '&msg=' + escape(msg) + '&line=' + escape(line) + sn + lc + '&d=' + escape(d);
          // Build a GET string from the data we have pieced together about the error event.
  
        errImage[numErrorEvents] = new Image();  
        errImage[numErrorEvents].src = errLogEntry;
          // The Image() object is essentially the only Object
          // in NS3, NS4, and MSIE that can have its URL refreshed
          // without reloading the page, so we use it as a background data
          // carrier for client->server communication.  We set the new URL equal
          // to our GET string, which will get parsed by the CGI on the server.
          // The CGI will return empty/garbage data, but we don't care,
          // since the image we're loading here isn't for display.
      }
      
      if (showErrorAsStatusMessage) { window.defaultStatus = 'JavaScript Error: ' + msg + ' in ' + line; }
      
      numErrorEvents++;
    }
  }
  
  return trapErrors;
}

function restoreWindowToPreviousState() {
  // Set window.onerror and window.defaultStatus
  // to their initial state when leaving the page.
  if (!MSIE) { window.onerror = originalErrorHandler; }
  window.defaultStatus = originalDefaultStatus;
}

window.onUnload = restoreWindowToPreviousState;

window.onerror = handleErrors;

// -->

</script>