WIP: feat: add new inputs to clean-up previously added stale comments

CONTRIBUTING.md

@@ -133,6 +133,7 @@ To help us have a clear vision over the workflow and also for you if you are jus
 
 ### Initialization
 
+- Check if all GitHub schemas are valid, and stop the processing (failing status) if not
 - Reach and parse the inputs from the job
 - Authenticate to GitHub API by using the `github-token`
 
@@ -165,15 +166,15 @@ To help us have a clear vision over the workflow and also for you if you are jus
     - Else, check if issue last update is older than X days (coming from `issue-days-before-close`)
       - If it is old, close the issue (using the close reason coming from `issue-close-reason`)
       - Check if the action should also add a comment (coming from the `issue-close-comment` input)
-        - When the input value is not empty, add a comment
+        - When the input value is not empty, add a comment (with a special header)
       - Check if the action should also add extra labels (coming from the `issue-add-labels-after-close` input)
         - When the input value is filled list, add the listed labels
       - Check if the action should also remove extra labels (coming from the `issue-remove-labels-after-close` input)
         - When the input value is filled list, remove the listed labels
 - Check if the issue last update is older than X days (coming from the `issue-days-before-stale`)
 - If the issue last update is older than X days (coming from the `issue-days-before-stale`)
   - Check if the action should also add a comment (coming from the `issue-stale-comment` input)
-    - When the input value is not empty, add a comment
+    - When the input value is not empty, add a comment (with a special header)
   - Check if the action should also add extra labels (coming from the `issue-add-labels-after-stale` input)
     - When the input value is filled list, add the listed labels
   - Check if the action should also remove extra labels (coming from the `issue-remove-labels-after-stale` input)
@@ -211,7 +212,7 @@ To help us have a clear vision over the workflow and also for you if you are jus
     - Else, check if pull request last update is older than X days (coming from `pull-request-days-before-close`)
       - If it is old, close the pull request
       - Check if the action should also add a comment (coming from the `pull-request-close-comment` input)
-        - When the input value is not empty, add a comment
+        - When the input value is not empty, add a comment (with a special header)
       - Check if the action should also add extra labels (coming from the `pull-request-add-labels-after-close` input)
         - When the input value is filled list, add the listed labels
       - Check if the action should also remove extra labels (coming from the `pull-request-remove-labels-after-close` input)
@@ -225,7 +226,7 @@ To help us have a clear vision over the workflow and also for you if you are jus
       - Convert to draft and stop the processing
     - If the draft mode is disabled
       - Check if the action should also add a comment (coming from the `pull-request-stale-comment` input)
-        - When the input value is not empty, add a comment
+        - When the input value is not empty, add a comment (with a special header)
       - Check if the action should also add extra labels (coming from the `pull-request-add-labels-after-stale` input)
         - When the input value is filled list, add the listed labels
       - Check if the action should also remove extra labels (coming from the `pull-request-remove-labels-after-stale` input)

src/core/inputs/core-inputs.service.ts

@@ -81,7 +81,7 @@ export class CoreInputsService {
       return fallback;
     }
 
-    // @todo find a way to get rid of this type hack
+    // TODO find a way to get rid of this type hack
     return inputValue as unknown as TEnum;
   }
 }

src/core/processing/abstract-comments-processor.ts

@@ -2,6 +2,8 @@ import { CommonInputsService } from '@core/inputs/common-inputs.service';
 import { ICommonInputs } from '@core/inputs/interfaces/common-inputs.interface';
 import { IssueProcessor } from '@core/processing/issues/issue-processor';
 import { PullRequestProcessor } from '@core/processing/pull-requests/pull-request-processor';
+import { ECommentType } from '@utils/enums/comment-type.enum';
+import { ICommentHeaderOptions } from '@utils/interfaces/comment-header-options.interface';
 import { LoggerService } from '@utils/loggers/logger.service';
 import { AbstractProcessor } from '@utils/processors/abstract-processor';
 import { IComment } from '@utils/types/comment';
