Welcome!

You will be redirected in 30 seconds or close now.

ColdFusion Authors: Yakov Fain, Jeremy Geelan, Maureen O'Gara, Nancy Y. Nee, Tad Anderson

Related Topics: ColdFusion

ColdFusion: Article

Error Handling in JavaScript

Error Handling in JavaScript

Have you ever been to a site and gotten a pop-up box telling you about a JavaScript error on the page? It can be really annoying.

What's worse is that the person responsible for maintaining the site doesn't even know that the error occurred.

This article isn't about ColdFusion error handling. That was covered in 2000 and 2001 in CFDJ by Charlie Arehart's four-part series, "Toward Better Error Handling," as well as by others. Rather, this article will tell you some ways to trap JavaScript errors on the client. More important, it'll tell you how to communicate these errors to ColdFusion automatically so you can write the errors to a log file or e-mail the errors to yourself and find out about them right away. Indeed, the trick we use may be useful to you in ways beyond just error handling.

Error Prevention
The primary way to prevent JavaScript errors in your application, of course, is to catch them during development. To do this you'll have to know when they occur. Browsers may be set by default to hide them. To correct that you must turn on error display in your browser. This means that you see any JavaScript errors on all sites you visit, but to my mind it's a small price to pay to see them in your own site.

It's essential to know about JavaScript errors on your site, especially when debugging. Before I enabled this in my browsers, I wasted hours trying to figure out the cause of problems that became obvious when I enabled error display in my browser.

To do this in Internet Explorer, go to Tools -> Options -> Advanced and check "Display a notification about every script error". To see errors in Netscape, you must use the JavaScript console. To see the console in Netscape Navigator 4x, you must type "javascript:" into the location window. This will bring up the JavaScript console in your browser window. JavaScript errors will be written to the console as they occur. You can also use the console to test individual JavaScript statements. NN6 allows you to have the JavaScript console display in a separate window by going to Tasks -> Tools -> JavaScript Console.

Error Trapping with JavaScript
One of the most common ways to trap errors in troublesome ColdFusion code is to wrap a <cftry>/<cfcatch> block around it. If you're not using this method, you really should look into it. Part 4 of Charlie Arehart's series (June 2002) dealt with this topic.

JavaScript actually has try/catch statements of its own. As in CF, this is used to test for errors that you can anticipate. The simple example I use in Listing 1 only shows the error message (called "description" in IE and "message" in NN). You can catch information other than the message/description in that scope as well. However, the other variables also differ from browser to browser. Variables available in one browser aren't necessarily available in another. Table 1 (from JavaScript: The Complete Reference by Thomas Powell and Fritz Schneider [Osborne McGraw-Hill]) illustrates some of the variables that will be available in selected browsers.

The main problem with depending on try/catch for error handling in JavaScript is that it was only introduced in IE5 and NN6. This leaves out a good portion of your audience. Additionally, you have to write try/ catch statements around every bit of troubling code. While you can nest JavaScript try/catch statements just as you can ColdFusion ones, the nature of JavaScript means that encompassing all of your code in try/catch statements just isn't practical. Besides, we don't have the time to rewrite all of our existing code to use try/catch. There's got to be a better way.

Enter the "onerror" Property
This property of the window object has been available since NN3 and IE4. It's a great way to deal with JavaScript errors on a universal level (sort of like <cferror> - see Part 3 of Charlie Arehart's series [February 2001]). It can be used to deal with any JavaScript errors on the entire page, making it a very powerful error handler. Yet it rarely gets used.

The onerror property is used in the window object and in some cases it's available in other JavaScript objects as well (like the img object). I only cover the onerror property of the window object here.

The onerror property tells the browser to execute a function when a JavaScript error occurs anywhere on the page. If this function returns a value of true, this will also disable the browser's default error handling, including displaying the error message to the user for those who've opted to see them (as above).

