Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Project Management Automation: Derive due date from previous milestone #20851

Merged
merged 2 commits into from
May 1, 2020
Merged

Project Management Automation: Derive due date from previous milestone #20851

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
af7f5ef
Project Management Automation: Derive due date from previous milestone
aduth Mar 12, 2020
c00140f
Project Management Automation: Search milestones by all states
aduth May 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 84 additions & 34 deletions packages/project-management-automation/lib/add-milestone.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,13 @@ const getAssociatedPullRequest = require( './get-associated-pull-request' );
/** @typedef {import('@octokit/rest').HookError} HookError */
/** @typedef {import('@actions/github').GitHub} GitHub */
/** @typedef {import('@octokit/webhooks').WebhookPayloadPush} WebhookPayloadPush */
/** @typedef {import('@octokit/rest').IssuesListMilestonesForRepoResponseItem} OktokitIssuesListMilestonesForRepoResponseItem */

// Milestone due dates are calculated from a known due date:
// 6.3, which was due on August 12 2019.
const REFERENCE_MAJOR = 6;
const REFERENCE_MINOR = 3;
const REFERENCE_DATE = '2019-08-12';

// Releases are every 14 days.
/**
* Number of expected days elapsed between releases.
*
* @type {number}
*/
const DAYS_PER_RELEASE = 14;

/**
Expand All @@ -34,6 +33,45 @@ const isDuplicateValidationError = ( error ) =>
Array.isArray( error.errors ) &&
error.errors.some( ( { code } ) => code === 'already_exists' );

/**
* Returns a promise resolving to a milestone by a given title, if exists.
*
* @param {GitHub} octokit Initialized Octokit REST client.
* @param {string} owner Repository owner.
* @param {string} repo Repository name.
* @param {string} title Milestone title.
*
* @return {Promise<OktokitIssuesListMilestonesForRepoResponseItem|void>} Promise resolving to milestone, if exists.
*/
async function getMilestoneByTitle( octokit, owner, repo, title ) {
/** @type {Partial<import('@octokit/rest').IssuesListMilestonesForRepoParams>} */
const params = {
state: 'all',
sort: 'due_on',
direction: 'desc',
};

const options = octokit.issues.listMilestonesForRepo.endpoint.merge( {
owner,
repo,
...params,
} );

/**
* @type {AsyncIterableIterator<import('@octokit/rest').Response<import('@octokit/rest').IssuesListMilestonesForRepoResponse>>}
*/
const responses = octokit.paginate.iterator( options );

for await ( const response of responses ) {
const milestones = response.data;
for ( const milestone of milestones ) {
if ( milestone.title === title ) {
return milestone;
}
}
}
}

