diff --git a/__tests__/main.test.ts b/__tests__/main.test.ts index 781fbf88..cdae22a0 100644 --- a/__tests__/main.test.ts +++ b/__tests__/main.test.ts @@ -595,3 +595,33 @@ test('stale issues should be closed if the closed nubmer of days (additive) is a expect(processor.closedIssues.length).toEqual(1); 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.staleIssues.length).toEqual(1); +}); diff --git a/dist/index.js b/dist/index.js index 9b977dd5..452db2f3 100644 --- a/dist/index.js +++ b/dist/index.js @@ -8479,12 +8479,12 @@ class IssueProcessor { const issues = yield 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(`Found issue: issue #${issue.number} - ${issue.title} last updated ${issue.updated_at} (is pr? ${isPr})`); + core.info(`Found issue: issue #${issue.number} - ${issue.title} last updated ${issue.updated_at} (is pr? ${isPr})`); // calculate string based messages for this issue const staleMessage = isPr ? this.options.stalePrMessage @@ -8495,19 +8495,19 @@ class IssueProcessor { const exemptLabels = IssueProcessor.parseCommaSeparatedString(isPr ? this.options.exemptPrLabels : this.options.exemptIssueLabels); const issueType = 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 } if (exemptLabels.some((exemptLabel) => 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? @@ -8515,14 +8515,14 @@ class IssueProcessor { // determine if this issue needs to be marked stale first if (!isStale && !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`); + core.info(`Marking ${issueType} stale because it was last updated on ${issue.updated_at} and it does not have a stale label`); yield 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) if (isStale) { - core.debug(`Found a stale ${issueType}`); + core.info(`Found a stale ${issueType}`); yield this.processStaleIssue(issue, issueType, staleLabel); } } @@ -8541,38 +8541,40 @@ class IssueProcessor { const issueHasComments = yield this.isIssueStillStale(issue, markedStaleOn || issue.updated_at); const issueHasUpdate = IssueProcessor.updatedSince(issue.updated_at, this.options.daysBeforeClose + ((_a = this.options.daysBeforeStale) !== null && _a !== void 0 ? _a : 0)); if (markedStaleOn) { - core.debug(`Issue #${issue.number} marked stale on: ${markedStaleOn}`); + core.info(`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.info(`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}`); + core.info(`Issue #${issue.number} has been updated: ${issueHasUpdate}`); + core.info(`Issue #${issue.number} has been commented on: ${issueHasComments}`); if (!issueHasComments && !issueHasUpdate) { - core.debug(`Closing ${issueType} because it was last updated on ${issue.updated_at}`); + core.info(`Closing ${issueType} because it was last updated on ${issue.updated_at}`); yield this.closeIssue(issue); } else { if (this.options.removeStaleWhenUpdated) { yield this.removeLabel(issue, staleLabel); } - core.debug(`Ignoring stale ${issueType} because it was updated recently`); + core.info(`Ignoring stale ${issueType} because it was updated recently`); } }); } // checks to see if a given issue is still stale (has had activity on it) isIssueStillStale(issue, sinceDate) { return __awaiter(this, void 0, void 0, function* () { - core.debug(`Checking for comments on issue #${issue.number} since ${sinceDate} to see if it is still stale`); + core.info(`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 = yield this.listIssueComments(issue.number, sinceDate); + const filteredComments = comments.filter(comment => comment.user.type === 'User' && + comment.user.login !== github.context.actor); + core.info(`Comments not made by ${github.context.actor} or another bot: ${filteredComments.length}`); // if there are any user comments returned, and they were not by this bot, the issue is not stale anymore - return (comments.filter(comment => comment.user.type === 'User' && - comment.user.login !== github.context.actor).length > 0); + return filteredComments.length > 0; }); } // grab comments for an issue since a given date @@ -8605,7 +8607,7 @@ class IssueProcessor { // Mark an issue as stale with a comment and a label markStale(issue, staleMessage, staleLabel) { return __awaiter(this, void 0, void 0, function* () { - 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 (this.options.debugOnly) { @@ -8628,7 +8630,7 @@ class IssueProcessor { // Close an issue based on staleness closeIssue(issue) { return __awaiter(this, void 0, void 0, function* () { - core.debug(`Closing issue #${issue.number} - ${issue.title} for being stale`); + core.info(`Closing issue #${issue.number} - ${issue.title} for being stale`); this.closedIssues.push(issue); this.operationsLeft -= 1; if (this.options.debugOnly) { @@ -8645,7 +8647,7 @@ class IssueProcessor { // Remove a label from an issue removeLabel(issue, label) { return __awaiter(this, void 0, void 0, function* () { - core.debug(`Removing label ${label} from issue #${issue.number} - ${issue.title}`); + core.info(`Removing label ${label} from issue #${issue.number} - ${issue.title}`); this.removedLabelIssues.push(issue); this.operationsLeft -= 1; if (this.options.debugOnly) { @@ -8663,7 +8665,7 @@ class IssueProcessor { ///see https://developer.github.com/v3/activity/events/ getLabelCreationDate(issue, label) { return __awaiter(this, void 0, void 0, function* () { - core.debug(`Checking for label ${label} on issue #${issue.number}`); + core.info(`Checking for label ${label} on issue #${issue.number}`); this.operationsLeft -= 1; const options = this.client.issues.listEvents.endpoint.merge({ owner: github.context.repo.owner, diff --git a/src/IssueProcessor.ts b/src/IssueProcessor.ts index 38a8eac2..e350e734 100644 --- a/src/IssueProcessor.ts +++ b/src/IssueProcessor.ts @@ -107,14 +107,14 @@ export class IssueProcessor { 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})` ); @@ -131,17 +131,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,7 +150,7 @@ 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 } @@ -165,7 +165,7 @@ export class IssueProcessor { this.options.daysBeforeStale ) ) { - core.debug( + core.info( `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); @@ -175,7 +175,7 @@ export class IssueProcessor { // process any issues marked stale (including the issue above, if it was marked) if (isStale) { - core.debug(`Found a stale ${issueType}`); + core.info(`Found a stale ${issueType}`); await this.processStaleIssue(issue, issueType, staleLabel); } } @@ -208,19 +208,19 @@ export class IssueProcessor { ); if (markedStaleOn) { - core.debug(`Issue #${issue.number} marked stale on: ${markedStaleOn}`); + core.info(`Issue #${issue.number} marked stale on: ${markedStaleOn}`); } else { - core.debug( + core.info( `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( + core.info(`Issue #${issue.number} has been updated: ${issueHasUpdate}`); + core.info( `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); @@ -228,7 +228,7 @@ export class IssueProcessor { if (this.options.removeStaleWhenUpdated) { await this.removeLabel(issue, staleLabel); } - core.debug(`Ignoring stale ${issueType} because it was updated recently`); + core.info(`Ignoring stale ${issueType} because it was updated recently`); } } @@ -237,7 +237,7 @@ export class IssueProcessor { issue: Issue, sinceDate: string ): Promise { - core.debug( + core.info( `Checking for comments on issue #${issue.number} since ${sinceDate} to see if it is still stale` ); @@ -250,14 +250,18 @@ export class IssueProcessor { // 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 - return ( - comments.filter( - comment => - comment.user.type === 'User' && - comment.user.login !== github.context.actor - ).length > 0 + const filteredComments = comments.filter( + comment => + comment.user.type === 'User' && + comment.user.login !== github.context.actor ); + + core.info( + `Comments not made by ${github.context.actor} or another bot: ${filteredComments.length}` + ); + + // if there are any user comments returned, and they were not by this bot, the issue is not stale anymore + return filteredComments.length > 0; } // grab comments for an issue since a given date @@ -296,7 +300,7 @@ export class IssueProcessor { staleMessage: string, staleLabel: string ): Promise { - core.debug(`Marking issue #${issue.number} - ${issue.title} as stale`); + core.info(`Marking issue #${issue.number} - ${issue.title} as stale`); this.staleIssues.push(issue); @@ -323,7 +327,7 @@ export class IssueProcessor { // Close an issue based on staleness private async closeIssue(issue: Issue): Promise { - core.debug( + core.info( `Closing issue #${issue.number} - ${issue.title} for being stale` ); @@ -345,7 +349,7 @@ export class IssueProcessor { // Remove a label from an issue private async removeLabel(issue: Issue, label: string): Promise { - core.debug( + core.info( `Removing label ${label} from issue #${issue.number} - ${issue.title}` ); @@ -371,7 +375,7 @@ export class IssueProcessor { issue: Issue, label: string ): Promise { - core.debug(`Checking for label ${label} on issue #${issue.number}`); + core.info(`Checking for label ${label} on issue #${issue.number}`); this.operationsLeft -= 1;