Revert "Revert "Make changes and add tests""

This reverts commit a776616.

Author: karenrasmussen

src/annotator/integrations/test/html-metadata-test.js

@@ -289,6 +289,132 @@ describe('HTMLMetadata', () => {
     });
   });
 
+  describe('#_getVersion', () => {
+    function setVersionMeta(id, publicUrl, canonicalHref) {
+      let html = '';
+      if (id) {
+        html += `<meta name="citation_id" content="${id}">`;
+      }
+      if (publicUrl) {
+        html += `<meta name="citation_public_url" content="${publicUrl}">`;
+      }
+      if (canonicalHref) {
+        html += `<link rel="canonical" href="${canonicalHref}">`;
+      }
+      tempDocumentHead.innerHTML = html;
+    }
+
+    it('returns version when all three sources agree', () => {
+      setVersionMeta(
+        'doc-v3',
+        'https://example.com/doc-v3',
+        'https://example.com/doc-v3',
+      );
+      const metadata = testDocument.getDocumentMetadata();
+      assert.equal(metadata.version, 3);
+    });
+
+    it('returns null when sources have different versions', () => {
+      setVersionMeta(
+        'doc-v3',
+        'https://example.com/doc-v5',
+        'https://example.com/doc-v3',
+      );
+      const metadata = testDocument.getDocumentMetadata();
+      assert.isUndefined(metadata.version);
+    });
+
+    it('returns null when one source is missing a version', () => {
+      setVersionMeta(
+        'doc-v3',
+        'https://example.com/doc',
+        'https://example.com/doc-v3',
+      );
+      const metadata = testDocument.getDocumentMetadata();
+      assert.isUndefined(metadata.version);
+    });
+
+    it('returns null when no sources have a version', () => {
+      setVersionMeta(
+        'doc-abc',
+        'https://example.com/doc',
+        'https://example.com/doc',
+      );
+      const metadata = testDocument.getDocumentMetadata();
+      assert.isUndefined(metadata.version);
+    });
+
+    it('returns null when canonical link is missing', () => {
+      tempDocumentHead.innerHTML = `
+        <meta name="citation_id" content="doc-v3">
+        <meta name="citation_public_url" content="https://example.com/doc-v3">
+      `;
+      const metadata = testDocument.getDocumentMetadata();
+      assert.isUndefined(metadata.version);
+    });
+
+    it('returns null when citation_id is missing', () => {
+      tempDocumentHead.innerHTML = `
+        <meta name="citation_public_url" content="https://example.com/doc-v3">
+        <link rel="canonical" href="https://example.com/doc-v3">
+      `;
+      const metadata = testDocument.getDocumentMetadata();
+      assert.isUndefined(metadata.version);
+    });
+
+    it('accepts versions from v1 to v25', () => {
+      setVersionMeta(
+        'doc-v1',
+        'https://example.com/doc-v1',
+        'https://example.com/doc-v1',
+      );
+      assert.equal(testDocument.getDocumentMetadata().version, 1);
+
+      setVersionMeta(
+        'doc-v25',
+        'https://example.com/doc-v25',
+        'https://example.com/doc-v25',
+      );
+      assert.equal(testDocument.getDocumentMetadata().version, 25);
+    });
+
+    it('rejects versions above 25', () => {
+      setVersionMeta(
+        'doc-v26',
+        'https://example.com/doc-v26',
+        'https://example.com/doc-v26',
+      );
+      assert.isUndefined(testDocument.getDocumentMetadata().version);
+    });
+
+    it('rejects version 0', () => {
+      setVersionMeta(
+        'doc-v0',
+        'https://example.com/doc-v0',
+        'https://example.com/doc-v0',
+      );
+      assert.isUndefined(testDocument.getDocumentMetadata().version);
+    });
+
+    it('is case insensitive for version suffix', () => {
+      setVersionMeta(
+        'doc-V3',
+        'https://example.com/doc-V3',
+        'https://example.com/doc-V3',
+      );
+      assert.equal(testDocument.getDocumentMetadata().version, 3);
+    });
+
+    it('does not match version embedded in a word', () => {
+      setVersionMeta(
+        'docrev3',
+        'https://example.com/docrev3',
+        'https://example.com/docrev3',
+      );
+      assert.isUndefined(testDocument.getDocumentMetadata().version);
+    });
+  });
+
   describe('#_absoluteUrl', () => {
     it('should add the protocol when the url starts with two slashes', () => {
       const result = testDocument._absoluteUrl('//example.com/');

src/sidebar/store/modules/frames.ts

@@ -188,10 +188,16 @@ function searchUrisForFrame(frame: Frame): string[] {
     });
   }
 
-  // If the document has a version, append :v0:v{version} to each URI
+  // If the document has a version, append a version suffix to each URI.
+  // v0 is the base version and should not be appended.
+  // Only v1 includes v0 annotations (`:v0:v1`), other versions only search their own (`:v{version}`).
   const version = frame.metadata?.version;
-  if (version) {
-    uris = uris.map(uri => `${uri}:v0:v${version}`);
+  if (version && version > 0) {
+    if (version === 1) {
+      uris = uris.map(uri => `${uri}:v0:v1`);
+    } else {
+      uris = uris.map(uri => `${uri}:v${version}`);
+    }
   }
 
   return uris;

src/sidebar/store/modules/test/frames-test.js

@@ -213,6 +213,81 @@ describe('sidebar/store/modules/frames', () => {
         ],
         searchUris: ['https://publisher.org/article.html', 'doi:10.1.1/1234'],
       },
+      {
+        when: 'version 1 includes v0 annotations',
+        frames: [
+          {
+            uri: 'https://publisher.org/article.html',
+            metadata: {
+              version: 1,
+              link: [],
+            },
+          },
+        ],
+        searchUris: ['https://publisher.org/article.html:v0:v1'],
+      },
+      {
+        when: 'version > 1 only searches its own version',
+        frames: [
+          {
+            uri: 'https://publisher.org/article.html',
+            metadata: {
+              version: 3,
+              link: [],
+            },
+          },
+        ],
+        searchUris: ['https://publisher.org/article.html:v3'],
+      },
+      {
+        when: 'a PDF frame with version > 1 only searches its own version',
+        frames: [
+          {
+            uri: 'https://publisher.org/article.pdf',
+            metadata: {
+              documentFingerprint: '1234',
+              version: 5,
+              link: [
+                {
+                  href: 'urn:x-pdf:1234',
+                },
+                {
+                  href: 'https://publisher.org/article.pdf?from_meta_link=1',
+                },
+              ],
+            },
+          },
+        ],
+        searchUris: [
+          'urn:x-pdf:1234:v5',
+          'https://publisher.org/article.pdf?from_meta_link=1:v5',
+        ],
+      },
+      {
+        when: 'the document metadata has no version',
+        frames: [
+          {
+            uri: 'https://publisher.org/article.html',
+            metadata: {
+              link: [],
+            },
+          },
+        ],
+        searchUris: ['https://publisher.org/article.html'],
+      },
+      {
+        when: 'the document metadata has version 0 (base version)',
+        frames: [
+          {
+            uri: 'https://publisher.org/article.html',
+            metadata: {
+              version: 0,
+              link: [],
+            },
+          },
+        ],
+        searchUris: ['https://publisher.org/article.html'],
+      },
     ].forEach(testCase => {
       it(testCase.when, () => {
         testCase.frames.forEach(frame => {