@@ -31,7 +33,9 @@ export abstract class AbstractCommentsProcessor<
     if (!commonInputs.dryRun) {
       this.processor.logger.info(`Adding the stale comment...`);
 
-      await this._addComment(this._getItemId(), staleComment);
+      await this._addComment(this._getItemId(), staleComment, {
+        commentType: ECommentType.STALE,
+      });
     }
 
     this._increaseAddedCommentsCountStatistic();
@@ -55,7 +59,9 @@ export abstract class AbstractCommentsProcessor<
     if (!commonInputs.dryRun) {
       this.processor.logger.info(`Adding the close comment...`);
 
-      await this._addComment(this._getItemId(), closeComment);
+      await this._addComment(this._getItemId(), closeComment, {
+        commentType: ECommentType.CLOSE,
+      });
     }
 
     this._increaseAddedCommentsCountStatistic();
@@ -64,7 +70,11 @@ export abstract class AbstractCommentsProcessor<
 
   protected abstract _getItemId(): IUuid;
 
-  protected abstract _addComment(itemId: Readonly<IUuid>, comment: Readonly<IComment>): Promise<void>;
+  protected abstract _addComment(
+    itemId: Readonly<IUuid>,
+    comment: Readonly<IComment>,
+    commentHeaderOptions: Readonly<ICommentHeaderOptions>
+  ): Promise<void>;
 
   protected abstract _getCloseComment(): IComment | '';
 

src/core/processing/abstract-processing.service.ts

@@ -78,7 +78,7 @@ export abstract class AbstractProcessingService<TItems extends IGithubApiGetIssu
       }
 
       // Expose the item data for debug purpose
-      LoggerService.debug(JSON.stringify(item));
+      this._logItem(item);
 
       // Note: we do not wish to have a blazing fast action
       // The goal is to process a single item at a time
