Add support for posting comment on closure (#99)

* allow ordering of issue lookup

__tests__/main.test.ts

@@ -35,6 +35,8 @@ const DefaultProcessorOptions: IssueProcessorOptions = {
   repoToken: 'none',
   staleIssueMessage: 'This issue is stale',
   stalePrMessage: 'This PR is stale',
+  closeIssueMessage: 'This issue is being closed',
+  closePrMessage: 'This PR is being closed',
   daysBeforeStale: 1,
   daysBeforeClose: 30,
   staleIssueLabel: 'Stale',
@@ -44,7 +46,8 @@ const DefaultProcessorOptions: IssueProcessorOptions = {
   onlyLabels: '',
   operationsPerRun: 100,
   debugOnly: true,
-  removeStaleWhenUpdated: false
+  removeStaleWhenUpdated: false,
+  ascending: false
 };
 
 test('empty issue list results in 1 operation', async () => {
@@ -62,11 +65,36 @@ test('empty issue list results in 1 operation', async () => {
   expect(operationsLeft).toEqual(99);
 });
 
-test('processing an issue with no label will make it stale and close it, if it is old enough', async () => {
+test('processing an issue with no label will make it stale and close it, if it is old enough only if days-before-close is set to 0', async () => {
   const TestIssueList: Issue[] = [
     generateIssue(1, 'An issue with no label', '2020-01-01T17:00:00Z')
   ];
 
+  const opts = {...DefaultProcessorOptions};
+  opts.daysBeforeClose = 0;
+
+  const processor = new IssueProcessor(
+    opts,
+    async p => (p == 1 ? TestIssueList : []),
+    async (num, dt) => [],
+    async (issue, label) => new Date().toDateString()
+  );
+
+  // process our fake issue list
+  await processor.processIssues(1);
+
+  expect(processor.staleIssues.length).toEqual(1);
+  expect(processor.closedIssues.length).toEqual(1);
+});
+
+test('processing an issue with no label will make it stale and not close it if days-before-close is set to > 0', async () => {
+  const TestIssueList: Issue[] = [
+    generateIssue(1, 'An issue with no label', '2020-01-01T17:00:00Z')
+  ];
+
+  const opts = {...DefaultProcessorOptions};
+  opts.daysBeforeClose = 15;
+
   const processor = new IssueProcessor(
     DefaultProcessorOptions,
     async p => (p == 1 ? TestIssueList : []),
@@ -78,7 +106,7 @@ test('processing an issue with no label will make it stale and close it, if it i
   await processor.processIssues(1);
 
   expect(processor.staleIssues.length).toEqual(1);
-  expect(processor.closedIssues.length).toEqual(1);
+  expect(processor.closedIssues.length).toEqual(0);
 });
 
 test('processing an issue with no label will make it stale but not close it', async () => {
@@ -426,6 +454,7 @@ test('exempt issue labels will not be marked stale (multi issue label)', async (
 
   expect(processor.staleIssues.length).toEqual(0);
   expect(processor.closedIssues.length).toEqual(0);
+  expect(processor.removedLabelIssues.length).toEqual(0);
 });
 
 test('exempt pr labels will not be marked stale', async () => {
@@ -474,6 +503,7 @@ test('stale issues should not be closed if days is set to -1', async () => {
   await processor.processIssues(1);
 
   expect(processor.closedIssues.length).toEqual(0);
+  expect(processor.removedLabelIssues.length).toEqual(0);
 });
 
 test('stale label should be removed if a comment was added to a stale issue', async () => {
@@ -562,6 +592,7 @@ test('stale issues should not be closed until after the closed number of days',
   await processor.processIssues(1);
 
   expect(processor.closedIssues.length).toEqual(0);
+  expect(processor.removedLabelIssues.length).toEqual(0);
   expect(processor.staleIssues.length).toEqual(1);
 });
 
@@ -593,5 +624,37 @@ test('stale issues should be closed if the closed nubmer of days (additive) is a
   await processor.processIssues(1);
 
   expect(processor.closedIssues.length).toEqual(1);
+  expect(processor.removedLabelIssues.length).toEqual(0);
   expect(processor.staleIssues.length).toEqual(0);
 });
+
+test('stale issues should not be closed until after the closed number of days (long)', async () => {
+  let lastUpdate = new Date();
+  lastUpdate.setDate(lastUpdate.getDate() - 10);
+  const TestIssueList: Issue[] = [
+    generateIssue(
+      1,
+      'An issue that should be marked stale but not closed',
+      lastUpdate.toString(),
+      false
+    )
+  ];
+
+  const opts = DefaultProcessorOptions;
+  opts.daysBeforeStale = 5; // stale after 5 days
+  opts.daysBeforeClose = 20; // closes after 25 days
+
+  const processor = new IssueProcessor(
+    opts,
+    async p => (p == 1 ? TestIssueList : []),
+    async (num, dt) => [],
+    async (issue, label) => new Date().toDateString()
+  );
+
+  // process our fake issue list
+  await processor.processIssues(1);
+
+  expect(processor.closedIssues.length).toEqual(0);
+  expect(processor.removedLabelIssues.length).toEqual(0);
+  expect(processor.staleIssues.length).toEqual(1);
+});

action.yml

@@ -9,6 +9,10 @@ inputs:
     description: 'The message to post on the issue when tagging it. If none provided, will not mark issues stale.'
   stale-pr-message:
     description: 'The message to post on the pr when tagging it. If none provided, will not mark pull requests stale.'
+  close-issue-message:
+    description: 'The message to post on the issue when closing it. If none provided, will not comment when closing an issue.'
+  close-pr-message:
+    description: 'The message to post on the pr when closing it. If none provided, will not comment when closing a pull requests.'
   days-before-stale:
     description: 'The number of days old an issue can be before marking it stale.'
     default: 60
@@ -39,6 +43,9 @@ inputs:
   debug-only:
     description: 'Run the processor in debug mode without actually performing any operations on live issues.'
     default: false
+  ascending:
+    description: 'The order to get issues or pull requests. Defaults to false, which is descending'
+    default: false
 runs:
   using: 'node12'
   main: 'dist/index.js'

src/IssueProcessor.ts

@@ -37,6 +37,8 @@ export interface IssueProcessorOptions {
   repoToken: string;
   staleIssueMessage: string;
   stalePrMessage: string;
+  closeIssueMessage: string;
+  closePrMessage: string;
   daysBeforeStale: number;
   daysBeforeClose: number;
   staleIssueLabel: string;
@@ -47,6 +49,7 @@ export interface IssueProcessorOptions {
   operationsPerRun: number;
   removeStaleWhenUpdated: boolean;
   debugOnly: boolean;
+  ascending: boolean;
 }
 
 /***
@@ -97,24 +100,19 @@ export class IssueProcessor {
   }
 
   async processIssues(page: number = 1): Promise<number> {
-    if (this.operationsLeft <= 0) {
-      core.warning('Reached max number of operations to process. Exiting.');
-      return 0;
-    }
-
     // get the next batch of issues
     const issues: Issue[] = await this.getIssues(page);
     this.operationsLeft -= 1;
 
     if (issues.length <= 0) {
-      core.debug('No more issues found to process. Exiting.');
+      core.info('No more issues found to process. Exiting.');
       return this.operationsLeft;
     }
 
     for (const issue of issues.values()) {
       const isPr = !!issue.pull_request;
 
-      core.debug(
+      core.info(
         `Found issue: issue #${issue.number} - ${issue.title} last updated ${issue.updated_at} (is pr? ${isPr})`
       );
 
@@ -122,6 +120,9 @@ export class IssueProcessor {
       const staleMessage: string = isPr
         ? this.options.stalePrMessage
         : this.options.staleIssueMessage;
+      const closeMessage: string = isPr
+        ? this.options.closePrMessage
+        : this.options.closeIssueMessage;
       const staleLabel: string = isPr
         ? this.options.stalePrLabel
         : this.options.staleIssueLabel;
@@ -131,17 +132,17 @@ export class IssueProcessor {
       const issueType: string = isPr ? 'pr' : 'issue';
 
       if (!staleMessage) {
-        core.debug(`Skipping ${issueType} due to empty stale message`);
+        core.info(`Skipping ${issueType} due to empty stale message`);
         continue;
       }
 
       if (issue.state === 'closed') {
-        core.debug(`Skipping ${issueType} because it is closed`);
+        core.info(`Skipping ${issueType} because it is closed`);
         continue; // don't process closed issues
       }
 
       if (issue.locked) {
-        core.debug(`Skipping ${issueType} because it is locked`);
+        core.info(`Skipping ${issueType} because it is locked`);
         continue; // don't process locked issues
       }
 
@@ -150,36 +151,45 @@ export class IssueProcessor {
           IssueProcessor.isLabeled(issue, exemptLabel)
         )
       ) {
-        core.debug(`Skipping ${issueType} because it has an exempt label`);
+        core.info(`Skipping ${issueType} because it has an exempt label`);
         continue; // don't process exempt issues
       }
 
       // does this issue have a stale label?
       let isStale = IssueProcessor.isLabeled(issue, staleLabel);
 
+      // should this issue be marked stale?
+      const shouldBeStale = !IssueProcessor.updatedSince(
+        issue.updated_at,
+        this.options.daysBeforeStale
+      );
+
       // determine if this issue needs to be marked stale first
-      if (
+      if (!isStale && shouldBeStale) {
-        !isStale &&
+        core.info(
-        !IssueProcessor.updatedSince(
-          issue.updated_at,
-          this.options.daysBeforeStale
-        )
-      ) {
-        core.debug(
           `Marking ${issueType} stale because it was last updated on ${issue.updated_at} and it does not have a stale label`
         );
         await this.markStale(issue, staleMessage, staleLabel);
-        this.operationsLeft -= 2;
         isStale = true; // this issue is now considered stale
       }
 
-      // process any issues marked stale (including the issue above, if it was marked)
+      // process the issue if it was marked stale
       if (isStale) {
-        core.debug(`Found a stale ${issueType}`);
+        core.info(`Found a stale ${issueType}`);
-        await this.processStaleIssue(issue, issueType, staleLabel);
+        await this.processStaleIssue(
+          issue,
+          issueType,
+          staleLabel,
+          closeMessage
+        );
       }
     }
 
+    if (this.operationsLeft <= 0) {
+      core.warning('Reached max number of operations to process. Exiting.');
+      return 0;
+    }
+
     // do the next batch
     return this.processIssues(page + 1);
   }
@@ -188,76 +198,80 @@ export class IssueProcessor {
   private async processStaleIssue(
     issue: Issue,
     issueType: string,
-    staleLabel: string
+    staleLabel: string,
+    closeMessage?: string
   ) {
+    const markedStaleOn: string =
+      (await this.getLabelCreationDate(issue, staleLabel)) || issue.updated_at;
+    core.info(`Issue #${issue.number} marked stale on: ${markedStaleOn}`);
+
+    const issueHasComments: boolean = await this.hasCommentsSince(
+      issue,
+      markedStaleOn
+    );
+    core.info(
+      `Issue #${issue.number} has been commented on: ${issueHasComments}`
+    );
+
+    const issueHasUpdate: boolean = IssueProcessor.updatedSince(
+      issue.updated_at,
+      this.options.daysBeforeClose
+    );
+    core.info(`Issue #${issue.number} has been updated: ${issueHasUpdate}`);
+
+    // should we un-stale this issue?
+    if (this.options.removeStaleWhenUpdated && issueHasComments) {
+      core.info(
+        `Issue #${issue.number} is no longer stale. Removing stale label.`
+      );
+      await this.removeLabel(issue, staleLabel);
+    }
+
+    // now start closing logic
     if (this.options.daysBeforeClose < 0) {
       return; // nothing to do because we aren't closing stale issues
     }
 
-    const markedStaleOn: string | undefined = await this.getLabelCreationDate(
-      issue,
-      staleLabel
-    );
-    const issueHasComments: boolean = await this.isIssueStillStale(
-      issue,
-      markedStaleOn || issue.updated_at
-    );
-    const issueHasUpdate: boolean = IssueProcessor.updatedSince(
-      issue.updated_at,
-      this.options.daysBeforeClose + (this.options.daysBeforeStale ?? 0)
-    );
-
-    if (markedStaleOn) {
-      core.debug(`Issue #${issue.number} marked stale on: ${markedStaleOn}`);
-    } else {
-      core.debug(
-        `Issue #${issue.number} is not marked stale, but last update of ${issue.updated_at} is older than ${this.options.daysBeforeStale} days`
-      );
-    }
-    core.debug(`Issue #${issue.number} has been updated: ${issueHasUpdate}`);
-    core.debug(
-      `Issue #${issue.number} has been commented on: ${issueHasComments}`
-    );
-
     if (!issueHasComments && !issueHasUpdate) {
-      core.debug(
+      core.info(
         `Closing ${issueType} because it was last updated on ${issue.updated_at}`
       );
-      await this.closeIssue(issue);
+      await this.closeIssue(issue, closeMessage);
     } else {
-      if (this.options.removeStaleWhenUpdated) {
+      core.info(
-        await this.removeLabel(issue, staleLabel);
+        `Stale ${issueType} is not old enough to close yet (hasComments? ${issueHasComments}, hasUpdate? ${issueHasUpdate}`
-      }
+      );
-      core.debug(`Ignoring stale ${issueType} because it was updated recently`);
     }
   }
 
   // checks to see if a given issue is still stale (has had activity on it)
-  private async isIssueStillStale(
+  private async hasCommentsSince(
     issue: Issue,
     sinceDate: string
   ): Promise<boolean> {
-    core.debug(
+    core.info(
-      `Checking for comments on issue #${issue.number} since ${sinceDate} to see if it is still stale`
+      `Checking for comments on issue #${issue.number} since ${sinceDate}`
     );
 
     if (!sinceDate) {
-      return true; // if no date was provided then the issue was marked stale a long time ago
+      return true;
     }
 
-    this.operationsLeft -= 1;
+    // find any comments since the date
-
-    // find any comments since the stale label
     const comments = await this.listIssueComments(issue.number, sinceDate);
 
-    // if there are any user comments returned, and they were not by this bot, the issue is not stale anymore
+    const filteredComments = comments.filter(
-    return (
+      comment =>
-      comments.filter(
+        comment.user.type === 'User' &&
-        comment =>
+        comment.user.login !== github.context.actor
-          comment.user.type === 'User' &&
-          comment.user.login !== github.context.actor
-      ).length > 0
     );
+
+    core.info(
+      `Comments not made by ${github.context.actor} or another bot: ${filteredComments.length}`
+    );
+
+    // if there are any user comments returned
+    return filteredComments.length > 0;
   }
 
   // grab comments for an issue since a given date
@@ -266,28 +280,39 @@ export class IssueProcessor {
     sinceDate: string
   ): Promise<Comment[]> {
     // find any comments since date on the given issue
-    const comments = await this.client.issues.listComments({
+    try {
-      owner: github.context.repo.owner,
+      const comments = await this.client.issues.listComments({
-      repo: github.context.repo.repo,
+        owner: github.context.repo.owner,
-      issue_number: issueNumber,
+        repo: github.context.repo.repo,
-      since: sinceDate
+        issue_number: issueNumber,
-    });
+        since: sinceDate
-
+      });
-    return comments.data;
+      return comments.data;
+    } catch (error) {
+      core.error(`List issue comments error: ${error.message}`);
+      return Promise.resolve([]);
+    }
   }
 
   // grab issues from github in baches of 100
   private async getIssues(page: number): Promise<Issue[]> {
-    const issueResult: OctoKitIssueList = await this.client.issues.listForRepo({
+    try {
-      owner: github.context.repo.owner,
+      const issueResult: OctoKitIssueList = await this.client.issues.listForRepo(
-      repo: github.context.repo.repo,
+        {
-      state: 'open',
+          owner: github.context.repo.owner,
-      labels: this.options.onlyLabels,
+          repo: github.context.repo.repo,
-      per_page: 100,
+          state: 'open',
-      page
+          labels: this.options.onlyLabels,
-    });
+          per_page: 100,
-
+          direction: this.options.ascending ? 'asc' : 'desc',
-    return issueResult.data;
+          page
+        }
+      );
+      return issueResult.data;
+    } catch (error) {
+      core.error(`Get issues for repo error: ${error.message}`);
+      return Promise.resolve([]);
+    }
   }
 
   // Mark an issue as stale with a comment and a label
@@ -296,34 +321,47 @@ export class IssueProcessor {
     staleMessage: string,
     staleLabel: string
   ): Promise<void> {
-    core.debug(`Marking issue #${issue.number} - ${issue.title} as stale`);
+    core.info(`Marking issue #${issue.number} - ${issue.title} as stale`);
 
     this.staleIssues.push(issue);
 
     this.operationsLeft -= 2;
 
+    // if the issue is being marked stale, the updated date should be changed to right now
+    // so that close calculations work correctly
+    const newUpdatedAtDate: Date = new Date();
+    issue.updated_at = newUpdatedAtDate.toString();
+
     if (this.options.debugOnly) {
       return;
     }
 
-    await this.client.issues.createComment({
+    try {
-      owner: github.context.repo.owner,
+      await this.client.issues.createComment({
-      repo: github.context.repo.repo,
+        owner: github.context.repo.owner,
-      issue_number: issue.number,
+        repo: github.context.repo.repo,
-      body: staleMessage
+        issue_number: issue.number,
-    });
+        body: staleMessage
+      });
+    } catch (error) {
+      core.error(`Error creating a comment: ${error.message}`);
+    }
 
-    await this.client.issues.addLabels({
+    try {
-      owner: github.context.repo.owner,
+      await this.client.issues.addLabels({
-      repo: github.context.repo.repo,
+        owner: github.context.repo.owner,
-      issue_number: issue.number,
+        repo: github.context.repo.repo,
-      labels: [staleLabel]
+        issue_number: issue.number,
-    });
+        labels: [staleLabel]
+      });
+    } catch (error) {
+      core.error(`Error adding a label: ${error.message}`);
+    }
   }
 
   // Close an issue based on staleness
-  private async closeIssue(issue: Issue): Promise<void> {
+  private async closeIssue(issue: Issue, closeMessage?: string): Promise<void> {
-    core.debug(
+    core.info(
       `Closing issue #${issue.number} - ${issue.title} for being stale`
     );
 
@@ -335,17 +373,34 @@ export class IssueProcessor {
       return;
     }
 
-    await this.client.issues.update({
+    if (closeMessage) {
-      owner: github.context.repo.owner,
+      try {
-      repo: github.context.repo.repo,
+        await this.client.issues.createComment({
-      issue_number: issue.number,
+          owner: github.context.repo.owner,
-      state: 'closed'
+          repo: github.context.repo.repo,
-    });
+          issue_number: issue.number,
+          body: closeMessage
+        });
+      } catch (error) {
+        core.error(`Error creating a comment: ${error.message}`);
+      }
+    }
+
+    try {
+      await this.client.issues.update({
+        owner: github.context.repo.owner,
+        repo: github.context.repo.repo,
+        issue_number: issue.number,
+        state: 'closed'
+      });
+    } catch (error) {
+      core.error(`Error updating an issue: ${error.message}`);
+    }
   }
 
   // Remove a label from an issue
   private async removeLabel(issue: Issue, label: string): Promise<void> {
-    core.debug(
+    core.info(
       `Removing label ${label} from issue #${issue.number} - ${issue.title}`
     );
 
@@ -357,12 +412,16 @@ export class IssueProcessor {
       return;
     }
 
-    await this.client.issues.removeLabel({
+    try {
-      owner: github.context.repo.owner,
+      await this.client.issues.removeLabel({
-      repo: github.context.repo.repo,
+        owner: github.context.repo.owner,
-      issue_number: issue.number,
+        repo: github.context.repo.repo,
-      name: encodeURIComponent(label) // A label can have a "?" in the name
+        issue_number: issue.number,
-    });
+        name: encodeURIComponent(label) // A label can have a "?" in the name
+      });
+    } catch (error) {
+      core.error(`Error removing a label: ${error.message}`);
+    }
   }
 
   // returns the creation date of a given label on an issue (or nothing if no label existed)
@@ -371,7 +430,7 @@ export class IssueProcessor {
     issue: Issue,
     label: string
   ): Promise<string | undefined> {
-    core.debug(`Checking for label ${label} on issue #${issue.number}`);
+    core.info(`Checking for label ${label} on issue #${issue.number}`);
 
     this.operationsLeft -= 1;
 
@@ -408,7 +467,7 @@ export class IssueProcessor {
     const millisSinceLastUpdated =
       new Date().getTime() - new Date(timestamp).getTime();
 
-    return millisSinceLastUpdated < daysInMillis;
+    return millisSinceLastUpdated <= daysInMillis;
   }
 
   private static parseCommaSeparatedString(s: string): string[] {

src/main.ts

@@ -18,6 +18,8 @@ function getAndValidateArgs(): IssueProcessorOptions {
     repoToken: core.getInput('repo-token', {required: true}),
     staleIssueMessage: core.getInput('stale-issue-message'),
     stalePrMessage: core.getInput('stale-pr-message'),
+    closeIssueMessage: core.getInput('close-issue-message'),
+    closePrMessage: core.getInput('close-pr-message'),
     daysBeforeStale: parseInt(
       core.getInput('days-before-stale', {required: true})
     ),
@@ -35,7 +37,8 @@ function getAndValidateArgs(): IssueProcessorOptions {
     removeStaleWhenUpdated: !(
       core.getInput('remove-stale-when-updated') === 'false'
     ),
-    debugOnly: core.getInput('debug-only') === 'true'
+    debugOnly: core.getInput('debug-only') === 'true',
+    ascending: core.getInput('ascending') === 'true'
   };
 
   for (const numberInput of [