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
2026-01-10 01:08:18 +00:00 · 2021-09-17 15:54:38 +02:00
parent 002bc97450
commit 1cdda06bb3
24 changed files with 2268 additions and 1015 deletions
--- a/src/classes/ignore-updates.spec.ts
+++ b/src/classes/ignore-updates.spec.ts
@@ -0,0 +1,251 @@
+import {DefaultProcessorOptions} from '../../__tests__/constants/default-processor-options';
+import {generateIIssue} from '../../__tests__/functions/generate-iissue';
+import {IIssue} from '../interfaces/issue';
+import {IIssuesProcessorOptions} from '../interfaces/issues-processor-options';
+import {IgnoreUpdates} from './ignore-updates';
+import {Issue} from './issue';
+
+describe('IgnoreUpdates', (): void => {
+  let ignoreUpdates: IgnoreUpdates;
+  let optionsInterface: IIssuesProcessorOptions;
+  let issue: Issue;
+  let issueInterface: IIssue;
+
+  beforeEach((): void => {
+    optionsInterface = {
+      ...DefaultProcessorOptions,
+      ignoreIssueUpdates: true
+    };
+    issueInterface = generateIIssue();
+  });
+
+  describe('shouldIgnoreUpdates()', (): void => {
+    describe('when the given issue is not a pull request', (): void => {
+      beforeEach((): void => {
+        issueInterface.pull_request = undefined;
+      });
+
+      describe('when the given options are configured to reset the stale on updates', (): void => {
+        beforeEach((): void => {
+          optionsInterface.ignoreUpdates = false;
+        });
+
+        describe('when the given options are not configured to reset the issue stale on updates', (): void => {
+          beforeEach((): void => {
+            delete optionsInterface.ignoreIssueUpdates;
+          });
+
+          it('should return false', (): void => {
+            expect.assertions(1);
+            issue = new Issue(optionsInterface, issueInterface);
+            ignoreUpdates = new IgnoreUpdates(optionsInterface, issue);
+
+            const result = ignoreUpdates.shouldIgnoreUpdates();
+
+            expect(result).toStrictEqual(false);
+          });
+        });
+
+        describe('when the given options are configured to reset the issue stale on updates', (): void => {
+          beforeEach((): void => {
+            optionsInterface.ignoreIssueUpdates = false;
+          });
+
+          it('should return false', (): void => {
+            expect.assertions(1);
+            issue = new Issue(optionsInterface, issueInterface);
+            ignoreUpdates = new IgnoreUpdates(optionsInterface, issue);
+
+            const result = ignoreUpdates.shouldIgnoreUpdates();
+
+            expect(result).toStrictEqual(false);
+          });
+        });
+
+        describe('when the given options are configured to not reset the issue stale on updates', (): void => {
+          beforeEach((): void => {
+            optionsInterface.ignoreIssueUpdates = true;
+          });
+
+          it('should return true', (): void => {
+            expect.assertions(1);
+            issue = new Issue(optionsInterface, issueInterface);
+            ignoreUpdates = new IgnoreUpdates(optionsInterface, issue);
+
+            const result = ignoreUpdates.shouldIgnoreUpdates();
+
+            expect(result).toStrictEqual(true);
+          });
+        });
+      });
+
+      describe('when the given options are configured to reset the stale on updates', (): void => {
+        beforeEach((): void => {
+          optionsInterface.ignoreUpdates = true;
+        });
+
+        describe('when the given options are not configured to reset the issue stale on updates', (): void => {
+          beforeEach((): void => {
+            delete optionsInterface.ignoreIssueUpdates;
+          });
+
+          it('should return true', (): void => {
+            expect.assertions(1);
+            issue = new Issue(optionsInterface, issueInterface);
+            ignoreUpdates = new IgnoreUpdates(optionsInterface, issue);
+
+            const result = ignoreUpdates.shouldIgnoreUpdates();
+
+            expect(result).toStrictEqual(true);
+          });
+        });
+
+        describe('when the given options are configured to reset the issue stale on updates', (): void => {
+          beforeEach((): void => {
+            optionsInterface.ignoreIssueUpdates = false;
+          });
+
+          it('should return false', (): void => {
+            expect.assertions(1);
+            issue = new Issue(optionsInterface, issueInterface);
+            ignoreUpdates = new IgnoreUpdates(optionsInterface, issue);
+
+            const result = ignoreUpdates.shouldIgnoreUpdates();
+
+            expect(result).toStrictEqual(false);
+          });
+        });
+
+        describe('when the given options are configured to not reset the issue stale on updates', (): void => {
+          beforeEach((): void => {
+            optionsInterface.ignoreIssueUpdates = true;
+          });
+
+          it('should return true', (): void => {
+            expect.assertions(1);
+            issue = new Issue(optionsInterface, issueInterface);
+            ignoreUpdates = new IgnoreUpdates(optionsInterface, issue);
+
+            const result = ignoreUpdates.shouldIgnoreUpdates();
+
+            expect(result).toStrictEqual(true);
+          });
+        });
+      });
+    });
+
+    describe('when the given issue is a pull request', (): void => {
+      beforeEach((): void => {
+        issueInterface.pull_request = {};
+      });
+
+      describe('when the given options are configured to reset the stale on updates', (): void => {
+        beforeEach((): void => {
+          optionsInterface.ignoreUpdates = false;
+        });
+
+        describe('when the given options are not configured to reset the pull request stale on updates', (): void => {
+          beforeEach((): void => {
+            delete optionsInterface.ignorePrUpdates;
+          });
+
+          it('should return false', (): void => {
+            expect.assertions(1);
+            issue = new Issue(optionsInterface, issueInterface);
+            ignoreUpdates = new IgnoreUpdates(optionsInterface, issue);
+
+            const result = ignoreUpdates.shouldIgnoreUpdates();
+
+            expect(result).toStrictEqual(false);
+          });
+        });
+
+        describe('when the given options are configured to reset the pull request stale on updates', (): void => {
+          beforeEach((): void => {
+            optionsInterface.ignorePrUpdates = false;
+          });
+
+          it('should return false', (): void => {
+            expect.assertions(1);
+            issue = new Issue(optionsInterface, issueInterface);
+            ignoreUpdates = new IgnoreUpdates(optionsInterface, issue);
+
+            const result = ignoreUpdates.shouldIgnoreUpdates();
+
+            expect(result).toStrictEqual(false);
+          });
+        });
+
+        describe('when the given options are configured to not reset the pull request stale on updates', (): void => {
+          beforeEach((): void => {
+            optionsInterface.ignorePrUpdates = true;
+          });
+
+          it('should return true', (): void => {
+            expect.assertions(1);
+            issue = new Issue(optionsInterface, issueInterface);
+            ignoreUpdates = new IgnoreUpdates(optionsInterface, issue);
+
+            const result = ignoreUpdates.shouldIgnoreUpdates();
+
+            expect(result).toStrictEqual(true);
+          });
+        });
+      });
+
+      describe('when the given options are configured to not reset the stale on updates', (): void => {
+        beforeEach((): void => {
+          optionsInterface.ignoreUpdates = true;
+        });
+
+        describe('when the given options are not configured to reset the pull request stale on updates', (): void => {
+          beforeEach((): void => {
+            delete optionsInterface.ignorePrUpdates;
+          });
+
+          it('should return true', (): void => {
+            expect.assertions(1);
+            issue = new Issue(optionsInterface, issueInterface);
+            ignoreUpdates = new IgnoreUpdates(optionsInterface, issue);
+
+            const result = ignoreUpdates.shouldIgnoreUpdates();
+
+            expect(result).toStrictEqual(true);
+          });
+        });
+
+        describe('when the given options are configured to reset the pull request stale on updates', (): void => {
+          beforeEach((): void => {
+            optionsInterface.ignorePrUpdates = false;
+          });
+
+          it('should return false', (): void => {
+            expect.assertions(1);
+            issue = new Issue(optionsInterface, issueInterface);
+            ignoreUpdates = new IgnoreUpdates(optionsInterface, issue);
+
+            const result = ignoreUpdates.shouldIgnoreUpdates();
+
+            expect(result).toStrictEqual(false);
+          });
+        });
+
+        describe('when the given options are configured to not reset the pull request stale on updates', (): void => {
+          beforeEach((): void => {
+            optionsInterface.ignorePrUpdates = true;
+          });
+
+          it('should return true', (): void => {
+            expect.assertions(1);
+            issue = new Issue(optionsInterface, issueInterface);
+            ignoreUpdates = new IgnoreUpdates(optionsInterface, issue);
+
+            const result = ignoreUpdates.shouldIgnoreUpdates();
+
+            expect(result).toStrictEqual(true);
+          });
+        });
+      });
+    });
+  });
+});