Display page numbers on annotation cards if feature enabled

Display page numbers on annotation cards when:

 - The `page_numbers` feature flag is enabled AND
 - The annotation has a `PageSelector` selector. This applies to VitalSource
   books and PDFs.

Part of https://github.com/hypothesis/client/issues/5986

src/sidebar/components/Annotation/AnnotationHeader.tsx

@@ -12,6 +12,7 @@ import {
   isHighlight,
   isReply,
   hasBeenEdited,
+  pageLabel as getPageLabel,
 } from '../../helpers/annotation-metadata';
 import {
   annotationAuthorLink,
@@ -54,6 +55,7 @@ function AnnotationHeader({
   const defaultAuthority = store.defaultAuthority();
   const displayNamesEnabled = store.isFeatureEnabled('client_display_names');
   const userURL = store.getLink('user', { user: annotation.user });
+  const pageNumbersEnabled = store.isFeatureEnabled('page_numbers');
 
   const authorName = useMemo(
     () =>
@@ -101,7 +103,14 @@ function AnnotationHeader({
     // an ID.
     store.setExpanded(annotation.id!, true);
 
-  const group = store.getGroup(annotation.group);
+  // As part of the `page_numbers` feature, we are hiding the group on cards in
+  // contexts where it is the same for all cards and is shown elsewhere in the
+  // UI (eg. the top bar). This is to reduce visual clutter.
+  let group;
+  if (!pageNumbersEnabled || store.route() !== 'sidebar') {
+    group = store.getGroup(annotation.group);
+  }
+  const pageNumber = pageNumbersEnabled ? getPageLabel(annotation) : undefined;
 
   return (
     <header>
@@ -153,6 +162,8 @@ function AnnotationHeader({
               className="w-[10px] h-[10px] text-color-text-light"
             />
           )}
+          {(showDocumentInfo || pageNumber) && (
+            <span className="flex">
               {showDocumentInfo && (
                 <AnnotationDocumentInfo
                   domain={documentInfo.domain}
@@ -160,6 +171,13 @@ function AnnotationHeader({
                   title={documentInfo.titleText}
                 />
               )}
+              {pageNumber && (
+                <span className="text-grey-6" data-testid="page-number">
+                  {showDocumentInfo && ', '}p.{pageNumber}
+                </span>
+              )}
+            </span>
+          )}
         </div>
       )}
     </header>

src/sidebar/components/Annotation/test/AnnotationHeader-test.js

@@ -8,6 +8,7 @@ import * as fixtures from '../../../test/annotation-fixtures';
 import AnnotationHeader, { $imports } from '../AnnotationHeader';
 
 describe('AnnotationHeader', () => {
+  let activeFeatures;
   let fakeAnnotationAuthorLink;
   let fakeAnnotationDisplayName;
   let fakeDomainAndTitle;
@@ -33,6 +34,11 @@ describe('AnnotationHeader', () => {
   };
 
   beforeEach(() => {
+    activeFeatures = {
+      client_display_names: true,
+      page_numbers: false,
+    };
+
     fakeAnnotationAuthorLink = sinon
       .stub()
       .returns('http://www.example.com/user/');
@@ -54,10 +60,13 @@ describe('AnnotationHeader', () => {
 
     fakeStore = {
       defaultAuthority: sinon.stub().returns('example.com'),
-      isFeatureEnabled: sinon
-        .stub()
-        .withArgs('client_display_names')
-        .returns(true),
+      isFeatureEnabled: sinon.stub().callsFake(feature => {
+        const enabled = activeFeatures[feature];
+        if (enabled === undefined) {
+          throw new Error(`Unknown feature "${feature}"`);
+        }
+        return enabled;
+      }),
       getGroup: sinon.stub().returns(fakeGroup),
       getLink: sinon
         .stub()
@@ -443,6 +452,52 @@ describe('AnnotationHeader', () => {
     });
   });
 
+  context('when page_numbers feature is enabled', () => {
+    beforeEach(() => {
+      activeFeatures.page_numbers = true;
+
+      // Un-mock the `pageLabel` function.
+      $imports.$restore({
+        '../../helpers/annotation-metadata': true,
+      });
+    });
+
+    it('should not display page number if missing', () => {
+      const annotation = fixtures.defaultAnnotation();
+      const wrapper = createAnnotationHeader({ annotation });
+      assert.isFalse(wrapper.exists('[data-testid="page-number"]'));
+    });
+
+    it('should display page number if available', () => {
+      const annotation = fixtures.defaultAnnotation();
+      annotation.target[0].selector.push({
+        type: 'PageSelector',
+        index: 10,
+        label: '11',
+      });
+      const wrapper = createAnnotationHeader({ annotation });
+      const pageNumber = wrapper.find('[data-testid="page-number"]');
+      assert.isTrue(pageNumber.exists());
+      assert.equal(pageNumber.text(), 'p.11');
+    });
+
+    it('should hide group name in sidebar', () => {
+      fakeStore.route.returns('sidebar');
+      const wrapper = createAnnotationHeader({
+        annotation: fixtures.defaultAnnotation(),
+      });
+      assert.isFalse(wrapper.exists('AnnotationShareInfo'));
+    });
+
+    it('should still show group name outside the sidebar', () => {
+      fakeStore.route.returns('annotation');
+      const wrapper = createAnnotationHeader({
+        annotation: fixtures.defaultAnnotation(),
+      });
+      assert.isTrue(wrapper.exists('AnnotationShareInfo'));
+    });
+  });
+
   it(
     'should pass a11y checks',
     checkAccessibility([

src/sidebar/helpers/annotation-metadata.ts

 import type {
   APIAnnotationData,
   Annotation,
+  PageSelector,
   SavedAnnotation,
   TextQuoteSelector,
 } from '../../types/api';
@@ -341,6 +342,18 @@ export function quote(annotation: APIAnnotationData): string | null {
   return quoteSel ? quoteSel.exact : null;
 }
 
+/**
+ * Return the label of the page that an annotation comes from.
+ *
+ * This is usually a 1-based page number, but can also be roman numerals etc.
+ */
+export function pageLabel(annotation: APIAnnotationData): string | undefined {
+  const pageSel = annotation.target[0]?.selector?.find(
+    s => s.type === 'PageSelector',
+  ) as PageSelector | undefined;
+  return pageSel?.label;
+}
+
 /**
  * Has this annotation been edited subsequent to its creation?
  */

src/sidebar/helpers/test/annotation-metadata-test.js

@@ -4,6 +4,7 @@ import {
   documentMetadata,
   domainAndTitle,
   isSaved,
+  pageLabel,
 } from '../annotation-metadata';
 
 describe('sidebar/helpers/annotation-metadata', () => {
@@ -587,6 +588,27 @@ describe('sidebar/helpers/annotation-metadata', () => {
     });
   });
 
+  describe('pageLabel', () => {
+    it('returns page label for annotation', () => {
+      const ann = {
+        target: [
+          {
+            source: 'https://publisher.org/article.pdf',
+            selector: [{ type: 'PageSelector', index: 10, label: '11' }],
+          },
+        ],
+      };
+      assert.equal(pageLabel(ann), '11');
+    });
+
+    it('returns undefined if annotation has no `PageSelector` selector', () => {
+      const anns = [fixtures.newPageNote(), fixtures.newAnnotation()];
+      for (const ann of anns) {
+        assert.isUndefined(pageLabel(ann));
+      }
+    });
+  });
+
   describe('hasBeenEdited', () => {
     it('should return false if created and updated timestamps are equal', () => {
       const annotation = fakeAnnotation({