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.

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

fix: add default reviewers to manual backports #274

Merged
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
6 changes: 6 additions & 0 deletions spec/fixtures/backport_pull_request.closed.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@
"head": {
"ref": "123456789iuytdxcvbnjhfdriuyfedfgy54escghjnbg"
},
"base": {
"ref": "main",
"repo": {
"default_branch": "main"
}
},
"body": "Backport of #14\nSee that PR for details.\nNotes: <!-- One-line Change Summary Here-->",
"created_at": "2018-11-01T17:29:51Z",
"merged_at": "2018-11-01T17:30:11Z",
Expand Down
6 changes: 6 additions & 0 deletions spec/fixtures/backport_pull_request.merged.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@
"head": {
"ref": "123456789iuytdxcvbnjhfdriuyfedfgy54escghjnbg"
},
"base": {
"ref": "main",
"repo": {
"default_branch": "main"
}
},
"body": "Backport of #14\nSee that PR for details.\nNotes: <!-- One-line Change Summary Here-->",
"created_at": "2018-11-01T17:29:51Z",
"merged_at": "2018-11-01T17:30:11Z",
Expand Down
1 change: 1 addition & 0 deletions spec/fixtures/backport_pull_request.opened.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"action": "opened",
"number": 7,
"pull_request": {
"number": 7,
"url": "my_cool_url",
"title": "CHANGE README",
"merged": true,
Expand Down
12 changes: 12 additions & 0 deletions spec/index.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -392,6 +392,12 @@ Notes: <!-- One-line Change Summary Here-->`,
head: {
ref: '123456789iuytdxcvbnjhfdriuyfedfgy54escghjnbg',
},
base: {
ref: 'main',
repo: {
default_branch: 'main',
},
},
labels: [
{
color: 'ededed',
Expand Down Expand Up @@ -429,6 +435,12 @@ Notes: <!-- One-line Change Summary Here-->`,
head: {
ref: '123456789iuytdxcvbnjhfdriuyfedfgy54escghjnbg',
},
base: {
ref: 'main',
repo: {
default_branch: 'main',
},
},
labels: [
{
color: 'ededed',
Expand Down
67 changes: 67 additions & 0 deletions spec/operations.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,12 @@ import * as fs from 'fs-extra';
import * as os from 'os';
import * as path from 'path';
import simpleGit from 'simple-git';

import { PRChange } from '../src/enums';
import { initRepo } from '../src/operations/init-repo';
import { setupRemotes } from '../src/operations/setup-remotes';
import { updateManualBackport } from '../src/operations/update-manual-backport';
import { tagBackportReviewers } from '../src/utils';

let dirObject: { dir?: string } | null = null;

Expand All @@ -13,6 +17,22 @@ const saveDir = (o: { dir: string }) => {
return o.dir;
};

const backportPRClosedEvent = require('./fixtures/backport_pull_request.closed.json');
const backportPRMergedEvent = require('./fixtures/backport_pull_request.merged.json');
const backportPROpenedEvent = require('./fixtures/backport_pull_request.opened.json');

jest.mock('../src/utils', () => ({
tagBackportReviewers: jest.fn().mockReturnValue(Promise.resolve()),
isSemverMinorPR: jest.fn().mockReturnValue(false),
}));

jest.mock('../src/utils/label-utils', () => ({
labelExistsOnPR: jest.fn().mockResolvedValue(true),
getSemverLabel: jest.fn().mockResolvedValue(false),
addLabels: jest.fn(),
removeLabel: jest.fn(),
}));

describe('runner', () => {
jest.setTimeout(30000);
console.error = jest.fn();
Expand Down Expand Up @@ -101,4 +121,51 @@ describe('runner', () => {
}
});
});

describe('updateManualBackport()', () => {
let context: any;
const octokit = {
pulls: {
get: jest.fn().mockReturnValue(Promise.resolve({})),
},
issues: {
createComment: jest.fn().mockReturnValue(Promise.resolve({})),
listComments: jest.fn().mockReturnValue(Promise.resolve({ data: [] })),
},
};

it('tags reviewers on manual backport creation', async () => {
context = {
...backportPROpenedEvent,
octokit,
repo: jest.fn(),
};
await updateManualBackport(context, PRChange.OPEN, 1234);
expect(tagBackportReviewers).toHaveBeenCalled();
expect(tagBackportReviewers).toHaveBeenCalledWith({
context,
targetPrNumber: 7,
});
});

it('does not tag reviewers on merged PRs', async () => {
context = {
...backportPRMergedEvent,
octokit,
repo: jest.fn(),
};
await updateManualBackport(context, PRChange.MERGE, 1234);
expect(tagBackportReviewers).not.toHaveBeenCalled();
});

it('does not tag reviewers on closed PRs', async () => {
context = {
...backportPRClosedEvent,
octokit,
repo: jest.fn(),
};
await updateManualBackport(context, PRChange.CLOSE, 1234);
expect(tagBackportReviewers).not.toHaveBeenCalled();
});
});
});
2 changes: 0 additions & 2 deletions spec/queue.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ import * as sinon from 'sinon';

