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

Jump to bottom

[Feature] Ajout d'info dans les message slack de PRs #74

Merged
merged 6 commits into from
May 12, 2021
Merged

[Feature] Ajout d'info dans les message slack de PRs #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6efcc28
[FEATURE] :sparkles: Add reviews in PR slack messages
aceol May 3, 2021
d751591
Sort PR with in progress last
aceol May 10, 2021
b0b112c
BSR: Add _ prefix for not exported method in github service
VincentHardouin May 12, 2021
17fdc77
BSR: Remove redundant variable in _createResponseForSlack
VincentHardouin May 12, 2021
8bb243b
BSR: Remove duplicate character in regex
VincentHardouin May 12, 2021
c5b17a1
Wrap octokit.search.issuesAndPullRequests inside try catch block
jonasgrilleres May 12, 2021
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
146 changes: 102 additions & 44 deletions common/services/github.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
const { Octokit } = require('@octokit/rest');
const axios = require('axios');
const settings = require('../../config');
const { zipWith, countBy, entries, noop } = require('lodash');

const color = {
'team-evaluation': '#FDEEC1',
Expand All @@ -10,66 +10,113 @@ const color = {
'team-acces': '#A2DCC1',
};

function getUrlForGithub(label) {
label = label.replace(/ /g, '%20');
return `https://api.github.com/search/issues?q=is:pr+is:open+archived:false+sort:updated-desc+user:1024pix+label:${label}`;
function _createOctokit() {
return new Octokit({
auth: settings.github.token,
log: {
debug: noop,
info: noop,
warn: console.warn,
error: console.error
},
});
}

async function getDataFromGithub(label) {
const url = getUrlForGithub(label);
const githubToken = settings.github.token;
const config = {
headers: {
'Authorization': 'token ' + githubToken
}
};
return axios.get(url, config)
.then(response => {
return response.data.items;
})
.catch(error => {
console.log(error);
async function _getPullReviewsFromGithub(label){
const owner = settings.github.owner;

label = label.replace(/ /g, '%20');
const octokit = _createOctokit();

try {
const { data } = await octokit.search.issuesAndPullRequests({
q: `is:pr+is:open+archived:false+user:${owner}+label:${label}`,
sort: 'updated',
order: 'desc'
});

return data.items;
} catch (err) {
console.error(err);
throw err;
}
}

function getEmojis(pullRequests) {
async function _getReviewsFromGithub(pull_number){
const owner = settings.github.owner;
const repo = settings.github.repository;
const octokit = _createOctokit();
const { data } = await octokit.pulls.listReviews({
owner,
repo,
pull_number
});
return data;
}

function _getEmojis(pullRequests) {
const labelsEmojis = pullRequests.labels.map(label => {
const match = label.name.match(/^:[A-z,_,-]*:/);
const match = label.name.match(/^:[A-z,_-]*:/);
return match ? match[0] : '';
});
return labelsEmojis.filter(Boolean).join(' ');
}

function createResponseForSlack(pullRequests, label) {
const attachments = pullRequests.map((pullRequests) => {
const emojis = getEmojis(pullRequests);
function _getReviewsLabel(reviews) {
const countByState = countBy(reviews, 'state');
return entries(countByState)
.map(([label, times]) => {
switch(label) {
case 'COMMENTED': return `💬x${times}`;
case 'APPROVED': return `✅x${times}`;
case 'CHANGES_REQUESTED': return `❌x${times}`;
}
}).join(' ');
}

function _createResponseForSlack(data, label) {
const attachments = data.map(({pullRequest, reviews}) => {
const emojis = _getEmojis(pullRequest);
const reviewsLabel = _getReviewsLabel(reviews);
const link = `<${pullRequest.html_url}|${pullRequest.title}>`;
const message = [reviewsLabel, emojis, link].filter(Boolean).join(' | ');
return {
color: color[label],
pretext: '',
fields:[ {value: `${emojis}<${pullRequests.html_url}|${pullRequests.title}>`, short: false},],
fields:[ {value: message, short: false},],
};
}).sort().reverse();
}).sort(_sortWithInProgressLast);

const response = {
return {
response_type: 'in_channel',
text: 'PRs à review pour ' + label,
attachments
};
}

function _sortWithInProgressLast(prA, prB) {
const fieldA = prA.fields[0].value;
const fieldB = prB.fields[0].value;
const inProgressIcon = ':construction:';
const isAinProgress = fieldA.indexOf(inProgressIcon) !== -1;
const isBinProgress = fieldB.indexOf(inProgressIcon) !== -1;

return response;
if(isAinProgress && !isBinProgress) return 1;
if(!isAinProgress && isBinProgress) return -1;
return fieldA.localeCompare(fieldB);
}

async function getLastCommitUrl({ branchName, tagName }) {
if (branchName) {
return await getBranchLastCommitUrl(branchName);
return await _getBranchLastCommitUrl(branchName);
}
return getTagCommitUrl(tagName);
return _getTagCommitUrl(tagName);
}

async function getBranchLastCommitUrl(branch) {
async function _getBranchLastCommitUrl(branch) {
const owner = settings.github.owner;
const repo = settings.github.repository;
const octokit = new Octokit({ auth: settings.github.token });
const octokit = _createOctokit();
const { data } = await octokit.repos.getBranch({
owner,
repo,
Expand All @@ -78,30 +125,30 @@ async function getBranchLastCommitUrl(branch) {
return data.commit.url;
}

async function getTagCommitUrl(tagName) {
async function _getTagCommitUrl(tagName) {
const owner = settings.github.owner;
const repo = settings.github.repository;
const tags = await getTags(owner, repo);
const tags = await _getTags(owner, repo);
const tag = tags.find((tag) => tag.name === tagName);
return tag.commit.url;
}

async function getLatestRelease(repoOwner, repoName) {
const tags = await getTags(repoOwner, repoName);
const tags = await _getTags(repoOwner, repoName);
return tags[0];
}

async function getTags(repoOwner, repoName) {
const { repos } = new Octokit({ auth: settings.github.token });
async function _getTags(repoOwner, repoName) {
const { repos } = _createOctokit();
const { data } = await repos.listTags({
owner: repoOwner,
repo: repoName,
});
return data;
}

async function getDefaultBranch(repoOwner, repoName) {
const { repos } = new Octokit({ auth: settings.github.token });
async function _getDefaultBranch(repoOwner, repoName) {
const { repos } = _createOctokit();
const { data } = await repos.get({
owner: repoOwner,
repo: repoName,
Expand All @@ -110,8 +157,8 @@ async function getDefaultBranch(repoOwner, repoName) {
}

async function _getMergedPullRequestsSortedByDescendingDate(repoOwner, repoName) {
const defaultBranch = await getDefaultBranch(repoOwner, repoName);
const { pulls } = new Octokit({ auth: settings.github.token });
const defaultBranch = await _getDefaultBranch(repoOwner, repoName);
const { pulls } = _createOctokit();
const { data } = await pulls.list({
owner: repoOwner,
repo: repoName,
Expand All @@ -134,7 +181,7 @@ async function _getLatestReleaseTagName(repoOwner, repoName) {
}

async function _getCommitAtURL(commitUrl) {
const { request } = new Octokit({ auth: settings.github.token });
const { request } = _createOctokit();
const { data } = await request(commitUrl);
return data.commit;
}
Expand All @@ -149,8 +196,19 @@ async function _getLatestReleaseDate(repoOwner, repoName) {
module.exports = {

async getPullRequests(label) {
const pullRequests = await getDataFromGithub(label);
return createResponseForSlack(pullRequests, label);
const pullRequests = await _getPullReviewsFromGithub(label);
const reviewsByPR = await Promise.all(
pullRequests.map(({number}) => _getReviewsFromGithub(number))
);

const data = zipWith(pullRequests, reviewsByPR, (pullRequest, reviews) => {
aceol marked this conversation as resolved.
Show resolved Hide resolved
return {
pullRequest,
reviews,
};
});

return _createResponseForSlack(data, label);
},

async getLatestReleaseTag(repoName = settings.github.repository) {
Expand All @@ -173,7 +231,7 @@ module.exports = {
const githubCICheckName = 'build-test-and-deploy';
const commitUrl = await getLastCommitUrl({ branchName, tagName });
const commitStatusUrl = commitUrl + '/check-runs';
const octokit = new Octokit({ auth: settings.github.token });
const octokit = _createOctokit();
const { data } = await octokit.request(commitStatusUrl);
const runs = data.check_runs;
const ciRuns = runs.filter((run) => run.name === githubCICheckName);
Expand Down
46 changes: 33 additions & 13 deletions test/unit/build/services/github_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,35 @@
const { describe, it } = require('mocha');
const { expect } = require('chai');
const { sinon, nock } = require('../../../test-helper');
const axios = require('axios');
const { nock } = require('../../../test-helper');
const githubService = require('../../../../common/services/github');

describe('#getPullRequests', function() {
const items = [
{ html_url: 'http://test1.fr', title: 'PR1', labels: [ { name: 'team certif'} ]},
{ html_url: 'http://test2.fr', title: 'PR2', labels: [ { name: ':construction: toto'}, { name: ':idea: team certif'}] },
];
beforeEach(() => {
sinon.stub(axios, 'get').resolves({ data: { items: items } });
});


it('should return the response for slack', async function() {
// given
const items = [
{ html_url: 'http://test1.fr', number: 0, title: 'PR1', labels: [ { name: 'team certif'} ]},
{ html_url: 'http://test2.fr', number: 1, title: 'PR2', labels: [ { name: ':construction: toto'}, { name: ':idea: team certif'}] },
];

nock('https://api.github.com')
.get('/search/issues?q=is%3Apr+is%3Aopen+archived%3Afalse+user%3Agithub-owner+label%3Ateam-certif&sort=updated&order=desc')
.reply(200, {items});

nock('https://api.github.com')
.get('/repos/github-owner/github-repository/pulls/0/reviews')
.reply(200, [{state: 'COMMENTED'}, {state: 'APPROVED'}]);
nock('https://api.github.com')
.get('/repos/github-owner/github-repository/pulls/1/reviews')
.reply(200, [{state: 'CHANGES_REQUESTED'}]);

const expectedResponse = {
response_type: 'in_channel',
text: 'PRs à review pour team-certif',
attachments: [
{ color: '#B7CEF5', pretext: '', fields: [{ value: ':construction: :idea:<http://test2.fr|PR2>', short: false }] },
{ color: '#B7CEF5', pretext: '', fields: [{ value: '<http://test1.fr|PR1>', short: false }] }
{ color: '#B7CEF5', pretext: '', fields: [{ value: '💬x1 ✅x1 | <http://test1.fr|PR1>', short: false }] },
{ color: '#B7CEF5', pretext: '', fields: [{ value: '❌x1 | :construction: :idea: | <http://test2.fr|PR2>', short: false }] },
]
};

Expand All @@ -33,13 +42,24 @@ describe('#getPullRequests', function() {

it('should call the Github API with the label without space', async function() {
// given
const expectedUrl = 'https://api.github.com/search/issues?q=is:pr+is:open+archived:false+sort:updated-desc+user:1024pix+label:Tech%20Review%20Needed';
let scopePr, scopeReview;
const items = [
{ html_url: 'http://test1.fr', number: 0, title: 'PR1', labels: [ { name: 'team certif'} ]},
];
scopePr = nock('https://api.github.com')
.get('/search/issues?q=is%3Apr+is%3Aopen+archived%3Afalse+user%3Agithub-owner+label%3ATech%2520Review%2520Needed&sort=updated&order=desc')
.reply(200, {items});

scopeReview = nock('https://api.github.com')
.get('/repos/github-owner/github-repository/pulls/0/reviews')
.reply(200, []);

// when
await githubService.getPullRequests('Tech Review Needed');

// then
sinon.assert.calledWith(axios.get, expectedUrl);
expect(scopePr.isDone());
expect(scopeReview.isDone());
});

});
Expand Down