Fix: Ensure pending annotations are destroyed on re-render (#194)

box · May 31, 2018 · 1422357 · 1422357
1 parent b74484b
commit 1422357
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/src/controllers/AnnotationModeController.js b/src/controllers/AnnotationModeController.js
@@ -432,6 +432,13 @@ class AnnotationModeController extends EventEmitter {
 
         const pageThreads = this.threads[pageNum].all() || [];
         pageThreads.forEach((thread, index) => {
+            // Destroy any pending threads that may exist on re-render
+            if (isPending(thread.state)) {
+                this.unregisterThread(thread);
+                thread.destroy();
+                return;
+            }
+
             thread.hideDialog();
 
             // Sets the annotatedElement if the thread was fetched before the

diff --git a/src/controllers/__tests__/AnnotationModeController-test.js b/src/controllers/__tests__/AnnotationModeController-test.js
@@ -495,6 +495,7 @@ describe('controllers/AnnotationModeController', () => {
         });
 
         it('should render the annotations on every page', () => {
+            sandbox.stub(util, 'isPending').returns(false);
             controller.threads = {
                 // eslint-disable-next-line new-cap
                 1: new rbush(),
@@ -506,9 +507,24 @@ describe('controllers/AnnotationModeController', () => {
 
             stubs.threadMock.expects('hideDialog').once();
             stubs.threadMock.expects('show').once();
+            stubs.threadMock.expects('destroy').never();
             controller.renderPage(1);
             expect(stubs.thread.annotatedElement).to.equal('el');
         });
+
+        it('should destroy any pending annotations on re-render', () => {
+            sandbox.stub(util, 'isPending').returns(true);
+            controller.threads = {
+                // eslint-disable-next-line new-cap
+                1: new rbush()
+            };
+            controller.threads[1].insert(stubs.thread);
+
+            stubs.threadMock.expects('hideDialog').never();
+            stubs.threadMock.expects('show').never();
+            stubs.threadMock.expects('destroy').once();
+            controller.renderPage(1);
+        });
     });
 
     describe('destroyPendingThreads()', () => {