Skip to content

chore(dashboard): http function to list pull requests with conflicts #6675

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

Merged
Merged
Show file tree
Hide file tree
Changes from all 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
1 change: 1 addition & 0 deletions tools/dashboard/functions/functions.ts
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
export {payloadGithubStatus} from './payload-github-status';
export {pullRequestsWithConflicts} from './pull-requests-with-conflicts';
22 changes: 22 additions & 0 deletions tools/dashboard/functions/github/github-api.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import {GraphQLClient} from 'graphql-request';
import {config} from 'firebase-functions';
import * as GithubApi from 'github';

/** API token for the Github repository. Required to set the github status on commits and PRs. */
const githubAccessToken = config().secret.github;

/** API Endpoint for the Github API v4 using GraphQL. */
const githubApiV4Endpoint = 'https://api.github.com/graphql';

/** Export the GitHub V3 API instance that is authenticated. */
export const githubApiV3 = new GithubApi();

/** Export the GraphQL client that can be used to query the Github API v4. */
export const githubApiV4 = new GraphQLClient(githubApiV4Endpoint, {
headers: {
Authorization: `Bearer ${githubAccessToken}`,
}
});

// Authenticate the Github API package with the user token.
githubApiV3.authenticate({type: 'token', token: githubAccessToken});
43 changes: 43 additions & 0 deletions tools/dashboard/functions/github/github-graphql-queries.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
import {githubApiV4} from './github-api';

/** GraphQL query that finds all Pull Requests and their mergeable state. */
const getOpenPullRequestsWithMergeableStateQuery = `
query getOpenPullRequestsWithMergeableState($lastCursor: String) {
repository(owner: "angular", name: "material2") {
pullRequests(states: OPEN, first: 100, after: $lastCursor) {
pageInfo {
hasNextPage,
endCursor
}
nodes {
number,
mergeable
}
}
}
}`;

/** Pull Request node that will be returned by the Github V4 API. */
export interface PullRequestWithMergeableState {
number: number;
mergeable: string;
}

/** Queries the GitHub API to find all open pull requests and their mergeable state. */
export async function getOpenPullRequestsWithMergeableState()
: Promise<PullRequestWithMergeableState[]> {
const nodes: PullRequestWithMergeableState[] = [];
let lastData: any|null = null;

while (!lastData || lastData.repository.pullRequests.pageInfo.hasNextPage) {
lastData = await githubApiV4.request(getOpenPullRequestsWithMergeableStateQuery, {
lastCursor: lastData && lastData.repository.pullRequests.pageInfo.endCursor
});

nodes.push(...lastData.repository.pullRequests.nodes);
}

return nodes;
}


30 changes: 6 additions & 24 deletions tools/dashboard/functions/github/github-status.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,4 @@
import {config} from 'firebase-functions';

const request = require('request');
const {version, name} = require('../package.json');

/** API token for the Github repository. Required to set the github status on commits and PRs. */
const repoToken = config().secret.github;
import {githubApiV3} from './github-api';

/** Data that must be specified to set a Github PR status. */
export type GithubStatusData = {
Expand All @@ -18,25 +12,13 @@ export type GithubStatusData = {
export function setGithubStatus(commitSHA: string, data: GithubStatusData) {
const state = data.result ? 'success' : 'failure';

const requestData = {
return githubApiV3.repos.createStatus({
owner: 'angular',
repo: 'material2',
sha: commitSHA,
state: state,
target_url: data.url,
description: data.description,
context: data.name,
description: data.description
};

const headers = {
'Authorization': `token ${repoToken}`,
'User-Agent': `${name}/${version}`
};

return new Promise((resolve, reject) => {
request({
url: `https://api.github.com/repos/angular/material2/statuses/${commitSHA}`,
method: 'POST',
body: requestData,
headers: headers,
json: true
}, (error: any, response: any) => error ? reject(error) : resolve(response.statusCode));
});
}
2 changes: 2 additions & 0 deletions tools/dashboard/functions/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
"@types/jsonwebtoken": "^7.2.1",
"firebase-admin": "~4.2.1",
"firebase-functions": "^0.5.7",
"github": "^10.0.0",
"graphql-request": "^1.3.4",
"jsonwebtoken": "^7.4.1",
"request": "^2.81.0",
"ts-node": "^3.0.6",
Expand Down
13 changes: 13 additions & 0 deletions tools/dashboard/functions/pull-requests-with-conflicts.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import {https} from 'firebase-functions';
import {getOpenPullRequestsWithMergeableState} from './github/github-graphql-queries';

/**
* Firebase HTTP trigger that responds with a list of Pull Requests that have merge conflicts.
*/
export const pullRequestsWithConflicts = https.onRequest(async (_request, response) => {
const pullRequests = (await getOpenPullRequestsWithMergeableState())
.filter(pullRequest => pullRequest.mergeable === 'CONFLICTING');

response.status(200).json(pullRequests);
});