cargdev/angular
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(dev-infra): migrate discover-new-conflicts tool to use new logging system (#37232)

Browse Source 
Migrate the discover-new-conflicts tool in ng-dev to use new logging system
rather than directly calling console.* to create a better experience
for users.

PR Close #37232
This commit is contained in:
Joey Perrott 2020-05-20 14:28:27 -07:00 committed by Matias Niemelä
parent 171d967993
commit 9388e47e1e
2 changed files with 17 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
dev-infra/pr/discover-new-conflicts/cli.ts
View File

@ -1,5 +1,7 @@
import {Arguments, Argv} from 'yargs'; import {Arguments, Argv} from 'yargs';
import {error} from '../../utils/console';
import {discoverNewConflictsForPr} from './index'; import {discoverNewConflictsForPr} from './index';
/** Builds the discover-new-conflicts pull request command. */ /** Builds the discover-new-conflicts pull request command. */
@ -16,7 +18,7 @@ export function buildDiscoverNewConflictsCommand(yargs: Argv) {
export async function handleDiscoverNewConflictsCommand({prNumber, date}: Arguments) { export async function handleDiscoverNewConflictsCommand({prNumber, date}: Arguments) {
// If a provided date is not able to be parsed, yargs provides it as NaN. // If a provided date is not able to be parsed, yargs provides it as NaN.
if (isNaN(date)) { if (isNaN(date)) {
console.error('Unable to parse the value provided via --date flag'); error('Unable to parse the value provided via --date flag');
process.exit(1); process.exit(1);
} }
await discoverNewConflictsForPr(prNumber, date); await discoverNewConflictsForPr(prNumber, date);

25
dev-infra/pr/discover-new-conflicts/index.ts
View File

@ -10,6 +10,7 @@ import {Bar} from 'cli-progress';
import {types as graphQLTypes} from 'typed-graphqlify'; import {types as graphQLTypes} from 'typed-graphqlify';
import {getConfig, NgDevConfig} from '../../utils/config'; import {getConfig, NgDevConfig} from '../../utils/config';
import {error, info} from '../../utils/console';
import {getCurrentBranch, hasLocalChanges} from '../../utils/git'; import {getCurrentBranch, hasLocalChanges} from '../../utils/git';
import {getPendingPrs} from '../../utils/github'; import {getPendingPrs} from '../../utils/github';
import {exec} from '../../utils/shelljs'; import {exec} from '../../utils/shelljs';
@ -57,7 +58,7 @@ export async function discoverNewConflictsForPr(
// If there are any local changes in the current repository state, the // If there are any local changes in the current repository state, the
// check cannot run as it needs to move between branches. // check cannot run as it needs to move between branches.
if (hasLocalChanges()) { if (hasLocalChanges()) {
console.error('Cannot run with local changes. Please make sure there are no local changes.'); error('Cannot run with local changes. Please make sure there are no local changes.');
process.exit(1); process.exit(1);
} }
@ -68,15 +69,15 @@ export async function discoverNewConflictsForPr(
/* PRs which were found to be conflicting. */ /* PRs which were found to be conflicting. */
const conflicts: Array<PullRequest> = []; const conflicts: Array<PullRequest> = [];
console.info(`Requesting pending PRs from Github`); info(`Requesting pending PRs from Github`);
/** List of PRs from github currently known as mergable. */ /** List of PRs from github currently known as mergable. */
const allPendingPRs = (await getPendingPrs(PR_SCHEMA, config.github)).map(processPr); const allPendingPRs = (await getPendingPrs(PR_SCHEMA, config.github)).map(processPr);
/** The PR which is being checked against. */ /** The PR which is being checked against. */
const requestedPr = allPendingPRs.find(pr => pr.number === newPrNumber); const requestedPr = allPendingPRs.find(pr => pr.number === newPrNumber);
if (requestedPr === undefined) { if (requestedPr === undefined) {
console.error( error(
`The request PR, #${newPrNumber} was not found as a pending PR on github, please confirm`); `The request PR, #${newPrNumber} was not found as a pending PR on github, please confirm`);
console.error(`the PR number is correct and is an open PR`); error(`the PR number is correct and is an open PR`);
process.exit(1); process.exit(1);
} }
@ -89,8 +90,8 @@ export async function discoverNewConflictsForPr(
// PRs updated after the provided date // PRs updated after the provided date
pr.updatedAt >= updatedAfter); pr.updatedAt >= updatedAfter);
}); });
console.info(`Retrieved ${allPendingPRs.length} total pending PRs`); info(`Retrieved ${allPendingPRs.length} total pending PRs`);
console.info(`Checking ${pendingPrs.length} PRs for conflicts after a merge of #${newPrNumber}`); info(`Checking ${pendingPrs.length} PRs for conflicts after a merge of #${newPrNumber}`);
// Fetch and checkout the PR being checked. // Fetch and checkout the PR being checked.
exec(`git fetch ${requestedPr.headRef.repository.url} ${requestedPr.headRef.name}`); exec(`git fetch ${requestedPr.headRef.repository.url} ${requestedPr.headRef.name}`);
@ -100,7 +101,7 @@ export async function discoverNewConflictsForPr(
exec(`git fetch ${requestedPr.baseRef.repository.url} ${requestedPr.baseRef.name}`); exec(`git fetch ${requestedPr.baseRef.repository.url} ${requestedPr.baseRef.name}`);
const result = exec(`git rebase FETCH_HEAD`); const result = exec(`git rebase FETCH_HEAD`);
if (result.code) { if (result.code) {
console.error('The requested PR currently has conflicts'); error('The requested PR currently has conflicts');
cleanUpGitState(originalBranch); cleanUpGitState(originalBranch);
process.exit(1); process.exit(1);
} }
@ -125,21 +126,23 @@ export async function discoverNewConflictsForPr(
} }
// End the progress bar as all PRs have been processed. // End the progress bar as all PRs have been processed.
progressBar.stop(); progressBar.stop();
console.info(`\nResult:`); info();
info(`Result:`);
cleanUpGitState(originalBranch); cleanUpGitState(originalBranch);
// If no conflicts are found, exit successfully. // If no conflicts are found, exit successfully.
if (conflicts.length === 0) { if (conflicts.length === 0) {
console.info(`No new conflicting PRs found after #${newPrNumber} merging`); info(`No new conflicting PRs found after #${newPrNumber} merging`);
process.exit(0); process.exit(0);
} }
// Inform about discovered conflicts, exit with failure. // Inform about discovered conflicts, exit with failure.
console.error(`${conflicts.length} PR(s) which conflict(s) after #${newPrNumber} merges:`); error.group(`${conflicts.length} PR(s) which conflict(s) after #${newPrNumber} merges:`);
for (const pr of conflicts) { for (const pr of conflicts) {
console.error(` - ${pr.number}: ${pr.title}`); error(` - ${pr.number}: ${pr.title}`);
} }
error.groupEnd();
process.exit(1); process.exit(1);
} }