Chore: Bundling Annotators separately in annotations.js #75

pramodsum · 2017-04-14T06:44:53Z

Determines which annotator to initialize based on the viewer provided in options
Bundles the annotators separately to reduce the size of preview.js
NOTE: There are still annotator methods remaining in individual viewers which will be removed in future commits

pramodsum · 2017-04-18T02:44:30Z

Requires #81 to be merged first in order for all the unrelated unit tests to pass - MERGED

tonyjin · 2017-04-18T20:40:52Z

build/webpack.config.js

@@ -54,7 +54,8 @@ function updateConfig(conf, language, index) {
    const config = Object.assign(conf, {
        entry: {
            preview:        [`${lib}/Preview.js`],
-            csv:            [`${lib}/viewers/text/BoxCSV.js`]
+            csv:            [`${lib}/viewers/text/BoxCSV.js`],
+            annotations:    [`${lib}/annotations/AnnotatorLoader.js`]


How about we call this BoxAnnotations.js? I realize it's a 'loader' similar to the viewer loaders, but this terminology may make it clearer it's a separate file and take us in the step of entirely decoupling annotations. I'd imagine we'd want to export something like BoxAnnotations.js from the future separate project.

Ah you beat me to it!

tonyjin · 2017-04-18T20:41:30Z

src/lib/annotations/Annotator.js

@@ -65,8 +65,29 @@ class Annotator extends EventEmitter {
     * @return {void}
     */
    init() {
+        this._annotatedElement = this.getAnnotatedEl(this._container);
+        this._annotationService = this.initAnnotationService(this.options);


We probably want to move away from this underscore = private syntax at some point since the rest of Preview doesn't use it.

I'll do it in a separate commit so it doesn't overwhelm this PR

Fixed in #83

tonyjin · 2017-04-18T20:42:04Z

src/lib/annotations/AnnotatorLoader.js

+        VIEWER: ['Image'],
+        TYPE: ['point']
+    }
+];


Good idea mirroring the viewer loaders!

tonyjin · 2017-04-18T20:42:52Z

src/lib/annotations/AnnotatorLoader.js

+    /**
+     * Determines if this loader can be used
+     *
+     * @param {Object} viewer - Viewer


May be good to clarify this is the viewer info object, not an instance of a viewer. Open to ideas on how we can more clearly differentiate between the two.

Clarified that we are referring to the info object here. Looking into this method more... I don't think it's explicitly used to load annotators. I might be able to actually remove this method altogether

tonyjin · 2017-04-18T20:43:50Z

src/lib/annotations/AnnotatorLoader.js

+                return false;
+            }
+            return annotator.VIEWER.indexOf(viewer) > -1;
+        });


I wonder if there's some combination of filter / find we can use instead of this check inside find

I think this would do the same thing
return this.annotators.find(annotator => !(disabledAnnotators.includes(annotator.NAME)) && annotator.VIEWER.includes(viewer));

Got it! Thanks!

tonyjin · 2017-04-18T20:45:39Z

src/lib/annotations/doc/__tests__/DocAnnotator-test.js

@@ -44,6 +48,12 @@ describe('lib/annotations/doc/DocAnnotator', () => {
        stubs = {};
    });

+    describe('getAnnotatedEl()', () => {
+        it('should set the annotated element as the document', () => {


I'd do this test as it('should return the document container as the annotated element'). You're setting annotated element explicitly in setup but that's not what getAnnotatedEl() does

Whoops! I changed the method to return the annotated element and forgot to change the test description! Good catch thanks!

tonyjin · 2017-04-18T20:45:53Z

src/lib/annotations/image/__tests__/ImageAnnotator-test.js

@@ -28,15 +32,16 @@ describe('lib/annotations/image/ImageAnnotator', () => {
        annotator = null;
    });

+    describe('getAnnotatedEl()', () => {
+        it('should set the annotated element as the document', () => {


Same as above

tonyjin · 2017-04-18T20:46:30Z

src/lib/viewers/BaseViewer.js

    STATUS_SUCCESS,
    STATUS_VIEWABLE
 } from '../constants';

+const JS = ['annotations.js'];


ANNOTATIONS_JS to be clear - the other viewers include actual viewer static assets in their JS const.

tonyjin · 2017-04-18T20:47:12Z

src/lib/viewers/BaseViewer.js

@@ -255,6 +268,12 @@ class BaseViewer extends EventEmitter {
        this.addListener('togglepointannotationmode', () => {
            this.annotator.togglePointModeHandler();
        });
+
+        this.addListener('viewerloaded', () => {


Can you just use load event that already exists?

@tonyjin I actually wasn't sure if I should be using the 'load' event that already exists or not. If that's fine then i'll just use the load event rather than emitting a new one altogether

tonyjin · 2017-04-18T20:48:10Z

src/lib/viewers/BaseViewer.js

+     */
+    initAnnotator() {
+        /* global AnnotatorLoader */
+        this.loader = new AnnotatorLoader();


What happens if AnnotatorLoaded is not loaded? Do we still want to have annotations NOT be loaded under the cookie switch in the WebApp?

Should i have it only load the AnnotatorLoader if ?showAnnotations=true is enabled?

Only loading the annotations.js file if ?showAnnotaitons=true is enabled

pramodsum · 2017-04-18T20:39:26Z

src/lib/viewers/BaseViewer.js

@@ -255,6 +268,12 @@ class BaseViewer extends EventEmitter {
        this.addListener('togglepointannotationmode', () => {
            this.annotator.togglePointModeHandler();
        });
+
+        this.addListener('viewerloaded', () => {


I didn't want to hijack the load event that already gets emitted so I emitted this event instead. Does 'viewerloaded' make sense? Or should it be renamed to something else

I'm not sure what you mean by hijack. Events can have multiple listeners so adding a listener to the load event won't affect other listeners as long as load is fired at time when you need it (which seems to be the case - load means the viewer has loaded content and is ready to be interact-able).

Ah sorry hijack was the wrong word. Cool I'll just use the load event then! Thanks!

pramodsum · 2017-04-18T20:39:47Z

build/webpack.config.js

@@ -54,7 +54,8 @@ function updateConfig(conf, language, index) {
    const config = Object.assign(conf, {
        entry: {
            preview:        [`${lib}/Preview.js`],
-            csv:            [`${lib}/viewers/text/BoxCSV.js`]
+            csv:            [`${lib}/viewers/text/BoxCSV.js`],
+            annotations:    [`${lib}/annotations/AnnotatorLoader.js`]


should this be named annotations or boxannotations?

Let's just call it BoxAnnotations for now and rename later if needed

jeremypress · 2017-04-24T20:56:36Z

src/lib/viewers/BaseViewer.js

+     * @protected
+     * @return {void}
+     */
+    initAnnotator() {


maybe change this method name since we actually init the Annotator in the initAnnotations() method?

Changing it to loadAnnotator

jeremypress · 2017-04-24T20:58:11Z

src/lib/viewers/doc/DocBaseViewer.js

@@ -218,6 +215,8 @@ class DocBaseViewer extends BaseViewer {
        this.initViewer(this.pdfUrl);
        this.initPrint();
        this.initFind();
+
+        this.setScale(this.pdfViewer.currentScale);


was there a bug without this?

I think I had added it as a part of the remaining refactoring of annotations but i'm not entirely sure why. Tested it and it doesn't seem to be related to a bug so removing it for now

- Moving showAnnotate() into BaseViewer - Triggering annotations load on 'viewerloaded' event

- Revert "Fix: Ensuring annotations are loaded when viewer has permissions (#90)" - Revert "Chore: Bundling Annotators separately in annotations.js (#75)" - This fixes preview performance metrics based on the 'load' event

pramodsum changed the title ~~Chore: Bundling Annotations separately in annotations.js~~ Chore: Bundling Annotators separately in annotations.js Apr 14, 2017

pramodsum mentioned this pull request Apr 14, 2017

New: Multi Image Annotations #73

Closed

pramodsum requested review from tonyjin and JustinHoldstock April 14, 2017 21:55

tonyjin reviewed Apr 18, 2017

View reviewed changes

pramodsum commented Apr 18, 2017

View reviewed changes

jeremypress reviewed Apr 24, 2017

View reviewed changes

pramodsum added 5 commits April 24, 2017 14:30

Chore: Bundling Annotations separately in annotations.js

ae3f440

- Moving showAnnotate() into BaseViewer - Triggering annotations load on 'viewerloaded' event

Chore: Unit tests

40ca1cb

Chore: Renaming AnnotatorLoader as BoxAnnotations

61e6e6c

Chore: Fixes from comments

6734be3

Chore: Renaming initAnnotator to loadAnnotator

294f413

jeremypress approved these changes Apr 24, 2017

View reviewed changes

pramodsum merged commit efa8b2a into box:master Apr 24, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Chore: Bundling Annotators separately in annotations.js #75

Chore: Bundling Annotators separately in annotations.js #75

pramodsum commented Apr 14, 2017 •

edited

Loading

pramodsum commented Apr 18, 2017 •

edited

Loading

tonyjin Apr 18, 2017

pramodsum Apr 18, 2017

tonyjin Apr 18, 2017

pramodsum Apr 18, 2017

pramodsum Apr 18, 2017

tonyjin Apr 18, 2017

tonyjin Apr 18, 2017

pramodsum Apr 18, 2017

tonyjin Apr 18, 2017

jeremypress Apr 18, 2017 •

edited

Loading

pramodsum Apr 18, 2017

tonyjin Apr 18, 2017

pramodsum Apr 18, 2017

tonyjin Apr 18, 2017

tonyjin Apr 18, 2017

tonyjin Apr 18, 2017

pramodsum Apr 18, 2017

tonyjin Apr 18, 2017

pramodsum Apr 18, 2017

pramodsum Apr 21, 2017

pramodsum Apr 18, 2017

tonyjin Apr 18, 2017

pramodsum Apr 18, 2017

pramodsum Apr 18, 2017

tonyjin Apr 18, 2017

jeremypress Apr 24, 2017

pramodsum Apr 24, 2017

jeremypress Apr 24, 2017

pramodsum Apr 24, 2017

Chore: Bundling Annotators separately in annotations.js #75

Chore: Bundling Annotators separately in annotations.js #75

Conversation

pramodsum commented Apr 14, 2017 • edited Loading

pramodsum commented Apr 18, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeremypress Apr 18, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pramodsum commented Apr 14, 2017 •

edited

Loading

pramodsum commented Apr 18, 2017 •

edited

Loading

jeremypress Apr 18, 2017 •

edited

Loading