Compare commits

..

4 Commits

Author SHA1 Message Date
Ross Brodbeck
6e01d91097 Fix operation counting 2020-05-26 09:13:49 -04:00
Ross Brodbeck
55ac880ddb Add ( 2020-05-26 09:06:01 -04:00
Ross Brodbeck
bb7acbc692 Fix un-stale logic in processor 2020-05-26 08:43:40 -04:00
Ross Brodbeck
6d710eccec Update dits 2020-05-26 05:27:59 -04:00
5 changed files with 1091 additions and 1426 deletions

View File

@@ -31,12 +31,10 @@ function generateIssue(
}; };
} }
const DefaultProcessorOptions: IssueProcessorOptions = Object.freeze({ const DefaultProcessorOptions: IssueProcessorOptions = {
repoToken: 'none', repoToken: 'none',
staleIssueMessage: 'This issue is stale', staleIssueMessage: 'This issue is stale',
stalePrMessage: 'This PR is stale', stalePrMessage: 'This PR is stale',
closeIssueMessage: 'This issue is being closed',
closePrMessage: 'This PR is being closed',
daysBeforeStale: 1, daysBeforeStale: 1,
daysBeforeClose: 30, daysBeforeClose: 30,
staleIssueLabel: 'Stale', staleIssueLabel: 'Stale',
@@ -46,9 +44,8 @@ const DefaultProcessorOptions: IssueProcessorOptions = Object.freeze({
onlyLabels: '', onlyLabels: '',
operationsPerRun: 100, operationsPerRun: 100,
debugOnly: true, debugOnly: true,
removeStaleWhenUpdated: false, removeStaleWhenUpdated: false
ascending: false };
});
test('empty issue list results in 1 operation', async () => { test('empty issue list results in 1 operation', async () => {
const processor = new IssueProcessor( const processor = new IssueProcessor(
@@ -65,36 +62,11 @@ test('empty issue list results in 1 operation', async () => {
expect(operationsLeft).toEqual(99); expect(operationsLeft).toEqual(99);
}); });
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 () => { test('processing an issue with no label will make it stale and close it, if it is old enough', async () => {
const TestIssueList: Issue[] = [ const TestIssueList: Issue[] = [
generateIssue(1, 'An issue with no label', '2020-01-01T17:00:00Z') 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( const processor = new IssueProcessor(
DefaultProcessorOptions, DefaultProcessorOptions,
async p => (p == 1 ? TestIssueList : []), async p => (p == 1 ? TestIssueList : []),
@@ -106,32 +78,7 @@ test('processing an issue with no label will make it stale and not close it if d
await processor.processIssues(1); await processor.processIssues(1);
expect(processor.staleIssues.length).toEqual(1); expect(processor.staleIssues.length).toEqual(1);
expect(processor.closedIssues.length).toEqual(0); expect(processor.closedIssues.length).toEqual(1);
});
test('processing an issue with no label will not make it stale if days-before-stale is set to -1', async () => {
const TestIssueList: Issue[] = [
generateIssue(1, 'An issue with no label', '2020-01-01T17:00:00Z')
];
const opts = {
...DefaultProcessorOptions,
staleIssueMessage: '',
daysBeforeStale: -1
};
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(0);
expect(processor.closedIssues.length).toEqual(0);
}); });
test('processing an issue with no label will make it stale but not close it', async () => { test('processing an issue with no label will make it stale but not close it', async () => {
@@ -208,60 +155,6 @@ test('processing a stale PR will close it', async () => {
expect(processor.closedIssues.length).toEqual(1); expect(processor.closedIssues.length).toEqual(1);
}); });
test('processing a stale issue will close it even if configured not to mark as stale', async () => {
const TestIssueList: Issue[] = [
generateIssue(1, 'An issue with no label', '2020-01-01T17:00:00Z', false, [
'Stale'
])
];
const opts = {
...DefaultProcessorOptions,
daysBeforeStale: -1,
staleIssueMessage: ''
};
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(0);
expect(processor.closedIssues.length).toEqual(1);
});
test('processing a stale PR will close it even if configured not to mark as stale', async () => {
const TestIssueList: Issue[] = [
generateIssue(1, 'An issue with no label', '2020-01-01T17:00:00Z', true, [
'Stale'
])
];
const opts = {
...DefaultProcessorOptions,
daysBeforeStale: -1,
stalePrMessage: ''
};
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(0);
expect(processor.closedIssues.length).toEqual(1);
});
test('closed issues will not be marked stale', async () => { test('closed issues will not be marked stale', async () => {
const TestIssueList: Issue[] = [ const TestIssueList: Issue[] = [
generateIssue( generateIssue(
@@ -596,7 +489,7 @@ test('stale label should be removed if a comment was added to a stale issue', as
) )
]; ];
const opts = {...DefaultProcessorOptions}; const opts = DefaultProcessorOptions;
opts.removeStaleWhenUpdated = true; opts.removeStaleWhenUpdated = true;
const processor = new IssueProcessor( const processor = new IssueProcessor(
@@ -626,7 +519,7 @@ test('stale label should not be removed if a comment was added by the bot (and t
) )
]; ];
const opts = {...DefaultProcessorOptions}; const opts = DefaultProcessorOptions;
opts.removeStaleWhenUpdated = true; opts.removeStaleWhenUpdated = true;
const processor = new IssueProcessor( const processor = new IssueProcessor(
@@ -656,7 +549,7 @@ test('stale issues should not be closed until after the closed number of days',
) )
]; ];
const opts = {...DefaultProcessorOptions}; const opts = DefaultProcessorOptions;
opts.daysBeforeStale = 5; // stale after 5 days opts.daysBeforeStale = 5; // stale after 5 days
opts.daysBeforeClose = 1; // closes after 6 days opts.daysBeforeClose = 1; // closes after 6 days
@@ -688,7 +581,7 @@ test('stale issues should be closed if the closed nubmer of days (additive) is a
) )
]; ];
const opts = {...DefaultProcessorOptions}; const opts = DefaultProcessorOptions;
opts.daysBeforeStale = 5; // stale after 5 days opts.daysBeforeStale = 5; // stale after 5 days
opts.daysBeforeClose = 1; // closes after 6 days opts.daysBeforeClose = 1; // closes after 6 days
@@ -719,7 +612,7 @@ test('stale issues should not be closed until after the closed number of days (l
) )
]; ];
const opts = {...DefaultProcessorOptions}; const opts = DefaultProcessorOptions;
opts.daysBeforeStale = 5; // stale after 5 days opts.daysBeforeStale = 5; // stale after 5 days
opts.daysBeforeClose = 20; // closes after 25 days opts.daysBeforeClose = 20; // closes after 25 days

View File

@@ -9,12 +9,8 @@ inputs:
description: 'The message to post on the issue when tagging it. If none provided, will not mark issues stale.' description: 'The message to post on the issue when tagging it. If none provided, will not mark issues stale.'
stale-pr-message: stale-pr-message:
description: 'The message to post on the pr when tagging it. If none provided, will not mark pull requests stale.' 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: days-before-stale:
description: 'The number of days old an issue can be before marking it stale. Set to -1 to never mark issues or pull requests as stale automatically.' description: 'The number of days old an issue can be before marking it stale.'
default: 60 default: 60
days-before-close: days-before-close:
description: 'The number of days to wait to close an issue or pull request after it being marked stale. Set to -1 to never close stale issues.' description: 'The number of days to wait to close an issue or pull request after it being marked stale. Set to -1 to never close stale issues.'
@@ -43,9 +39,6 @@ inputs:
debug-only: debug-only:
description: 'Run the processor in debug mode without actually performing any operations on live issues.' description: 'Run the processor in debug mode without actually performing any operations on live issues.'
default: false default: false
ascending:
description: 'The order to get issues or pull requests. Defaults to false, which is descending'
default: false
runs: runs:
using: 'node12' using: 'node12'
main: 'dist/index.js' main: 'dist/index.js'

2218
dist/index.js vendored

File diff suppressed because it is too large Load Diff

View File

@@ -37,8 +37,6 @@ export interface IssueProcessorOptions {
repoToken: string; repoToken: string;
staleIssueMessage: string; staleIssueMessage: string;
stalePrMessage: string; stalePrMessage: string;
closeIssueMessage: string;
closePrMessage: string;
daysBeforeStale: number; daysBeforeStale: number;
daysBeforeClose: number; daysBeforeClose: number;
staleIssueLabel: string; staleIssueLabel: string;
@@ -49,7 +47,6 @@ export interface IssueProcessorOptions {
operationsPerRun: number; operationsPerRun: number;
removeStaleWhenUpdated: boolean; removeStaleWhenUpdated: boolean;
debugOnly: boolean; debugOnly: boolean;
ascending: boolean;
} }
/*** /***
@@ -120,9 +117,6 @@ export class IssueProcessor {
const staleMessage: string = isPr const staleMessage: string = isPr
? this.options.stalePrMessage ? this.options.stalePrMessage
: this.options.staleIssueMessage; : this.options.staleIssueMessage;
const closeMessage: string = isPr
? this.options.closePrMessage
: this.options.closeIssueMessage;
const staleLabel: string = isPr const staleLabel: string = isPr
? this.options.stalePrLabel ? this.options.stalePrLabel
: this.options.staleIssueLabel; : this.options.staleIssueLabel;
@@ -130,9 +124,8 @@ export class IssueProcessor {
isPr ? this.options.exemptPrLabels : this.options.exemptIssueLabels isPr ? this.options.exemptPrLabels : this.options.exemptIssueLabels
); );
const issueType: string = isPr ? 'pr' : 'issue'; const issueType: string = isPr ? 'pr' : 'issue';
const shouldMarkWhenStale = this.options.daysBeforeStale > -1;
if (!staleMessage && shouldMarkWhenStale) { if (!staleMessage) {
core.info(`Skipping ${issueType} due to empty stale message`); core.info(`Skipping ${issueType} due to empty stale message`);
continue; continue;
} }
@@ -166,7 +159,7 @@ export class IssueProcessor {
); );
// determine if this issue needs to be marked stale first // determine if this issue needs to be marked stale first
if (!isStale && shouldBeStale && shouldMarkWhenStale) { if (!isStale && shouldBeStale) {
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`
); );
@@ -177,12 +170,7 @@ export class IssueProcessor {
// process the issue if it was marked stale // 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( await this.processStaleIssue(issue, issueType, staleLabel);
issue,
issueType,
staleLabel,
closeMessage
);
} }
} }
@@ -199,8 +187,7 @@ export class IssueProcessor {
private async processStaleIssue( private async processStaleIssue(
issue: Issue, issue: Issue,
issueType: string, issueType: string,
staleLabel: string, staleLabel: string
closeMessage?: string
) { ) {
const markedStaleOn: string = const markedStaleOn: string =
(await this.getLabelCreationDate(issue, staleLabel)) || issue.updated_at; (await this.getLabelCreationDate(issue, staleLabel)) || issue.updated_at;
@@ -216,7 +203,7 @@ export class IssueProcessor {
const issueHasUpdate: boolean = IssueProcessor.updatedSince( const issueHasUpdate: boolean = IssueProcessor.updatedSince(
issue.updated_at, issue.updated_at,
this.options.daysBeforeClose this.options.daysBeforeClose + (this.options.daysBeforeStale ?? 0)
); );
core.info(`Issue #${issue.number} has been updated: ${issueHasUpdate}`); core.info(`Issue #${issue.number} has been updated: ${issueHasUpdate}`);
@@ -237,7 +224,7 @@ export class IssueProcessor {
core.info( core.info(
`Closing ${issueType} because it was last updated on ${issue.updated_at}` `Closing ${issueType} because it was last updated on ${issue.updated_at}`
); );
await this.closeIssue(issue, closeMessage); await this.closeIssue(issue);
} else { } else {
core.info( core.info(
`Stale ${issueType} is not old enough to close yet (hasComments? ${issueHasComments}, hasUpdate? ${issueHasUpdate}` `Stale ${issueType} is not old enough to close yet (hasComments? ${issueHasComments}, hasUpdate? ${issueHasUpdate}`
@@ -281,39 +268,28 @@ export class IssueProcessor {
sinceDate: string sinceDate: string
): Promise<Comment[]> { ): Promise<Comment[]> {
// find any comments since date on the given issue // find any comments since date on the given issue
try { const comments = await this.client.issues.listComments({
const comments = await this.client.issues.listComments({ owner: github.context.repo.owner,
owner: github.context.repo.owner, repo: github.context.repo.repo,
repo: github.context.repo.repo, issue_number: issueNumber,
issue_number: issueNumber, since: sinceDate
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 // grab issues from github in baches of 100
private async getIssues(page: number): Promise<Issue[]> { private async getIssues(page: number): Promise<Issue[]> {
try { const issueResult: OctoKitIssueList = await this.client.issues.listForRepo({
const issueResult: OctoKitIssueList = await this.client.issues.listForRepo( owner: github.context.repo.owner,
{ repo: github.context.repo.repo,
owner: github.context.repo.owner, state: 'open',
repo: github.context.repo.repo, labels: this.options.onlyLabels,
state: 'open', per_page: 100,
labels: this.options.onlyLabels, page
per_page: 100, });
direction: this.options.ascending ? 'asc' : 'desc',
page return issueResult.data;
}
);
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 // Mark an issue as stale with a comment and a label
@@ -328,40 +304,27 @@ export class IssueProcessor {
this.operationsLeft -= 2; 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) { if (this.options.debugOnly) {
return; return;
} }
try { await this.client.issues.createComment({
await this.client.issues.createComment({ owner: github.context.repo.owner,
owner: github.context.repo.owner, repo: github.context.repo.repo,
repo: github.context.repo.repo, issue_number: issue.number,
issue_number: issue.number, body: staleMessage
body: staleMessage });
});
} catch (error) {
core.error(`Error creating a comment: ${error.message}`);
}
try { await this.client.issues.addLabels({
await this.client.issues.addLabels({ owner: github.context.repo.owner,
owner: github.context.repo.owner, repo: github.context.repo.repo,
repo: github.context.repo.repo, issue_number: issue.number,
issue_number: issue.number, labels: [staleLabel]
labels: [staleLabel] });
});
} catch (error) {
core.error(`Error adding a label: ${error.message}`);
}
} }
// Close an issue based on staleness // Close an issue based on staleness
private async closeIssue(issue: Issue, closeMessage?: string): Promise<void> { private async closeIssue(issue: Issue): Promise<void> {
core.info( core.info(
`Closing issue #${issue.number} - ${issue.title} for being stale` `Closing issue #${issue.number} - ${issue.title} for being stale`
); );
@@ -374,29 +337,12 @@ export class IssueProcessor {
return; return;
} }
if (closeMessage) { await this.client.issues.update({
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, state: 'closed'
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 // Remove a label from an issue
@@ -413,16 +359,12 @@ export class IssueProcessor {
return; return;
} }
try { await this.client.issues.removeLabel({
await this.client.issues.removeLabel({ owner: github.context.repo.owner,
owner: github.context.repo.owner, repo: github.context.repo.repo,
repo: github.context.repo.repo, issue_number: issue.number,
issue_number: issue.number, name: encodeURIComponent(label) // A label can have a "?" in the name
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) // returns the creation date of a given label on an issue (or nothing if no label existed)
@@ -468,7 +410,7 @@ export class IssueProcessor {
const millisSinceLastUpdated = const millisSinceLastUpdated =
new Date().getTime() - new Date(timestamp).getTime(); new Date().getTime() - new Date(timestamp).getTime();
return millisSinceLastUpdated <= daysInMillis; return millisSinceLastUpdated < daysInMillis;
} }
private static parseCommaSeparatedString(s: string): string[] { private static parseCommaSeparatedString(s: string): string[] {

View File

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