@@ -138,7 +138,7 @@ export abstract class AbstractProcessingService<TItems extends IGithubApiGetIssu
     const hasReachedQueriesLimit: boolean = this.hasReachedQueriesLimit$$();
 
     if (hasReachedQueriesLimit) {
-      // @todo add the reached count
+      // TODO add the reached count
       LoggerService.info(
         `The limit of ${_.toLower(
           this._itemType
@@ -148,13 +148,13 @@ export abstract class AbstractProcessingService<TItems extends IGithubApiGetIssu
       return false;
     }
 
-    // @todo add the reached count versus reached count total
+    // TODO add the reached count versus reached count total
     LoggerService.info(`The limit of API queries calls count is not reached yet, continuing...`);
 
     const hasReachedMutationsLimit: boolean = this.hasReachedMutationsLimit$$();
 
     if (hasReachedMutationsLimit) {
-      // @todo add the reached count
+      // TODO add the reached count
       LoggerService.info(
         `The limit of ${_.toLower(
           this._itemType
@@ -164,7 +164,7 @@ export abstract class AbstractProcessingService<TItems extends IGithubApiGetIssu
       return false;
     }
 
-    // @todo add the reached count versus reached count total
+    // TODO add the reached count versus reached count total
     LoggerService.info(`The limit of API mutations calls count is not reached yet, continuing...`);
 
     LoggerService.info(
@@ -195,7 +195,7 @@ export abstract class AbstractProcessingService<TItems extends IGithubApiGetIssu
   /**
    * @description
    * Allow to check if the items are issues or pull requests
-   * @todo find a better way to check that with pure typings
+   * TODO find a better way to check that with pure typings
    * @param {IGithubApiGetIssues | IGithubApiGetPullRequests} _items The items to check
    * @returns {boolean} Return true when the items are issues
    * @private
@@ -204,6 +204,10 @@ export abstract class AbstractProcessingService<TItems extends IGithubApiGetIssu
     return this._itemType === `issue`;
   }
 
+  private _logItem(item: Readonly<IGithubApiIssue | IGithubApiPullRequest>): void {
+    LoggerService.debug(JSON.stringify(item));
+  }
+
   /**
    * @description
    * Check if the limit of API queries calls count is reached

src/core/processing/issues/issue-comments-processor.spec.ts

@@ -6,6 +6,8 @@ import { IssueCommentsProcessor } from '@core/processing/issues/issue-comments-p
 import { IssueProcessor } from '@core/processing/issues/issue-processor';
 import { IssuesStatisticsService } from '@core/statistics/issues-statistics.service';
 import { GithubApiIssueCommentsService } from '@github/api/comments/github-api-issue-comments.service';
+import { ECommentType } from '@utils/enums/comment-type.enum';
+import { ICommentHeaderOptions } from '@utils/interfaces/comment-header-options.interface';
 import { IUuid } from '@utils/types/uuid';
 import faker from 'faker';
 import { createHydratedMock } from 'ts-auto-mock';
@@ -180,7 +182,7 @@ describe(`IssueCommentsProcessor`, (): void => {
           });
 
           it(`should add the stale comment on the issue`, async (): Promise<void> => {
-            expect.assertions(4);
+            expect.assertions(6);
 
             await issueCommentsProcessor.processStaleComment();
 
@@ -192,6 +194,10 @@ describe(`IssueCommentsProcessor`, (): void => {
             );
             expect(issueProcessorLoggerInfoSpy).toHaveBeenNthCalledWith(3, `Adding the stale comment...`);
             expect(issueProcessorLoggerInfoSpy).toHaveBeenNthCalledWith(4, `Stale comment added`);
+            expect(githubApiIssueCommentsServiceAddCommentSpy).toHaveBeenCalledTimes(1);
+            expect(githubApiIssueCommentsServiceAddCommentSpy).toHaveBeenCalledWith(issueId, `dummy-comment`, {
+              commentType: ECommentType.STALE,
+            } as ICommentHeaderOptions);
           });
 
           it(`should increase the added issues comments count by 1`, async (): Promise<void> => {
@@ -350,7 +356,7 @@ describe(`IssueCommentsProcessor`, (): void => {
           });
 
           it(`should add the close comment on the issue`, async (): Promise<void> => {
-            expect.assertions(4);
+            expect.assertions(6);
 
             await issueCommentsProcessor.processCloseComment();
 
@@ -362,6 +368,10 @@ describe(`IssueCommentsProcessor`, (): void => {
             );
             expect(issueProcessorLoggerInfoSpy).toHaveBeenNthCalledWith(3, `Adding the close comment...`);
             expect(issueProcessorLoggerInfoSpy).toHaveBeenNthCalledWith(4, `Close comment added`);
+            expect(githubApiIssueCommentsServiceAddCommentSpy).toHaveBeenCalledTimes(1);
+            expect(githubApiIssueCommentsServiceAddCommentSpy).toHaveBeenCalledWith(issueId, `dummy-comment`, {
+              commentType: ECommentType.CLOSE,
+            } as ICommentHeaderOptions);
           });
 
           it(`should increase the added issues comments count by 1`, async (): Promise<void> => {

src/core/processing/issues/issue-comments-processor.ts

@@ -4,6 +4,7 @@ import { AbstractCommentsProcessor } from '@core/processing/abstract-comments-pr
 import { IssueProcessor } from '@core/processing/issues/issue-processor';
 import { IssuesStatisticsService } from '@core/statistics/issues-statistics.service';
 import { GithubApiIssueCommentsService } from '@github/api/comments/github-api-issue-comments.service';
+import { ICommentHeaderOptions } from '@utils/interfaces/comment-header-options.interface';
 import { IComment } from '@utils/types/comment';
 import { IUuid } from '@utils/types/uuid';
 
@@ -35,7 +36,11 @@ export class IssueCommentsProcessor extends AbstractCommentsProcessor<IssueProce
     IssuesStatisticsService.getInstance().increaseAddedIssuesCommentsCount();
   }
 
-  protected _addComment(itemId: Readonly<IUuid>, comment: Readonly<IComment>): Promise<void> {
-    return this.githubApiIssueCommentsService$$.addComment(itemId, comment);
+  protected _addComment(
+    itemId: Readonly<IUuid>,
+    comment: Readonly<IComment>,
+    commentHeaderOptions: Readonly<ICommentHeaderOptions>
+  ): Promise<void> {
+    return this.githubApiIssueCommentsService$$.addComment(itemId, comment, commentHeaderOptions);
   }
 }

src/core/processing/issues/issue-ignore-processor.ts

@@ -194,7 +194,7 @@ export class IssueIgnoreProcessor extends AbstractIgnoreProcessor<IssueProcessor
 
     this.processor.logger.debug(`Note: in case of issue, we may need to use a RegExp to ignore sensitivity`);
 
-    // @todo handle the pagination
+    // TODO handle the pagination
     const { totalCount } = this.processor.item.labels;
 
     if (totalCount > GithubApiIssuesService.labelsPerIssue) {
@@ -241,7 +241,7 @@ export class IssueIgnoreProcessor extends AbstractIgnoreProcessor<IssueProcessor
 
     this.processor.logger.debug(`Note: in case of issue, we may need to use a RegExp to ignore sensitivity`);
 
-    // @todo handle the pagination
+    // TODO handle the pagination
     const { totalCount } = this.processor.item.assignees;
 
     if (totalCount > GithubApiIssuesService.assigneesPerIssue) {
@@ -288,7 +288,7 @@ export class IssueIgnoreProcessor extends AbstractIgnoreProcessor<IssueProcessor
 
     this.processor.logger.debug(`Note: in case of issue, we may need to use a RegExp to ignore sensitivity`);
 
-    // @todo handle the pagination
+    //  TODO handle the pagination
     const { totalCount } = this.processor.item.projectCards;
 
     if (totalCount > GithubApiIssuesService.projectCardsPerIssue) {

src/core/processing/issues/issue-include-processor.ts

@@ -81,7 +81,7 @@ export class IssueIncludeProcessor extends AbstractIncludeProcessor<IssueProcess
 
     this.processor.logger.debug(`Note: in case of issue, we may need to use a RegExp to ignore sensitivity`);
 
-    // @todo handle the pagination
+    // TODO handle the pagination
     const { totalCount } = this.processor.item.projectCards;
 
     if (totalCount > GithubApiIssuesService.projectCardsPerIssue) {
@@ -227,7 +227,7 @@ export class IssueIncludeProcessor extends AbstractIncludeProcessor<IssueProcess
 
     this.processor.logger.debug(`Note: in case of issue, we may need to use a RegExp to ignore sensitivity`);
 
-    // @todo handle the pagination
+    // TODO handle the pagination
     const { totalCount } = this.processor.item.assignees;
 
     if (totalCount > GithubApiIssuesService.assigneesPerIssue) {

src/core/processing/pull-requests/pull-request-comments-processor.spec.ts

@@ -6,6 +6,8 @@ import { PullRequestCommentsProcessor } from '@core/processing/pull-requests/pul
 import { PullRequestProcessor } from '@core/processing/pull-requests/pull-request-processor';
 import { PullRequestsStatisticsService } from '@core/statistics/pull-requests-statistics.service';
 import { GithubApiPullRequestCommentsService } from '@github/api/comments/github-api-pull-request-comments.service';
+import { ECommentType } from '@utils/enums/comment-type.enum';
+import { ICommentHeaderOptions } from '@utils/interfaces/comment-header-options.interface';
 import { IUuid } from '@utils/types/uuid';
 import faker from 'faker';
 import { createHydratedMock } from 'ts-auto-mock';
@@ -187,7 +189,7 @@ describe(`PullRequestCommentsProcessor`, (): void => {
           });
 
           it(`should add the stale comment on the pull request`, async (): Promise<void> => {
-            expect.assertions(4);
+            expect.assertions(6);
 
             await pullRequestCommentsProcessor.processStaleComment();
 
@@ -199,6 +201,14 @@ describe(`PullRequestCommentsProcessor`, (): void => {
             );
             expect(pullRequestProcessorLoggerInfoSpy).toHaveBeenNthCalledWith(3, `Adding the stale comment...`);
             expect(pullRequestProcessorLoggerInfoSpy).toHaveBeenNthCalledWith(4, `Stale comment added`);
+            expect(githubApiPullRequestCommentsServiceAddCommentSpy).toHaveBeenCalledTimes(1);
+            expect(githubApiPullRequestCommentsServiceAddCommentSpy).toHaveBeenCalledWith(
+              pullRequestId,
+              `dummy-comment`,
+              {
+                commentType: ECommentType.STALE,
+              } as ICommentHeaderOptions
+            );
           });
 
           it(`should increase the added pull requests comments count by 1`, async (): Promise<void> => {
@@ -364,7 +374,7 @@ describe(`PullRequestCommentsProcessor`, (): void => {
           });
 
           it(`should add the close comment on the pull request`, async (): Promise<void> => {
-            expect.assertions(4);
+            expect.assertions(6);
 
             await pullRequestCommentsProcessor.processCloseComment();
 
@@ -376,6 +386,14 @@ describe(`PullRequestCommentsProcessor`, (): void => {
             );
             expect(pullRequestProcessorLoggerInfoSpy).toHaveBeenNthCalledWith(3, `Adding the close comment...`);
             expect(pullRequestProcessorLoggerInfoSpy).toHaveBeenNthCalledWith(4, `Close comment added`);
+            expect(githubApiPullRequestCommentsServiceAddCommentSpy).toHaveBeenCalledTimes(1);
+            expect(githubApiPullRequestCommentsServiceAddCommentSpy).toHaveBeenCalledWith(
+              pullRequestId,
+              `dummy-comment`,
+              {
+                commentType: ECommentType.CLOSE,
+              } as ICommentHeaderOptions
+            );
           });
 
           it(`should increase the added pull requests comments count by 1`, async (): Promise<void> => {

src/core/processing/pull-requests/pull-request-comments-processor.ts

@@ -4,6 +4,7 @@ import { AbstractCommentsProcessor } from '@core/processing/abstract-comments-pr
 import { PullRequestProcessor } from '@core/processing/pull-requests/pull-request-processor';
 import { PullRequestsStatisticsService } from '@core/statistics/pull-requests-statistics.service';
 import { GithubApiPullRequestCommentsService } from '@github/api/comments/github-api-pull-request-comments.service';
+import { ICommentHeaderOptions } from '@utils/interfaces/comment-header-options.interface';
 import { IComment } from '@utils/types/comment';
 import { IUuid } from '@utils/types/uuid';
 
@@ -35,7 +36,11 @@ export class PullRequestCommentsProcessor extends AbstractCommentsProcessor<Pull
     PullRequestsStatisticsService.getInstance().increaseAddedPullRequestsCommentsCount();
   }
 
-  protected _addComment(itemId: Readonly<IUuid>, comment: Readonly<IComment>): Promise<void> {
-    return this.githubApiPullRequestCommentsService$$.addComment(itemId, comment);
+  protected _addComment(
+    itemId: Readonly<IUuid>,
+    comment: Readonly<IComment>,
+    commentHeaderOptions: Readonly<ICommentHeaderOptions>
+  ): Promise<void> {
+    return this.githubApiPullRequestCommentsService$$.addComment(itemId, comment, commentHeaderOptions);
   }
 }

src/core/processing/pull-requests/pull-request-ignore-processor.ts

@@ -200,7 +200,7 @@ export class PullRequestIgnoreProcessor extends AbstractIgnoreProcessor<PullRequ
 
     this.processor.logger.debug(`Note: in case of issue, we may need to use a RegExp to ignore sensitivity`);
 
-    // @todo handle the pagination
+    // TODO handle the pagination
     const { totalCount } = this.processor.item.labels;
 
     if (totalCount > GithubApiPullRequestsService.labelsPerPullRequest) {
@@ -247,7 +247,7 @@ export class PullRequestIgnoreProcessor extends AbstractIgnoreProcessor<PullRequ
 
     this.processor.logger.debug(`Note: in case of issue, we may need to use a RegExp to ignore sensitivity`);
 
-    // @todo handle the pagination
+    // TODO handle the pagination
     const { totalCount } = this.processor.item.assignees;
 
     if (totalCount > GithubApiPullRequestsService.assigneesPerPullRequest) {
@@ -294,7 +294,7 @@ export class PullRequestIgnoreProcessor extends AbstractIgnoreProcessor<PullRequ
 
     this.processor.logger.debug(`Note: in case of issue, we may need to use a RegExp to ignore sensitivity`);
 
-    // @todo handle the pagination
+    // TODO handle the pagination
     const { totalCount } = this.processor.item.projectCards;
 
     if (totalCount > GithubApiPullRequestsService.projectCardsPerPullRequest) {