import { ExecutionQueue } from '../src/Queue';

const noop = async () => {};

const waitForEvent = (emitter: EventEmitter, event: string) => {
return new Promise<void>((resolve) => {
emitter.once(event, resolve);
Expand Down
14 changes: 10 additions & 4 deletions src/operations/update-manual-backport.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
import * as labelUtils from '../utils/label-utils';
import { log } from '../utils/log-util';
import { PRChange, PRStatus, LogLevel } from '../enums';
import {
BACKPORT_LABEL,
BACKPORT_REQUESTED_LABEL,
SKIP_CHECK_LABEL,
} from '../constants';
import { isSemverMinorPR } from '../utils';
import { PRChange, PRStatus, LogLevel } from '../enums';
import { WebHookPRContext } from '../types';
import { isSemverMinorPR, tagBackportReviewers } from '../utils';
import * as labelUtils from '../utils/label-utils';
import { log } from '../utils/log-util';

/**
* Updates the labels on a backport's original PR as well as comments with links
Expand Down Expand Up @@ -135,6 +135,12 @@ please check out #${pr.number}`;
}),
);
}

// Tag default reviewers to manual backport
await tagBackportReviewers({
context,
targetPrNumber: pr.number,
});
} else if (type === PRChange.MERGE) {
log(
'updateManualBackport',
Expand Down
55 changes: 37 additions & 18 deletions src/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -397,6 +397,38 @@ const createBackportComment = async (
return body;
};

export const tagBackportReviewers = async ({
context,
targetPrNumber,
user,
}: {
context: SimpleWebHookRepoContext;
targetPrNumber: number;
user?: string;
}) => {
const reviewers = [];

if (DEFAULT_BACKPORT_REVIEW_TEAM) {
reviewers.push(DEFAULT_BACKPORT_REVIEW_TEAM);
}

if (user) {
const hasWrite = await checkUserHasWriteAccess(context, user);
// Optionally request a default review team for backports.
// If the PR author has write access, also request their review.
if (hasWrite) reviewers.push(user);
}

if (reviewers.length > 0) {
await context.octokit.pulls.requestReviewers(
context.repo({
pull_number: targetPrNumber,
reviewers,
}),
);
}
};

export const backportImpl = async (
robot: Probot,
context: SimpleWebHookRepoContext,
Expand Down Expand Up @@ -561,24 +593,11 @@ export const backportImpl = async (
}),
);

const reviewers = [];
const hasWrite = await checkUserHasWriteAccess(context, pr.user.login);

// Optionally request a default review team for backports.
// If the PR author has write access, also request their review.
if (hasWrite) reviewers.push(pr.user.login);
if (DEFAULT_BACKPORT_REVIEW_TEAM) {
reviewers.push(DEFAULT_BACKPORT_REVIEW_TEAM);
}

if (reviewers.length > 0) {
await context.octokit.pulls.requestReviewers(
context.repo({
pull_number: newPr.number,
reviewers,
}),
);
}
await tagBackportReviewers({
context,
targetPrNumber: newPr.number,
user: pr.user.login,
});

log(
'backportImpl',
Expand Down
Loading