firebase-tools
Version:
Command-Line Interface for Firebase
198 lines (197 loc) • 8.7 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.AbortedDeploymentError = exports.DeploymentError = void 0;
exports.logAndTrackDeployStats = logAndTrackDeployStats;
exports.printErrors = printErrors;
exports.printAbortedErrors = printAbortedErrors;
exports.triggerTag = triggerTag;
const backend = require("../backend");
const clc = require("colorette");
const logger_1 = require("../../../logger");
const track_1 = require("../../../track");
const utils = require("../../../utils");
const functionsDeployHelper_1 = require("../functionsDeployHelper");
class DeploymentError extends Error {
constructor(endpoint, op, original) {
super(`Failed to ${op} function ${endpoint.id} in region ${endpoint.region}`);
this.endpoint = endpoint;
this.op = op;
this.original = original;
}
}
exports.DeploymentError = DeploymentError;
class AbortedDeploymentError extends DeploymentError {
constructor(endpoint) {
super(endpoint, "delete", new Error("aborted"));
this.endpoint = endpoint;
}
}
exports.AbortedDeploymentError = AbortedDeploymentError;
async function logAndTrackDeployStats(summary, context) {
let totalTime = 0;
let totalErrors = 0;
let totalSuccesses = 0;
let totalAborts = 0;
const reports = [];
const regions = new Set();
const codebases = new Set();
for (const result of summary.results) {
const fnDeployEvent = {
platform: result.endpoint.platform,
trigger_type: backend.endpointTriggerType(result.endpoint),
region: result.endpoint.region,
runtime: result.endpoint.runtime,
status: !result.error
? "success"
: result.error instanceof AbortedDeploymentError
? "aborted"
: "failure",
duration: result.durationMs,
};
reports.push((0, track_1.trackGA4)("function_deploy", fnDeployEvent));
regions.add(result.endpoint.region);
codebases.add(result.endpoint.codebase || "default");
totalTime += result.durationMs;
if (!result.error) {
totalSuccesses++;
if (context?.codebaseDeployEvents?.[result.endpoint.codebase || "default"] !== undefined) {
context.codebaseDeployEvents[result.endpoint.codebase || "default"]
.fn_deploy_num_successes++;
}
}
else if (result.error instanceof AbortedDeploymentError) {
totalAborts++;
if (context?.codebaseDeployEvents?.[result.endpoint.codebase || "default"] !== undefined) {
context.codebaseDeployEvents[result.endpoint.codebase || "default"]
.fn_deploy_num_canceled++;
}
}
else {
totalErrors++;
if (context?.codebaseDeployEvents?.[result.endpoint.codebase || "default"] !== undefined) {
context.codebaseDeployEvents[result.endpoint.codebase || "default"]
.fn_deploy_num_failures++;
}
}
}
for (const codebase of codebases) {
if (context?.codebaseDeployEvents) {
reports.push((0, track_1.trackGA4)("codebase_deploy", { ...context.codebaseDeployEvents[codebase] }));
}
}
const fnDeployGroupEvent = {
codebase_deploy_count: codebases.size >= 5 ? "5+" : codebases.size.toString(),
fn_deploy_num_successes: totalSuccesses,
fn_deploy_num_canceled: totalAborts,
fn_deploy_num_failures: totalErrors,
has_runtime_config: String(!!context?.hasRuntimeConfig),
};
reports.push((0, track_1.trackGA4)("function_deploy_group", fnDeployGroupEvent));
const avgTime = totalTime / (totalSuccesses + totalErrors);
logger_1.logger.debug(`Total Function Deployment time: ${summary.totalTime}`);
logger_1.logger.debug(`${totalErrors + totalSuccesses + totalAborts} Functions Deployed`);
logger_1.logger.debug(`${totalErrors} Functions Errored`);
logger_1.logger.debug(`${totalAborts} Function Deployments Aborted`);
logger_1.logger.debug(`Average Function Deployment time: ${avgTime}`);
await utils.allSettled(reports);
}
function printErrors(summary) {
const errored = summary.results.filter((r) => r.error);
if (errored.length === 0) {
return;
}
errored.sort((left, right) => backend.compareFunctions(left.endpoint, right.endpoint));
logger_1.logger.info("");
logger_1.logger.info("Functions deploy had errors with the following functions:" +
errored
.filter((r) => !(r.error instanceof AbortedDeploymentError))
.map((result) => `\n\t${(0, functionsDeployHelper_1.getFunctionLabel)(result.endpoint)}`)
.join(""));
printIamErrors(errored);
printQuotaErrors(errored);
printAbortedErrors(errored);
}
function printIamErrors(results) {
const iamFailures = results.filter((r) => r.error instanceof DeploymentError && r.error.op === "set invoker");
if (!iamFailures.length) {
return;
}
logger_1.logger.info("");
logger_1.logger.info("Unable to set the invoker for the IAM policy on the following functions:" +
iamFailures.map((result) => `\n\t${(0, functionsDeployHelper_1.getFunctionLabel)(result.endpoint)}`).join(""));
logger_1.logger.info("");
logger_1.logger.info("Some common causes of this:");
logger_1.logger.info("");
logger_1.logger.info("- You may not have the roles/functions.admin IAM role. Note that " +
"roles/functions.developer does not allow you to change IAM policies.");
logger_1.logger.info("");
logger_1.logger.info("- An organization policy that restricts Network Access on your project.");
const hadImplicitMakePublic = iamFailures.find((r) => backend.isHttpsTriggered(r.endpoint) && !r.endpoint.httpsTrigger.invoker);
if (!hadImplicitMakePublic) {
return;
}
logger_1.logger.info("");
logger_1.logger.info("One or more functions were being implicitly made publicly available on function create.");
logger_1.logger.info("Functions are not implicitly made public on updates. To try to make " +
"these functions public on next deploy, configure these functions with " +
`${clc.bold("invoker")} set to ${clc.bold(`"public"`)}`);
}
function printQuotaErrors(results) {
const hadQuotaError = results.find((r) => {
if (!(r.error instanceof DeploymentError)) {
return false;
}
const original = r.error.original;
const code = original?.status ||
original?.code ||
original?.context?.response?.statusCode ||
original?.original?.code ||
original?.original?.context?.response?.statusCode;
return code === 429 || code === 409;
});
if (!hadQuotaError) {
return;
}
logger_1.logger.info("");
logger_1.logger.info("Exceeded maximum retries while deploying functions. " +
"If you are deploying a large number of functions, " +
"please deploy your functions in batches by using the --only flag, " +
"and wait a few minutes before deploying again. " +
"Go to https://firebase.google.com/docs/cli/#partial_deploys to learn more.");
}
function printAbortedErrors(results) {
const aborted = results.filter((r) => r.error instanceof AbortedDeploymentError);
if (!aborted.length) {
return;
}
logger_1.logger.info("");
logger_1.logger.info("Because there were errors creating or updating functions, the following " +
"functions were not deleted" +
aborted.map((result) => `\n\t${(0, functionsDeployHelper_1.getFunctionLabel)(result.endpoint)}`).join(""));
logger_1.logger.info(`To delete these, use ${clc.bold("firebase functions:delete")}`);
}
function triggerTag(endpoint) {
const prefix = endpoint.platform === "gcfv1" ? "v1" : "v2";
if (backend.isScheduleTriggered(endpoint)) {
return `${prefix}.scheduled`;
}
if (backend.isTaskQueueTriggered(endpoint)) {
return `${prefix}.taskQueue`;
}
if (backend.isCallableTriggered(endpoint)) {
return `${prefix}.callable`;
}
if (backend.isHttpsTriggered(endpoint)) {
if (endpoint.labels?.["deployment-callable"]) {
return `${prefix}.callable`;
}
return `${prefix}.https`;
}
if (backend.isDataConnectGraphqlTriggered(endpoint)) {
return `${prefix}.dataConnectGraphql`;
}
if (backend.isBlockingTriggered(endpoint)) {
return `${prefix}.blocking`;
}
return endpoint.eventTrigger.eventType;
}