cc6f36a9d7
Previously, Travis pushed the build artitfacts to the preview server. This required us to use JWT to secure the POST request from Travis, to ensure we couldn't receive malicious builds. JWT has been deprecated and we are moving our builds to CircleCI. This commit rewrites the TypeScript part of the preview server that handles converting build artifact into hosted previews of the docs.
47 lines
1.8 KiB
TypeScript
47 lines
1.8 KiB
TypeScript
import {GithubPullRequests, PullRequest} from '../common/github-pull-requests';
|
|
import {GithubTeams} from '../common/github-teams';
|
|
import {assertNotMissingOrEmpty} from '../common/utils';
|
|
|
|
/**
|
|
* A helper to verify whether builds are trusted.
|
|
*/
|
|
export class BuildVerifier {
|
|
/**
|
|
* Construct a new BuildVerifier instance.
|
|
* @param prs A helper to access PR information.
|
|
* @param teams A helper to access Github team information.
|
|
* @param allowedTeamSlugs The teams that are trusted.
|
|
* @param trustedPrLabel The github label that indicates that a PR is trusted.
|
|
*/
|
|
constructor(protected prs: GithubPullRequests, protected teams: GithubTeams,
|
|
protected allowedTeamSlugs: string[], protected trustedPrLabel: string) {
|
|
assertNotMissingOrEmpty('allowedTeamSlugs', allowedTeamSlugs && allowedTeamSlugs.join(''));
|
|
assertNotMissingOrEmpty('trustedPrLabel', trustedPrLabel);
|
|
}
|
|
|
|
/**
|
|
* Check whether a PR contains files that are significant to the build.
|
|
* @param pr The number of the PR to check
|
|
* @param significantFilePattern A regex that selects files that are significant.
|
|
*/
|
|
public async getSignificantFilesChanged(pr: number, significantFilePattern: RegExp) {
|
|
const files = await this.prs.fetchFiles(pr);
|
|
return files.some(file => significantFilePattern.test(file.filename));
|
|
}
|
|
|
|
/**
|
|
* Check whether a PR is trusted.
|
|
* @param pr The number of the PR to check.
|
|
* @returns true if the PR is trusted.
|
|
*/
|
|
public async getPrIsTrusted(pr: number): Promise<boolean> {
|
|
const prInfo = await this.prs.fetch(pr);
|
|
return this.hasLabel(prInfo, this.trustedPrLabel) ||
|
|
(await this.teams.isMemberBySlug(prInfo.user.login, this.allowedTeamSlugs));
|
|
}
|
|
|
|
protected hasLabel(prInfo: PullRequest, label: string) {
|
|
return prInfo.labels.some(labelObj => labelObj.name === label);
|
|
}
|
|
}
|