/**
* Assigns the correct milestone to PRs once merged.
*
Expand All @@ -53,16 +91,14 @@ async function addMilestone( payload, octokit ) {
}

debug( 'add-milestone: Fetching current milestone' );
const owner = payload.repository.owner.login;
const repo = payload.repository.name;

const {
data: { milestone },
} = await octokit.issues.get( {
owner: payload.repository.owner.login,
repo: payload.repository.name,
issue_number: prNumber,
} );
data: { milestone: pullMilestone },
} = await octokit.issues.get( { owner, repo, issue_number: prNumber } );

if ( milestone ) {
if ( pullMilestone ) {
debug(
'add-milestone: Pull request already has a milestone. Aborting'
);
Expand All @@ -74,8 +110,8 @@ async function addMilestone( payload, octokit ) {
const {
data: { content, encoding },
} = await octokit.repos.getContents( {
owner: payload.repository.owner.login,
repo: payload.repository.name,
owner,
repo,
path: 'package.json',
} );

Expand All @@ -87,29 +123,39 @@ async function addMilestone( payload, octokit ) {

debug( `add-milestone: Current plugin version is ${ major }.${ minor }` );

const lastTitle = `Gutenberg ${ major }.${ minor }`;
const lastMilestone = await getMilestoneByTitle(
octokit,
owner,
repo,
lastTitle
);

if ( ! lastMilestone ) {
throw new Error(
'Could not find milestone for current version: ' + lastTitle
);
}

if ( minor === 9 ) {
major += 1;
minor = 0;
} else {
minor += 1;
}

const numVersionsElapsed =
( major - REFERENCE_MAJOR ) * 10 + ( minor - REFERENCE_MINOR );
const numDaysElapsed = numVersionsElapsed * DAYS_PER_RELEASE;

// Using UTC for the calculation ensures it's not affected by daylight savings.
const dueDate = new Date( REFERENCE_DATE );
dueDate.setUTCDate( dueDate.getUTCDate() + numDaysElapsed );
const dueDate = new Date( lastMilestone.due_on );
dueDate.setUTCDate( dueDate.getUTCDate() + DAYS_PER_RELEASE );

debug(
`add-milestone: Creating 'Gutenberg ${ major }.${ minor }' milestone, due on ${ dueDate.toISOString() }`
);

try {
await octokit.issues.createMilestone( {
owner: payload.repository.owner.login,
repo: payload.repository.name,
owner,
repo,
title: `Gutenberg ${ major }.${ minor }`,
due_on: dueDate.toISOString(),
} );
Expand All @@ -127,24 +173,28 @@ async function addMilestone( payload, octokit ) {

debug( 'add-milestone: Fetching all milestones' );

const { data: milestones } = await octokit.issues.listMilestonesForRepo( {
owner: payload.repository.owner.login,
repo: payload.repository.name,
} );
const title = `Gutenberg ${ major }.${ minor }`;

const [ { number } ] = milestones.filter(
( { title } ) => title === `Gutenberg ${ major }.${ minor }`
const milestone = await getMilestoneByTitle(
octokit,
payload.repository.owner.login,
payload.repository.name,
title
);

if ( ! milestone ) {
throw new Error( 'Could not rediscover milestone by title: ' + title );
}

debug(
`add-milestone: Adding issue #${ prNumber } to milestone #${ number }`
`add-milestone: Adding issue #${ prNumber } to milestone #${ milestone.number }`
);

await octokit.issues.update( {
owner: payload.repository.owner.login,
repo: payload.repository.name,
owner,
repo,
issue_number: prNumber,
milestone: number,
milestone: milestone.number,
} );
}

Expand Down
98 changes: 70 additions & 28 deletions packages/project-management-automation/lib/test/add-milestone.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,17 @@ describe( 'addMilestone', () => {
ref: 'refs/heads/not-master',
};
const octokit = {
paginate: {
iterator: jest.fn(),
},
issues: {
get: jest.fn(),
createMilestone: jest.fn(),
listMilestonesForRepo: jest.fn(),
listMilestonesForRepo: {
endpoint: {
merge: jest.fn(),
},
},
update: jest.fn(),
},
repos: {
Expand All @@ -24,7 +31,9 @@ describe( 'addMilestone', () => {

expect( octokit.issues.get ).not.toHaveBeenCalled();
expect( octokit.issues.createMilestone ).not.toHaveBeenCalled();
expect( octokit.issues.listMilestonesForRepo ).not.toHaveBeenCalled();
expect(
octokit.issues.listMilestonesForRepo.endpoint.merge
).not.toHaveBeenCalled();
expect( octokit.issues.update ).not.toHaveBeenCalled();
expect( octokit.repos.getContents ).not.toHaveBeenCalled();
} );
Expand All @@ -41,6 +50,9 @@ describe( 'addMilestone', () => {
},
};
const octokit = {
paginate: {
iterator: jest.fn(),
},
issues: {
get: jest.fn( () =>
Promise.resolve( {
Expand Down Expand Up @@ -83,6 +95,29 @@ describe( 'addMilestone', () => {
},
};
const octokit = {
paginate: {
iterator: jest.fn().mockReturnValue( [
Promise.resolve( {
data: [
{
title: 'Gutenberg 6.2',
number: 10,
due_on: '2019-07-29T00:00:00.000Z',
},
{
title: 'Gutenberg 6.3',
number: 11,
due_on: '2019-08-12T00:00:00.000Z',
},
{
title: 'Gutenberg 6.4',
number: 12,
due_on: '2019-08-26T00:00:00.000Z',
},
],
} ),
] ),
},
issues: {
get: jest.fn( () =>
Promise.resolve( {
Expand All @@ -92,15 +127,11 @@ describe( 'addMilestone', () => {
} )
),
createMilestone: jest.fn(),
listMilestonesForRepo: jest.fn( () =>
Promise.resolve( {
data: [
{ title: 'Gutenberg 6.2', number: 10 },
{ title: 'Gutenberg 6.3', number: 11 },
{ title: 'Gutenberg 6.4', number: 12 },
],
} )
),
listMilestonesForRepo: {
endpoint: {
merge: jest.fn(),
},
},
update: jest.fn(),
},
repos: {
Expand Down Expand Up @@ -137,10 +168,6 @@ describe( 'addMilestone', () => {
title: 'Gutenberg 6.4',
due_on: '2019-08-26T00:00:00.000Z',
} );
expect( octokit.issues.listMilestonesForRepo ).toHaveBeenCalledWith( {
owner: 'WordPress',
repo: 'gutenberg',
} );
expect( octokit.issues.update ).toHaveBeenCalledWith( {
owner: 'WordPress',
repo: 'gutenberg',
Expand All @@ -161,6 +188,29 @@ describe( 'addMilestone', () => {
},
};
const octokit = {
paginate: {
iterator: jest.fn().mockReturnValue( [
Promise.resolve( {
data: [
{
title: 'Gutenberg 6.8',
number: 10,
due_on: '2019-10-21T00:00:00.000Z',
},
{
title: 'Gutenberg 6.9',
number: 11,
due_on: '2019-11-04T00:00:00.000Z',
},
{
title: 'Gutenberg 7.0',
number: 12,
due_on: '2019-11-18T00:00:00.000Z',
},
],
} ),
] ),
},
issues: {
get: jest.fn( () =>
Promise.resolve( {
Expand All @@ -170,15 +220,11 @@ describe( 'addMilestone', () => {
} )
),
createMilestone: jest.fn(),
listMilestonesForRepo: jest.fn( () =>
Promise.resolve( {
data: [
{ title: 'Gutenberg 6.8', number: 10 },
{ title: 'Gutenberg 6.9', number: 11 },
{ title: 'Gutenberg 7.0', number: 12 },
],
} )
),
listMilestonesForRepo: {
endpoint: {
merge: jest.fn(),
},
},
update: jest.fn(),
},
repos: {
Expand Down Expand Up @@ -215,10 +261,6 @@ describe( 'addMilestone', () => {
title: 'Gutenberg 7.0',
due_on: '2019-11-18T00:00:00.000Z',
} );
expect( octokit.issues.listMilestonesForRepo ).toHaveBeenCalledWith( {
owner: 'WordPress',
repo: 'gutenberg',
} );
expect( octokit.issues.update ).toHaveBeenCalledWith( {
owner: 'WordPress',
repo: 'gutenberg',
Expand Down