Merge pull request #820 from hypothesis/share-link-config

Enable third-party authorities to globally disable annotation share links

docs/publishers/config.rst

@@ -156,7 +156,9 @@ loads.
       items in the array are ignored.
 
    Each item in the :option:`services` array should be an object describing an
-   annotation service, with the following keys:
+   annotation service.
+
+   Required keys:
 
    .. option:: apiUrl
 
@@ -179,12 +181,12 @@ loads.
          :ref:`Generating authorization grant tokens` for how to generate grant
          tokens for the `hypothes.is <https://hypothes.is/>`_ service.
 
-   .. option:: icon
+  Optional keys:
 
-      ``String|null``. The URL to an image for the annotation service. This
-      image will appear to the left of the name of the currently selected
-      group. The image should be suitable for display at 16x16px and the
-      recommended format is SVG.
+   .. option:: enableShareLinks
+
+      ``boolean``. A flag indicating whether annotation cards should show links
+      that take the user to see an annotation in context. (Default: ``true``).
 
    .. option:: groups
 
@@ -195,6 +197,13 @@ loads.
       This can be useful in contexts where it is important that annotations
       are made in a particular group.
 
+   .. option:: icon
+
+      ``String|null``. The URL to an image for the annotation service. This
+      image will appear to the left of the name of the currently selected
+      group. The image should be suitable for display at 16x16px and the
+      recommended format is SVG.
+
    .. option:: onLoginRequest
 
      ``function``. A JavaScript function that the Hypothesis client will

src/sidebar/components/annotation.js

@@ -3,6 +3,7 @@
 const annotationMetadata = require('../annotation-metadata');
 const events = require('../events');
 const { isThirdPartyUser } = require('../util/account-id');
+const serviceConfig = require('../service-config');
 
 const isNew = annotationMetadata.isNew;
 const isReply = annotationMetadata.isReply;
@@ -23,6 +24,23 @@ function updateModel(annotation, changes, permissions) {
   });
 }
 
+/**
+ * Return true if share links are globally enabled.
+ *
+ * Share links will only be shown on annotation cards if this is true and if
+ * these links are included in API responses.
+ */
+function shouldEnableShareLinks(settings) {
+  const serviceConfig_ = serviceConfig(settings);
+  if (serviceConfig_ === null) {
+    return true;
+  }
+  if (typeof serviceConfig_.enableShareLinks !== 'boolean') {
+    return true;
+  }
+  return serviceConfig_.enableShareLinks;
+}
+
 // @ngInject
 function AnnotationController(
   $document, $rootScope, $scope, $timeout, $window, analytics, store,
@@ -32,6 +50,8 @@ function AnnotationController(
   const self = this;
   let newlyCreatedByHighlightButton;
 
+  const enableShareLinks = shouldEnableShareLinks(settings);
+
   /** Save an annotation to the server. */
   function save(annot) {
     let saved;
@@ -487,7 +507,7 @@ function AnnotationController(
   };
 
   this.incontextLink = function () {
-    if (self.annotation.links) {
+    if (enableShareLinks && self.annotation.links) {
       return self.annotation.links.incontext ||
              self.annotation.links.html ||
              '';

src/sidebar/components/test/annotation-test.js

@@ -1164,6 +1164,22 @@ describe('annotation', function() {
         const controller = createDirective(annotation).controller;
         assert.equal(controller.incontextLink(), '');
       });
+
+      [true, false].forEach(enableShareLinks => {
+        it('does not render links if share links are globally disabled', () => {
+          const annotation = Object.assign({}, fixtures.defaultAnnotation(), {
+            links: {
+              incontext: 'https://hpt.is/deadbeef',
+            },
+          });
+          fakeSettings.services = [{
+            enableShareLinks,
+          }];
+          const controller = createDirective(annotation).controller;
+          const hasIncontextLink = controller.incontextLink() === annotation.links.incontext;
+          assert.equal(hasIncontextLink, enableShareLinks);
+        });
+      });
     });
 
     it('renders quotes as plain text', function () {