@opentermsarchive/engine 2.3.1 → 2.3.2

package/package.json

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

package/src/reporter/github.js

@@ -79,28 +79,15 @@ export default class GitHub {
     return issue;
   }
 
-  async setIssueLabels({ issue, labels }) {
-    await this.octokit.request('PUT /repos/{owner}/{repo}/issues/{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,
     });
-  }
 
-  async openIssue(issue) {
-    await this.octokit.request('PATCH /repos/{owner}/{repo}/issues/{issue_number}', {
-      ...this.commonParams,
-      issue_number: issue.number,
-      state: GitHub.ISSUE_STATE_OPEN,
-    });
-  }
-
-  async closeIssue(issue) {
-    await this.octokit.request('PATCH /repos/{owner}/{repo}/issues/{issue_number}', {
-      ...this.commonParams,
-      issue_number: issue.number,
-      state: GitHub.ISSUE_STATE_CLOSED,
-    });
+    return updatedIssue;
   }
 
   async getIssue({ title, ...searchParams }) {
@@ -110,7 +97,7 @@ export default class GitHub {
       ...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;
   }
@@ -134,9 +121,10 @@ export default class GitHub {
       }
 
       await this.addCommentToIssue({ issue: openedIssue, comment });
-      await this.closeIssue(openedIssue);
+      logger.info(`Added comment to issue #${openedIssue.number}: ${openedIssue.html_url}`);
 
-      return logger.info(`Closed issue #${openedIssue.number}: ${openedIssue.html_url}`);
+      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}`);
     }
@@ -152,23 +140,22 @@ export default class GitHub {
         return logger.info(`Created issue #${createdIssue.number} "${title}": ${createdIssue.html_url}`);
       }
 
-      if (issue.state == GitHub.ISSUE_STATE_CLOSED) {
-        await this.openIssue(issue);
-        logger.info(`Reopened issue #${issue.number}: ${issue.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 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
+      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.setIssueLabels({ issue, labels: [ label, ...labelsNotManagedToKeep ] });
-      await this.addCommentToIssue({ issue, comment: description });
+      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 });
+
+      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', () => {