@opentermsarchive/engine 2.3.0 → 2.3.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentermsarchive/engine",
-  "version": "2.3.0",
+  "version": "2.3.2",
   "description": "Tracks and makes visible changes to the terms of online services",
   "homepage": "https://opentermsarchive.org",
   "bugs": {
@@ -90,7 +90,7 @@
     "mongodb": "^4.9.0",
     "morgan": "^1.10.0",
     "node-fetch": "^3.1.0",
-    "octokit": "^1.7.0",
+    "octokit": "2.0.2",
     "pdfjs-dist": "^2.9.359",
     "puppeteer": "^22.8.1",
     "puppeteer-extra": "^3.3.6",

package/src/reporter/github.js

@@ -16,7 +16,14 @@ export default class GitHub {
   constructor(repository) {
     const { version } = require('../../package.json');
 
-    this.octokit = new Octokit({ auth: process.env.OTA_ENGINE_GITHUB_TOKEN, userAgent: `opentermsarchive/${version}` });
+    this.octokit = new Octokit({
+      auth: process.env.OTA_ENGINE_GITHUB_TOKEN,
+      userAgent: `opentermsarchive/${version}`,
+      throttle: {
+        onRateLimit: () => false, // Do not retry after hitting a rate limit error
+        onSecondaryRateLimit: () => false, // Do not retry after hitting a secondary rate limit error
+      },
+    });
 
     const [ owner, repo ] = repository.split('/');
 
@@ -25,173 +32,132 @@ export default class GitHub {
 
   async initialize() {
     this.MANAGED_LABELS = require('./labels.json');
-
-    const existingLabels = await this.getRepositoryLabels();
-    const existingLabelsNames = existingLabels.map(label => label.name);
-    const missingLabels = this.MANAGED_LABELS.filter(label => !existingLabelsNames.includes(label.name));
-
-    if (missingLabels.length) {
-      logger.info(`🤖 Following required labels are not present on the repository: ${missingLabels.map(label => `"${label.name}"`).join(', ')}. Creating them…`);
-
-      for (const label of missingLabels) {
-        await this.createLabel({ /* eslint-disable-line no-await-in-loop */
-          name: label.name,
-          color: label.color,
-          description: `${label.description} ${MANAGED_BY_OTA_MARKER}`,
-        });
+    try {
+      const existingLabels = await this.getRepositoryLabels();
+      const existingLabelsNames = existingLabels.map(label => label.name);
+      const missingLabels = this.MANAGED_LABELS.filter(label => !existingLabelsNames.includes(label.name));
+
+      if (missingLabels.length) {
+        logger.info(`Following required labels are not present on the repository: ${missingLabels.map(label => `"${label.name}"`).join(', ')}. Creating them…`);
+
+        for (const label of missingLabels) {
+          await this.createLabel({ /* eslint-disable-line no-await-in-loop */
+            name: label.name,
+            color: label.color,
+            description: `${label.description} ${MANAGED_BY_OTA_MARKER}`,
+          });
+        }
       }
+    } catch (error) {
+      logger.error(`Failed to handle repository labels: ${error.message}`);
     }
   }
 
   async getRepositoryLabels() {
-    try {
-      const { data: labels } = await this.octokit.request('GET /repos/{owner}/{repo}/labels', { ...this.commonParams });
+    const { data: labels } = await this.octokit.request('GET /repos/{owner}/{repo}/labels', { ...this.commonParams });
 
-      return labels;
-    } catch (error) {
-      logger.error(`🤖 Could not get labels: ${error}`);
-    }
+    return labels;
   }
 
   async createLabel({ name, color, description }) {
-    try {
-      await this.octokit.request('POST /repos/{owner}/{repo}/labels', {
-        ...this.commonParams,
-        name,
-        color,
-        description,
-      });
-
-      logger.info(`🤖 Created repository label "${name}"`);
-    } catch (error) {
-      logger.error(`🤖 Could not create label "${name}": ${error}`);
-    }
+    await this.octokit.request('POST /repos/{owner}/{repo}/labels', {
+      ...this.commonParams,
+      name,
+      color,
+      description,
+    });
   }
 
   async createIssue({ title, description: body, labels }) {
-    try {
-      const { data: issue } = await this.octokit.request('POST /repos/{owner}/{repo}/issues', {
-        ...this.commonParams,
-        title,
-        body,
-        labels,
-      });
-
-      logger.info(`🤖 Created GitHub issue #${issue.number} "${title}": ${issue.html_url}`);
-
-      return issue;
-    } catch (error) {
-      logger.error(`🤖 Could not create GitHub issue "${title}": ${error}`);
-    }
+    const { data: issue } = await this.octokit.request('POST /repos/{owner}/{repo}/issues', {
+      ...this.commonParams,
+      title,
+      body,
+      labels,
+    });
+
+    return issue;
   }
 
-  async setIssueLabels({ issue, labels }) {
-    try {
-      await this.octokit.request('PUT /repos/{owner}/{repo}/issues/{issue_number}/labels', {
-        ...this.commonParams,
-        issue_number: issue.number,
-        labels,
-      });
+  async updateIssue(issue, { state, labels }) {
+    const { data: updatedIssue } = await this.octokit.request('PATCH /repos/{owner}/{repo}/issues/{issue_number}', {
+      ...this.commonParams,
+      issue_number: issue.number,
+      state,
+      labels,
+    });
 
-      logger.info(`🤖 Updated labels to GitHub issue #${issue.number}`);
-    } catch (error) {
-      logger.error(`🤖 Could not update GitHub issue #${issue.number} "${issue.title}": ${error}`);
-    }
-  }
-
-  async openIssue(issue) {
-    try {
-      await this.octokit.request('PATCH /repos/{owner}/{repo}/issues/{issue_number}', {
-        ...this.commonParams,
-        issue_number: issue.number,
-        state: GitHub.ISSUE_STATE_OPEN,
-      });
-
-      logger.info(`🤖 Opened GitHub issue #${issue.number}`);
-    } catch (error) {
-      logger.error(`🤖 Could not update GitHub issue #${issue.number} "${issue.title}": ${error}`);
-    }
-  }
-
-  async closeIssue(issue) {
-    try {
-      await this.octokit.request('PATCH /repos/{owner}/{repo}/issues/{issue_number}', {
-        ...this.commonParams,
-        issue_number: issue.number,
-        state: GitHub.ISSUE_STATE_CLOSED,
-      });
-
-      logger.info(`🤖 Closed GitHub issue #${issue.number}`);
-    } catch (error) {
-      logger.error(`🤖 Could not update GitHub issue #${issue.number} "${issue.title}": ${error}`);
-    }
+    return updatedIssue;
   }
 
   async getIssue({ title, ...searchParams }) {
-    try {
-      const issues = await this.octokit.paginate('GET /repos/{owner}/{repo}/issues', {
-        ...this.commonParams,
-        per_page: 100,
-        ...searchParams,
-      }, response => response.data);
+    const issues = await this.octokit.paginate('GET /repos/{owner}/{repo}/issues', {
+      ...this.commonParams,
+      per_page: 100,
+      ...searchParams,
+    }, response => response.data);
 
-      const [issue] = issues.filter(item => item.title === title); // since only one is expected, use the first one
+    const [issue] = issues.filter(item => item.title === title); // Since only one is expected, use the first one
 
-      return issue;
-    } catch (error) {
-      logger.error(`🤖 Could not find GitHub issue "${title}": ${error}`);
-    }
+    return issue;
   }
 
   async addCommentToIssue({ issue, comment: body }) {
-    try {
-      const { data: comment } = await this.octokit.request('POST /repos/{owner}/{repo}/issues/{issue_number}/comments', {
-        ...this.commonParams,
-        issue_number: issue.number,
-        body,
-      });
+    const { data: comment } = await this.octokit.request('POST /repos/{owner}/{repo}/issues/{issue_number}/comments', {
+      ...this.commonParams,
+      issue_number: issue.number,
+      body,
+    });
 
-      logger.info(`🤖 Added comment to GitHub issue #${issue.number}: ${comment.html_url}`);
-
-      return comment;
-    } catch (error) {
-      logger.error(`🤖 Could not add comment to GitHub issue #${issue.number} "${issue.title}": ${error}`);
-    }
+    return comment;
   }
 
   async closeIssueWithCommentIfExists({ title, comment }) {
-    const openedIssue = await this.getIssue({ title, state: GitHub.ISSUE_STATE_OPEN });
+    try {
+      const openedIssue = await this.getIssue({ title, state: GitHub.ISSUE_STATE_OPEN });
 
-    if (!openedIssue) {
-      return;
-    }
+      if (!openedIssue) {
+        return;
+      }
 
-    await this.addCommentToIssue({ issue: openedIssue, comment });
+      await this.addCommentToIssue({ issue: openedIssue, comment });
+      logger.info(`Added comment to issue #${openedIssue.number}: ${openedIssue.html_url}`);
 
-    return this.closeIssue(openedIssue);
+      await this.updateIssue(openedIssue, { state: GitHub.ISSUE_STATE_CLOSED });
+      logger.info(`Closed issue #${openedIssue.number}: ${openedIssue.html_url}`);
+    } catch (error) {
+      logger.error(`Failed to update issue "${title}": ${error.message}`);
+    }
   }
 
   async createOrUpdateIssue({ title, description, label }) {
-    const issue = await this.getIssue({ title, state: GitHub.ISSUE_STATE_ALL });
+    try {
+      const issue = await this.getIssue({ title, state: GitHub.ISSUE_STATE_ALL });
 
-    if (!issue) {
-      return this.createIssue({ title, description, labels: [label] });
-    }
+      if (!issue) {
+        const createdIssue = await this.createIssue({ title, description, labels: [label] });
 
-    if (issue.state == GitHub.ISSUE_STATE_CLOSED) {
-      await this.openIssue(issue);
-    }
+        return logger.info(`Created issue #${createdIssue.number} "${title}": ${createdIssue.html_url}`);
+      }
 
-    const managedLabelsNames = this.MANAGED_LABELS.map(label => label.name);
-    const [managedLabel] = issue.labels.filter(label => managedLabelsNames.includes(label.name)); // it is assumed that only one specific reason for failure is possible at a time, making managed labels mutually exclusive
+      const managedLabelsNames = this.MANAGED_LABELS.map(label => label.name);
+      const labelsNotManagedToKeep = issue.labels.map(label => label.name).filter(label => !managedLabelsNames.includes(label));
+      const [managedLabel] = issue.labels.filter(label => managedLabelsNames.includes(label.name)); // It is assumed that only one specific reason for failure is possible at a time, making managed labels mutually exclusive
 
-    if (managedLabel?.name == label) { // if the label is already assigned to the issue, the error is redundant with the one already reported and no further action is necessary
-      return;
-    }
+      if (issue.state !== GitHub.ISSUE_STATE_CLOSED && managedLabel?.name === label) {
+        return;
+      }
 
-    const labelsNotManagedToKeep = issue.labels.map(label => label.name).filter(label => !managedLabelsNames.includes(label));
+      await this.updateIssue(issue, {
+        state: GitHub.ISSUE_STATE_OPEN,
+        labels: [ label, ...labelsNotManagedToKeep ],
+      });
+      logger.info(`Updated issue #${issue.number}: ${issue.html_url}`);
+      await this.addCommentToIssue({ issue, comment: description });
 
-    await this.setIssueLabels({ issue, labels: [ label, ...labelsNotManagedToKeep ] });
-    await this.addCommentToIssue({ issue, comment: description });
+      logger.info(`Added comment to issue #${issue.number}: ${issue.html_url}`);
+    } catch (error) {
+      logger.error(`Failed to update issue "${title}": ${error.message}`);
+    }
   }
 }

package/src/reporter/github.test.js

@@ -118,66 +118,6 @@ describe('GitHub', function () {
     });
   });
 
-  describe('#setIssueLabels', () => {
-    let scope;
-    const ISSUE_NUMBER = 123;
-    const LABELS = [ 'bug', 'enhancement' ];
-
-    before(async () => {
-      scope = nock('https://api.github.com')
-        .put(`/repos/owner/repo/issues/${ISSUE_NUMBER}/labels`, { labels: LABELS })
-        .reply(200);
-
-      await github.setIssueLabels({ issue: { number: ISSUE_NUMBER }, labels: LABELS });
-    });
-
-    after(nock.cleanAll);
-
-    it('sets labels on the issue', () => {
-      expect(scope.isDone()).to.be.true;
-    });
-  });
-
-  describe('#openIssue', () => {
-    let scope;
-    const ISSUE = { number: 123 };
-    const EXPECTED_REQUEST_BODY = { state: 'open' };
-
-    before(async () => {
-      scope = nock('https://api.github.com')
-        .patch(`/repos/owner/repo/issues/${ISSUE.number}`, EXPECTED_REQUEST_BODY)
-        .reply(200);
-
-      await github.openIssue(ISSUE);
-    });
-
-    after(nock.cleanAll);
-
-    it('opens the issue', () => {
-      expect(scope.isDone()).to.be.true;
-    });
-  });
-
-  describe('#closeIssue', () => {
-    let scope;
-    const ISSUE = { number: 123 };
-    const EXPECTED_REQUEST_BODY = { state: 'closed' };
-
-    before(async () => {
-      scope = nock('https://api.github.com')
-        .patch(`/repos/owner/repo/issues/${ISSUE.number}`, EXPECTED_REQUEST_BODY)
-        .reply(200);
-
-      await github.closeIssue(ISSUE);
-    });
-
-    after(nock.cleanAll);
-
-    it('closes the issue', () => {
-      expect(scope.isDone()).to.be.true;
-    });
-  });
-
   describe('#getIssue', () => {
     let scope;
     let result;
@@ -376,9 +316,8 @@ describe('GitHub', function () {
       };
 
       context('when issue is closed', () => {
-        let setIssueLabelsScope;
+        let updateIssueScope;
         let addCommentScope;
-        let openIssueScope;
 
         const GITHUB_RESPONSE_FOR_EXISTING_ISSUE = {
           number: 123,
@@ -394,12 +333,8 @@ describe('GitHub', function () {
             .query(true)
             .reply(200, [GITHUB_RESPONSE_FOR_EXISTING_ISSUE]);
 
-          openIssueScope = nock('https://api.github.com')
-            .patch(`/repos/owner/repo/issues/${GITHUB_RESPONSE_FOR_EXISTING_ISSUE.number}`, { state: GitHub.ISSUE_STATE_OPEN })
-            .reply(200);
-
-          setIssueLabelsScope = nock('https://api.github.com')
-            .put(`/repos/owner/repo/issues/${GITHUB_RESPONSE_FOR_EXISTING_ISSUE.number}/labels`, { labels: ['location'] })
+          updateIssueScope = nock('https://api.github.com')
+            .patch(`/repos/owner/repo/issues/${GITHUB_RESPONSE_FOR_EXISTING_ISSUE.number}`, { state: GitHub.ISSUE_STATE_OPEN, labels: ['location'] })
             .reply(200);
 
           addCommentScope = nock('https://api.github.com')
@@ -409,12 +344,8 @@ describe('GitHub', function () {
           await github.createOrUpdateIssue(ISSUE);
         });
 
-        it('reopens the issue', () => {
-          expect(openIssueScope.isDone()).to.be.true;
-        });
-
-        it("updates the issue's label", () => {
-          expect(setIssueLabelsScope.isDone()).to.be.true;
+        it('reopens the issue and its labels', () => {
+          expect(updateIssueScope.isDone()).to.be.true;
         });
 
         it('adds comment to the issue', () => {
@@ -423,9 +354,8 @@ describe('GitHub', function () {
       });
 
       context('when issue is already opened', () => {
-        let setIssueLabelsScope;
         let addCommentScope;
-        let openIssueScope;
+        let updateIssueScope;
 
         const GITHUB_RESPONSE_FOR_EXISTING_ISSUE = {
           number: 123,
@@ -441,12 +371,8 @@ describe('GitHub', function () {
             .query(true)
             .reply(200, [GITHUB_RESPONSE_FOR_EXISTING_ISSUE]);
 
-          openIssueScope = nock('https://api.github.com')
-            .patch(`/repos/owner/repo/issues/${GITHUB_RESPONSE_FOR_EXISTING_ISSUE.number}`, { state: GitHub.ISSUE_STATE_OPEN })
-            .reply(200);
-
-          setIssueLabelsScope = nock('https://api.github.com')
-            .put(`/repos/owner/repo/issues/${GITHUB_RESPONSE_FOR_EXISTING_ISSUE.number}/labels`, { labels: ['location'] })
+          updateIssueScope = nock('https://api.github.com')
+            .patch(`/repos/owner/repo/issues/${GITHUB_RESPONSE_FOR_EXISTING_ISSUE.number}`, { state: GitHub.ISSUE_STATE_OPEN, labels: ['location'] })
             .reply(200);
 
           addCommentScope = nock('https://api.github.com')
@@ -456,12 +382,8 @@ describe('GitHub', function () {
           await github.createOrUpdateIssue(ISSUE);
         });
 
-        it('does not change the issue state', () => {
-          expect(openIssueScope.isDone()).to.be.false;
-        });
-
-        it("updates the issue's label", () => {
-          expect(setIssueLabelsScope.isDone()).to.be.true;
+        it("updates the issue's labels", () => {
+          expect(updateIssueScope.isDone()).to.be.true;
         });
 
         it('adds comment to the issue', () => {