From 6b8ffe79f4e616d6179f6b16099e7c25e7ae5cb1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn=20Zaefferer?= Date: Thu, 21 Dec 2006 13:35:32 +0000 Subject: [PATCH] Implemented a better error handling for ajax requests. Exceptions caused by dropping connections are now handled, too. --- build/test/data/testrunner.js | 5 +- newandnoteworthy.txt | 1 + src/ajax/ajax.js | 106 ++++++++++++++++++---------------- src/ajax/ajaxTest.js | 4 +- 4 files changed, 63 insertions(+), 53 deletions(-) diff --git a/build/test/data/testrunner.js b/build/test/data/testrunner.js index 3888ad9b..86a16d5c 100644 --- a/build/test/data/testrunner.js +++ b/build/test/data/testrunner.js @@ -35,7 +35,10 @@ function process() { function stop() { _config.blocking = true; - _config.timeout = setTimeout(start, _config.asyncTimeout * 1000); + _config.timeout = setTimeout(function() { + ok( false, "Test timed out" ); + start(); + }, _config.asyncTimeout * 1000); } function start() { if(_config.timeout) diff --git a/newandnoteworthy.txt b/newandnoteworthy.txt index 10aa9eae..713ef092 100644 --- a/newandnoteworthy.txt +++ b/newandnoteworthy.txt @@ -12,6 +12,7 @@ New and Noteworthy - Improved jQuery.merge to avoid unnecessary loops - Fixed docs for html(): Now mentions that is not available for XML documents - Improved docs for blur() and focus(), mentioning the difference between calling the jQuery method and the DOM method + - Implemented a better error handling for ajax requests. Exceptions caused by dropping connections are now handled, too. 1.0.4 ----- diff --git a/src/ajax/ajax.js b/src/ajax/ajax.js index 2c86812b..9d4e8b51 100644 --- a/src/ajax/ajax.js +++ b/src/ajax/ajax.js @@ -207,7 +207,8 @@ if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" ) * Attach a function to be executed whenever an AJAX request fails. * * The XMLHttpRequest and settings used for that request are passed - * as arguments to the callback. + * as arguments to the callback. A third argument, an exception object, + * is passed if an exception occured while processing the request. * * @example $("#msg").ajaxError(function(request, settings){ * $(this).append("
  • Error requesting page " + settings.url + "
    • "); @@ -480,8 +481,9 @@ jQuery.extend({ * like ajaxStart or ajaxStop are triggered. * * (Function) error - A function to be called if the request fails. The - * function gets passed two arguments: The XMLHttpRequest object and a - * string describing the type of error that occurred. + * function gets passed tree arguments: The XMLHttpRequest object, a + * string describing the type of error that occurred and an optional + * exception object, if one occured. * * (Function) success - A function to be called if the request succeeds. The * function gets passed one argument: The data returned from the server, @@ -618,40 +620,35 @@ jQuery.extend({ // The transfer is complete and the data is available, or the request timed out if ( xml && (xml.readyState == 4 || isTimeout == "timeout") ) { requestDone = true; - - var status = jQuery.httpSuccess( xml ) && isTimeout != "timeout" ? - s.ifModified && jQuery.httpNotModified( xml, s.url ) ? "notmodified" : "success" : "error"; - - // Make sure that the request was successful or notmodified - if ( status != "error" ) { - // Cache Last-Modified header, if ifModified mode. - var modRes; - try { - modRes = xml.getResponseHeader("Last-Modified"); - } catch(e) {} // swallow exception thrown by FF if header is not available - - if ( s.ifModified && modRes ) - jQuery.lastModified[s.url] = modRes; - - // process the data (runs the xml through httpData regardless of callback) - var data = jQuery.httpData( xml, s.dataType ); - - // If a local callback was specified, fire it and pass it the data - if ( s.success ) - s.success( data, status ); - - // Fire the global callback - if( s.global ) - jQuery.event.trigger( "ajaxSuccess", [xml, s] ); - - // Otherwise, the request was not successful - } else { - // If a local callback was specified, fire it - if ( s.error ) s.error( xml, status ); - - // Fire the global callback - if( s.global ) - jQuery.event.trigger( "ajaxError", [xml, s] ); + var status; + try { + status = jQuery.httpSuccess( xml ) && isTimeout != "timeout" ? + s.ifModified && jQuery.httpNotModified( xml, s.url ) ? "notmodified" : "success" : "error"; + // Make sure that the request was successful or notmodified + if ( status != "error" ) { + // Cache Last-Modified header, if ifModified mode. + var modRes; + try { + modRes = xml.getResponseHeader("Last-Modified"); + } catch(e) {} // swallow exception thrown by FF if header is not available + + if ( s.ifModified && modRes ) + jQuery.lastModified[s.url] = modRes; + + // process the data (runs the xml through httpData regardless of callback) + var data = jQuery.httpData( xml, s.dataType ); + + // If a local callback was specified, fire it and pass it the data + if ( s.success ) + s.success( data, status ); + + // Fire the global callback + if( s.global ) + jQuery.event.trigger( "ajaxSuccess", [xml, s] ); + } + } catch(e) { + status = "error"; + jQuery.handleError(s, xml, status, e); } // The request was completed @@ -691,35 +688,42 @@ jQuery.extend({ var xml2 = xml; // Send the data - xml2.send(s.data); + try { + xml2.send(s.data); + } catch(e) { + jQuery.handleError(s, xml, null, e); + } // return XMLHttpRequest to allow aborting the request etc. return xml2; }, + handleError: function(s, xml, status, e) { + // If a local callback was specified, fire it + if ( s.error ) s.error( xml, status, e ); + + // Fire the global callback + if( s.global ) + jQuery.event.trigger( "ajaxError", [xml, s, e] ); + }, + // Counter for holding the number of active queries active: 0, // Determines if an XMLHttpRequest was successful or not httpSuccess: function(r) { - try { - return !r.status && location.protocol == "file:" || - ( r.status >= 200 && r.status < 300 ) || r.status == 304 || - jQuery.browser.safari && r.status == undefined; - } catch(e){} - return false; + return !r.status && location.protocol == "file:" || + ( r.status >= 200 && r.status < 300 ) || r.status == 304 || + jQuery.browser.safari && r.status == undefined; }, // Determines if an XMLHttpRequest returns NotModified httpNotModified: function(xml, url) { - try { - var xmlRes = xml.getResponseHeader("Last-Modified"); + var xmlRes = xml.getResponseHeader("Last-Modified"); - // Firefox always returns 200. check Last-Modified date - return xml.status == 304 || xmlRes == jQuery.lastModified[url] || - jQuery.browser.safari && xml.status == undefined; - } catch(e){} - return false; + // Firefox always returns 200. check Last-Modified date + return xml.status == 304 || xmlRes == jQuery.lastModified[url] || + jQuery.browser.safari && xml.status == undefined; }, /* Get the data out of an XMLHttpRequest. diff --git a/src/ajax/ajaxTest.js b/src/ajax/ajaxTest.js index 3159fb81..ad85e053 100644 --- a/src/ajax/ajaxTest.js +++ b/src/ajax/ajaxTest.js @@ -45,7 +45,7 @@ test("synchronous request", function() { test("synchronous request with callbacks", function() { var result; - $.ajax({url: "data/json.php", async: false, success: function(data) { result = data; }}); + $.ajax({url: "data/json.php", async: false, success: function(data) { result = data; } }); ok( /^{ "data"/.test( result ), "check returned text" ); }); @@ -234,6 +234,8 @@ test("$.ajaxTimeout(Number) - with global timeout", function() { error: pass, success: fail }); + // reset timeout + $.ajaxTimeout(0); }); test("$.ajaxTimeout(Number) with localtimeout", function() {