Link feed entries to GitHub commits

Author: clementbiron

src/collection-api/routes/feed.js

@@ -66,13 +66,18 @@ function buildEntryId(collection, version) {
 }
 
 function buildEntry(collection, baseUrl, version) {
+  const apiLink = buildVersionLink(baseUrl, version);
+  const githubCommitLink = collection.metadata?.versions && `${collection.metadata.versions}/commit/${version.id}`;
+
+  const links = [{ _attributes: { rel: 'alternate', type: 'text/html', href: githubCommitLink || apiLink } }];
+
+  if (githubCommitLink) {
+    links.push({ _attributes: { rel: 'related', type: 'text/html', href: apiLink } });
+  }
+
   return {
     id: { _text: buildEntryId(collection, version) },
-    link: { _attributes: {
-      rel: 'alternate',
-      type: 'text/html',
-      href: buildVersionLink(baseUrl, version),
-    } },
+    link: links,
     title: { _text: buildEntryTitle(version) },
     updated: { _text: version.fetchDate.toISOString() },
     category: [

src/collection-api/routes/feed.test.js

@@ -159,8 +159,15 @@ describe('Feed API', () => {
         expect(firstEntry).to.include(`<id>${expected}</id>`);
       });
 
-      it('has an alternate link to the version API endpoint', () => {
+      it('has an alternate link to the GitHub commit', async () => {
+        const collection = await getCollection();
         const href = firstEntry.match(/<link[^>]*rel="alternate"[^>]*href="([^"]+)"/)[1];
+
+        expect(href).to.equal(`${collection.metadata.versions}/commit/${savedVersions.technicalUpgradeRecord.id}`);
+      });
+
+      it('has a related link to the version API endpoint', () => {
+        const href = firstEntry.match(/<link[^>]*rel="related"[^>]*href="([^"]+)"/)[1];
         const expectedPathFragment = `/version/${encodeURIComponent('service-2')}/${encodeURIComponent('Privacy Policy')}/${encodeURIComponent(toISODateWithoutMilliseconds(FETCH_DATE_UPGRADE))}`;
 
         expect(href).to.include(expectedPathFragment);
@@ -399,8 +406,8 @@ describe('Feed API', () => {
       expect(href).to.not.include('Service B!');
     });
 
-    it('URL-encodes spaces and special characters in entry alternate links', () => {
-      const href = response.text.match(/<link[^>]*rel="alternate"[^>]*href="([^"]+)"/)[1];
+    it('URL-encodes spaces and special characters in entry related links', () => {
+      const href = response.text.match(/<link[^>]*rel="related"[^>]*href="([^"]+)"/)[1];
 
       expect(href).to.include('Service%20B!');
       expect(href).to.include('Privacy%20Policy');