Eli
Eli

Reputation: 99348

jQuery: Automatically abort AjaxRequests on Page Unload?

Thanks for reading.

I've noticed that if I have a page that has one or more ajax requests open, and I click a link to leave a page, or refresh it, it will wait for the ajax requests to complete before unloading.

This isn't usually an issue, but if the request takes a while, it can be.

I'm looking for something like:

$(window).bind("beforeunload", function() {AjaxRequest.abort();});

to automatically abort requests before unload, but not quite sure how to find the ajax requests. Would they be under window somewhere?

Upvotes: 13

Views: 16981

Answers (5)

yourpublicdisplayname
yourpublicdisplayname

Reputation: 214

The following code is tested and aborts all outstanding jQuery ajax requests on page unload in Chrome, but it gets used by Edge and IE using clients as well without error.

Put the following as the first jQuery ready handler:

$(onPageLoaded)

And put this somewhere accessible:

function onPageLoaded() {
    var jqxhrs = [];

    $(window).bind("beforeunload", function (event) {
        $.each(jqxhrs, function (idx, jqxhr) {
            if (jqxhr)
                jqxhr.abort();
        });
    });

    function registerJqxhr(event, jqxhr, settings) {
        jqxhrs.push(jqxhr);
    }

    function unregisterJqxhr(event, jqxhr, settings) {
        var idx = $.inArray(jqxhr, jqxhrs);
        jqxhrs.splice(idx, 1);
    }

    $(document).ajaxSend(registerJqxhr);
    $(document).ajaxComplete(unregisterJqxhr);
};

Upvotes: 8

Vitalii Ivanov
Vitalii Ivanov

Reputation: 3251

You have to persist all you ajax request and when page is being reloading abort all requests. Sample

var _requests = [];

var _abortAllRequests = function () {
    $(_requests).each(function (i, xhr) { xhr.abort(); });

    _requests = [];
}

$(window).on("beforeunload", function () { 
    _abortAllRequests();
});

somewhere in your code

 _requests.push($.ajax(...))

Additionally you can pop done requests using $.ajaxSetup with events ajaxStart ajaxStop, but its up to you

Upvotes: 2

servermanfail
servermanfail

Reputation: 2538

I just had this issue, I was doing a long-loop in PHP which was being called from $.ajax. My solution was to add session_write_close(); before the long loop.

My theory is, Chrome requests the next page before cancelling any background ajax requests. If your ajax request is the same _SESSION as the page you're navigating away from AND TO, then you have a deadlock before even your first line of PHP code is hit.

Upvotes: 4

Luca Matteis
Luca Matteis

Reputation: 29267

The $.ajax() jQuery method returns the XMLHttpRequest Object. This means you can apply standard methods on the object, like abort().

To unload use the built in unload jQuery event method.

var myajax = $.ajax(...); 
$(window).unload( function () { myajax.abort(); } );

Upvotes: 10

Sergey Galashyn
Sergey Galashyn

Reputation: 6956

Think you need window.onunload event plus AjaxRequestX = $.get(...) for each request, maybe keep objects in array and go through them on unload.

Upvotes: 1

Related Questions