feat(options): add new option ignore-updates to stale even with activity (#540)

* chore(assignees): add logs

* docs(readme): use the override syntax to simplify the reading

* docs(readme): add missing default options

* docs(readme): add 3 new options to ignore activity before stale

* chore(action): add 3 new options

* fix(removeStaleWhenUpdated): use the value of the action config as expected

Fixes #451

* chore(main): add 3 new options

* feat(ignore): add new class to ignore all activities before stale

* feat(option): add new options to ignore all activities before stale

* chore(index): update index file

* docs(readme): fix typo

* docs(readme): add missing empty row

* chore(rebase): fix logger issues due to rebase

* chore: aplly changes due to rebase

* refactor(naming): change the name of the options as suggested

* chore(logs): reverse the logs as well

* docs(readme): format the table of options

* refactor(naming): rename the the options

* style(rename): rename more updates wording to activities

* build(ci): run the test step as expected for a CI

instead of using a real linter with auto fix and the tests verbose as fuck

* chore: handle breaking changes due to new changes

* refactor(naming): rename and reverse the options

* style(tests): use plural for some describe

* docs(days-before-stale): list the new option

* chore(index): update index file

* chore: keep static methods on top

* chore(logs): remove useless log

__tests__/any-of-labels.spec.ts

@@ -8,7 +8,7 @@ import {generateIssue} from './functions/generate-issue';
 let issuesProcessorBuilder: IssuesProcessorBuilder;
 let issuesProcessor: IssuesProcessorMock;
 
-describe('any-of-labels option', (): void => {
+describe('any-of-labels options', (): void => {
   beforeEach((): void => {
     issuesProcessorBuilder = new IssuesProcessorBuilder();
   });

__tests__/constants/default-processor-options.ts

@@ -46,5 +46,8 @@ export const DefaultProcessorOptions: IIssuesProcessorOptions = Object.freeze({
   exemptAllPrAssignees: undefined,
   enableStatistics: true,
   labelsToRemoveWhenUnstale: '',
-  labelsToAddWhenUnstale: ''
+  labelsToAddWhenUnstale: '',
+  ignoreUpdates: false,
+  ignoreIssueUpdates: undefined,
+  ignorePrUpdates: undefined
 });

__tests__/functions/generate-issue.ts

@@ -1,5 +1,5 @@
 import {Issue} from '../../src/classes/issue';
-import {IAssignee} from '../../src/interfaces/assignee';
+import {IUserAssignee} from '../../src/interfaces/assignee';
 import {IIssuesProcessorOptions} from '../../src/interfaces/issues-processor-options';
 import {IsoDateString} from '../../src/types/iso-date-string';
 
@@ -32,9 +32,10 @@ export function generateIssue(
           title: milestone
         }
       : undefined,
-    assignees: assignees.map((assignee: Readonly<string>): IAssignee => {
+    assignees: assignees.map((assignee: Readonly<string>): IUserAssignee => {
       return {
-        login: assignee
+        login: assignee,
+        type: 'User'
       };
     })
   });

__tests__/only-labels.spec.ts

@@ -8,7 +8,7 @@ import {generateIssue} from './functions/generate-issue';
 let issuesProcessorBuilder: IssuesProcessorBuilder;
 let issuesProcessor: IssuesProcessorMock;
 
-describe('only-labels option', (): void => {
+describe('only-labels options', (): void => {
   beforeEach((): void => {
     issuesProcessorBuilder = new IssuesProcessorBuilder();
   });

__tests__/operations-per-run.spec.ts

@@ -5,7 +5,7 @@ import {IssuesProcessorMock} from './classes/issues-processor-mock';
 import {DefaultProcessorOptions} from './constants/default-processor-options';
 import {generateIssue} from './functions/generate-issue';
 
-describe('operations per run option', (): void => {
+describe('operations-per-run option', (): void => {
   let sut: SUT;
 
   beforeEach((): void => {

__tests__/updates-reset-stale.spec.ts

@@ -0,0 +1,696 @@
+import {Issue} from '../src/classes/issue';
+import {IIssuesProcessorOptions} from '../src/interfaces/issues-processor-options';
+import {IsoDateString} from '../src/types/iso-date-string';
+import {IssuesProcessorMock} from './classes/issues-processor-mock';
+import {DefaultProcessorOptions} from './constants/default-processor-options';
+import {generateIssue} from './functions/generate-issue';
+
+describe('ignore-updates options', (): void => {
+  let sut: SUT;
+
+  beforeEach((): void => {
+    sut = new SUT();
+  });
+
+  describe('when the issue should be stale within 10 days and was created 20 days ago and updated 5 days ago', (): void => {
+    beforeEach((): void => {
+      sut.toIssue().staleIn(10).created(20).updated(5);
+    });
+
+    describe('when the ignore updates option is disabled', (): void => {
+      beforeEach((): void => {
+        sut.staleOnUpdates();
+      });
+
+      it('should not stale the issue', async () => {
+        expect.assertions(3);
+
+        await sut.test();
+
+        expect(sut.processor.staleIssues).toHaveLength(0);
+        expect(sut.processor.closedIssues).toHaveLength(0);
+        expect(sut.processor.removedLabelIssues).toHaveLength(0);
+      });
+
+      describe('when the ignore issue updates option is enabled', (): void => {
+        beforeEach((): void => {
+          sut.ignoreIssueUpdates();
+        });
+
+        it('should stale the issue', async () => {
+          expect.assertions(3);
+
+          await sut.test();
+
+          expect(sut.processor.staleIssues).toHaveLength(1);
+          expect(sut.processor.closedIssues).toHaveLength(0);
+          expect(sut.processor.removedLabelIssues).toHaveLength(0);
+        });
+      });
+
+      describe('when the ignore issue updates option is disabled', (): void => {
+        beforeEach((): void => {
+          sut.staleOnIssueUpdates();
+        });
+
+        it('should not stale the issue', async () => {
+          expect.assertions(3);
+
+          await sut.test();
+
+          expect(sut.processor.staleIssues).toHaveLength(0);
+          expect(sut.processor.closedIssues).toHaveLength(0);
+          expect(sut.processor.removedLabelIssues).toHaveLength(0);
+        });
+      });
+
+      describe('when the ignore issue updates option is unset', (): void => {
+        beforeEach((): void => {
+          sut.unsetIgnoreIssueUpdates();
+        });
+
+        it('should not stale the issue', async () => {
+          expect.assertions(3);
+
+          await sut.test();
+
+          expect(sut.processor.staleIssues).toHaveLength(0);
+          expect(sut.processor.closedIssues).toHaveLength(0);
+          expect(sut.processor.removedLabelIssues).toHaveLength(0);
+        });
+      });
+    });
+
+    describe('when the ignore updates option is enabled', (): void => {
+      beforeEach((): void => {
+        sut.ignoreUpdates();
+      });
+
+      it('should stale the issue', async () => {
+        expect.assertions(3);
+
+        await sut.test();
+
+        expect(sut.processor.staleIssues).toHaveLength(1);
+        expect(sut.processor.closedIssues).toHaveLength(0);
+        expect(sut.processor.removedLabelIssues).toHaveLength(0);
+      });
+
+      describe('when the ignore issue updates option is enabled', (): void => {
+        beforeEach((): void => {
+          sut.ignoreIssueUpdates();
+        });
+
+        it('should stale the issue', async () => {
+          expect.assertions(3);
+
+          await sut.test();
+
+          expect(sut.processor.staleIssues).toHaveLength(1);
+          expect(sut.processor.closedIssues).toHaveLength(0);
+          expect(sut.processor.removedLabelIssues).toHaveLength(0);
+        });
+      });
+
+      describe('when the ignore issue updates option is disabled', (): void => {
+        beforeEach((): void => {
+          sut.staleOnIssueUpdates();
+        });
+
+        it('should not stale the issue', async () => {
+          expect.assertions(3);
+
+          await sut.test();
+
+          expect(sut.processor.staleIssues).toHaveLength(0);
+          expect(sut.processor.closedIssues).toHaveLength(0);
+          expect(sut.processor.removedLabelIssues).toHaveLength(0);
+        });
+      });
+
+      describe('when the ignore issue updates option is unset', (): void => {
+        beforeEach((): void => {
+          sut.unsetIgnoreIssueUpdates();
+        });
+
+        it('should stale the issue', async () => {
+          expect.assertions(3);
+
+          await sut.test();
+
+          expect(sut.processor.staleIssues).toHaveLength(1);
+          expect(sut.processor.closedIssues).toHaveLength(0);
+          expect(sut.processor.removedLabelIssues).toHaveLength(0);
+        });
+      });
+    });
+  });
+
+  describe('when the issue should be stale within 10 days and was created 20 days ago and updated 15 days ago', (): void => {
+    beforeEach((): void => {
+      sut.toIssue().staleIn(10).created(20).updated(15);
+    });
+
+    describe('when the ignore updates option is disabled', (): void => {
+      beforeEach((): void => {
+        sut.staleOnUpdates();
+      });
+
+      it('should stale the issue', async () => {
+        expect.assertions(3);
+
+        await sut.test();
+
+        expect(sut.processor.staleIssues).toHaveLength(1);
+        expect(sut.processor.closedIssues).toHaveLength(0);
+        expect(sut.processor.removedLabelIssues).toHaveLength(0);
+      });
+
+      describe('when the ignore issue updates option is enabled', (): void => {
+        beforeEach((): void => {
+          sut.ignoreIssueUpdates();
+        });
+
+        it('should stale the issue', async () => {
+          expect.assertions(3);
+
+          await sut.test();
+
+          expect(sut.processor.staleIssues).toHaveLength(1);
+          expect(sut.processor.closedIssues).toHaveLength(0);
+          expect(sut.processor.removedLabelIssues).toHaveLength(0);
+        });
+      });
+
+      describe('when the ignore issue updates option is disabled', (): void => {
+        beforeEach((): void => {
+          sut.staleOnIssueUpdates();
+        });
+
+        it('should stale the issue', async () => {
+          expect.assertions(3);
+
+          await sut.test();
+
+          expect(sut.processor.staleIssues).toHaveLength(1);
+          expect(sut.processor.closedIssues).toHaveLength(0);
+          expect(sut.processor.removedLabelIssues).toHaveLength(0);
+        });
+      });
+
+      describe('when the ignore issue updates option is unset', (): void => {
+        beforeEach((): void => {
+          sut.unsetIgnoreIssueUpdates();
+        });
+
+        it('should stale the issue', async () => {
+          expect.assertions(3);
+
+          await sut.test();
+
+          expect(sut.processor.staleIssues).toHaveLength(1);
+          expect(sut.processor.closedIssues).toHaveLength(0);
+          expect(sut.processor.removedLabelIssues).toHaveLength(0);
+        });
+      });
+    });
+
+    describe('when the ignore updates option is enabled', (): void => {
+      beforeEach((): void => {
+        sut.ignoreUpdates();
+      });
+
+      it('should stale the issue', async () => {
+        expect.assertions(3);
+
+        await sut.test();
+
+        expect(sut.processor.staleIssues).toHaveLength(1);
+        expect(sut.processor.closedIssues).toHaveLength(0);
+        expect(sut.processor.removedLabelIssues).toHaveLength(0);
+      });
+
+      describe('when the ignore issue updates option is enabled', (): void => {
+        beforeEach((): void => {
+          sut.ignoreIssueUpdates();
+        });
+
+        it('should stale the issue', async () => {
+          expect.assertions(3);
+
+          await sut.test();
+
+          expect(sut.processor.staleIssues).toHaveLength(1);
+          expect(sut.processor.closedIssues).toHaveLength(0);
+          expect(sut.processor.removedLabelIssues).toHaveLength(0);
+        });
+      });
+
+      describe('when the ignore issue updates option is disabled', (): void => {
+        beforeEach((): void => {
+          sut.staleOnIssueUpdates();
+        });
+
+        it('should stale the issue', async () => {
+          expect.assertions(3);
+
+          await sut.test();
+
+          expect(sut.processor.staleIssues).toHaveLength(1);
+          expect(sut.processor.closedIssues).toHaveLength(0);
+          expect(sut.processor.removedLabelIssues).toHaveLength(0);
+        });
+      });
+
+      describe('when the ignore issue updates option is unset', (): void => {
+        beforeEach((): void => {
+          sut.unsetIgnoreIssueUpdates();
+        });
+
+        it('should stale the issue', async () => {
+          expect.assertions(3);
+
+          await sut.test();
+
+          expect(sut.processor.staleIssues).toHaveLength(1);
+          expect(sut.processor.closedIssues).toHaveLength(0);
+          expect(sut.processor.removedLabelIssues).toHaveLength(0);
+        });
+      });
+    });
+  });
+
+  describe('when the pull request should be stale within 10 days and was created 20 days ago and updated 5 days ago', (): void => {
+    beforeEach((): void => {
+      sut.toPullRequest().staleIn(10).created(20).updated(5);
+    });
+
+    describe('when the ignore updates option is disabled', (): void => {
+      beforeEach((): void => {
+        sut.staleOnUpdates();
+      });
+
+      it('should not stale the pull request', async () => {
+        expect.assertions(3);
+
+        await sut.test();
+
+        expect(sut.processor.staleIssues).toHaveLength(0);
+        expect(sut.processor.closedIssues).toHaveLength(0);
+        expect(sut.processor.removedLabelIssues).toHaveLength(0);
+      });
+
+      describe('when the ignore pull request updates option is enabled', (): void => {
+        beforeEach((): void => {
+          sut.ignorePullRequestUpdates();
+        });
+
+        it('should stale the pull request', async () => {
+          expect.assertions(3);
+
+          await sut.test();
+
+          expect(sut.processor.staleIssues).toHaveLength(1);
+          expect(sut.processor.closedIssues).toHaveLength(0);
+          expect(sut.processor.removedLabelIssues).toHaveLength(0);
+        });
+      });
+
+      describe('when the ignore pull request updates option is disabled', (): void => {
+        beforeEach((): void => {
+          sut.staleOnPullRequestUpdates();
+        });
+
+        it('should not stale the pull request', async () => {
+          expect.assertions(3);
+
+          await sut.test();
+
+          expect(sut.processor.staleIssues).toHaveLength(0);
+          expect(sut.processor.closedIssues).toHaveLength(0);
+          expect(sut.processor.removedLabelIssues).toHaveLength(0);
+        });
+      });
+
+      describe('when the ignore pull request updates option is unset', (): void => {
+        beforeEach((): void => {
+          sut.unsetIgnorePullRequestUpdates();
+        });
+
+        it('should not stale the pull request', async () => {
+          expect.assertions(3);
+
+          await sut.test();
+
+          expect(sut.processor.staleIssues).toHaveLength(0);
+          expect(sut.processor.closedIssues).toHaveLength(0);
+          expect(sut.processor.removedLabelIssues).toHaveLength(0);
+        });
+      });
+    });
+
+    describe('when the ignore updates option is enabled', (): void => {
+      beforeEach((): void => {
+        sut.ignoreUpdates();
+      });
+
+      it('should stale the pull request', async () => {
+        expect.assertions(3);
+
+        await sut.test();
+
+        expect(sut.processor.staleIssues).toHaveLength(1);
+        expect(sut.processor.closedIssues).toHaveLength(0);
+        expect(sut.processor.removedLabelIssues).toHaveLength(0);
+      });
+
+      describe('when the ignore pull request updates option is enabled', (): void => {
+        beforeEach((): void => {
+          sut.ignorePullRequestUpdates();
+        });
+
+        it('should stale the pull request', async () => {
+          expect.assertions(3);
+
+          await sut.test();
+
+          expect(sut.processor.staleIssues).toHaveLength(1);
+          expect(sut.processor.closedIssues).toHaveLength(0);
+          expect(sut.processor.removedLabelIssues).toHaveLength(0);
+        });
+      });
+
+      describe('when the ignore pull request updates option is disabled', (): void => {
+        beforeEach((): void => {
+          sut.staleOnPullRequestUpdates();
+        });
+
+        it('should not stale the pull request', async () => {
+          expect.assertions(3);
+
+          await sut.test();
+
+          expect(sut.processor.staleIssues).toHaveLength(0);
+          expect(sut.processor.closedIssues).toHaveLength(0);
+          expect(sut.processor.removedLabelIssues).toHaveLength(0);
+        });
+      });
+
+      describe('when the ignore pull request updates option is unset', (): void => {
+        beforeEach((): void => {
+          sut.unsetIgnorePullRequestUpdates();
+        });
+
+        it('should stale the pull request', async () => {
+          expect.assertions(3);
+
+          await sut.test();
+
+          expect(sut.processor.staleIssues).toHaveLength(1);
+          expect(sut.processor.closedIssues).toHaveLength(0);
+          expect(sut.processor.removedLabelIssues).toHaveLength(0);
+        });
+      });
+    });
+  });
+
+  describe('when the pull request should be stale within 10 days and was created 20 days ago and updated 15 days ago', (): void => {
+    beforeEach((): void => {
+      sut.toPullRequest().staleIn(10).created(20).updated(15);
+    });
+
+    describe('when the ignore updates option is disabled', (): void => {
+      beforeEach((): void => {
+        sut.staleOnUpdates();
+      });
+
+      it('should stale the pull request', async () => {
+        expect.assertions(3);
+
+        await sut.test();
+
+        expect(sut.processor.staleIssues).toHaveLength(1);
+        expect(sut.processor.closedIssues).toHaveLength(0);
+        expect(sut.processor.removedLabelIssues).toHaveLength(0);
+      });
+
+      describe('when the ignore pull request updates option is enabled', (): void => {
+        beforeEach((): void => {
+          sut.ignorePullRequestUpdates();
+        });
+
+        it('should stale the pull request', async () => {
+          expect.assertions(3);
+
+          await sut.test();
+
+          expect(sut.processor.staleIssues).toHaveLength(1);
+          expect(sut.processor.closedIssues).toHaveLength(0);
+          expect(sut.processor.removedLabelIssues).toHaveLength(0);
+        });
+      });
+
+      describe('when the ignore pull request updates option is disabled', (): void => {
+        beforeEach((): void => {
+          sut.staleOnPullRequestUpdates();
+        });
+
+        it('should stale the pull request', async () => {
+          expect.assertions(3);
+
+          await sut.test();
+
+          expect(sut.processor.staleIssues).toHaveLength(1);
+          expect(sut.processor.closedIssues).toHaveLength(0);
+          expect(sut.processor.removedLabelIssues).toHaveLength(0);
+        });
+      });
+
+      describe('when the ignore pull request updates option is unset', (): void => {
+        beforeEach((): void => {
+          sut.unsetIgnorePullRequestUpdates();
+        });
+
+        it('should stale the pull request', async () => {
+          expect.assertions(3);
+
+          await sut.test();
+
+          expect(sut.processor.staleIssues).toHaveLength(1);
+          expect(sut.processor.closedIssues).toHaveLength(0);
+          expect(sut.processor.removedLabelIssues).toHaveLength(0);
+        });
+      });
+    });
+
+    describe('when the ignore updates option is enabled', (): void => {
+      beforeEach((): void => {
+        sut.ignoreUpdates();
+      });
+
+      it('should stale the pull request', async () => {
+        expect.assertions(3);
+
+        await sut.test();
+
+        expect(sut.processor.staleIssues).toHaveLength(1);
+        expect(sut.processor.closedIssues).toHaveLength(0);
+        expect(sut.processor.removedLabelIssues).toHaveLength(0);
+      });
+
+      describe('when the ignore pull request updates option is enabled', (): void => {
+        beforeEach((): void => {
+          sut.ignorePullRequestUpdates();
+        });
+
+        it('should stale the pull request', async () => {
+          expect.assertions(3);
+
+          await sut.test();
+
+          expect(sut.processor.staleIssues).toHaveLength(1);
+          expect(sut.processor.closedIssues).toHaveLength(0);
+          expect(sut.processor.removedLabelIssues).toHaveLength(0);
+        });
+      });
+
+      describe('when the ignore pull request updates option is disabled', (): void => {
+        beforeEach((): void => {
+          sut.staleOnPullRequestUpdates();
+        });
+
+        it('should stale the pull request', async () => {
+          expect.assertions(3);
+
+          await sut.test();
+
+          expect(sut.processor.staleIssues).toHaveLength(1);
+          expect(sut.processor.closedIssues).toHaveLength(0);
+          expect(sut.processor.removedLabelIssues).toHaveLength(0);
+        });
+      });
+
+      describe('when the ignore pull request updates option is unset', (): void => {
+        beforeEach((): void => {
+          sut.unsetIgnorePullRequestUpdates();
+        });
+
+        it('should stale the pull request', async () => {
+          expect.assertions(3);
+
+          await sut.test();
+
+          expect(sut.processor.staleIssues).toHaveLength(1);
+          expect(sut.processor.closedIssues).toHaveLength(0);
+          expect(sut.processor.removedLabelIssues).toHaveLength(0);
+        });
+      });
+    });
+  });
+});
+
+class SUT {
+  processor!: IssuesProcessorMock;
+  private _opts: IIssuesProcessorOptions = {...DefaultProcessorOptions};
+  private _isPullRequest = false;
+  private _createdAt: IsoDateString = '2020-01-01T17:00:00Z';
+  private _updatedAt: IsoDateString = '2020-01-01T17:00:00Z';
+  private _testIssueList: Issue[] = [];
+
+  toIssue(): SUT {
+    this._isPullRequest = false;
+
+    return this;
+  }
+
+  toPullRequest(): SUT {
+    this._isPullRequest = true;
+
+    return this;
+  }
+
+  staleIn(days: number): SUT {
+    this._updateOptions({
+      daysBeforeIssueStale: days,
+      daysBeforePrStale: days
+    });
+
+    return this;
+  }
+
+  created(daysAgo: number): SUT {
+    const today = new Date();
+    today.setDate(today.getDate() - daysAgo);
+    this._createdAt = today.toISOString();
+
+    return this;
+  }
+
+  updated(daysAgo: number): SUT {
+    const today = new Date();
+    today.setDate(today.getDate() - daysAgo);
+    this._updatedAt = today.toISOString();
+
+    return this;
+  }
+
+  ignoreUpdates(): SUT {
+    this._updateOptions({
+      ignoreUpdates: true
+    });
+
+    return this;
+  }
+
+  staleOnUpdates(): SUT {
+    this._updateOptions({
+      ignoreUpdates: false
+    });
+
+    return this;
+  }
+
+  ignoreIssueUpdates(): SUT {
+    this._updateOptions({
+      ignoreIssueUpdates: true
+    });
+
+    return this;
+  }
+
+  staleOnIssueUpdates(): SUT {
+    this._updateOptions({
+      ignoreIssueUpdates: false
+    });
+
+    return this;
+  }
+
+  unsetIgnoreIssueUpdates(): SUT {
+    this._updateOptions({
+      ignoreIssueUpdates: undefined
+    });
+
+    return this;
+  }
+
+  ignorePullRequestUpdates(): SUT {
+    this._updateOptions({
+      ignorePrUpdates: true
+    });
+
+    return this;
+  }
+
+  staleOnPullRequestUpdates(): SUT {
+    this._updateOptions({
+      ignorePrUpdates: false
+    });
+
+    return this;
+  }
+
+  unsetIgnorePullRequestUpdates(): SUT {
+    this._updateOptions({
+      ignorePrUpdates: undefined
+    });
+
+    return this;
+  }
+
+  async test(): Promise<number> {
+    return this._setTestIssueList()._setProcessor();
+  }
+
+  private _updateOptions(opts: Partial<IIssuesProcessorOptions>): SUT {
+    this._opts = {...this._opts, ...opts};
+
+    return this;
+  }
+
+  private _setTestIssueList(): SUT {
+    this._testIssueList = [
+      generateIssue(
+        this._opts,
+        1,
+        'My first issue',
+        this._updatedAt,
+        this._createdAt,
+        this._isPullRequest
+      )
+    ];
+
+    return this;
+  }
+
+  private async _setProcessor(): Promise<number> {
+    this.processor = new IssuesProcessorMock(
+      this._opts,
+      async p => (p === 1 ? this._testIssueList : []),
+      async () => [],
+      async () => new Date().toDateString()
+    );
+
+    return this.processor.processIssues(1);
+  }
+}