Skip to content

Commit

Permalink
Update issue.updated_at if we have just marked an issue stale (#85)
Browse files Browse the repository at this point in the history
This is to ensure we do not close issues before days-before-close has
expired. Without this fix we can encounter a situation where an issue
gets marked as stale and it gets closed immediately without waiting
days-before-close number of days.
  • Loading branch information
fjeremic committed May 29, 2020
1 parent b6f9559 commit db0a205
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 3 deletions.
29 changes: 27 additions & 2 deletions __tests__/main.test.ts
Expand Up @@ -62,13 +62,16 @@ 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(
DefaultProcessorOptions,
opts,
async p => (p == 1 ? TestIssueList : []),
async (num, dt) => [],
async (issue, label) => new Date().toDateString()
Expand All @@ -81,6 +84,28 @@ test('processing an issue with no label will make it stale and close it, if it i
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 : []),
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(0);
});

test('processing an issue with no label will make it stale but not close it', async () => {
// issue should be from 2 days ago so it will be
// stale but not close-able, based on default settings
Expand Down
16 changes: 15 additions & 1 deletion src/IssueProcessor.ts
Expand Up @@ -304,6 +304,20 @@ export class IssueProcessor {

this.operationsLeft -= 2;

// We are about to modify the issue by adding a comment and applying a label, so update the modification timestamp
// to `days-before-stale` days ago to simulate as if we marked this issue stale on the very first day it actually
// became stale. This has the effect of respecting `days-before-close` no matter what value it is set to. The user
// can request to close the issue immediately by using `days-before-close` === 0, or they can set it to any number
// of days to wait before actually closing the issue.
const daysBeforeStaleInMillis =
1000 * 60 * 60 * 24 * this.options.daysBeforeStale;
const newUpdatedAtDate: Date = new Date();
newUpdatedAtDate.setTime(
newUpdatedAtDate.getTime() - daysBeforeStaleInMillis
);

issue.updated_at = newUpdatedAtDate.toString();

if (this.options.debugOnly) {
return;
}
Expand Down Expand Up @@ -410,7 +424,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[] {
Expand Down

0 comments on commit db0a205

Please sign in to comment.