add tests for Plotly.purge and Plots.cleanPlot

Author: etpinard

test/jasmine/tests/gl_plot_interact_test.js

@@ -36,14 +36,19 @@ describe('Test gl plot interactions', function() {
 
         sceneIds = Plots.getSubplotIds(fullLayout, 'gl3d');
         sceneIds.forEach(function(id) {
-            fullLayout[id]._scene.destroy();
+            var scene = fullLayout[id]._scene;
+
+            if(scene.glplot) scene.destroy();
         });
 
         sceneIds = Plots.getSubplotIds(fullLayout, 'gl2d');
         sceneIds.forEach(function(id) {
             var scene2d = fullLayout._plots[id]._scene2d;
-            scene2d.stopped = true;
-            scene2d.destroy();
+
+            if(scene2d.glplot) {
+                scene2d.stopped = true;
+                scene2d.destroy();
+            }
         });
 
         destroyGraphDiv();
@@ -369,4 +374,43 @@ describe('Test gl plot interactions', function() {
         });
 
     });
+
+    describe('Plots.cleanPlot', function() {
+
+        it('should remove gl context from the graph div of a gl3d plot', function(done) {
+            gd = createGraphDiv();
+
+            var mockData = [{
+                type: 'scatter3d'
+            }];
+
+            Plotly.plot(gd, mockData).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();
+
+            var mockData = [{
+                type: 'scattergl',
+                x: [1,2,3],
+                y: [1,2,3]
+            }];
+
+            Plotly.plot(gd, mockData).then(function() {
+                expect(gd._fullLayout._plots.xy._scene2d.glplot).toBeDefined();
+
+                Plots.cleanPlot([], {}, gd._fullData, gd._fullLayout);
+                expect(gd._fullLayout._plots.xy._scene2d.glplot).toBe(null);
+
+                done();
+            });
+        });
+    });
 });

test/jasmine/tests/plot_api_test.js

@@ -7,6 +7,8 @@ var Bar = require('@src/traces/bar');
 var Legend = require('@src/components/legend');
 var pkg = require('../../../package.json');
 
+var createGraphDiv = require('../assets/create_graph_div');
+var destroyGraphDiv = require('../assets/destroy_graph_div');
 
 describe('Test plot api', function() {
     'use strict';
@@ -616,4 +618,25 @@ describe('Test plot api', function() {
             expect(gd.data).toEqual(cachedData);
         });
     });
+
+    describe('Plotly.purge', function() {
+
+        afterEach(destroyGraphDiv);
+
+        it('should return the graph div in its original state', function(done) {
+            var gd = createGraphDiv();
+            var initialKeys = Object.keys(gd);
+            var intialHTML = gd.innerHTML;
+            var mockData = [{ x: [1,2,3], y: [2,3,4] }];
+
+            Plotly.plot(gd, mockData).then(function() {
+                Plotly.purge(gd);
+
+                expect(Object.keys(gd)).toEqual(initialKeys);
+                expect(gd.innerHTML).toEqual(intialHTML);
+
+                done();
+            });
+        });
+    });
 });