Merge branch 'master' into crossframe-sidebar-hide-show

CHANGELOG.md

@@ -4,6 +4,16 @@ Entries in this change log follow the format suggested at http://keepachangelog.
 
 # Change Log
 
+## [1.24.0] - 2017-06-26
+
+### Changed
+
+- Enable feature flagging in the annotation layer
+  ([#440](https://github.com/hypothesis/client/pull/440)).
+
+- Fix sidebar app failing to load in Firefox extension.
+  ([#460](https://github.com/hypothesis/client/pull/460)).
+
 ## [1.23.0] - 2017-06-19
 
 ### Changed

package.json

 {
   "name": "hypothesis",
-  "version": "1.23.0",
+  "version": "1.24.0",
   "description": "Annotate with anyone, anywhere.",
   "license": "BSD-2-Clause",
   "homepage": "https://hypothes.is",

src/annotator/features.js

@@ -14,7 +14,7 @@ module.exports = {
   init: function(crossframe) {
     crossframe.on(events.FEATURE_FLAGS_UPDATED, _set);
   },
-  
+
   reset: function() {
     _set({});
   },

src/annotator/highlighter.coffee → src/annotator/highlighter/dom-wrap-highlighter/index.coffee

 $ = require('jquery')
 
-
 # Public: Wraps the DOM Nodes within the provided range with a highlight
 # element of the specified class and returns the highlight Elements.
 #

src/annotator/test/highlighter-test.coffee → src/annotator/highlighter/dom-wrap-highlighter/test.coffee

-Range = require('../anchoring/range')
+Range = require('../../anchoring/range')
 $ = require('jquery')
 
-highlighter = require('../highlighter')
+highlighter = require('./index')
 
 describe "highlightRange", ->
   it 'wraps a highlight span around the given range', ->

src/annotator/highlighter/index.js

+'use strict';
+
+const domWrapHighlighter = require('./dom-wrap-highlighter');
+const overlayHighlighter = require('./overlay-highlighter');
+const features = require('../features');
+
+// we need a facade for the highlighter interface
+// that will let us lazy check the overlay_highlighter feature
+// flag and later determine which interface should be used.
+const highlighterFacade = {};
+let overlayFlagEnabled;
+
+Object.keys(domWrapHighlighter).forEach((methodName)=>{
+  highlighterFacade[methodName] = (...args)=>{
+    // lazy check the value but we will
+    // use that first value as the rule throughout
+    // the in memory session
+    if(overlayFlagEnabled === undefined){
+      overlayFlagEnabled = features.flagEnabled('overlay_highlighter');
+    }
+
+    const method = overlayFlagEnabled ? overlayHighlighter[methodName] : domWrapHighlighter[methodName];
+    return method.apply(null, args);
+  };
+});
+
+module.exports = highlighterFacade;

src/annotator/highlighter/overlay-highlighter/index.js

+'use strict';
+
+module.exports = {
+  highlightRange: () => {
+    // eslint-disable-next-line no-console
+    console.log('highlightRange not implemented');
+  },
+
+  removeHighlights: () => {
+    // eslint-disable-next-line no-console
+    console.log('removeHighlights not implemented');
+  },
+
+  getBoundingClientRect: () => {
+    // eslint-disable-next-line no-console
+    console.log('getBoundingClientRect not implemented');
+  },
+};

src/annotator/sidebar.coffee

@@ -51,6 +51,7 @@ module.exports = class Sidebar extends Host
   _setupSidebarEvents: ->
     annotationCounts(document.body, @crossframe)
     sidebarTrigger(document.body, => this.show())
+    features.init(@crossframe)
 
     @crossframe.on('showSidebar', => this.show())
     @crossframe.on('hideSidebar', => this.hide())

src/annotator/test/guest-test.coffee

@@ -58,6 +58,8 @@ describe 'Guest', ->
     return new Guest(element, config)
 
   beforeEach ->
+    sinon.stub(console, 'warn')
+
     FakeAdder::instance = null
     rangeUtil = {
       isSelectionBackwards: sinon.stub()
@@ -94,6 +96,7 @@ describe 'Guest', ->
 
   afterEach ->
     sandbox.restore()
+    console.warn.restore()
 
   describe 'plugins', ->
     fakePlugin = null

src/annotator/test/integration/anchoring-test.js

@@ -54,6 +54,7 @@ describe('anchoring', function () {
   });
 
   beforeEach(function () {
+    sinon.stub(console, 'warn');
     container = document.createElement('div');
     container.innerHTML = require('./test-page.html');
     document.body.appendChild(container);
@@ -63,6 +64,7 @@ describe('anchoring', function () {
   afterEach(function () {
     guest.destroy();
     container.parentNode.removeChild(container);
+    console.warn.restore();
   });
 
   unroll('should highlight #tag when annotations are loaded', function (testCase) {

src/sidebar/app.js

@@ -225,5 +225,16 @@ module.exports = angular.module('h', [
 
 processAppOpts();
 
+// Work around a check in Angular's $sniffer service that causes it to
+// incorrectly determine that Firefox extensions are Chrome Packaged Apps which
+// do not support the HTML 5 History API. This results Angular redirecting the
+// browser on startup and thus the app fails to load.
+// See https://github.com/angular/angular.js/blob/a03b75c6a812fcc2f616fc05c0f1710e03fca8e9/src/ng/sniffer.js#L30
+if (window.chrome && !window.chrome.app) {
+  window.chrome.app = {
+    dummyAddedByHypothesisClient: true,
+  };
+}
+
 var appEl = document.querySelector('hypothesis-app');
 angular.bootstrap(appEl, ['h'], {strictDi: true});