Listing 2 is a simple example of the onerror property in use. All this does is display a series of alert boxes when an error occurs. It isn't terribly useful, but does make an effective demo. Note the three parameters used in defining the onerror event handler (function). The information used wasn't explicitly passed to the script, but rather was part of how the browser naturally passes information to the onerror event. Note also that I put it before any other HTML. I did this to demonstrate that you could include this script (or one like it) in your Application.cfm and it would still work. Naturally, you could put any other JavaScript statements in this script.

Bringing ColdFusion into the Picture
Certainly you've gotten information from the browser to ColdFusion before, but for this technique to work smoothly, we must do it in such a way that we don't distract from the user's experience. Notice that no other window is opened, and that our current page is not forced to refresh (which would likely cause the error to recur and put the user in an infinite loop). Any of that could interfere with the user's experience. So how do we do it?

The trick is getting images. Any time you use JavaScript to define an image source, you're making a trip to the server to get that image so it will be ready for use on the page. The source of an image object doesn't have to be an actual image. JavaScript doesn't check what sort of file you're using as the source. So you can call a ColdFusion page via the JavaScript image source functionality. You can even append variables to the URL in your request and JavaScript will dutifully send the request to the page and use that page as the source of an image.

This would cause a problem if you actually tried to display the image, but we have no need to do that. We're just sending information to a ColdFusion page. The image is simply our way to do it without forcing the user to leave the page. This is the only way I know of that this can be done in HTML, that is consistent across browsers, and that doesn't distract from the user's experience.

Once we know this, everything else is just an extension of what we've learned so far. The technique could have other uses as well. For example, you could pull a ColdFusion page that's using <CFCONTENT> to make the page output its contents as a .gif or .jpg instead of HTML. This would allow server-side processing to be used to choose an image without the user having to experience a page reload. While I haven't seen any practical uses for this yet, I'm hoping this suggestion will whet enough appetites that I might hear ideas from others.

Now all you have to do is pass on the variables that were passed to your error handler script to your ColdFusion page as follows:

errImage = new Image();
errImage.src = 'JSErrs.cfm?url=' + escape(errUrl)
+ '&msg=' + escape(msg) + '&line=' + line;

