Skip to content

Memory leak fixes #724

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 8, 2016
Merged

Memory leak fixes #724

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c123ebc
Memory leak fix candidates: 1) purge must destroy scene2d otherwise r…
monfera Jul 6, 2016
6c92920
Lint
monfera Jul 6, 2016
57c7779
Call cleanPlot from newPlot directly; Changed the location of the tra…
monfera Jul 8, 2016
8937668
Adding test cases that check that Plotly.newPlot indeed causes derefe…
monfera Jul 8, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/plot_api/plot_api.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -835,6 +835,10 @@ Plotly.redraw = function(gd) {
*/
Plotly.newPlot = function(gd, data, layout, config) {
gd = getGraphDiv(gd);

// remove gl contexts
Plots.cleanPlot([], {}, gd._fullData || {}, gd._fullLayout || {});
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great!

@monfera would you adding a test case for checking that Plotly.newPlot does clear existing gl contexts similar to the one for Plots.cleanPlot ?

Thanks in advance.


Plots.purge(gd);
return Plotly.plot(gd, data, layout, config);
};
Expand Down
10 changes: 10 additions & 0 deletions src/plots/gl2d/scene2d.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,6 +310,16 @@ proto.cameraChanged = function() {
};

proto.destroy = function() {

var traces = this.traces;

if(traces) {
Object.keys(traces).map(function(key) {
traces[key].dispose();
delete traces[key];
});
}

this.glplot.dispose();

if(!this.staticPlot) this.container.removeChild(this.canvas);
Expand Down
134 changes: 112 additions & 22 deletions test/jasmine/tests/gl_plot_interact_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -507,41 +507,131 @@ describe('Test gl plot interactions', function() {
});
});

describe('Plots.cleanPlot', function() {
describe('Removal of gl contexts', function() {

it('should remove gl context from the graph div of a gl3d plot', function(done) {
gd = createGraphDiv();
var mockData2d = [{
type: 'scattergl',
x: [1, 2, 3],
y: [2, 1, 3]
}];

var mockData = [{
type: 'scatter3d'
}];

Plotly.plot(gd, mockData).then(function() {
expect(gd._fullLayout.scene._scene.glplot).toBeDefined();
var mockData3d = [{
type: 'scatter3d',
x: [1, 2, 3],
y: [2, 1, 3],
z: [3, 2, 1]
}];

Plots.cleanPlot([], {}, gd._fullData, gd._fullLayout);
expect(gd._fullLayout.scene._scene.glplot).toBe(null);
describe('Plots.cleanPlot', function() {

done();
it('should remove gl context from the graph div of a gl3d plot', function(done) {
gd = createGraphDiv();

Plotly.plot(gd, mockData3d).then(function() {
expect(gd._fullLayout.scene._scene.glplot).toBeDefined();

Plots.cleanPlot([], {}, gd._fullData, gd._fullLayout);
expect(gd._fullLayout.scene._scene.glplot).toBe(null);

done();
});
});
});

it('should remove gl context from the graph div of a gl2d plot', function(done) {
gd = createGraphDiv();
it('should remove gl context from the graph div of a gl2d plot', function(done) {
gd = createGraphDiv();

var mockData = [{
Plotly.plot(gd, mockData2d).then(function() {
expect(gd._fullLayout._plots.xy._scene2d.glplot).toBeDefined();

Plots.cleanPlot([], {}, gd._fullData, gd._fullLayout);
expect(gd._fullLayout._plots).toEqual({});

done();
});
});
});
describe('Plotly.newPlot', function() {

var mockData2dNew = [{
type: 'scattergl',
x: [1, 2, 3],
y: [1, 2, 3]
x: [1, 3, 2],
y: [2, 3, 1]
}];

Plotly.plot(gd, mockData).then(function() {
expect(gd._fullLayout._plots.xy._scene2d.glplot).toBeDefined();

Plots.cleanPlot([], {}, gd._fullData, gd._fullLayout);
expect(gd._fullLayout._plots).toEqual({});
var mockData3dNew = [{
type: 'scatter3d',
x: [2, 1, 3],
y: [1, 2, 3],
z: [2, 1, 3]
}];

done();

it('should remove gl context from the graph div of a gl3d plot', function(done) {
gd = createGraphDiv();

Plotly.plot(gd, mockData3d).then(function() {

var firstGlplotObject = gd._fullLayout.scene._scene.glplot;
var firstGlContext = firstGlplotObject.gl;
var firstCanvas = firstGlContext.canvas;

expect(firstGlplotObject).toBeDefined();

Plotly.newPlot(gd, mockData3dNew, {}).then(function() {

var secondGlplotObject = gd._fullLayout.scene._scene.glplot;
var secondGlContext = secondGlplotObject.gl;
var secondCanvas = secondGlContext.canvas;

expect(secondGlplotObject).not.toBe(firstGlplotObject);
expect(firstGlplotObject.gl === null);
expect(secondGlContext instanceof WebGLRenderingContext);
expect(secondGlContext).not.toBe(firstGlContext);

// The same canvas can't possibly be reassinged a new WebGL context, but let's leave room
// for the implementation to make the context get lost and have the old canvas stick around
// in a disused state.
expect(firstCanvas.parentNode === null ||
firstCanvas !== secondCanvas && firstGlContext.isContextLost());

done();

});
});
});

it('should remove gl context from the graph div of a gl2d plot', function(done) {
gd = createGraphDiv();

Plotly.plot(gd, mockData2d).then(function() {

var firstGlplotObject = gd._fullLayout._plots.xy._scene2d.glplot;
var firstGlContext = firstGlplotObject.gl;
var firstCanvas = firstGlContext.canvas;

expect(firstGlplotObject).toBeDefined();
expect(firstGlContext).toBeDefined();
expect(firstGlContext instanceof WebGLRenderingContext);

Plotly.newPlot(gd, mockData2dNew, {}).then(function() {

var secondGlplotObject = gd._fullLayout._plots.xy._scene2d.glplot;
var secondGlContext = secondGlplotObject.gl;
var secondCanvas = secondGlContext.canvas;

expect(Object.keys(gd._fullLayout._plots).length === 1);
expect(secondGlplotObject).not.toBe(firstGlplotObject);
expect(firstGlplotObject.gl === null);
expect(secondGlContext instanceof WebGLRenderingContext);
expect(secondGlContext).not.toBe(firstGlContext);
expect(firstCanvas.parentNode === null ||
firstCanvas !== secondCanvas && firstGlContext.isContextLost());

done();
});
});
});
});
});
Expand Down