actions/stale
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix un-stale logic in processor

Browse Source
This commit is contained in:
Ross Brodbeck 2020-05-26 08:43:40 -04:00
parent 6d710eccec
commit bb7acbc692
3 changed files with 67 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
__tests__/main.test.ts
View File

@ -426,6 +426,7 @@ test('exempt issue labels will not be marked stale (multi issue label)', async (
expect(processor.staleIssues.length).toEqual(0); expect(processor.staleIssues.length).toEqual(0);
expect(processor.closedIssues.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 () => { test('exempt pr labels will not be marked stale', async () => {
@ -474,6 +475,7 @@ test('stale issues should not be closed if days is set to -1', async () => {
await processor.processIssues(1); await processor.processIssues(1);
expect(processor.closedIssues.length).toEqual(0); 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 () => { test('stale label should be removed if a comment was added to a stale issue', async () => {
@ -562,6 +564,7 @@ test('stale issues should not be closed until after the closed number of days',
await processor.processIssues(1); await processor.processIssues(1);
expect(processor.closedIssues.length).toEqual(0); expect(processor.closedIssues.length).toEqual(0);
expect(processor.removedLabelIssues.length).toEqual(0);
expect(processor.staleIssues.length).toEqual(1); expect(processor.staleIssues.length).toEqual(1);
}); });
@ -593,6 +596,7 @@ test('stale issues should be closed if the closed nubmer of days (additive) is a
await processor.processIssues(1); await processor.processIssues(1);
expect(processor.closedIssues.length).toEqual(1); expect(processor.closedIssues.length).toEqual(1);
expect(processor.removedLabelIssues.length).toEqual(0);
expect(processor.staleIssues.length).toEqual(0); expect(processor.staleIssues.length).toEqual(0);
}); });
@ -623,5 +627,6 @@ test('stale issues should not be closed until after the closed number of days (l
await processor.processIssues(1); await processor.processIssues(1);
expect(processor.closedIssues.length).toEqual(0); expect(processor.closedIssues.length).toEqual(0);
expect(processor.removedLabelIssues.length).toEqual(0);
expect(processor.staleIssues.length).toEqual(1); expect(processor.staleIssues.length).toEqual(1);
}); });

46
dist/index.js vendored
View File

@ -8512,15 +8512,17 @@ class IssueProcessor {
} }
// does this issue have a stale label? // does this issue have a stale label?
let isStale = IssueProcessor.isLabeled(issue, staleLabel); let isStale = IssueProcessor.isLabeled(issue, staleLabel);
// should this issue be marked stale?
const shouldBeStale = !IssueProcessor.updatedSince(issue.updated_at, this.options.daysBeforeStale);
// TODO: better stale calculation here not including bot comments
// determine if this issue needs to be marked stale first // determine if this issue needs to be marked stale first
if (!isStale && if (!isStale && shouldBeStale) {
!IssueProcessor.updatedSince(issue.updated_at, this.options.daysBeforeStale)) {
core.info(`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); yield this.markStale(issue, staleMessage, staleLabel);
this.operationsLeft -= 2; this.operationsLeft -= 2;
isStale = true; // this issue is now considered stale 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) { if (isStale) {
core.info(`Found a stale ${issueType}`); core.info(`Found a stale ${issueType}`);
yield this.processStaleIssue(issue, issueType, staleLabel); yield this.processStaleIssue(issue, issueType, staleLabel);
@ -8534,46 +8536,44 @@ class IssueProcessor {
processStaleIssue(issue, issueType, staleLabel) { processStaleIssue(issue, issueType, staleLabel) {
var _a; var _a;
return __awaiter(this, void 0, void 0, function* () { return __awaiter(this, void 0, void 0, function* () {
const markedStaleOn = (yield this.getLabelCreationDate(issue, staleLabel)) || issue.updated_at;
core.info(`Issue #${issue.number} marked stale on: ${markedStaleOn}`);
const issueHasComments = yield this.hasCommentsSince(issue, markedStaleOn);
core.info(`Issue #${issue.number} has been commented on: ${issueHasComments}`);
const issueHasUpdate = IssueProcessor.updatedSince(issue.updated_at, this.options.daysBeforeClose + ((_a = this.options.daysBeforeStale) !== null && _a !== void 0 ? _a : 0));
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.`);
yield this.removeLabel(issue, staleLabel);
}
// now start closing logic
if (this.options.daysBeforeClose < 0) { if (this.options.daysBeforeClose < 0) {
return; // nothing to do because we aren't closing stale issues return; // nothing to do because we aren't closing stale issues
} }
const markedStaleOn = yield this.getLabelCreationDate(issue, staleLabel);
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.info(`Issue #${issue.number} marked stale on: ${markedStaleOn}`);
}
else {
core.info(`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} has been updated: ${issueHasUpdate}`);
core.info(`Issue #${issue.number} has been commented on: ${issueHasComments}`);
if (!issueHasComments && !issueHasUpdate) { if (!issueHasComments && !issueHasUpdate) {
core.info(`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); yield this.closeIssue(issue);
} }
else { else {
if (this.options.removeStaleWhenUpdated) { core.info(`Stale ${issueType} is not old enough to close yet (hasComments? ${issueHasComments}, hasUpdate? ${issueHasUpdate}`);
yield this.removeLabel(issue, staleLabel);
}
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) // checks to see if a given issue is still stale (has had activity on it)
isIssueStillStale(issue, sinceDate) { hasCommentsSince(issue, sinceDate) {
return __awaiter(this, void 0, void 0, function* () { return __awaiter(this, void 0, void 0, function* () {
core.info(`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}`);
if (!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; this.operationsLeft -= 1;
// find any comments since the stale label // find any comments since the date
const comments = yield this.listIssueComments(issue.number, sinceDate); const comments = yield this.listIssueComments(issue.number, sinceDate);
const filteredComments = comments.filter(comment => comment.user.type === 'User' && const filteredComments = comments.filter(comment => comment.user.type === 'User' &&
comment.user.login !== github.context.actor); comment.user.login !== github.context.actor);
core.info(`Comments not made by ${github.context.actor} or another bot: ${filteredComments.length}`); 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 // if there are any user comments returned
return filteredComments.length > 0; return filteredComments.length > 0;
}); });
} }

75
src/IssueProcessor.ts
View File

@ -157,14 +157,16 @@ export class IssueProcessor {
// does this issue have a stale label? // does this issue have a stale label?
let isStale = IssueProcessor.isLabeled(issue, staleLabel); let isStale = IssueProcessor.isLabeled(issue, staleLabel);
// should this issue be marked stale?
const shouldBeStale = !IssueProcessor.updatedSince(
issue.updated_at,
this.options.daysBeforeStale
);
// TODO: better stale calculation here not including bot comments
// determine if this issue needs to be marked stale first // determine if this issue needs to be marked stale first
if ( if (!isStale && shouldBeStale) {
!isStale &&
!IssueProcessor.updatedSince(
issue.updated_at,
this.options.daysBeforeStale
)
) {
core.info( core.info(
`Marking ${issueType} stale because it was last updated on ${issue.updated_at} and it does not have a stale label` `Marking ${issueType} stale because it was last updated on ${issue.updated_at} and it does not have a stale label`
); );
@ -173,7 +175,7 @@ export class IssueProcessor {
isStale = true; // this issue is now considered stale 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) { if (isStale) {
core.info(`Found a stale ${issueType}`); core.info(`Found a stale ${issueType}`);
await this.processStaleIssue(issue, issueType, staleLabel); await this.processStaleIssue(issue, issueType, staleLabel);
@ -190,34 +192,36 @@ export class IssueProcessor {
issueType: string, issueType: string,
staleLabel: string staleLabel: string
) { ) {
if (this.options.daysBeforeClose < 0) { const markedStaleOn: string =
return; // nothing to do because we aren't closing stale issues (await this.getLabelCreationDate(issue, staleLabel)) || issue.updated_at;
} core.info(`Issue #${issue.number} marked stale on: ${markedStaleOn}`);
const markedStaleOn: string | undefined = await this.getLabelCreationDate( const issueHasComments: boolean = await this.hasCommentsSince(
issue, issue,
staleLabel markedStaleOn
); );
const issueHasComments: boolean = await this.isIssueStillStale( core.info(
issue, `Issue #${issue.number} has been commented on: ${issueHasComments}`
markedStaleOn || issue.updated_at
); );
const issueHasUpdate: boolean = IssueProcessor.updatedSince( const issueHasUpdate: boolean = IssueProcessor.updatedSince(
issue.updated_at, issue.updated_at,
this.options.daysBeforeClose + (this.options.daysBeforeStale ?? 0) this.options.daysBeforeClose + (this.options.daysBeforeStale ?? 0)
); );
if (markedStaleOn) {
core.info(`Issue #${issue.number} marked stale on: ${markedStaleOn}`);
} else {
core.info(
`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} has been updated: ${issueHasUpdate}`); core.info(`Issue #${issue.number} has been updated: ${issueHasUpdate}`);
core.info(
`Issue #${issue.number} has been commented on: ${issueHasComments}` // 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
}
if (!issueHasComments && !issueHasUpdate) { if (!issueHasComments && !issueHasUpdate) {
core.info( core.info(
@ -225,29 +229,28 @@ export class IssueProcessor {
); );
await this.closeIssue(issue); await this.closeIssue(issue);
} else { } 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.info(`Ignoring stale ${issueType} because it was updated recently`);
} }
} }
// checks to see if a given issue is still stale (has had activity on it) // checks to see if a given issue is still stale (has had activity on it)
private async isIssueStillStale( private async hasCommentsSince(
issue: Issue, issue: Issue,
sinceDate: string sinceDate: string
): Promise<boolean> { ): Promise<boolean> {
core.info( 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) { if (!sinceDate) {
return true; // if no date was provided then the issue was marked stale a long time ago return true;
} }
this.operationsLeft -= 1; this.operationsLeft -= 1;
// find any comments since the stale label // find any comments since the date
const comments = await this.listIssueComments(issue.number, sinceDate); const comments = await this.listIssueComments(issue.number, sinceDate);
const filteredComments = comments.filter( const filteredComments = comments.filter(
@ -260,7 +263,7 @@ export class IssueProcessor {
`Comments not made by ${github.context.actor} or another bot: ${filteredComments.length}` `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 // if there are any user comments returned
return filteredComments.length > 0; return filteredComments.length > 0;
} }