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.

Sign up for GitHub

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

Jump to bottom

Remove crossframe service and simplify communication with connected frames #116

Merged
merged 3 commits into from
Sep 21, 2016
Merged

Remove crossframe service and simplify communication with connected frames #116

merged 3 commits into from
Sep 21, 2016

Commits on Sep 21, 2016

  1. Simplify the sidebar app side of sidebar <-> host frame messaging 

    Previously the communication between the sidebar and host frame was
implemented by a shared AnnotationSync class, with a 'crossframe'
service which abstracted the event bus on each side.

This design however assumed that both sides wanted to listen to
the same messages and react to them in similar ways. This is not
the case, especially given the change to use Redux for state
management in the sidebar app.

This commit replaces the crossframe service and AnnotationSync class
with a new 'frameSync' service which implements only the event
listeners and sidebar -> page RPC calls that are actually needed.

As a result, local annotation tags for annotations loaded via the API
can now be assigned by the reducer in the Redux store, making this
easier to test and getting us another step closer to making Annotation
objects immutable in the sidebar app.
    @robertknight
    robertknight committed Sep 21, 2016
    Configuration menu
    Copy the full SHA
    55093eb View commit details
    Browse the repository at this point in the history

  2. Move AnnotationSync class to annotator/ dir and remove unused code 

    Now that AnnotationSync is no longer used in the sidebar app, we can
remove all of the handlers for events and messages arriving through the
channel which are not needed by the page itself.
    @robertknight
    robertknight committed Sep 21, 2016
    Configuration menu
    Copy the full SHA
    e126b97 View commit details
    Browse the repository at this point in the history

  3. Add a comment explaining what AnnotationSync is responsible for

    @robertknight
    robertknight committed Sep 21, 2016
    Configuration menu
    Copy the full SHA
    b08aafe View commit details
    Browse the repository at this point in the history