Wednesday, May 23, 2012

Simple jQuery Ajax call leaks memory in Internet Explorer


I created a web page that makes an Ajax call every second. In Internet Explorer 7, it leaks memory badly (20 MB in about 15 minutes).



The program is very simple. It just runs a JavaScript function that makes an Ajax call. The server returns an empty string, and the JavaScript code does nothing with it. I use setTimeout to run the function every second, and I'm using Drip to watch the thing.



Here is the source:




<html>
<head>
<script type="text/javascript" src="http://www.google.com/jsapi"></script>
<script type="text/javascript">
google.load('jquery', '1.4.2');
google.load('jqueryui', '1.7.2');
</script>
<script type="text/javascript">
setTimeout('testJunk()',1000);
function testJunk() {
$.ajax({ url: 'http://xxxxxxxxxxxxxx/test', // The url returns an empty string
dataType: 'html',
success: function(data){}
});
setTimeout('testJunk()',1000)
}
</script>
</head>
<body>
Why is memory usage going up?
</body>
</html>



How to plug this leak? I have a real application that updates a large table this way, but left unattended it will eat up gigabytes of memory.



Edit : okay, so after some good suggestions, I modified the code to:




<html>
<head>
<script type="text/javascript" src="http://www.google.com/jsapi"></script>
<script type="text/javascript">
google.load('jquery', '1.4.2');
google.load('jqueryui', '1.7.2');
</script>
<script type="text/javascript">
setTimeout(testJunk,1000);
function testJunk() {
$.ajax({ url: 'http://xxxxxxxxxxxxxx/test', // The url returns an empty string
dataType: 'html',
success: function(data){setTimeout(testJunk,1000)}
});
}
</script>
</head>
<body>
Why is memory usage going up?
</body>
</html>



It didn't seem to make any difference, though. I'm not doing anything with the DOM, and if I comment out the Ajax call, the memory leak stops. So it looks like the leak is entirely in the Ajax call. Does jQuery Ajax inherently create some sort of circular reference, and if so, how can I free it? By the way, it doesn't leak in Firefox.



Someone suggested running the test in another VM and see if the results are the same. Rather than setting up another VM, I found a laptop that was running XP Home with Internet Explorer 8. It exhibits the same problem.



I tried some older versions of jQuery and got better results, but the problem didn't go away entirely until I abandoned Ajax in jQuery and went with more traditional (and ugly) Ajax.


Source: Tips4all

5 comments:

  1. Here's a link to the bug over on jQuery, along with this as a suggested fix for jQuery 1.4.2:

    --- jquery-1.4.2.js 2010-04-08 12:10:20.000000000 -0700
    +++ jquery-1.4.2.js.fixed 2010-04-08 12:10:38.000000000 -0700
    @@ -5219,7 +5219,7 @@

    // Stop memory leaks
    if ( s.async ) {
    - xhr = null;
    + xhr.onreadystatechange = null; xhr.abort = null; xhr = null;
    }
    }
    };


    NOTE: This is officially fixed in jQuery 1.4.4, so your best bet is to just upgrade now.

    ReplyDelete
  2. eval() will eat up memory for sure (eval happens when passing a string to setTimeout to evaluate), don't use it in testing:

    setTimeout('testJunk()',1000);


    should be:

    setTimeout(testJunk, 1000);


    Also a better use overall would be setInterval() for a repeated operation like you want, try this:

    setInterval(testJunk, 1000);

    ReplyDelete
  3. I encountered the same issue and had been stumped all morning ... until a few moments ago. The problem is a circular reference that is created when you set the onreadystatechange handler, that IE isn't smart enough to break. The solution, therefore, is to break it explicitly. However, obviously you can't do it from within the handler itself (though it would be convenient if you could!).

    The magic statement:

    delete request['onreadystatechange'];


    You need to keep a record of each XMLHttpRequest object for which you set onreadystatechange. Then, at some point after readyState goes to 4, do your magic on the object. If you are already performing a repeated AJAX poll, the logical place to check for requests to clean up would be in the same polling loop. I defined a simple RequestTracker object to manage my requests.

    This worked for me; I verified that it solved the leak. Here's one link in particular that led the way (I would post more, but StackOverflow isn't letting me):


    http://bytes.com/topic/javascript/answers/152714-closures-xmlhttprequest-memory-leak

    ReplyDelete
  4. One problem with your code is that if your ajax request start to take a while you will start flooding the browser and server with ajax request you really should wait till the browser gets a return from the server before kicking off the next one.

    function testJunk() {
    $.ajax({ url: 'http://xxxxxxxxxxxxxx/test', // The url returns an empty string
    dataType: 'html',
    complete: function(data){
    setTimeout(testJunk,1000);
    }
    });
    }
    testJunk();

    ReplyDelete
  5. Just encountered this myself. I thought it was something to do with the UI library initially, but then it disappeared after I swapped in jQuery 1.5. for the version 1.4.2 that I was using. (1.4.4 didn't seem to fix the issue).

    ReplyDelete