Merge pull request #2619 from hypothesis/explicit-settings-for-websocket

Explicit settings for websocket

h/static/scripts/app.coffee

@@ -162,7 +162,7 @@ module.exports = angular.module('h', [
 .service('unicode', require('./unicode'))
 .service('viewFilter', require('./view-filter'))
 
-.factory('serviceUrl', require('./service-url'))
+.factory('settings', require('./settings'))
 
 .value('AnnotationSync', require('./annotation-sync'))
 .value('AnnotationUISync', require('./annotation-ui-sync'))

h/static/scripts/config/identity.js

@@ -7,8 +7,8 @@ var currentToken = null;
 
 
 // @ngInject
-function fetchToken($http, $q, jwtHelper, serviceUrl, session) {
-  var tokenUrl = new URL('token', serviceUrl).href;
+function fetchToken($http, $q, jwtHelper, session, settings) {
+  var tokenUrl = new URL('token', settings.apiUrl).href;
 
   if (currentToken === null || jwtHelper.isTokenExpired(currentToken)) {
     if (tokenPromise === null) {
@@ -47,13 +47,13 @@ function fetchToken($http, $q, jwtHelper, serviceUrl, session) {
 
 
 // @ngInject
-function tokenGetter($injector, config, serviceUrl) {
+function tokenGetter($injector, config, settings) {
   var requestUrl = config.url;
 
   // Only send the token on requests to the annotation storage service
   // and only if it is not the token request itself.
-  if (requestUrl !== serviceUrl) {
-    if (requestUrl.slice(0, serviceUrl.length) === serviceUrl) {
+  if (requestUrl !== settings.apiUrl) {
+    if (requestUrl.slice(0, settings.apiUrl.length) === settings.apiUrl) {
       return authPromise
         .then(function () {
           return $injector.invoke(fetchToken);

h/static/scripts/service-url.js

-/**
- * @ngdoc service
- * @name  serviceUrl
- *
- * @description
- * The 'serviceUrl' exposes the base URL of the API backend.
- */
-// @ngInject
-function serviceUrl($document) {
-  return $document
-    .find('link')
-    .filter(function () {
-      return (this.rel === 'service' &&
-              this.type === 'application/annotatorsvc+json');
-    })
-    .filter(function () {
-      return this.href;
-    })
-    .prop('href');
-}
-
-module.exports = serviceUrl;

h/static/scripts/settings.js

+'use strict';
+
+var angular = require('angular');
+
+/**
+ * @ngdoc factory
+ * @name  settings
+ *
+ * @description
+ * The 'settings' factory exposes shared application settings, read from the
+ * global variable 'hypothesis.settings' in the app page.
+ */
+// @ngInject
+function settings($window) {
+  var data = {};
+
+  if ($window.hypothesis && $window.hypothesis.settings) {
+    angular.copy($window.hypothesis.settings, data);
+  }
+
+  return data;
+}
+
+module.exports = settings;

h/static/scripts/store.coffee

@@ -10,16 +10,15 @@
 # store.SearchResource().
 ###
 module.exports = [
-  '$http', '$resource', 'serviceUrl'
-  ($http,   $resource,   serviceUrl) ->
+  '$http', '$resource', 'settings'
+  ($http,   $resource,   settings) ->
     camelize = (string) ->
       string.replace /(?:^|_)([a-z])/g, (_, char) -> char.toUpperCase()
 
     store =
       $resolved: false
-      # We call the service_url and the backend api gives back
-      # the actions and urls it provides.
-      $promise: $http.get(serviceUrl)
+      # We call the API root and it gives back the actions it provides.
+      $promise: $http.get(settings.apiUrl)
         .finally -> store.$resolved = true
         .then (response) ->
           for name, actions of response.data.links
@@ -27,6 +26,6 @@ module.exports = [
             # For the search resource, one URL is given for all actions.
             # For the annotations, each action has its own URL.
             prop = "#{camelize(name)}Resource"
-            store[prop] = $resource(actions.url or serviceUrl, {}, actions)
+            store[prop] = $resource(actions.url or settings.apiUrl, {}, actions)
           store
 ]

h/static/scripts/streamer.js

-var baseURI = require('document-base-uri')
 var uuid = require('node-uuid')
 
 // the randomly generated session UUID
@@ -17,14 +16,14 @@ var socket;
  * @param annotationMapper - The local annotation store
  * @param groups - The local groups store
  * @param session - Provides access to read and update the session state
+ * @param settings - Application settings
  *
  * @return An angular-websocket wrapper around the socket.
  */
 // @ngInject
-function connect($websocket, annotationMapper, groups, session) {
+function connect($websocket, annotationMapper, groups, session, settings) {
   // Get the socket URL
-  var url = new URL('/ws', baseURI);
-  url.protocol = url.protocol.replace('http', 'ws');
+  var url = settings.websocketUrl;
 
   // Close any existing socket
   if (socket) {
@@ -32,7 +31,7 @@ function connect($websocket, annotationMapper, groups, session) {
   }
 
   // Open the socket
-  socket = $websocket(url.href, [], {
+  socket = $websocket(url, [], {
     reconnectIfNotNormalClose: true
   });
   socket.send({

h/static/scripts/test/store-test.coffee

@@ -13,7 +13,7 @@ describe 'store', ->
 
   beforeEach module ($provide) ->
     sandbox = sinon.sandbox.create()
-    $provide.value 'serviceUrl', 'http://example.com/api'
+    $provide.value 'settings', {apiUrl: 'http://example.com/api'}
     return
 
   afterEach ->

h/static/scripts/test/streamer-test.js

@@ -34,6 +34,7 @@ describe('streamer', function () {
   var fakeAnnotationMapper;
   var fakeGroups;
   var fakeSession;
+  var fakeSettings;
   var socket;
 
   beforeEach(function () {
@@ -52,11 +53,16 @@ describe('streamer', function () {
       update: sinon.stub(),
     };
 
+    fakeSettings = {
+      websocketUrl: 'ws://example.com/ws',
+    };
+
     socket = streamer.connect(
       fakeSocketConstructor,
       fakeAnnotationMapper,
       fakeGroups,
-      fakeSession
+      fakeSession,
+      fakeSettings
     );
   });
 
@@ -70,7 +76,9 @@ describe('streamer', function () {
     var oldSocket = socket;
     var newSocket = streamer.connect(fakeSocketConstructor,
       fakeAnnotationMapper,
-      fakeGroups
+      fakeGroups,
+      fakeSession,
+      fakeSettings
     );
     assert.ok(oldSocket.didClose);
     assert.ok(!newSocket.didClose);