[patch][ccla] Chart2D with events causes considerable memory leak on render()

[Jared Jurkiewicz]

Reported by Masato Noguchi (IBM): When some events are listened by connectToPlot() or actions are added, dojox.charting.Chart2D causes considerable memory leaks on render(). Which is caused by calls of connect() to Shape in dojox.charting.plot2d.Base._connectEvents, which are never disconnected.

The following code actually eliminates the leaks:

dojo.extend(dojox.charting.plot2d.Base, {
		 resetEvents: function(){
		 		 dojo.forEach(this._connects, dojo.disconnect);
		 		 delete this._connects;
		 		 this.plotEvent({type: "onplotreset", plot: this});
		 },
		 _connectEvents: function(shape, o){
		 		 if(!this._connects){
		 		 		 this._connects = [];
		 		 }
		 		 this._connects.push(shape.connect("onmouseover", this, function(e){
		 		 		 o.type  = "onmouseover";
		 		 		 o.event = e;
		 		 		 this.plotEvent(o);
		 		 }));
		 		 this._connects.push(shape.connect("onmouseout", this, function(e){
		 		 		 o.type  = "onmouseout";
		 		 		 o.event = e;
		 		 		 this.plotEvent(o);
		 		 }));
		 		 this._connects.push(shape.connect("onclick", this, function(e){
		 		 		 o.type  = "onclick";
		 		 		 o.event = e;
		 		 		 this.plotEvent(o);
		 		 }));
		 }
});

[Les]

This is something I don't understand about Dojo. If I destroy a widget or remove a DOM element, all event event handlers bound to that widget or DOM element should be unbound. I shouldn't have to worry about it.

See the jQuery doc for the remove() method. They unbound event handlers, but dojo.orphan() is not doing that.

​http://api.jquery.com/remove/

[bill]

1.4.2 has already been released. Suggest targeting for 1.5 although we could have a 1.4.3.

[Eugene Lazutkin]

Replying to Les:

Next time just open a separate ticket, if you see a general problem. I opened a ticket against the core: #10941.

[Eugene Lazutkin]

(In [21714]) Guarding against potential memory leaks, thx Masato Noguchi (IBM) and jaredj!, !strict, fixes #10827.

[Adam Peller]

Sheng Tian (IBM) reports:

dojox.charting.action2d.Magnify, dojox.charting.action2d.MoveSlice?,dojox.charting.action2d.Shake, dojox.charting.DataChart?, dojox.charting.plot2d.Pie, all have dojo.connect without disconnect.

[Adam Peller]

new patch provided

[ESBANTE]

Seems like charting.action2d.Tooltip needs to be fixed too.

[ESBANTE]

Memory leak example

[ESBANTE]

hi, I was getting memory leaks on IE 8 so i applied the patch to my dojo lib to see if it will fix the problem. although the memory leak persists. I am not sure if the problem is the patch or something on the approach I am using on the chart (see attached file. chart_leak.html)

[shengt]

Still can see some memory leak on IE8 after applying Tooltip, Magnify, Highlight actions. See attached test file.

[Adam Peller]

updated patch from xiangxz

[Eugene Lazutkin]

(In [22375]) charting: eliminating potential memory leaks in programmatic events, thx vmware!, !strict, refs #11356, refs #11374, refs #10827.

[Eugene Lazutkin]

Replying to shengt:

Still can see some memory leak on IE8 after applying Tooltip, Magnify, Highlight actions. See attached test file.

No wonder --- your test file creates and attaches actions yet never destroys them. All external objects (actions, legends, data stores, and so on) should be destroyed separately --- the same way they were created separately.

[Eugene Lazutkin]

I spent quality time with the updated leak test and with current code I see a sustainable memory level. I tired Chrome, IE6, and IE8.

[Eugene Lazutkin]

Robot missed: (In [22379]) charting: memory-leak preventive changes, !strict, fixes #10827.

[Eugene Lazutkin]

BTW, it is safe to leave JavaScript objects connected using dojo.connect(). But if a JavaScript object connected to a DOM node, it may cause leaks, and such links should be disconnected with dojo.disconnect(). That's why actions do not have to disconnect when they connected to a local animation object.

[aryalrabin]

line chart leak

[aryalrabin]

I am still seeing memory leaks on IE 8, FF, Chrome. I have similar as chart_leak.html. I have attached file linechart_leak.html.

[aryalrabin]

I am using dojo 1.5

[Eugene Lazutkin]

Bumping from non-existant 1.5.1 to 1.6.

[Eugene Lazutkin]

I ran linechart_leak.html using the trunk for one hour on Chrome watching the memory size --- it was clearly bounded from above being on average between 40-80M.