@opentermsarchive/engine 16.1.0 → 16.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentermsarchive/engine",
-  "version": "16.1.0",
+  "version": "16.1.1",
   "description": "Tracks and makes visible changes to the terms of online services",
   "homepage": "https://opentermsarchive.org",
   "bugs": {

package/src/reporter/factory.js

@@ -4,9 +4,9 @@ import GitLab from './gitlab/index.js';
 export function createReporter(config) {
   switch (config.type) {
   case 'github':
-    return new GitHub(config.repositories.declarations);
+    return new GitHub(config.repositories);
   case 'gitlab':
-    return new GitLab(config.repositories.declarations, config.baseURL, config.apiBaseURL);
+    return new GitLab(config.repositories, config.baseURL, config.apiBaseURL);
   default:
     throw new Error(`Unsupported reporter type: ${config.type}`);
   }

package/src/reporter/github/index.js

@@ -13,7 +13,7 @@ export default class GitHub {
   static ISSUE_STATE_ALL = 'all';
   static MAX_LABEL_DESCRIPTION_LENGTH = 100;
 
-  constructor(repository) {
+  constructor(repositories) {
     const { version } = require('../../../package.json');
 
     this.octokit = new Octokit({
@@ -25,7 +25,9 @@ export default class GitHub {
       },
     });
 
-    const [ owner, repo ] = repository.split('/');
+    this.repositories = repositories; // Each generated link points into its own repository, while the issues live in the declarations one
+
+    const [ owner, repo ] = repositories.declarations.split('/');
 
     this.commonParams = { owner, repo };
 
@@ -272,14 +274,14 @@ export default class GitHub {
   }
 
   generateDeclarationURL(serviceName) {
-    return `https://github.com/${this.commonParams.owner}/${this.commonParams.repo}/blob/main/declarations/${encodeURIComponent(serviceName)}.json`;
+    return `https://github.com/${this.repositories.declarations}/blob/main/declarations/${encodeURIComponent(serviceName)}.json`;
   }
 
   generateVersionURL(serviceName, termsType) {
-    return `https://github.com/${this.commonParams.owner}/${this.commonParams.repo}/blob/main/${encodeURIComponent(serviceName)}/${encodeURIComponent(termsType)}.md`;
+    return `https://github.com/${this.repositories.versions}/blob/main/${encodeURIComponent(serviceName)}/${encodeURIComponent(termsType)}.md`;
   }
 
   generateSnapshotsBaseUrl(serviceName, termsType) {
-    return `https://github.com/${this.commonParams.owner}/${this.commonParams.repo}/blob/main/${encodeURIComponent(serviceName)}/${encodeURIComponent(termsType)}`;
+    return `https://github.com/${this.repositories.snapshots}/blob/main/${encodeURIComponent(serviceName)}/${encodeURIComponent(termsType)}`;
   }
 }

package/src/reporter/github/index.test.js

@@ -10,12 +10,13 @@ describe('GitHub', function () {
 
   let MANAGED_LABELS;
   let github;
+  const REPOSITORIES = { declarations: 'owner/repo', versions: 'owner/versions-repo', snapshots: 'owner/snapshots-repo' };
   const EXISTING_OPEN_ISSUE = { number: 1, title: 'Opened issue', description: 'Issue description', state: GitHub.ISSUE_STATE_OPEN, labels: [{ name: LABELS.HTTP_403.name }] };
   const EXISTING_CLOSED_ISSUE = { number: 2, title: 'Closed issue', description: 'Issue description', state: GitHub.ISSUE_STATE_CLOSED, labels: [{ name: LABELS.EMPTY_CONTENT.name }] };
 
   before(async () => {
     MANAGED_LABELS = Object.values(LABELS);
-    github = new GitHub('owner/repo');
+    github = new GitHub(REPOSITORIES);
     nock('https://api.github.com')
       .get('/repos/owner/repo/issues')
       .query(true)
@@ -518,4 +519,18 @@ describe('GitHub', function () {
       });
     });
   });
+
+  describe('URL generation', () => {
+    it('links the declaration into the declarations repository', () => {
+      expect(github.generateDeclarationURL('Service A')).to.equal('https://github.com/owner/repo/blob/main/declarations/Service%20A.json');
+    });
+
+    it('links the version into the versions repository', () => {
+      expect(github.generateVersionURL('Service A', 'Terms of Service')).to.equal('https://github.com/owner/versions-repo/blob/main/Service%20A/Terms%20of%20Service.md');
+    });
+
+    it('links the snapshots into the snapshots repository', () => {
+      expect(github.generateSnapshotsBaseUrl('Service A', 'Terms of Service')).to.equal('https://github.com/owner/snapshots-repo/blob/main/Service%20A/Terms%20of%20Service');
+    });
+  });
 });

package/src/reporter/gitlab/index.js

@@ -14,8 +14,8 @@ export default class GitLab {
   static ISSUE_STATE_ALL = 'all';
   static MAX_LABEL_DESCRIPTION_LENGTH = 255;
 
-  constructor(repository, baseURL = BASE_URL, apiBaseURL = API_BASE_URL) {
-    this.repositoryPath = repository;
+  constructor(repositories, baseURL = BASE_URL, apiBaseURL = API_BASE_URL) {
+    this.repositories = repositories; // Each generated link points into its own repository, while the issues live in the declarations one
     this.projectId = null;
     this.baseURL = baseURL;
     this.apiBaseURL = apiBaseURL;
@@ -26,7 +26,7 @@ export default class GitLab {
 
     try {
       const response = await nodeFetch(
-        `${this.apiBaseURL}/projects/${encodeURIComponent(this.repositoryPath)}`,
+        `${this.apiBaseURL}/projects/${encodeURIComponent(this.repositories.declarations)}`,
         options,
       );
 
@@ -478,15 +478,15 @@ export default class GitLab {
   }
 
   generateDeclarationURL(serviceName) {
-    return `${this.baseURL}/${this.repositoryPath}/-/blob/main/declarations/${encodeURIComponent(serviceName)}.json`;
+    return `${this.baseURL}/${this.repositories.declarations}/-/blob/main/declarations/${encodeURIComponent(serviceName)}.json`;
   }
 
   generateVersionURL(serviceName, termsType) {
-    return `${this.baseURL}/${this.repositoryPath}/-/blob/main/${encodeURIComponent(serviceName)}/${encodeURIComponent(termsType)}.md`;
+    return `${this.baseURL}/${this.repositories.versions}/-/blob/main/${encodeURIComponent(serviceName)}/${encodeURIComponent(termsType)}.md`;
   }
 
   generateSnapshotsBaseUrl(serviceName, termsType) {
-    return `${this.baseURL}/${this.repositoryPath}/-/blob/main/${encodeURIComponent(serviceName)}/${encodeURIComponent(termsType)}`;
+    return `${this.baseURL}/${this.repositories.snapshots}/-/blob/main/${encodeURIComponent(serviceName)}/${encodeURIComponent(termsType)}`;
   }
 
   // GitLab API responses are not cached unlike GitHub, so this method only exists to satisfy the Reporter interface contract

package/src/reporter/gitlab/index.test.js

@@ -11,10 +11,11 @@ describe('GitLab', function () {
   let MANAGED_LABELS;
   let gitlab;
   const PROJECT_ID = '4';
+  const REPOSITORIES = { declarations: 'owner/repo', versions: 'owner/versions-repo', snapshots: 'owner/snapshots-repo' };
 
   before(() => {
     MANAGED_LABELS = Object.values(LABELS);
-    gitlab = new GitLab('owner/repo');
+    gitlab = new GitLab(REPOSITORIES);
   });
 
   describe('#initialize', () => {
@@ -767,4 +768,26 @@ describe('GitLab', function () {
       });
     });
   });
+
+  describe('URL generation', () => {
+    it('links the declaration into the declarations repository', () => {
+      expect(gitlab.generateDeclarationURL('Service A')).to.equal('https://gitlab.com/owner/repo/-/blob/main/declarations/Service%20A.json');
+    });
+
+    it('links the version into the versions repository', () => {
+      expect(gitlab.generateVersionURL('Service A', 'Terms of Service')).to.equal('https://gitlab.com/owner/versions-repo/-/blob/main/Service%20A/Terms%20of%20Service.md');
+    });
+
+    it('links the snapshots into the snapshots repository', () => {
+      expect(gitlab.generateSnapshotsBaseUrl('Service A', 'Terms of Service')).to.equal('https://gitlab.com/owner/snapshots-repo/-/blob/main/Service%20A/Terms%20of%20Service');
+    });
+
+    context('with a custom base URL', () => {
+      it('links into the custom instance', () => {
+        const customGitlab = new GitLab(REPOSITORIES, 'https://gitlab.example.test');
+
+        expect(customGitlab.generateVersionURL('Service A', 'Terms of Service')).to.equal('https://gitlab.example.test/owner/versions-repo/-/blob/main/Service%20A/Terms%20of%20Service.md');
+      });
+    });
+  });
 });

package/src/reporter/index.test.js

@@ -64,7 +64,7 @@ describe('Reporter', () => {
   describe('#generateDescription', () => {
     const buildReporter = () => new Reporter({
       type: 'github',
-      repositories: { declarations: 'OpenTermsArchive/test-declarations', snapshots: 'OpenTermsArchive/test-snapshots' },
+      repositories: { declarations: 'OpenTermsArchive/test-declarations', versions: 'OpenTermsArchive/test-versions', snapshots: 'OpenTermsArchive/test-snapshots' },
     });
 
     const buildTerms = ({ sourceCount = 1, hasSnapshots = true, withoutSnapshotIndexes = [] } = {}) => {
@@ -159,5 +159,32 @@ describe('Reporter', () => {
         expect(description.length).to.be.lessThan(65000);
       });
     });
+
+    context('references links', () => {
+      it('links the latest version into the versions repository', () => {
+        const description = buildReporter().generateDescription({ error, terms: buildTerms() });
+
+        expect(description).to.include('github.com/OpenTermsArchive/test-versions/blob/main/TestService/Terms%20of%20Service.md');
+      });
+
+      it('links the latest snapshots into the snapshots repository', () => {
+        const description = buildReporter().generateDescription({ error, terms: buildTerms() });
+
+        expect(description).to.include('github.com/OpenTermsArchive/test-snapshots/blob/main/TestService/Terms%20of%20Service');
+        expect(description).to.not.include('test-declarations/blob/main/TestService/Terms%20of%20Service'); // A version or snapshot link into the declarations repository is the regression this guards against
+      });
+
+      context('when only the declarations repository is configured', () => {
+        it('omits the version and snapshots links instead of generating broken ones', () => {
+          const reporter = new Reporter({ type: 'github', repositories: { declarations: 'OpenTermsArchive/test-declarations' } });
+
+          const description = reporter.generateDescription({ error, terms: buildTerms() });
+
+          expect(description).to.not.include('Latest version');
+          expect(description).to.not.include('Latest snapshot');
+          expect(description).to.not.include('undefined');
+        });
+      });
+    });
   });
 });