feat(annotation): handle create event (#1199)

box · Apr 17, 2020 · 888b4ae · 888b4ae
1 parent 12e1966
commit 888b4ae
Show file tree

Hide file tree

Showing 4 changed files with 70 additions and 5 deletions.
diff --git a/src/lib/AnnotationControls.ts b/src/lib/AnnotationControls.ts
@@ -94,6 +94,10 @@ export default class AnnotationControls {
      */
     private handleFullscreenExit = (): void => this.handleFullscreenChange(false);
 
+    public getActiveMode = (): AnnotationMode => {
+        return this.currentActiveControl;
+    };
+
     /**
      * Deactivate current control button
      */

diff --git a/src/lib/__tests__/AnnotationControls-test.js b/src/lib/__tests__/AnnotationControls-test.js
@@ -156,4 +156,11 @@ describe('lib/AnnotationControls', () => {
             expect(stubs.updateRegionButton).to.be.called;
         });
     });
+
+    describe('getActiveMode()', () => {
+        it('should return the current active mode', () => {
+            annotationControls.currentActiveControl = 'region';
+            expect(annotationControls.getActiveMode()).to.equal('region');
+        });
+    });
 });
diff --git a/src/lib/viewers/BaseViewer.js b/src/lib/viewers/BaseViewer.js
@@ -149,6 +149,7 @@ class BaseViewer extends EventEmitter {
         this.mobileZoomChangeHandler = this.mobileZoomChangeHandler.bind(this);
         this.mobileZoomEndHandler = this.mobileZoomEndHandler.bind(this);
         this.handleAnnotatorEvents = this.handleAnnotatorEvents.bind(this);
+        this.handleAnnotationCreateEvent = this.handleAnnotationCreateEvent.bind(this);
         this.handleFullscreenEnter = this.handleFullscreenEnter.bind(this);
         this.handleFullscreenExit = this.handleFullscreenExit.bind(this);
         this.createAnnotator = this.createAnnotator.bind(this);
@@ -976,7 +977,7 @@ class BaseViewer extends EventEmitter {
         this.annotator.addListener('annotatorevent', this.handleAnnotatorEvents);
 
         if (this.options.showAnnotationsControls && this.annotationControls) {
-            this.annotator.addListener('annotationcreate', this.annotationControls.resetControls);
+            this.annotator.addListener('annotations_create', this.handleAnnotationCreateEvent);
         }
     }
 
@@ -1100,6 +1101,17 @@ class BaseViewer extends EventEmitter {
         this.emit('annotatorevent', data);
     }
 
+    handleAnnotationCreateEvent({ annotation: { id } = {}, meta: { status } = {} }) {
+        // Only on success do we exit create annotation mode. If error occurs,
+        // we remain in create mode
+        if (status === 'success') {
+            const activeMode = this.annotationControls.getActiveMode();
+            this.annotator.toggleAnnotationMode(activeMode);
+            this.annotationControls.resetControls();
+            this.annotator.emit('annotations_active_set', id);
+        }
+    }
+
     /**
      * Creates combined options to give to the annotator
      *

diff --git a/src/lib/viewers/__tests__/BaseViewer-test.js b/src/lib/viewers/__tests__/BaseViewer-test.js
@@ -1139,10 +1139,7 @@ describe('lib/viewers/BaseViewer', () => {
             expect(base.addListener).to.be.calledWith('toggleannotationmode', sinon.match.func);
             expect(base.addListener).to.be.calledWith('scale', sinon.match.func);
             expect(base.addListener).to.be.calledWith('scrolltoannotation', sinon.match.func);
-            expect(base.annotator.addListener).to.be.calledWith(
-                'annotationcreate',
-                base.annotationControls.resetControls,
-            );
+            expect(base.annotator.addListener).to.be.calledWith('annotations_create', base.handleAnnotationCreateEvent);
             expect(base.annotator.addListener).to.be.calledWith('annotatorevent', sinon.match.func);
             expect(base.emit).to.be.calledWith('annotator', base.annotator);
         });
@@ -1495,4 +1492,49 @@ describe('lib/viewers/BaseViewer', () => {
             expect(stubs.emit).not.to.be.called;
         });
     });
+
+    describe('handleAnnotationCreateEvent()', () => {
+        beforeEach(() => {
+            base.annotationControls = {
+                getActiveMode: sandbox.stub(),
+                resetControls: sandbox.stub(),
+            };
+
+            base.annotator = {
+                toggleAnnotationMode: sandbox.stub(),
+                emit: sandbox.stub(),
+            };
+        });
+
+        const createEvent = status => ({
+            annotation: { id: '123' },
+            meta: {
+                status,
+            },
+        });
+
+        ['error', 'pending'].forEach(status => {
+            it(`should not do anything if status is ${status}`, () => {
+                const event = createEvent(status);
+                base.handleAnnotationCreateEvent(event);
+
+                expect(base.annotationControls.getActiveMode).not.to.be.called;
+                expect(base.annotator.toggleAnnotationMode).not.to.be.called;
+                expect(base.annotationControls.resetControls).not.to.be.called;
+                expect(base.annotator.emit).not.to.be.called;
+            });
+        });
+
+        it('should reset controls if status is success', () => {
+            base.annotationControls.getActiveMode.returns('region');
+
+            const event = createEvent('success');
+            base.handleAnnotationCreateEvent(event);
+
+            expect(base.annotationControls.getActiveMode).to.be.called;
+            expect(base.annotator.toggleAnnotationMode).to.be.calledWith('region');
+            expect(base.annotationControls.resetControls).to.be.called;
+            expect(base.annotator.emit).to.be.calledWith('annotations_active_set', '123');
+        });
+    });
 });