Click here to close now.



Welcome!

You will be redirected in 30 seconds or close now.

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

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
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 18th Cloud Expo, which will take place on June 7-9, 2015 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 ad...
Most people haven’t heard the word, “gamification,” even though they probably, and perhaps unwittingly, participate in it every day. Gamification is “the process of adding games or game-like elements to something (as a task) so as to encourage participation.” Further, gamification is about bringing game mechanics – rules, constructs, processes, and methods – into the real world in an effort to engage people. In his session at @ThingsExpo, Robert Endo, owner and engagement manager of Intrepid D...
With an estimated 50 billion devices connected to the Internet by 2020, several industries will begin to expand their capabilities for retaining end point data at the edge to better utilize the range of data types and sheer volume of M2M data generated by the Internet of Things. In his session at @ThingsExpo, Don DeLoach, CEO and President of Infobright, will discuss the infrastructures businesses will need to implement to handle this explosion of data by providing specific use cases for filte...
SYS-CON Events announced today that Fusion, a leading provider of cloud services, will exhibit at SYS-CON's 18th International Cloud Expo®, which will take place on June 7-9, 2016, at the Javits Center in New York City, NY. Fusion, a leading provider of integrated cloud solutions to small, medium and large businesses, is the industry's single source for the cloud. Fusion's advanced, proprietary cloud service platform enables the integration of leading edge solutions in the cloud, including clou...
SYS-CON Events announced today that Commvault, a global leader in enterprise data protection and information management, has been named “Bronze Sponsor” of SYS-CON's 18th International Cloud Expo, which will take place on June 7–9, 2016, at the Javits Center in New York City, NY, and the 19th International Cloud Expo, which will take place on November 1–3, 2016, at the Santa Clara Convention Center in Santa Clara, CA. Commvault is a leading provider of data protection and information management...
SYS-CON Events announced today that Alert Logic, Inc., the leading provider of Security-as-a-Service solutions for the cloud, will exhibit at SYS-CON's 18th International Cloud Expo®, which will take place on June 7-9, 2016, at the Javits Center in New York City, NY. Alert Logic, Inc., provides Security-as-a-Service for on-premises, cloud, and hybrid infrastructures, delivering deep security insight and continuous protection for customers at a lower cost than traditional security solutions. Ful...
The cloud promises new levels of agility and cost-savings for Big Data, data warehousing and analytics. But it’s challenging to understand all the options – from IaaS and PaaS to newer services like HaaS (Hadoop as a Service) and BDaaS (Big Data as a Service). In her session at @BigDataExpo at @ThingsExpo, Hannah Smalltree, a director at Cazena, will provide an educational overview of emerging “as-a-service” options for Big Data in the cloud. This is critical background for IT and data profes...
SYS-CON Events announced today that VAI, a leading ERP software provider, will exhibit at SYS-CON's 18th International Cloud Expo®, which will take place on June 7-9, 2016, at the Javits Center in New York City, NY. VAI (Vormittag Associates, Inc.) is a leading independent mid-market ERP software developer renowned for its flexible solutions and ability to automate critical business functions for the distribution, manufacturing, specialty retail and service sectors. An IBM Premier Business Part...
Fortunately, meaningful and tangible business cases for IoT are plentiful in a broad array of industries and vertical markets. These range from simple warranty cost reduction for capital intensive assets, to minimizing downtime for vital business tools, to creating feedback loops improving product design, to improving and enhancing enterprise customer experiences. All of these business cases, which will be briefly explored in this session, hinge on cost effectively extracting relevant data from ...
As enterprises work to take advantage of Big Data technologies, they frequently become distracted by product-level decisions. In most new Big Data builds this approach is completely counter-productive: it presupposes tools that may not be a fit for development teams, forces IT to take on the burden of evaluating and maintaining unfamiliar technology, and represents a major up-front expense. In his session at @BigDataExpo at @ThingsExpo, Andrew Warfield, CTO and Co-Founder of Coho Data, will dis...
With the Apple Watch making its way onto wrists all over the world, it’s only a matter of time before it becomes a staple in the workplace. In fact, Forrester reported that 68 percent of technology and business decision-makers characterize wearables as a top priority for 2015. Recognizing their business value early on, FinancialForce.com was the first to bring ERP to wearables, helping streamline communication across front and back office functions. In his session at @ThingsExpo, Kevin Roberts...
Eighty percent of a data scientist’s time is spent gathering and cleaning up data, and 80% of all data is unstructured and almost never analyzed. Cognitive computing, in combination with Big Data, is changing the equation by creating data reservoirs and using natural language processing to enable analysis of unstructured data sources. This is impacting every aspect of the analytics profession from how data is mined (and by whom) to how it is delivered. This is not some futuristic vision: it's ha...
WebRTC has had a real tough three or four years, and so have those working with it. Only a few short years ago, the development world were excited about WebRTC and proclaiming how awesome it was. You might have played with the technology a couple of years ago, only to find the extra infrastructure requirements were painful to implement and poorly documented. This probably left a bitter taste in your mouth, especially when things went wrong.
Learn how IoT, cloud, social networks and last but not least, humans, can be integrated into a seamless integration of cooperative organisms both cybernetic and biological. This has been enabled by recent advances in IoT device capabilities, messaging frameworks, presence and collaboration services, where devices can share information and make independent and human assisted decisions based upon social status from other entities. In his session at @ThingsExpo, Michael Heydt, founder of Seamless...
The IoT's basic concept of collecting data from as many sources possible to drive better decision making, create process innovation and realize additional revenue has been in use at large enterprises with deep pockets for decades. So what has changed? In his session at @ThingsExpo, Prasanna Sivaramakrishnan, Solutions Architect at Red Hat, discussed the impact commodity hardware, ubiquitous connectivity, and innovations in open source software are having on the connected universe of people, thi...
WebRTC: together these advances have created a perfect storm of technologies that are disrupting and transforming classic communications models and ecosystems. In his session at WebRTC Summit, Cary Bran, VP of Innovation and New Ventures at Plantronics and PLT Labs, provided an overview of this technological shift, including associated business and consumer communications impacts, and opportunities it may enable, complement or entirely transform.
There are so many tools and techniques for data analytics that even for a data scientist the choices, possible systems, and even the types of data can be daunting. In his session at @ThingsExpo, Chris Harrold, Global CTO for Big Data Solutions for EMC Corporation, showed how to perform a simple, but meaningful analysis of social sentiment data using freely available tools that take only minutes to download and install. Participants received the download information, scripts, and complete end-t...
For manufacturers, the Internet of Things (IoT) represents a jumping-off point for innovation, jobs, and revenue creation. But to adequately seize the opportunity, manufacturers must design devices that are interconnected, can continually sense their environment and process huge amounts of data. As a first step, manufacturers must embrace a new product development ecosystem in order to support these products.
Manufacturing connected IoT versions of traditional products requires more than multiple deep technology skills. It also requires a shift in mindset, to realize that connected, sensor-enabled “things” act more like services than what we usually think of as products. In his session at @ThingsExpo, David Friedman, CEO and co-founder of Ayla Networks, discussed how when sensors start generating detailed real-world data about products and how they’re being used, smart manufacturers can use the dat...
When it comes to IoT in the enterprise, namely the commercial building and hospitality markets, a benefit not getting the attention it deserves is energy efficiency, and IoT’s direct impact on a cleaner, greener environment when installed in smart buildings. Until now clean technology was offered piecemeal and led with point solutions that require significant systems integration to orchestrate and deploy. There didn't exist a 'top down' approach that can manage and monitor the way a Smart Buildi...