735 lines
32 KiB
JavaScript
735 lines
32 KiB
JavaScript
'use strict';
|
|
|
|
var tslib = require('tslib');
|
|
var fs = require('fs');
|
|
var path = require('path');
|
|
var chalk = require('chalk');
|
|
require('inquirer');
|
|
var child_process = require('child_process');
|
|
var semver = require('semver');
|
|
var graphql = require('@octokit/graphql');
|
|
var Octokit = require('@octokit/rest');
|
|
var typedGraphqlify = require('typed-graphqlify');
|
|
var url = require('url');
|
|
|
|
/**
|
|
* @license
|
|
* Copyright Google LLC All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by an MIT-style license that can be
|
|
* found in the LICENSE file at https://angular.io/license
|
|
*/
|
|
/** Whether the current environment is in dry run mode. */
|
|
function isDryRun() {
|
|
return process.env['DRY_RUN'] !== undefined;
|
|
}
|
|
/** Error to be thrown when a function or method is called in dryRun mode and shouldn't be. */
|
|
var DryRunError = /** @class */ (function (_super) {
|
|
tslib.__extends(DryRunError, _super);
|
|
function DryRunError() {
|
|
var _this = _super.call(this, 'Cannot call this function in dryRun mode.') || this;
|
|
// Set the prototype explicitly because in ES5, the prototype is accidentally lost due to
|
|
// a limitation in down-leveling.
|
|
// https://github.com/Microsoft/TypeScript/wiki/FAQ#why-doesnt-extending-built-ins-like-error-array-and-map-work.
|
|
Object.setPrototypeOf(_this, DryRunError.prototype);
|
|
return _this;
|
|
}
|
|
return DryRunError;
|
|
}(Error));
|
|
|
|
/**
|
|
* @license
|
|
* Copyright Google LLC All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by an MIT-style license that can be
|
|
* found in the LICENSE file at https://angular.io/license
|
|
*/
|
|
/** Error for failed Github API requests. */
|
|
var GithubApiRequestError = /** @class */ (function (_super) {
|
|
tslib.__extends(GithubApiRequestError, _super);
|
|
function GithubApiRequestError(status, message) {
|
|
var _this = _super.call(this, message) || this;
|
|
_this.status = status;
|
|
return _this;
|
|
}
|
|
return GithubApiRequestError;
|
|
}(Error));
|
|
/** Error for failed Github API requests. */
|
|
var GithubGraphqlClientError = /** @class */ (function (_super) {
|
|
tslib.__extends(GithubGraphqlClientError, _super);
|
|
function GithubGraphqlClientError() {
|
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
}
|
|
return GithubGraphqlClientError;
|
|
}(Error));
|
|
/**
|
|
* A Github client for interacting with the Github APIs.
|
|
*
|
|
* Additionally, provides convenience methods for actions which require multiple requests, or
|
|
* would provide value from memoized style responses.
|
|
**/
|
|
var GithubClient = /** @class */ (function (_super) {
|
|
tslib.__extends(GithubClient, _super);
|
|
/**
|
|
* @param token The github authentication token for Github Rest and Graphql API requests.
|
|
*/
|
|
function GithubClient(token) {
|
|
var _this =
|
|
// Pass in authentication token to base Octokit class.
|
|
_super.call(this, { auth: token }) || this;
|
|
_this.token = token;
|
|
/** The current user based on checking against the Github API. */
|
|
_this._currentUser = null;
|
|
/** The graphql instance with authentication set during construction. */
|
|
_this._graphql = graphql.graphql.defaults({ headers: { authorization: "token " + _this.token } });
|
|
_this.hook.error('request', function (error) {
|
|
// Wrap API errors in a known error class. This allows us to
|
|
// expect Github API errors better and in a non-ambiguous way.
|
|
throw new GithubApiRequestError(error.status, error.message);
|
|
});
|
|
// Note: The prototype must be set explictly as Github's Octokit class is a non-standard class
|
|
// definition which adjusts the prototype chain.
|
|
// See:
|
|
// https://github.com/Microsoft/TypeScript/wiki/FAQ#why-doesnt-extending-built-ins-like-error-array-and-map-work
|
|
// https://github.com/octokit/rest.js/blob/7b51cee4a22b6e52adcdca011f93efdffa5df998/lib/constructor.js
|
|
Object.setPrototypeOf(_this, GithubClient.prototype);
|
|
return _this;
|
|
}
|
|
/** Perform a query using Github's Graphql API. */
|
|
GithubClient.prototype.graphql = function (queryObject, params) {
|
|
if (params === void 0) { params = {}; }
|
|
return tslib.__awaiter(this, void 0, void 0, function () {
|
|
return tslib.__generator(this, function (_a) {
|
|
switch (_a.label) {
|
|
case 0:
|
|
if (this.token === undefined) {
|
|
throw new GithubGraphqlClientError('Cannot query via graphql without an authentication token set, use the authenticated ' +
|
|
'`GitClient` by calling `GitClient.getAuthenticatedInstance()`.');
|
|
}
|
|
return [4 /*yield*/, this._graphql(typedGraphqlify.query(queryObject).toString(), params)];
|
|
case 1: return [2 /*return*/, (_a.sent())];
|
|
}
|
|
});
|
|
});
|
|
};
|
|
/** Retrieve the login of the current user from Github. */
|
|
GithubClient.prototype.getCurrentUser = function () {
|
|
return tslib.__awaiter(this, void 0, void 0, function () {
|
|
var result;
|
|
return tslib.__generator(this, function (_a) {
|
|
switch (_a.label) {
|
|
case 0:
|
|
// If the current user has already been retrieved return the current user value again.
|
|
if (this._currentUser !== null) {
|
|
return [2 /*return*/, this._currentUser];
|
|
}
|
|
return [4 /*yield*/, this.graphql({
|
|
viewer: {
|
|
login: typedGraphqlify.types.string,
|
|
}
|
|
})];
|
|
case 1:
|
|
result = _a.sent();
|
|
return [2 /*return*/, this._currentUser = result.viewer.login];
|
|
}
|
|
});
|
|
});
|
|
};
|
|
return GithubClient;
|
|
}(Octokit));
|
|
|
|
/**
|
|
* @license
|
|
* Copyright Google LLC All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by an MIT-style license that can be
|
|
* found in the LICENSE file at https://angular.io/license
|
|
*/
|
|
/** URL to the Github page where personal access tokens can be managed. */
|
|
var GITHUB_TOKEN_SETTINGS_URL = 'https://github.com/settings/tokens';
|
|
/** URL to the Github page where personal access tokens can be generated. */
|
|
var GITHUB_TOKEN_GENERATE_URL = 'https://github.com/settings/tokens/new';
|
|
/** Adds the provided token to the given Github HTTPs remote url. */
|
|
function addTokenToGitHttpsUrl(githubHttpsUrl, token) {
|
|
var url$1 = new url.URL(githubHttpsUrl);
|
|
url$1.username = token;
|
|
return url$1.href;
|
|
}
|
|
/** Gets the repository Git URL for the given github config. */
|
|
function getRepositoryGitUrl(config, githubToken) {
|
|
if (config.useSsh) {
|
|
return "git@github.com:" + config.owner + "/" + config.name + ".git";
|
|
}
|
|
var baseHttpUrl = "https://github.com/" + config.owner + "/" + config.name + ".git";
|
|
if (githubToken !== undefined) {
|
|
return addTokenToGitHttpsUrl(baseHttpUrl, githubToken);
|
|
}
|
|
return baseHttpUrl;
|
|
}
|
|
|
|
/**
|
|
* @license
|
|
* Copyright Google LLC All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by an MIT-style license that can be
|
|
* found in the LICENSE file at https://angular.io/license
|
|
*/
|
|
/** Error for failed Git commands. */
|
|
var GitCommandError = /** @class */ (function (_super) {
|
|
tslib.__extends(GitCommandError, _super);
|
|
function GitCommandError(client, args) {
|
|
var _this =
|
|
// Errors are not guaranteed to be caught. To ensure that we don't
|
|
// accidentally leak the Github token that might be used in a command,
|
|
// we sanitize the command that will be part of the error message.
|
|
_super.call(this, "Command failed: git " + client.omitGithubTokenFromMessage(args.join(' '))) || this;
|
|
_this.args = args;
|
|
return _this;
|
|
}
|
|
return GitCommandError;
|
|
}(Error));
|
|
/**
|
|
* Common client for performing Git interactions with a given remote.
|
|
*
|
|
* Takes in two optional arguments:
|
|
* `githubToken`: the token used for authentication in Github interactions, by default empty
|
|
* allowing readonly actions.
|
|
* `config`: The dev-infra configuration containing information about the remote. By default
|
|
* the dev-infra configuration is loaded with its Github configuration.
|
|
**/
|
|
var GitClient = /** @class */ (function () {
|
|
/**
|
|
* @param githubToken The github token used for authentication, if provided.
|
|
* @param _config The configuration, containing the github specific configuration.
|
|
* @param baseDir The full path to the root of the repository base.
|
|
*/
|
|
function GitClient(githubToken, config, baseDir) {
|
|
this.githubToken = githubToken;
|
|
/** Whether verbose logging of Git actions should be used. */
|
|
this.verboseLogging = true;
|
|
/** The OAuth scopes available for the provided Github token. */
|
|
this._cachedOauthScopes = null;
|
|
/**
|
|
* Regular expression that matches the provided Github token. Used for
|
|
* sanitizing the token from Git child process output.
|
|
*/
|
|
this._githubTokenRegex = null;
|
|
/** Instance of the Github octokit API. */
|
|
this.github = new GithubClient(this.githubToken);
|
|
this.baseDir = baseDir || this.determineBaseDir();
|
|
this.config = config || getConfig(this.baseDir);
|
|
this.remoteConfig = this.config.github;
|
|
this.remoteParams = { owner: this.remoteConfig.owner, repo: this.remoteConfig.name };
|
|
// If a token has been specified (and is not empty), pass it to the Octokit API and
|
|
// also create a regular expression that can be used for sanitizing Git command output
|
|
// so that it does not print the token accidentally.
|
|
if (typeof githubToken === 'string') {
|
|
this._githubTokenRegex = new RegExp(githubToken, 'g');
|
|
}
|
|
}
|
|
/**
|
|
* Static method to get the singleton instance of the unauthorized GitClient, creating it if it
|
|
* has not yet been created.
|
|
*/
|
|
GitClient.getInstance = function () {
|
|
if (!GitClient.unauthenticated) {
|
|
GitClient.unauthenticated = new GitClient(undefined);
|
|
}
|
|
return GitClient.unauthenticated;
|
|
};
|
|
/**
|
|
* Static method to get the singleton instance of the authenticated GitClient if it has been
|
|
* generated.
|
|
*/
|
|
GitClient.getAuthenticatedInstance = function () {
|
|
if (!GitClient.authenticated) {
|
|
throw Error('The authenticated GitClient has not yet been generated.');
|
|
}
|
|
return GitClient.authenticated;
|
|
};
|
|
/** Build the authenticated GitClient instance. */
|
|
GitClient.authenticateWithToken = function (token) {
|
|
if (GitClient.authenticated) {
|
|
throw Error('Cannot generate new authenticated GitClient after one has already been generated.');
|
|
}
|
|
GitClient.authenticated = new GitClient(token);
|
|
};
|
|
/** Set the verbose logging state of the GitClient instance. */
|
|
GitClient.prototype.setVerboseLoggingState = function (verbose) {
|
|
this.verboseLogging = verbose;
|
|
return this;
|
|
};
|
|
/** Executes the given git command. Throws if the command fails. */
|
|
GitClient.prototype.run = function (args, options) {
|
|
var result = this.runGraceful(args, options);
|
|
if (result.status !== 0) {
|
|
throw new GitCommandError(this, args);
|
|
}
|
|
// Omit `status` from the type so that it's obvious that the status is never
|
|
// non-zero as explained in the method description.
|
|
return result;
|
|
};
|
|
/**
|
|
* Spawns a given Git command process. Does not throw if the command fails. Additionally,
|
|
* if there is any stderr output, the output will be printed. This makes it easier to
|
|
* info failed commands.
|
|
*/
|
|
GitClient.prototype.runGraceful = function (args, options) {
|
|
if (options === void 0) { options = {}; }
|
|
/** The git command to be run. */
|
|
var gitCommand = args[0];
|
|
if (isDryRun() && gitCommand === 'push') {
|
|
debug("\"git push\" is not able to be run in dryRun mode.");
|
|
throw new DryRunError();
|
|
}
|
|
// To improve the debugging experience in case something fails, we print all executed Git
|
|
// commands to better understand the git actions occuring. Depending on the command being
|
|
// executed, this debugging information should be logged at different logging levels.
|
|
var printFn = (!this.verboseLogging || options.stdio === 'ignore') ? debug : info;
|
|
// Note that we do not want to print the token if it is contained in the command. It's common
|
|
// to share errors with others if the tool failed, and we do not want to leak tokens.
|
|
printFn('Executing: git', this.omitGithubTokenFromMessage(args.join(' ')));
|
|
var result = child_process.spawnSync('git', args, tslib.__assign(tslib.__assign({ cwd: this.baseDir, stdio: 'pipe' }, options), {
|
|
// Encoding is always `utf8` and not overridable. This ensures that this method
|
|
// always returns `string` as output instead of buffers.
|
|
encoding: 'utf8' }));
|
|
if (result.stderr !== null) {
|
|
// Git sometimes prints the command if it failed. This means that it could
|
|
// potentially leak the Github token used for accessing the remote. To avoid
|
|
// printing a token, we sanitize the string before printing the stderr output.
|
|
process.stderr.write(this.omitGithubTokenFromMessage(result.stderr));
|
|
}
|
|
return result;
|
|
};
|
|
/** Git URL that resolves to the configured repository. */
|
|
GitClient.prototype.getRepoGitUrl = function () {
|
|
return getRepositoryGitUrl(this.remoteConfig, this.githubToken);
|
|
};
|
|
/** Whether the given branch contains the specified SHA. */
|
|
GitClient.prototype.hasCommit = function (branchName, sha) {
|
|
return this.run(['branch', branchName, '--contains', sha]).stdout !== '';
|
|
};
|
|
/** Gets the currently checked out branch or revision. */
|
|
GitClient.prototype.getCurrentBranchOrRevision = function () {
|
|
var branchName = this.run(['rev-parse', '--abbrev-ref', 'HEAD']).stdout.trim();
|
|
// If no branch name could be resolved. i.e. `HEAD` has been returned, then Git
|
|
// is currently in a detached state. In those cases, we just want to return the
|
|
// currently checked out revision/SHA.
|
|
if (branchName === 'HEAD') {
|
|
return this.run(['rev-parse', 'HEAD']).stdout.trim();
|
|
}
|
|
return branchName;
|
|
};
|
|
/** Gets whether the current Git repository has uncommitted changes. */
|
|
GitClient.prototype.hasUncommittedChanges = function () {
|
|
return this.runGraceful(['diff-index', '--quiet', 'HEAD']).status !== 0;
|
|
};
|
|
/** Whether the repo has any local changes. */
|
|
GitClient.prototype.hasLocalChanges = function () {
|
|
return this.runGraceful(['diff-index', '--quiet', 'HEAD']).status !== 0;
|
|
};
|
|
/** Sanitizes a given message by omitting the provided Github token if present. */
|
|
GitClient.prototype.omitGithubTokenFromMessage = function (value) {
|
|
// If no token has been defined (i.e. no token regex), we just return the
|
|
// value as is. There is no secret value that needs to be omitted.
|
|
if (this._githubTokenRegex === null) {
|
|
return value;
|
|
}
|
|
return value.replace(this._githubTokenRegex, '<TOKEN>');
|
|
};
|
|
/**
|
|
* Checks out a requested branch or revision, optionally cleaning the state of the repository
|
|
* before attempting the checking. Returns a boolean indicating whether the branch or revision
|
|
* was cleanly checked out.
|
|
*/
|
|
GitClient.prototype.checkout = function (branchOrRevision, cleanState) {
|
|
if (cleanState) {
|
|
// Abort any outstanding ams.
|
|
this.runGraceful(['am', '--abort'], { stdio: 'ignore' });
|
|
// Abort any outstanding cherry-picks.
|
|
this.runGraceful(['cherry-pick', '--abort'], { stdio: 'ignore' });
|
|
// Abort any outstanding rebases.
|
|
this.runGraceful(['rebase', '--abort'], { stdio: 'ignore' });
|
|
// Clear any changes in the current repo.
|
|
this.runGraceful(['reset', '--hard'], { stdio: 'ignore' });
|
|
}
|
|
return this.runGraceful(['checkout', branchOrRevision], { stdio: 'ignore' }).status === 0;
|
|
};
|
|
/** Gets the latest git tag on the current branch that matches SemVer. */
|
|
GitClient.prototype.getLatestSemverTag = function () {
|
|
var semVerOptions = { loose: true };
|
|
var tags = this.runGraceful(['tag', '--sort=-committerdate', '--merged']).stdout.split('\n');
|
|
var latestTag = tags.find(function (tag) { return semver.parse(tag, semVerOptions); });
|
|
if (latestTag === undefined) {
|
|
throw new Error("Unable to find a SemVer matching tag on \"" + this.getCurrentBranchOrRevision() + "\"");
|
|
}
|
|
return new semver.SemVer(latestTag, semVerOptions);
|
|
};
|
|
/** Gets the path of the directory for the repository base. */
|
|
GitClient.prototype.getBaseDir = function () {
|
|
var previousVerboseLoggingState = this.verboseLogging;
|
|
this.setVerboseLoggingState(false);
|
|
var _a = this.runGraceful(['rev-parse', '--show-toplevel']), stdout = _a.stdout, stderr = _a.stderr, status = _a.status;
|
|
this.setVerboseLoggingState(previousVerboseLoggingState);
|
|
if (status !== 0) {
|
|
throw Error("Unable to find the path to the base directory of the repository.\n" +
|
|
"Was the command run from inside of the repo?\n\n" +
|
|
("ERROR:\n " + stderr));
|
|
}
|
|
return stdout.trim();
|
|
};
|
|
/** Retrieve a list of all files in the repostitory changed since the provided shaOrRef. */
|
|
GitClient.prototype.allChangesFilesSince = function (shaOrRef) {
|
|
if (shaOrRef === void 0) { shaOrRef = 'HEAD'; }
|
|
return Array.from(new Set(tslib.__spreadArray(tslib.__spreadArray([], tslib.__read(gitOutputAsArray(this.runGraceful(['diff', '--name-only', '--diff-filter=d', shaOrRef])))), tslib.__read(gitOutputAsArray(this.runGraceful(['ls-files', '--others', '--exclude-standard']))))));
|
|
};
|
|
/** Retrieve a list of all files currently staged in the repostitory. */
|
|
GitClient.prototype.allStagedFiles = function () {
|
|
return gitOutputAsArray(this.runGraceful(['diff', '--name-only', '--diff-filter=ACM', '--staged']));
|
|
};
|
|
/** Retrieve a list of all files tracked in the repostitory. */
|
|
GitClient.prototype.allFiles = function () {
|
|
return gitOutputAsArray(this.runGraceful(['ls-files']));
|
|
};
|
|
/**
|
|
* Assert the GitClient instance is using a token with permissions for the all of the
|
|
* provided OAuth scopes.
|
|
*/
|
|
GitClient.prototype.hasOauthScopes = function (testFn) {
|
|
return tslib.__awaiter(this, void 0, void 0, function () {
|
|
var scopes, missingScopes, error;
|
|
return tslib.__generator(this, function (_a) {
|
|
switch (_a.label) {
|
|
case 0: return [4 /*yield*/, this.getAuthScopesForToken()];
|
|
case 1:
|
|
scopes = _a.sent();
|
|
missingScopes = [];
|
|
// Test Github OAuth scopes and collect missing ones.
|
|
testFn(scopes, missingScopes);
|
|
// If no missing scopes are found, return true to indicate all OAuth Scopes are available.
|
|
if (missingScopes.length === 0) {
|
|
return [2 /*return*/, true];
|
|
}
|
|
error = "The provided <TOKEN> does not have required permissions due to missing scope(s): " +
|
|
(yellow(missingScopes.join(', ')) + "\n\n") +
|
|
"Update the token in use at:\n" +
|
|
(" " + GITHUB_TOKEN_SETTINGS_URL + "\n\n") +
|
|
("Alternatively, a new token can be created at: " + GITHUB_TOKEN_GENERATE_URL + "\n");
|
|
return [2 /*return*/, { error: error }];
|
|
}
|
|
});
|
|
});
|
|
};
|
|
/**
|
|
* Retrieve the OAuth scopes for the loaded Github token.
|
|
**/
|
|
GitClient.prototype.getAuthScopesForToken = function () {
|
|
// If the OAuth scopes have already been loaded, return the Promise containing them.
|
|
if (this._cachedOauthScopes !== null) {
|
|
return this._cachedOauthScopes;
|
|
}
|
|
// OAuth scopes are loaded via the /rate_limit endpoint to prevent
|
|
// usage of a request against that rate_limit for this lookup.
|
|
return this._cachedOauthScopes = this.github.rateLimit.get().then(function (_response) {
|
|
var response = _response;
|
|
var scopes = response.headers['x-oauth-scopes'] || '';
|
|
return scopes.split(',').map(function (scope) { return scope.trim(); });
|
|
});
|
|
};
|
|
GitClient.prototype.determineBaseDir = function () {
|
|
this.setVerboseLoggingState(false);
|
|
var _a = this.runGraceful(['rev-parse', '--show-toplevel']), stdout = _a.stdout, stderr = _a.stderr, status = _a.status;
|
|
if (status !== 0) {
|
|
throw Error("Unable to find the path to the base directory of the repository.\n" +
|
|
"Was the command run from inside of the repo?\n\n" +
|
|
("ERROR:\n " + stderr));
|
|
}
|
|
this.setVerboseLoggingState(true);
|
|
return stdout.trim();
|
|
};
|
|
return GitClient;
|
|
}());
|
|
/**
|
|
* Takes the output from `GitClient.run` and `GitClient.runGraceful` and returns an array of strings
|
|
* for each new line. Git commands typically return multiple output values for a command a set of
|
|
* strings separated by new lines.
|
|
*
|
|
* Note: This is specifically created as a locally available function for usage as convenience
|
|
* utility within `GitClient`'s methods to create outputs as array.
|
|
*/
|
|
function gitOutputAsArray(gitCommandResult) {
|
|
return gitCommandResult.stdout.split('\n').map(function (x) { return x.trim(); }).filter(function (x) { return !!x; });
|
|
}
|
|
|
|
/**
|
|
* @license
|
|
* Copyright Google LLC All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by an MIT-style license that can be
|
|
* found in the LICENSE file at https://angular.io/license
|
|
*/
|
|
var yellow = chalk.yellow;
|
|
/**
|
|
* Supported levels for logging functions.
|
|
*
|
|
* Levels are mapped to numbers to represent a hierarchy of logging levels.
|
|
*/
|
|
var LOG_LEVELS;
|
|
(function (LOG_LEVELS) {
|
|
LOG_LEVELS[LOG_LEVELS["SILENT"] = 0] = "SILENT";
|
|
LOG_LEVELS[LOG_LEVELS["ERROR"] = 1] = "ERROR";
|
|
LOG_LEVELS[LOG_LEVELS["WARN"] = 2] = "WARN";
|
|
LOG_LEVELS[LOG_LEVELS["LOG"] = 3] = "LOG";
|
|
LOG_LEVELS[LOG_LEVELS["INFO"] = 4] = "INFO";
|
|
LOG_LEVELS[LOG_LEVELS["DEBUG"] = 5] = "DEBUG";
|
|
})(LOG_LEVELS || (LOG_LEVELS = {}));
|
|
/** Default log level for the tool. */
|
|
var DEFAULT_LOG_LEVEL = LOG_LEVELS.INFO;
|
|
/** Write to the console for at INFO logging level */
|
|
var info = buildLogLevelFunction(function () { return console.info; }, LOG_LEVELS.INFO);
|
|
/** Write to the console for at ERROR logging level */
|
|
var error = buildLogLevelFunction(function () { return console.error; }, LOG_LEVELS.ERROR);
|
|
/** Write to the console for at DEBUG logging level */
|
|
var debug = buildLogLevelFunction(function () { return console.debug; }, LOG_LEVELS.DEBUG);
|
|
/** Write to the console for at LOG logging level */
|
|
// tslint:disable-next-line: no-console
|
|
var log = buildLogLevelFunction(function () { return console.log; }, LOG_LEVELS.LOG);
|
|
/** Write to the console for at WARN logging level */
|
|
var warn = buildLogLevelFunction(function () { return console.warn; }, LOG_LEVELS.WARN);
|
|
/** Build an instance of a logging function for the provided level. */
|
|
function buildLogLevelFunction(loadCommand, level) {
|
|
/** Write to stdout for the LOG_LEVEL. */
|
|
var loggingFunction = function () {
|
|
var text = [];
|
|
for (var _i = 0; _i < arguments.length; _i++) {
|
|
text[_i] = arguments[_i];
|
|
}
|
|
runConsoleCommand.apply(void 0, tslib.__spreadArray([loadCommand, level], tslib.__read(text)));
|
|
};
|
|
/** Start a group at the LOG_LEVEL, optionally starting it as collapsed. */
|
|
loggingFunction.group = function (text, collapsed) {
|
|
if (collapsed === void 0) { collapsed = false; }
|
|
var command = collapsed ? console.groupCollapsed : console.group;
|
|
runConsoleCommand(function () { return command; }, level, text);
|
|
};
|
|
/** End the group at the LOG_LEVEL. */
|
|
loggingFunction.groupEnd = function () {
|
|
runConsoleCommand(function () { return console.groupEnd; }, level);
|
|
};
|
|
return loggingFunction;
|
|
}
|
|
/**
|
|
* Run the console command provided, if the environments logging level greater than the
|
|
* provided logging level.
|
|
*
|
|
* The loadCommand takes in a function which is called to retrieve the console.* function
|
|
* to allow for jasmine spies to still work in testing. Without this method of retrieval
|
|
* the console.* function, the function is saved into the closure of the created logging
|
|
* function before jasmine can spy.
|
|
*/
|
|
function runConsoleCommand(loadCommand, logLevel) {
|
|
var text = [];
|
|
for (var _i = 2; _i < arguments.length; _i++) {
|
|
text[_i - 2] = arguments[_i];
|
|
}
|
|
if (getLogLevel() >= logLevel) {
|
|
loadCommand().apply(void 0, tslib.__spreadArray([], tslib.__read(text)));
|
|
}
|
|
printToLogFile.apply(void 0, tslib.__spreadArray([logLevel], tslib.__read(text)));
|
|
}
|
|
/**
|
|
* Retrieve the log level from environment variables, if the value found
|
|
* based on the LOG_LEVEL environment variable is undefined, return the default
|
|
* logging level.
|
|
*/
|
|
function getLogLevel() {
|
|
var logLevelEnvValue = (process.env["LOG_LEVEL"] || '').toUpperCase();
|
|
var logLevel = LOG_LEVELS[logLevelEnvValue];
|
|
if (logLevel === undefined) {
|
|
return DEFAULT_LOG_LEVEL;
|
|
}
|
|
return logLevel;
|
|
}
|
|
/**
|
|
* The number of columns used in the prepended log level information on each line of the logging
|
|
* output file.
|
|
*/
|
|
var LOG_LEVEL_COLUMNS = 7;
|
|
/** Write the provided text to the log file, prepending each line with the log level. */
|
|
function printToLogFile(logLevel) {
|
|
var text = [];
|
|
for (var _i = 1; _i < arguments.length; _i++) {
|
|
text[_i - 1] = arguments[_i];
|
|
}
|
|
var logLevelText = (LOG_LEVELS[logLevel] + ":").padEnd(LOG_LEVEL_COLUMNS);
|
|
}
|
|
|
|
/**
|
|
* @license
|
|
* Copyright Google LLC All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by an MIT-style license that can be
|
|
* found in the LICENSE file at https://angular.io/license
|
|
*/
|
|
/** Whether ts-node has been installed and is available to ng-dev. */
|
|
function isTsNodeAvailable() {
|
|
try {
|
|
require.resolve('ts-node');
|
|
return true;
|
|
}
|
|
catch (_a) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @license
|
|
* Copyright Google LLC All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by an MIT-style license that can be
|
|
* found in the LICENSE file at https://angular.io/license
|
|
*/
|
|
/**
|
|
* The filename expected for creating the ng-dev config, without the file
|
|
* extension to allow either a typescript or javascript file to be used.
|
|
*/
|
|
var CONFIG_FILE_PATH = '.ng-dev/config';
|
|
/** The configuration for ng-dev. */
|
|
var cachedConfig = null;
|
|
function getConfig(baseDir) {
|
|
// If the global config is not defined, load it from the file system.
|
|
if (cachedConfig === null) {
|
|
baseDir = baseDir || GitClient.getInstance().getBaseDir();
|
|
// The full path to the configuration file.
|
|
var configPath = path.join(baseDir, CONFIG_FILE_PATH);
|
|
// Read the configuration and validate it before caching it for the future.
|
|
cachedConfig = validateCommonConfig(readConfigFile(configPath));
|
|
}
|
|
// Return a clone of the cached global config to ensure that a new instance of the config
|
|
// is returned each time, preventing unexpected effects of modifications to the config object.
|
|
return tslib.__assign({}, cachedConfig);
|
|
}
|
|
/** Validate the common configuration has been met for the ng-dev command. */
|
|
function validateCommonConfig(config) {
|
|
var errors = [];
|
|
// Validate the github configuration.
|
|
if (config.github === undefined) {
|
|
errors.push("Github repository not configured. Set the \"github\" option.");
|
|
}
|
|
else {
|
|
if (config.github.name === undefined) {
|
|
errors.push("\"github.name\" is not defined");
|
|
}
|
|
if (config.github.owner === undefined) {
|
|
errors.push("\"github.owner\" is not defined");
|
|
}
|
|
}
|
|
assertNoErrors(errors);
|
|
return config;
|
|
}
|
|
/**
|
|
* Resolves and reads the specified configuration file, optionally returning an empty object if the
|
|
* configuration file cannot be read.
|
|
*/
|
|
function readConfigFile(configPath, returnEmptyObjectOnError) {
|
|
if (returnEmptyObjectOnError === void 0) { returnEmptyObjectOnError = false; }
|
|
// If the `.ts` extension has not been set up already, and a TypeScript based
|
|
// version of the given configuration seems to exist, set up `ts-node` if available.
|
|
if (require.extensions['.ts'] === undefined && fs.existsSync(configPath + ".ts") &&
|
|
isTsNodeAvailable()) {
|
|
// Ensure the module target is set to `commonjs`. This is necessary because the
|
|
// dev-infra tool runs in NodeJS which does not support ES modules by default.
|
|
// Additionally, set the `dir` option to the directory that contains the configuration
|
|
// file. This allows for custom compiler options (such as `--strict`).
|
|
require('ts-node').register({ dir: path.dirname(configPath), transpileOnly: true, compilerOptions: { module: 'commonjs' } });
|
|
}
|
|
try {
|
|
return require(configPath);
|
|
}
|
|
catch (e) {
|
|
if (returnEmptyObjectOnError) {
|
|
debug("Could not read configuration file at " + configPath + ", returning empty object instead.");
|
|
debug(e);
|
|
return {};
|
|
}
|
|
error("Could not read configuration file at " + configPath + ".");
|
|
error(e);
|
|
process.exit(1);
|
|
}
|
|
}
|
|
/**
|
|
* Asserts the provided array of error messages is empty. If any errors are in the array,
|
|
* logs the errors and exit the process as a failure.
|
|
*/
|
|
function assertNoErrors(errors) {
|
|
var e_1, _a;
|
|
if (errors.length == 0) {
|
|
return;
|
|
}
|
|
error("Errors discovered while loading configuration file:");
|
|
try {
|
|
for (var errors_1 = tslib.__values(errors), errors_1_1 = errors_1.next(); !errors_1_1.done; errors_1_1 = errors_1.next()) {
|
|
var err = errors_1_1.value;
|
|
error(" - " + err);
|
|
}
|
|
}
|
|
catch (e_1_1) { e_1 = { error: e_1_1 }; }
|
|
finally {
|
|
try {
|
|
if (errors_1_1 && !errors_1_1.done && (_a = errors_1.return)) _a.call(errors_1);
|
|
}
|
|
finally { if (e_1) throw e_1.error; }
|
|
}
|
|
process.exit(1);
|
|
}
|
|
|
|
/**
|
|
* @license
|
|
* Copyright Google LLC All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by an MIT-style license that can be
|
|
* found in the LICENSE file at https://angular.io/license
|
|
*/
|
|
/** Retrieve and validate the config as `ReleaseConfig`. */
|
|
function getReleaseConfig(config = getConfig()) {
|
|
var _a, _b, _c;
|
|
// List of errors encountered validating the config.
|
|
const errors = [];
|
|
if (config.release === undefined) {
|
|
errors.push(`No configuration defined for "release"`);
|
|
}
|
|
if (((_a = config.release) === null || _a === void 0 ? void 0 : _a.npmPackages) === undefined) {
|
|
errors.push(`No "npmPackages" configured for releasing.`);
|
|
}
|
|
if (((_b = config.release) === null || _b === void 0 ? void 0 : _b.buildPackages) === undefined) {
|
|
errors.push(`No "buildPackages" function configured for releasing.`);
|
|
}
|
|
if (((_c = config.release) === null || _c === void 0 ? void 0 : _c.generateReleaseNotesForHead) === undefined) {
|
|
errors.push(`No "generateReleaseNotesForHead" function configured for releasing.`);
|
|
}
|
|
assertNoErrors(errors);
|
|
return config.release;
|
|
}
|
|
|
|
/**
|
|
* @license
|
|
* Copyright Google LLC All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by an MIT-style license that can be
|
|
* found in the LICENSE file at https://angular.io/license
|
|
*/
|
|
// Start the release package building.
|
|
main();
|
|
/** Main function for building the release packages. */
|
|
function main() {
|
|
return tslib.__awaiter(this, void 0, void 0, function* () {
|
|
if (process.send === undefined) {
|
|
throw Error('This script needs to be invoked as a NodeJS worker.');
|
|
}
|
|
const config = getReleaseConfig();
|
|
const builtPackages = yield config.buildPackages();
|
|
// Transfer the built packages back to the parent process.
|
|
process.send(builtPackages);
|
|
});
|
|
}
|