tweak purge related to @etpinard's extra fix in #2055

Author: alexcjohnson

src/plot_api/plot_api.js

@@ -2734,12 +2734,8 @@ Plotly.purge = function purge(gd) {
     // remove plot container
     if(fullLayout._container) fullLayout._container.remove();
 
+    // in contrast to Plotly.Plots.purge which does NOT clear _context!
     delete gd._context;
-    delete gd._replotPending;
-    delete gd._mouseDownTime;
-    delete gd._legendMouseDownTime;
-    delete gd._hmpixcount;
-    delete gd._hmlumcount;
 
     return gd;
 };

src/plots/plots.js

@@ -1341,14 +1341,25 @@ plots.purge = function(gd) {
     delete gd._promises;
     delete gd._redrawTimer;
     delete gd.firstscatter;
-    delete gd.hmlumcount;
-    delete gd.hmpixcount;
+    delete gd._hmlumcount;
+    delete gd._hmpixcount;
     delete gd.numboxes;
     delete gd._transitionData;
     delete gd._transitioning;
     delete gd._initialAutoSize;
     delete gd._transitioningWithDuration;
 
+    // created during certain events, that *should* clean them up
+    // themselves, but may not if there was an error
+    delete gd._dragging;
+    delete gd._dragged;
+    delete gd._hoverdata;
+    delete gd._snapshotInProgress;
+    delete gd._editing;
+    delete gd._replotPending;
+    delete gd._mouseDownTime;
+    delete gd._legendMouseDownTime;
+
     // remove all event listeners
     if(gd.removeAllListeners) gd.removeAllListeners();
 };

test/jasmine/tests/plots_test.js

@@ -408,6 +408,19 @@ describe('Test Plots', function() {
         beforeEach(function(done) {
             gd = createGraphDiv();
             Plotly.plot(gd, [{ x: [1, 2, 3], y: [2, 3, 4] }], {}).then(done);
+
+            // hacky: simulate getting stuck with these flags due to an error
+            // see #2055 and commit 6a44a9a - before fixing that error, we would
+            // end up in an inconsistent state that prevented future Plotly.newPlot
+            // because _dragging and _dragged were not cleared by purge.
+            gd._dragging = true;
+            gd._dragged = true;
+            gd._hoverdata = true;
+            gd._snapshotInProgress = true;
+            gd._editing = true;
+            gd._replotPending = true;
+            gd._mouseDownTime = true;
+            gd._legendMouseDownTime = true;
         });
 
         afterEach(destroyGraphDiv);
@@ -416,15 +429,16 @@ describe('Test Plots', function() {
             var expectedKeys = [
                 '_ev', '_internalEv', 'on', 'once', 'removeListener', 'removeAllListeners',
                 '_internalOn', '_internalOnce', '_removeInternalListener',
-                '_removeAllInternalListeners', 'emit', '_context', '_replotPending',
-                '_hmpixcount', '_hmlumcount', '_mouseDownTime', '_legendMouseDownTime',
+                '_removeAllInternalListeners', 'emit', '_context'
             ];
 
             var expectedUndefined = [
                 'data', 'layout', '_fullData', '_fullLayout', 'calcdata', 'framework',
                 'empty', 'fid', 'undoqueue', 'undonum', 'autoplay', 'changed',
-                '_promises', '_redrawTimer', 'firstscatter', 'hmlumcount', 'hmpixcount',
-                'numboxes', '_transitionData', '_transitioning'
+                '_promises', '_redrawTimer', 'firstscatter', 'numboxes',
+                '_transitionData', '_transitioning', '_hmpixcount', '_hmlumcount',
+                '_dragging', '_dragged', '_hoverdata', '_snapshotInProgress', '_editing',
+                '_replotPending', '_mouseDownTime', '_legendMouseDownTime'
             ];
 
             Plots.purge(gd);