Folks who regularly read my blog (or follow me on Twitter) know that I like to remind people about the built in networking tools in modern browsers. For a while this was Firebug, but now that I'm a Chrome user it's the dev tools. Nine times out of ten the answer to why your Ajax application isn't working can be discovered by just looking at what your network data result was. But what do you do when that fails to help? In this blog entry I'm going to talk about a real problem I encountered last night with one of my Ajax based applications and the tools I used to diagnose and fix the issue.
One of my open source projects, Lighthouse Pro, is a basic issue tracker written in ColdFusion. To make working with large sets of issues easier, jQuery is used to load in the data one page at a time. Users can filter, sort, search, and paginate all through Ajax requests. To give you a basic idea, here's a quick screen shot:
All of those form fields on top allow for different types of filtering and all immediately refresh the issue list. This worked fine (see note below) until a user last night discovered that the list suddenly stopped showing up. My first thought was a network issue, so in my Chrome browser I opened it up and took a look see...
Hmmm, status code 200. That implies no error on the server side. But maybe something funky is going on with the data?
Nope - nothing odd there. Obviously there was more data then what you see in that screen shot, but I didn't see anything odd in the JSON, nor did I see anything appended to the end or in front that would break the JSON. So what do I do?
Notice I've got an error handler for my Ajax but it only cares about one type of error - a session timeout. Who wants to bet that I have some other error? If you click on the line #, you can add a breakpoint. That's what I did below:
Notice that the breakpoint is now listed in the right hand side as well. Ok, so here is the kick butt part. I reload my browser and immediately see execution stop.
Parse error! Ahah. So right away I'm thinking - my JSON string looks nice, but I bet one of those funky, "special" characters is causing me an issue. I switch back to my Network tab - I copy out the response, and head over to a slick online JSON parser I found.
What's cool about this tool is that I can now begin cutting out text, carefully ensuring I keep the JSON structurally valid, and eventually get down to a very small string. I then notice something. As I move my cursor, at one point, it takes two clicks to move. Bam Evil character of death found. But what is it?
I know switch over to ColdFusion. I drop the string into a variable and simply iterate over each character so I can find the culprit.
<cfloop index="x" from="1" to="#len(badstr)#">
<cfset c = mid(badstr, x, 1)>
I was looking for some high value, 8000 or so, but instead ran across ascii code 11 - the vertical tab.
So at this point I simply whipped up a quick fix to my JSON encoding, pushed it, and verified it was fine.
Anyway - I hope this helps. If you do a quick Google for Chrome debugger you will find many more, deeper articles out there. Mainly I want my readers to know about this option. It saved my butt today.
p.s. Ok, you can stop reading now if bored. ;) Interestingly enough, Lighthouse Pro has now been the impetus for two really big growths in my Ajax learning. This obviously was very interesting and educational for me. But even more interesting was the story of how I first converted LHP to Ajax. I ran into many issues with performance that - frankly - surprised me. Ajax apps are always supposed to be faster, right? Faster, better, slicker, etc? Turns out that wasn't the case. I made some basic architectural mistakes in my move to Ajax that worked fine in limited testing but not in production. But I'll leave that story for another day...