CODEWITHSUNDEEP
jqueryajaxerror-handling
Shawn Mclean
Shawn Mclean

Reputation: 57469

Jquery Ajax error handling to ignore aborted

I want to have a global error handling method for ajax calls, this is what I have now:

$.ajaxSetup({
  error: function (XMLHttpRequest, textStatus, errorThrown) {
    displayError();
  }
});

I need to ignore the error of aborted. errorThrown is null and textStatus is error. How do I check for aborted?

Upvotes: 91

Views: 50150

Answers (9)

Paul Rademacher
Paul Rademacher

Reputation: 3011

You'll want to look at the textStatus argument passed into your error function. According to http://api.jquery.com/jQuery.ajax/, it can take the values "success", "notmodified", "error", "timeout", "abort", or "parsererror". "abort" is obviously what you want to check against.

Upvotes: 11

Sky
Sky

Reputation: 251

If you abort the ajax request manually, you can do like this:

var xhr;
function queryData () {
    if (xhr) {
      // tag it's been aborted
      xhr.hasAborted = true;

      // manually canceled request
      xhr.abort();
    }

    xhr = $.ajax({
        url: '...',
        error: function () {
            if (!xhr.hasAborted) {
                console.log('Internal Server Error!');
            }
        },
        complete: function () {
           xhr = null;
        }
    });
}

Upvotes: 0

Udi
Udi

Reputation: 30472

In modern jQuery you can just check if request.statusText is equal to 'abort':

error: function (request, textStatus, errorThrown) {
    if (request.statusText =='abort') {
        return;
    }
}

Upvotes: 45

secador de pelo
secador de pelo

Reputation: 699

Because bluecollarcoders answer doesn't work for ajax requests aborted by javascript, here is my solution:

var unloaded = false;
...
$(window).bind('beforeunload', function(){
    unloaded = true;
});


$(document).ajaxError(function(event, request, settings) {
    if (unloaded || request.statusText == "abort") {
        return;
    }
    ...
}

e.g.

handler = jQuery.get("foo")
handler.abort()

will now be ignored by ajaxError handler

Upvotes: 5

Diego Malone
Diego Malone

Reputation: 1052

I had the same issue here, and what I did as solution was to set an "aborting" var just before the call of abort(), as below:

aborting = true;
myAjax.abort();

and only show the error on the error handler of the ajax request, if abort isn't true.

$.ajax({
    [..]
    error: function() {
        if ( !aborting ) {
            // do some stuff..
        }
        aborting = false;
    }
});

Upvotes: 0

Leniel Maccaferri
Leniel Maccaferri

Reputation: 102368

Building upon Alastair Pitts'a answer, you can also do this to have more informative messages:

$(document).ajaxError(function (e, jqXHR, ajaxSettings, thrownError)
{
    {
        if (jqXHR.status === 0)
        {
            alert('Not connect.\n Verify Network.');
        } else if (jqXHR.status == 404)
        {
            alert('Requested page not found. [404]');
        } else if (jqXHR.status == 500)
        {
            alert('Internal Server Error [500].');
        } else if (exception === 'parsererror')
        {
            alert('Requested JSON parse failed.');
        } else if (exception === 'timeout')
        {
            alert('Time out error.');
        } else if (exception === 'abort')
        {
            alert('Ajax request aborted.');
        } else
        {
            alert('Uncaught Error.\n' + jqXHR.responseText);
        }
    }
});

Upvotes: 3

bluecollarcoder
bluecollarcoder

Reputation: 14399

I had to deal with the same use case today. The app I am working on has these long-running ajax calls that can be interrupted by 1) the user navigating away or 2) some kind of temporary connection/server failure. I want the error handler to run only for connection/server failure and not for the user navigating away.

I first tried Alastair Pitts' answer, but it did not work because both aborted requests and connection failure set status code and readyState to 0. Next, I tried sieppl's answer; also did not work because in both cases, no response is given, thus no header.

The only solution that worked for me is to set a listener for window.onbeforeunload, which sets a global variable to indicate that the page has been unloaded. The error handler can then check and only call the error handler only if the page has not been unloaded.

var globalVars = {unloaded:false};
$(window).bind('beforeunload', function(){
    globalVars.unloaded = true;
});
...
$.ajax({
    error: function(jqXHR,status,error){
        if (globalVars.unloaded)
            return;
    }
});

Upvotes: 57

sieppl
sieppl

Reputation: 714

$(document).ajaxError(function(event, jqXHR, ajaxSettings, thrownError) {

    if (!jqXHR.getAllResponseHeaders()) {
        return;
    }           
});

Upvotes: 2

Alastair Pitts
Alastair Pitts

Reputation: 19591

Something I found is that when there is an aborted request, the status and/or readyState equal 0.

In my global error handler, I have a check at the top of the method:

$(document).ajaxError(function (e, jqXHR, ajaxSettings, thrownError) {
    //If either of these are true, then it's not a true error and we don't care
    if (jqXHR.status === 0 || jqXHR.readyState === 0) {
        return;
    }

    //Do Stuff Here
});

I've found this works perfectly for me. Hope this helps you, or anyone else who runs into this :)

Upvotes: 22

Related Questions