Remove stale labels and ignore stale issues with comments (#58)

* Ignore issues that have recent comments and ignore the stale label. Defaulting to this behavior but added an option to turn it off.
* Fix up tests a bit to make this runnable. Add a test for the logic.
* Add vscode debugging configuration.

src/IssueProcessor.ts

@@ -14,6 +14,20 @@ export interface Issue {
   locked: boolean;
 }
 
+export interface User {
+  type: string;
+}
+
+export interface Comment {
+  user: User;
+}
+
+export interface IssueEvent {
+  created_at: string;
+  event: string;
+  label: Label;
+}
+
 export interface Label {
   name: string;
 }
@@ -30,6 +44,7 @@ export interface IssueProcessorOptions {
   exemptPrLabels: string;
   onlyLabels: string;
   operationsPerRun: number;
+  removeStaleWhenUpdated: boolean;
   debugOnly: boolean;
 }
 
@@ -43,10 +58,16 @@ export class IssueProcessor {
 
   readonly staleIssues: Issue[] = [];
   readonly closedIssues: Issue[] = [];
+  readonly removedLabelIssues: Issue[] = [];
 
   constructor(
     options: IssueProcessorOptions,
-    getIssues?: (page: number) => Promise<Issue[]>
+    getIssues?: (page: number) => Promise<Issue[]>,
+    listIssueComments?: (
+      issueNumber: number,
+      sinceDate: string
+    ) => Promise<Comment[]>,
+    getLabelCreationDate?: (issue: Issue, label: string) => Promise<string>
   ) {
     this.options = options;
     this.operationsLeft = options.operationsPerRun;
@@ -56,6 +77,14 @@ export class IssueProcessor {
       this.getIssues = getIssues;
     }
 
+    if (listIssueComments) {
+      this.listIssueComments = listIssueComments;
+    }
+
+    if (getLabelCreationDate) {
+      this.getLabelCreationDate = getLabelCreationDate;
+    }
+
     if (this.options.debugOnly) {
       core.warning(
         'Executing in debug mode. Debug output will be written but no issues will be processed.'
@@ -123,25 +152,12 @@ export class IssueProcessor {
 
       if (IssueProcessor.isLabeled(issue, staleLabel)) {
         core.debug(`Found a stale ${issueType}`);
-        if (
-          this.options.daysBeforeClose >= 0 &&
-          IssueProcessor.wasLastUpdatedBefore(
-            issue,
-            this.options.daysBeforeClose
-          )
-        ) {
-          core.debug(
-            `Closing ${issueType} because it was last updated on ${issue.updated_at}`
-          );
-          await this.closeIssue(issue);
-          this.operationsLeft -= 1;
-        } else {
-          core.debug(
-            `Ignoring stale ${issueType} because it was updated recenlty`
-          );
-        }
+        await this.processStaleIssue(issue, issueType, staleLabel);
       } else if (
-        IssueProcessor.wasLastUpdatedBefore(issue, this.options.daysBeforeStale)
+        !IssueProcessor.updatedSince(
+          issue.updated_at,
+          this.options.daysBeforeStale
+        )
       ) {
         core.debug(
           `Marking ${issueType} stale because it was last updated on ${issue.updated_at}`
@@ -155,6 +171,87 @@ export class IssueProcessor {
     return this.processIssues(page + 1);
   }
 
+  // handle all of the stale issue logic when we find a stale issue
+  private async processStaleIssue(
+    issue: Issue,
+    issueType: string,
+    staleLabel: string
+  ) {
+    if (this.options.daysBeforeClose < 0) {
+      return; // nothing to do because we aren't closing stale issues
+    }
+
+    const markedStaleOn: string = await this.getLabelCreationDate(
+      issue,
+      staleLabel
+    );
+    const issueHasComments: boolean = await this.isIssueStillStale(
+      issue,
+      markedStaleOn
+    );
+
+    const issueHasUpdate: boolean = IssueProcessor.updatedSince(
+      issue.updated_at,
+      this.options.daysBeforeClose
+    );
+
+    core.debug(`Issue #${issue.number} marked stale on: ${markedStaleOn}`);
+    core.debug(`Issue #${issue.number} has been updated: ${issueHasUpdate}`);
+    core.debug(
+      `Issue #${issue.number} has been commented on: ${issueHasComments}`
+    );
+
+    if (!issueHasComments && !issueHasUpdate) {
+      core.debug(
+        `Closing ${issueType} because it was last updated on ${issue.updated_at}`
+      );
+      await this.closeIssue(issue);
+    } else {
+      if (this.options.removeStaleWhenUpdated) {
+        await this.removeLabel(issue, staleLabel);
+      }
+      core.debug(`Ignoring stale ${issueType} because it was updated recenlty`);
+    }
+  }
+
+  // checks to see if a given issue is still stale (has had activity on it)
+  private async isIssueStillStale(
+    issue: Issue,
+    sinceDate: string
+  ): Promise<boolean> {
+    core.debug(
+      `Checking for comments on issue #${issue.number} since ${sinceDate} to see if it is still stale`
+    );
+
+    if (!sinceDate) {
+      return true; // if no date was provided then the issue was marked stale a long time ago
+    }
+
+    this.operationsLeft -= 1;
+
+    // find any comments since the stale label
+    const comments = await this.listIssueComments(issue.number, sinceDate);
+
+    // if there are any user comments returned, issue is not stale anymore
+    return comments.filter(comment => comment.user.type === 'User').length > 0;
+  }
+
+  // grab comments for an issue since a given date
+  private async listIssueComments(
+    issueNumber: number,
+    sinceDate: string
+  ): Promise<Comment[]> {
+    // find any comments since date on the given issue
+    const comments = await this.client.issues.listComments({
+      owner: github.context.repo.owner,
+      repo: github.context.repo.repo,
+      issue_number: issueNumber,
+      since: sinceDate
+    });
+
+    return comments.data;
+  }
+
   // grab issues from github in baches of 100
   private async getIssues(page: number): Promise<Issue[]> {
     const issueResult: OctoKitIssueList = await this.client.issues.listForRepo(
@@ -181,6 +278,8 @@ export class IssueProcessor {
 
     this.staleIssues.push(issue);
 
+    this.operationsLeft -= 2;
+
     if (this.options.debugOnly) {
       return;
     }
@@ -200,7 +299,7 @@ export class IssueProcessor {
     });
   }
 
-  /// Close an issue based on staleness
+  // Close an issue based on staleness
   private async closeIssue(issue: Issue): Promise<void> {
     core.debug(
       `Closing issue #${issue.number} - ${issue.title} for being stale`
@@ -208,6 +307,8 @@ export class IssueProcessor {
 
     this.closedIssues.push(issue);
 
+    this.operationsLeft -= 1;
+
     if (this.options.debugOnly) {
       return;
     }
@@ -220,17 +321,67 @@ export class IssueProcessor {
     });
   }
 
+  // Remove a label from an issue
+  private async removeLabel(issue: Issue, label: string): Promise<void> {
+    core.debug(
+      `Removing label ${label} from issue #${issue.number} - ${issue.title}`
+    );
+
+    this.removedLabelIssues.push(issue);
+
+    this.operationsLeft -= 1;
+
+    if (this.options.debugOnly) {
+      return;
+    }
+
+    await this.client.issues.removeLabel({
+      owner: github.context.repo.owner,
+      repo: github.context.repo.repo,
+      issue_number: issue.number,
+      name: encodeURIComponent(label) // A label can have a "?" in the name
+    });
+  }
+
+  // returns the creation date of a given label on an issue (or nothing if no label existed)
+  ///see https://developer.github.com/v3/activity/events/
+  private async getLabelCreationDate(
+    issue: Issue,
+    label: string
+  ): Promise<string> {
+    core.debug(`Checking for label ${label} on issue #${issue.number}`);
+
+    this.operationsLeft -= 1;
+
+    const options = this.client.issues.listEvents.endpoint.merge({
+      owner: github.context.repo.owner,
+      repo: github.context.repo.repo,
+      per_page: 100,
+      issue_number: issue.number
+    });
+
+    const events: IssueEvent[] = await this.client.paginate(options);
+    const reversedEvents = events.reverse();
+
+    const staleLabeledEvent = reversedEvents.find(
+      event => event.event === 'labeled' && event.label.name === label
+    );
+
+    return staleLabeledEvent!.created_at;
+  }
+
   private static isLabeled(issue: Issue, label: string): boolean {
     const labelComparer: (l: Label) => boolean = l =>
       label.localeCompare(l.name, undefined, {sensitivity: 'accent'}) === 0;
     return issue.labels.filter(labelComparer).length > 0;
   }
 
-  private static wasLastUpdatedBefore(issue: Issue, num_days: number): boolean {
+  private static updatedSince(timestamp: string, num_days: number): boolean {
     const daysInMillis = 1000 * 60 * 60 * 24 * num_days;
     const millisSinceLastUpdated =
-      new Date().getTime() - new Date(issue.updated_at).getTime();
-    return millisSinceLastUpdated >= daysInMillis;
+      new Date().getTime() - new Date(timestamp).getTime();
+
+    return millisSinceLastUpdated < daysInMillis;
   }
 
   private static parseCommaSeparatedString(s: string): string[] {

src/main.ts

@@ -32,6 +32,9 @@ function getAndValidateArgs(): IssueProcessorOptions {
     operationsPerRun: parseInt(
       core.getInput('operations-per-run', {required: true})
     ),
+    removeStaleWhenUpdated: !(
+      core.getInput('remove-stale-when-updated') === 'false'
+    ),
     debugOnly: core.getInput('debug-only') === 'true'
   };