Skip to content
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.

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

feat(annotation): handle create event #1199

Merged
merged 3 commits into from
Apr 17, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/lib/AnnotationControls.ts
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,10 @@ export default class AnnotationControls {
*/
private handleFullscreenExit = (): void => this.handleFullscreenChange(false);

public getActiveMode = (): AnnotationMode => {
return this.currentActiveControl;
};

/**
* Deactivate current control button
*/
Expand Down
7 changes: 7 additions & 0 deletions src/lib/__tests__/AnnotationControls-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -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');
});
});
});
14 changes: 13 additions & 1 deletion src/lib/viewers/BaseViewer.js
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down Expand Up @@ -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);
}
}

Expand Down Expand Up @@ -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);
ConradJChan marked this conversation as resolved.
Show resolved Hide resolved
this.annotationControls.resetControls();
this.annotator.emit('annotations_active_set', id);
}
}

/**
* Creates combined options to give to the annotator
*
Expand Down
50 changes: 46 additions & 4 deletions src/lib/viewers/__tests__/BaseViewer-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -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);
});
Expand Down Expand Up @@ -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');
});
});
});