You can then use this ColdFusion page to send yourself an e-mail or log the error. I generally put a <cfmail> tag in mine and have the JavaScript errors e-mailed to myself. If you make sure that you call a ColdFusion page that's in the same application as the executing script (I always do), you can also send yourself CGI and session variables. Your URL variables will automatically be included in the URL passed to your ColdFusion page. Listing 3 shows a basic script that could be used as the ColdFusion page to handle the JavaScript error. If you aren't using CF5 or above, you can manually loop through the session and URL variables (as shown in Part 2 of Charlie's series [December 2000]) or you can use the CF_Dump custom tag that should still be available in the Macromedia Developer's Exchange.

All this means that you can be notified about a JavaScript error without the user's even knowing that the error occurred. This makes debugging easier for you and a better experience for your user. Remember to test any code that deals with user input carefully and to use try/catch blocks around it so you can tell your user about these errors. If they're unable to submit a form and don't know why, they'll find it very frustrating.

Summary
In this article I covered some ways to detect and prevent Java-Script errors. I also addressed handling errors in JavaScript. Finally, I covered how to send information about JavaScript errors on your page to ColdFusion and showed how to e-mail those errors to yourself. Hopefully this will help you deal with potential JavaScript errors in your current and future development. Good luck!

More Stories By Steve Bryant

Steve Bryant is the founder and CEO of Bryant Web Consulting LLC (www.bryantwebconsulting.com) and teaches ColdFusion at Breakaway Interactive (www.breakawayinteractive.com). He got his BA in philosophy at Oklahoma State University. Steve, one of the top ColdFusion developers in the country, still has no idea how that led to a career in Web development. Steve blogs at steve.coldfusionjournal.com as one of CFDJ's published bloggers.

Comments (1) View Comments

Share your thoughts on this story.

Add your comment
You must be signed in to add a comment. Sign-in | Register

In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.


Most Recent Comments
10/17/02 03:31:00 PM EDT
@ThingsExpo Stories
As businesses adopt functionalities in cloud computing, it’s imperative that IT operations consistently ensure cloud systems work correctly – all of the time, and to their best capabilities. In his session at @BigDataExpo, Bernd Harzog, CEO and founder of OpsDataStore, will present an industry answer to the common question, “Are you running IT operations as efficiently and as cost effectively as you need to?” He will expound on the industry issues he frequently came up against as an analyst, and...
Your homes and cars can be automated and self-serviced. Why can't your storage? From simply asking questions to analyze and troubleshoot your infrastructure, to provisioning storage with snapshots, recovery and replication, your wildest sci-fi dream has come true. In his session at @DevOpsSummit at 20th Cloud Expo, Dan Florea, Director of Product Management at Tintri, will provide a ChatOps demo where you can talk to your storage and manage it from anywhere, through Slack and similar services ...
SYS-CON Events announced today that HTBase will exhibit at SYS-CON's 20th International Cloud Expo®, which will take place on June 6-8, 2017, at the Javits Center in New York City, NY. HTBase (Gartner 2016 Cool Vendor) delivers a Composable IT infrastructure solution architected for agility and increased efficiency. It turns compute, storage, and fabric into fluid pools of resources that are easily composed and re-composed to meet each application’s needs. With HTBase, companies can quickly prov...
SYS-CON Events announced today that Linux Academy, the foremost online Linux and cloud training platform and community, will exhibit at SYS-CON's 20th International Cloud Expo®, which will take place on June 6-8, 2017, at the Javits Center in New York City, NY. Linux Academy was founded on the belief that providing high-quality, in-depth training should be available at an affordable price. Industry leaders in quality training, provided services, and student certification passes, its goal is to c...
SYS-CON Events announced today that SoftLayer, an IBM Company, has been named “Gold Sponsor” of SYS-CON's 18th Cloud Expo, which will take place on June 7-9, 2016, at the Javits Center in New York, New York. SoftLayer, an IBM Company, provides cloud infrastructure as a service from a growing number of data centers and network points of presence around the world. SoftLayer’s customers range from Web startups to global enterprises.
In his session at @ThingsExpo, Eric Lachapelle, CEO of the Professional Evaluation and Certification Board (PECB), will provide an overview of various initiatives to certifiy the security of connected devices and future trends in ensuring public trust of IoT. Eric Lachapelle is the Chief Executive Officer of the Professional Evaluation and Certification Board (PECB), an international certification body. His role is to help companies and individuals to achieve professional, accredited and worldw...
SYS-CON Events announced today that Technologic Systems Inc., an embedded systems solutions company, will exhibit at SYS-CON's @ThingsExpo, which will take place on June 6-8, 2017, at the Javits Center in New York City, NY. Technologic Systems is an embedded systems company with headquarters in Fountain Hills, Arizona. They have been in business for 32 years, helping more than 8,000 OEM customers and building over a hundred COTS products that have never been discontinued. Technologic Systems’ pr...
SYS-CON Events announced today that Auditwerx will exhibit at SYS-CON's 20th International Cloud Expo®, which will take place on June 6-8, 2017, at the Javits Center in New York City, NY. Auditwerx specializes in SOC 1, SOC 2, and SOC 3 attestation services throughout the U.S. and Canada. As a division of Carr, Riggs & Ingram (CRI), one of the top 20 largest CPA firms nationally, you can expect the resources, skills, and experience of a much larger firm combined with the accessibility and attent...
SYS-CON Events announced today that CA Technologies has been named “Platinum Sponsor” of SYS-CON's 20th International Cloud Expo®, which will take place on June 6-8, 2017, at the Javits Center in New York City, NY, and the 21st International Cloud Expo®, which will take place October 31-November 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. CA Technologies helps customers succeed in a future where every business – from apparel to energy – is being rewritten by software. From ...
With major technology companies and startups seriously embracing Cloud strategies, now is the perfect time to attend @CloudExpo | @ThingsExpo, June 6-8, 2017, at the Javits Center in New York City, NY and October 31 - November 2, 2017, Santa Clara Convention Center, CA. Learn what is going on, contribute to the discussions, and ensure that your enterprise is on the right path to Digital Transformation.
SYS-CON Events announced today that Loom Systems will exhibit at SYS-CON's 20th International Cloud Expo®, which will take place on June 6-8, 2017, at the Javits Center in New York City, NY. Founded in 2015, Loom Systems delivers an advanced AI solution to predict and prevent problems in the digital business. Loom stands alone in the industry as an AI analysis platform requiring no prior math knowledge from operators, leveraging the existing staff to succeed in the digital era. With offices in S...
SYS-CON Events announced today that T-Mobile will exhibit at SYS-CON's 20th International Cloud Expo®, which will take place on June 6-8, 2017, at the Javits Center in New York City, NY. As America's Un-carrier, T-Mobile US, Inc., is redefining the way consumers and businesses buy wireless services through leading product and service innovation. The Company's advanced nationwide 4G LTE network delivers outstanding wireless experiences to 67.4 million customers who are unwilling to compromise on ...
SYS-CON Events announced today that Infranics will exhibit at SYS-CON's 20th International Cloud Expo®, which will take place on June 6-8, 2017, at the Javits Center in New York City, NY. Since 2000, Infranics has developed SysMaster Suite, which is required for the stable and efficient management of ICT infrastructure. The ICT management solution developed and provided by Infranics continues to add intelligence to the ICT infrastructure through the IMC (Infra Management Cycle) based on mathemat...
SYS-CON Events announced today that Interoute, owner-operator of one of Europe's largest networks and a global cloud services platform, has been named “Bronze Sponsor” of SYS-CON's 20th Cloud Expo, which will take place on June 6-8, 2017 at the Javits Center in New York, New York. Interoute is the owner-operator of one of Europe's largest networks and a global cloud services platform which encompasses 12 data centers, 14 virtual data centers and 31 colocation centers, with connections to 195 add...
SYS-CON Events announced today that Cloudistics, an on-premises cloud computing company, has been named “Bronze Sponsor” of SYS-CON's 20th International Cloud Expo®, which will take place on June 6-8, 2017, at the Javits Center in New York City, NY. Cloudistics delivers a complete public cloud experience with composable on-premises infrastructures to medium and large enterprises. Its software-defined technology natively converges network, storage, compute, virtualization, and management into a ...
SYS-CON Events announced today that SD Times | BZ Media has been named “Media Sponsor” of SYS-CON's 20th International Cloud Expo, which will take place on June 6–8, 2017, at the Javits Center in New York City, NY. BZ Media LLC is a high-tech media company that produces technical conferences and expositions, and publishes a magazine, newsletters and websites in the software development, SharePoint, mobile development and commercial UAV markets.
"I think that everyone recognizes that for IoT to really realize its full potential and value that it is about creating ecosystems and marketplaces and that no single vendor is able to support what is required," explained Esmeralda Swartz, VP, Marketing Enterprise and Cloud at Ericsson, in this SYS-CON.tv interview at @ThingsExpo, held June 7-9, 2016, at the Javits Center in New York City, NY.
Why do your mobile transformations need to happen today? Mobile is the strategy that enterprise transformation centers on to drive customer engagement. In his general session at @ThingsExpo, Roger Woods, Director, Mobile Product & Strategy – Adobe Marketing Cloud, covered key IoT and mobile trends that are forcing mobile transformation, key components of a solid mobile strategy and explored how brands are effectively driving mobile change throughout the enterprise.
My team embarked on building a data lake for our sales and marketing data to better understand customer journeys. This required building a hybrid data pipeline to connect our cloud CRM with the new Hadoop Data Lake. One challenge is that IT was not in a position to provide support until we proved value and marketing did not have the experience, so we embarked on the journey ourselves within the product marketing team for our line of business within Progress. In his session at @BigDataExpo, Sum...
Keeping pace with advancements in software delivery processes and tooling is taxing even for the most proficient organizations. Point tools, platforms, open source and the increasing adoption of private and public cloud services requires strong engineering rigor - all in the face of developer demands to use the tools of choice. As Agile has settled in as a mainstream practice, now DevOps has emerged as the next wave to improve software delivery speed and output. To make DevOps work, organization...