Merge pull request #2425 from hypothesis/frame-rpc

Switch out jschannel for frame-rpc

Author: nickstenning

LICENSE

@@ -71,41 +71,6 @@ For the annotator subcomponent:
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  THE SOFTWARE.
 
-For the jschannel subcomponent:
-
- Version: MPL 1.1/GPL 2.0/LGPL 2.1
-
- The contents of this file are subject to the Mozilla Public License Version
- 1.1 (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
- http://www.mozilla.org/MPL/
-
- Software distributed under the License is distributed on an "AS IS" basis,
- WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
- for the specific language governing rights and limitations under the
- License.
-
- The Original Code is jschannel.
-
- The Initial Developer of the Original Code is Lloyd Hilaiel.
-
- Portions created by the Initial Developer are Copyright (C) 2010
- the Initial Developer. All Rights Reserved.
-
- Contributor(s):
-
- Alternatively, the contents of this file may be used under the terms of
- either the GNU General Public License Version 2 or later (the "GPL"), or
- the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
- in which case the provisions of the GPL or the LGPL are applicable instead
- of those above. If you wish to allow use of your version of this file only
- under the terms of either the GPL or the LGPL, and not to allow others to
- use your version of this file under the terms of the MPL, indicate your
- decision by deleting the provisions above and replace them with the notice
- and other provisions required by the GPL or the LGPL. If you do not delete
- the provisions above, a recipient may use your version of this file under
- the terms of any one of the MPL, the GPL or the LGPL.
-
 For the jwz.js subcomponent:
 
  Copyright (c) 2011 Frederik Dietz & Max Ogden

NOTICE

@@ -14,10 +14,6 @@ This product also includes the following third-party components:
 
    Copyright 2012 Aron Carroll, Rufus Pollock, and Nick Stenning
 
- * jschannel (https://github.com/mozilla/jschannel)
-
-   Copyright (C) 2010, Lloyd Hilaiel
-
  * Gentleface icon set (http://www.gentleface.com/free_icon_set.html)
 
    Copyright © 2006-2012 Gentleface

h/static/scripts/annotation-sync.coffee

@@ -58,49 +58,47 @@ module.exports = class AnnotationSync
   getAnnotationForTag: (tag) ->
     @cache[tag] or null
 
-  sync: (annotations, cb) ->
+  sync: (annotations) ->
     annotations = (this._format a for a in annotations)
-    @bridge.call
-      method: 'sync'
-      params: annotations
-      callback: cb
+    @bridge.call 'sync', annotations, (err, annotations = []) =>
+      for a in annotations
+        this._parse(a)
     this
 
   # Handlers for messages arriving through a channel
   _channelListeners:
-    'beforeCreateAnnotation': (txn, body) ->
+    'beforeCreateAnnotation': (body, cb) ->
       annotation = this._parse(body)
       delete @cache[annotation.$$tag]
       @_emit 'beforeAnnotationCreated', annotation
       @cache[annotation.$$tag] = annotation
-      this._format annotation
+      cb(null, this._format(annotation))
 
-    'createAnnotation': (txn, body) ->
+    'createAnnotation': (body, cb) ->
       annotation = this._parse(body)
       delete @cache[annotation.$$tag]
       @_emit 'annotationCreated', annotation
       @cache[annotation.$$tag] = annotation
-      this._format annotation
+      cb(null, this._format(annotation))
 
-    'updateAnnotation': (txn, body) ->
+    'updateAnnotation': (body, cb) ->
       annotation = this._parse(body)
       delete @cache[annotation.$$tag]
       @_emit('beforeAnnotationUpdated', annotation)
       @_emit('annotationUpdated', annotation)
       @cache[annotation.$$tag] = annotation
-      this._format annotation
+      cb(null, this._format(annotation))
 
-    'deleteAnnotation': (txn, body) ->
+    'deleteAnnotation': (body, cb) ->
       annotation = this._parse(body)
       delete @cache[annotation.$$tag]
       @_emit('annotationDeleted', annotation)
-      res = this._format(annotation)
-      res
+      cb(null, this._format(annotation))
 
-    'sync': (ctx, bodies) ->
-      (this._format(this._parse(b)) for b in bodies)
+    'sync': (bodies, cb) ->
+      cb(null, (this._format(this._parse(b)) for b in bodies))
 
-    'loadAnnotations': (txn, bodies) ->
+    'loadAnnotations': (bodies) ->
       annotations = (this._parse(a) for a in bodies)
       @_emit('loadAnnotations', annotations)
 
@@ -127,17 +125,13 @@ module.exports = class AnnotationSync
     'annotationsLoaded': (annotations) ->
       bodies = (this._format a for a in annotations when not a.$$tag)
       return unless bodies.length
-      @bridge.notify
-        method: 'loadAnnotations'
-        params: bodies
+      @bridge.call('loadAnnotations', bodies)
 
   _syncCache: (channel) ->
     # Synchronise (here to there) the items in our cache
     annotations = (this._format a for t, a of @cache)
     if annotations.length
-      channel.notify
-        method: 'loadAnnotations'
-        params: annotations
+      channel.call('loadAnnotations', annotations)
 
   _mkCallRemotelyAndParseResults: (method, callBack) ->
     (annotation) =>
@@ -148,11 +142,7 @@ module.exports = class AnnotationSync
         callBack? failure, results
 
       # Call the remote method
-      options =
-        method: method
-        callback: wrappedCallback
-        params: this._format(annotation)
-      @bridge.call(options)
+      @bridge.call(method, this._format(annotation), wrappedCallback)
 
   # Parse returned message bodies to update cache with any changes made remotely
   _parseResults: (results) ->

h/static/scripts/annotation-ui-sync.coffee

@@ -18,18 +18,18 @@ module.exports = class AnnotationUISync
       tags.map(annotationSync.getAnnotationForTag, annotationSync)
 
     channelListeners =
-      showAnnotations: (ctx, tags=[]) ->
+      showAnnotations: (tags=[]) ->
         annotations = getAnnotationsByTags(tags)
         annotationUI.selectAnnotations(annotations)
-      focusAnnotations: (ctx, tags=[]) ->
+      focusAnnotations: (tags=[]) ->
         annotations = getAnnotationsByTags(tags)
         annotationUI.focusAnnotations(annotations)
-      toggleAnnotationSelection: (ctx, tags=[]) ->
+      toggleAnnotationSelection: (tags=[]) ->
         annotations = getAnnotationsByTags(tags)
         annotationUI.xorSelectedAnnotations(annotations)
-      setVisibleHighlights: (ctx, state) ->
+      setVisibleHighlights: (state) ->
         annotationUI.visibleHighlights = Boolean(state)
-        bridge.notify(method: 'setVisibleHighlights', params: state)
+        bridge.call('setVisibleHighlights', state)
 
     # Because the channel events are all outside of the angular framework we
     # need to inform Angular that it needs to re-check it's state and re-draw
@@ -45,8 +45,6 @@ module.exports = class AnnotationUISync
     onConnect = (channel, source) ->
       # Allow the host to define its own state
       unless source is $window.parent
-        channel.notify
-          method: 'setVisibleHighlights'
-          params: annotationUI.visibleHighlights
+        channel.call('setVisibleHighlights', annotationUI.visibleHighlights)
 
     bridge.onConnect(onConnect)

h/static/scripts/annotator/guest.coffee

@@ -72,10 +72,6 @@ module.exports = class Guest extends Annotator
         formatted = {}
         for k, v of annotation when k isnt 'anchors'
           formatted[k] = v
-        # Work around issue in jschannel where a repeated object is considered
-        # recursive, even if it is not its own ancestor.
-        if formatted.document?.title
-          formatted.document.title = formatted.document.title.slice()
         formatted
 
     this.addPlugin('CrossFrame', cfOptions)
@@ -115,21 +111,20 @@ module.exports = class Guest extends Annotator
     crossframe.onConnect(=> this.publish('panelReady'))
     crossframe.on('onEditorHide', this.onEditorHide)
     crossframe.on('onEditorSubmit', this.onEditorSubmit)
-    crossframe.on 'focusAnnotations', (ctx, tags=[]) =>
+    crossframe.on 'focusAnnotations', (tags=[]) =>
       for anchor in @anchors when anchor.highlights?
         toggle = anchor.annotation.$$tag in tags
         $(anchor.highlights).toggleClass('annotator-hl-focused', toggle)
-    crossframe.on 'scrollToAnnotation', (ctx, tag) =>
+    crossframe.on 'scrollToAnnotation', (tag) =>
       for anchor in @anchors when anchor.highlights?
         if anchor.annotation.$$tag is tag
           $(anchor.highlights).scrollintoview()
           return
-    crossframe.on 'getDocumentInfo', (trans) =>
-      trans.delayReturn(true)
+    crossframe.on 'getDocumentInfo', (cb) =>
       this.getDocumentInfo()
-      .then((info) -> trans.complete(info))
-      .catch((reason) -> trans.error(reason))
-    crossframe.on 'setVisibleHighlights', (ctx, state) =>
+      .then((info) -> cb(null, info))
+      .catch((reason) -> cb(reason))
+    crossframe.on 'setVisibleHighlights', (state) =>
       this.publish 'setVisibleHighlights', state
 
   _setupWrapper: ->
@@ -315,24 +310,20 @@ module.exports = class Guest extends Annotator
     return annotation
 
   showAnnotations: (annotations) =>
-    @crossframe?.notify
-      method: "showAnnotations"
-      params: (a.$$tag for a in annotations)
+    tags = (a.$$tag for a in annotations)
+    @crossframe?.call('showAnnotations', tags)
 
   toggleAnnotationSelection: (annotations) =>
-    @crossframe?.notify
-      method: "toggleAnnotationSelection"
-      params: (a.$$tag for a in annotations)
+    tags = (a.$$tag for a in annotations)
+    @crossframe?.call('toggleAnnotationSelection', tags)
 
   updateAnnotations: (annotations) =>
-    @crossframe?.notify
-      method: "updateAnnotations"
-      params: (a.$$tag for a in annotations)
+    tags = (a.$$tag for a in annotations)
+    @crossframe?.call('updateAnnotations', tags)
 
   focusAnnotations: (annotations) =>
-    @crossframe?.notify
-      method: "focusAnnotations"
-      params: (a.$$tag for a in annotations)
+    tags = (a.$$tag for a in annotations)
+    @crossframe?.call('focusAnnotations', tags)
 
   onSuccessfulSelection: (event, immediate) ->
     unless event?
@@ -396,11 +387,7 @@ module.exports = class Guest extends Annotator
   # Pass true to show the highlights in the frame or false to disable.
   setVisibleHighlights: (shouldShowHighlights) ->
     return if @visibleHighlights == shouldShowHighlights
-
-    @crossframe?.notify
-      method: 'setVisibleHighlights'
-      params: shouldShowHighlights
-
+    @crossframe?.call('setVisibleHighlights', shouldShowHighlights)
     this.toggleHighlightClass(shouldShowHighlights)
 
   toggleHighlightClass: (shouldShowHighlights) ->
@@ -413,11 +400,11 @@ module.exports = class Guest extends Annotator
 
   # Open the sidebar
   showFrame: ->
-    @crossframe?.notify method: 'open'
+    @crossframe?.call('open')
 
   # Close the sidebar
   hideFrame: ->
-    @crossframe?.notify method: 'back'
+    @crossframe?.call('back')
 
   onAdderMouseup: (event) ->
     event.preventDefault()

h/static/scripts/annotator/plugin/cross-frame.coffee

@@ -12,7 +12,7 @@ extract = extract = (obj, keys...) ->
 # as keeping the annotation state in sync with the sidebar application, this
 # frame acts as the bridge client, the sidebar is the server. This plugin
 # can also be used to send messages through to the sidebar using the
-# notify method.
+# call method.
 module.exports = class CrossFrame extends Annotator.Plugin
   constructor: (elem, options) ->
     super
@@ -41,8 +41,8 @@ module.exports = class CrossFrame extends Annotator.Plugin
     this.on = (event, fn) ->
       bridge.on(event, fn)
 
-    this.notify = (message) ->
-      bridge.notify(message)
+    this.call = (message, args...) ->
+      bridge.call(message, args...)
 
     this.onConnect = (fn) ->
       bridge.onConnect(fn)

h/static/scripts/annotator/plugin/test/cross-frame-test.coffee

@@ -21,7 +21,7 @@ describe 'Annotator.Plugin.CrossFrame', ->
     fakeBridge =
       createChannel: sandbox.stub()
       onConnect: sandbox.stub()
-      notify: sandbox.stub()
+      call: sandbox.stub()
       on: sandbox.stub()
 
     fakeAnnotationSync =
@@ -91,11 +91,11 @@ describe 'Annotator.Plugin.CrossFrame', ->
       bridge.on('event', 'arg')
       assert.calledWith(fakeBridge.on, 'event', 'arg')
 
-  describe '.notify', ->
+  describe '.call', ->
     it 'proxies the call to the bridge', ->
       bridge = createCrossFrame()
-      bridge.notify(method: 'method')
-      assert.calledWith(fakeBridge.notify, method: 'method')
+      bridge.call('method', 'arg1', 'arg2')
+      assert.calledWith(fakeBridge.call, 'method', 'arg1', 'arg2')
 
   describe '.onConnect', ->
     it 'proxies the call to the bridge', ->