firebase-tools 9.20.0 → 9.21.0

package/lib/gcp/cloudscheduler.js

@@ -1,12 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.jobFromSpec = exports.createOrReplaceJob = exports.updateJob = exports.getJob = exports.deleteJob = exports.createJob = exports.assertValidJob = void 0;
+exports.jobFromEndpoint = exports.createOrReplaceJob = exports.updateJob = exports.getJob = exports.deleteJob = exports.createJob = exports.assertValidJob = void 0;
 const _ = require("lodash");
 const error_1 = require("../error");
 const logger_1 = require("../logger");
 const api = require("../api");
 const backend = require("../deploy/functions/backend");
 const proto = require("./proto");
+const functional_1 = require("../functional");
 const VERSION = "v1beta1";
 const DEFAULT_TIME_ZONE = "America/Los_Angeles";
 function assertValidJob(job) {
@@ -86,21 +87,26 @@ function isIdentical(job, otherJob) {
         job.timeZone === otherJob.timeZone &&
         _.isEqual(job.retryConfig, otherJob.retryConfig));
 }
-function jobFromSpec(schedule, appEngineLocation) {
-    const job = {
-        name: backend.scheduleName(schedule, appEngineLocation),
-        schedule: schedule.schedule,
-    };
-    proto.copyIfPresent(job, schedule, "timeZone", "retryConfig");
-    if (schedule.transport === "https") {
-        throw new error_1.FirebaseError("HTTPS transport for scheduled functions is not yet supported");
+function jobFromEndpoint(endpoint, appEngineLocation) {
+    const job = {};
+    if (endpoint.platform === "gcfv1") {
+        const id = backend.scheduleIdForFunction(endpoint);
+        const region = appEngineLocation;
+        job.name = `projects/${endpoint.project}/locations/${region}/jobs/${id}`;
+        job.pubsubTarget = {
+            topicName: `projects/${endpoint.project}/topics/${id}`,
+            attributes: {
+                scheduled: "true",
+            },
+        };
     }
-    job.pubsubTarget = {
-        topicName: backend.topicName(schedule),
-        attributes: {
-            scheduled: "true",
-        },
-    };
+    else if (endpoint.platform === "gcfv2") {
+        throw new error_1.FirebaseError("Do not know how to create a scheduled GCFv2 function");
+    }
+    else {
+        functional_1.assertExhaustive(endpoint.platform);
+    }
+    proto.copyIfPresent(job, endpoint.scheduleTrigger, "schedule", "retryConfig", "timeZone");
     return job;
 }
-exports.jobFromSpec = jobFromSpec;
+exports.jobFromEndpoint = jobFromEndpoint;

package/lib/gcp/pubsub.js

@@ -1,9 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.topicFromSpec = exports.deleteTopic = exports.updateTopic = exports.getTopic = exports.createTopic = void 0;
+exports.deleteTopic = exports.updateTopic = exports.getTopic = exports.createTopic = void 0;
 const apiv2_1 = require("../apiv2");
 const api_1 = require("../api");
-const backend = require("../deploy/functions/backend");
 const proto = require("./proto");
 const API_VERSION = "v1";
 const client = new apiv2_1.Client({
@@ -33,10 +32,3 @@ async function deleteTopic(name) {
     await client.delete(name);
 }
 exports.deleteTopic = deleteTopic;
-function topicFromSpec(spec) {
-    return {
-        name: backend.topicName(spec),
-        labels: Object.assign({}, spec.labels),
-    };
-}
-exports.topicFromSpec = topicFromSpec;

package/lib/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.assertIsStringOrUndefined = exports.assertIsNumber = exports.assertIsString = exports.assertDefined = exports.thirtyDaysFromNow = exports.isRunningInWSL = exports.isCloudEnvironment = exports.datetimeString = exports.createDestroyer = exports.promiseWithSpinner = exports.setupLoggers = exports.tryParse = exports.tryStringify = exports.promiseProps = exports.promiseWhile = exports.promiseAllSettled = exports.getFunctionsEventProvider = exports.endpoint = exports.makeActiveProject = exports.streamToString = exports.stringToStream = exports.explainStdin = exports.reject = exports.logLabeledWarning = exports.logWarning = exports.logLabeledBullet = exports.logBullet = exports.logLabeledSuccess = exports.logSuccess = exports.addSubdomain = exports.addDatabaseNamespace = exports.getDatabaseViewDataUrl = exports.getDatabaseUrl = exports.envOverride = exports.getInheritedOption = exports.consoleUrl = exports.envOverrides = void 0;
+exports.assertIsStringOrUndefined = exports.assertIsNumber = exports.assertIsString = exports.assertDefined = exports.thirtyDaysFromNow = exports.isRunningInWSL = exports.isCloudEnvironment = exports.datetimeString = exports.createDestroyer = exports.promiseWithSpinner = exports.setupLoggers = exports.tryParse = exports.tryStringify = exports.promiseProps = exports.promiseWhile = exports.promiseAllSettled = exports.getFunctionsEventProvider = exports.endpoint = exports.makeActiveProject = exports.streamToString = exports.stringToStream = exports.explainStdin = exports.allSettled = exports.reject = exports.logLabeledWarning = exports.logWarning = exports.logLabeledBullet = exports.logBullet = exports.logLabeledSuccess = exports.logSuccess = exports.addSubdomain = exports.addDatabaseNamespace = exports.getDatabaseViewDataUrl = exports.getDatabaseUrl = exports.envOverride = exports.getInheritedOption = exports.consoleUrl = exports.envOverrides = void 0;
 const _ = require("lodash");
 const url = require("url");
 const clc = require("cli-color");
@@ -108,6 +108,35 @@ function reject(message, options) {
     return Promise.reject(new error_1.FirebaseError(message, options));
 }
 exports.reject = reject;
+function allSettled(promises) {
+    if (!promises.length) {
+        return Promise.resolve([]);
+    }
+    return new Promise((resolve) => {
+        let remaining = promises.length;
+        const results = [];
+        for (let i = 0; i < promises.length; i++) {
+            void Promise.resolve(promises[i])
+                .then((result) => {
+                results[i] = {
+                    status: "fulfilled",
+                    value: result,
+                };
+            }, (err) => {
+                results[i] = {
+                    status: "rejected",
+                    reason: err,
+                };
+            })
+                .then(() => {
+                if (!--remaining) {
+                    resolve(results);
+                }
+            });
+        }
+    });
+}
+exports.allSettled = allSettled;
 function explainStdin() {
     if (IS_WINDOWS) {
         throw new error_1.FirebaseError("STDIN input is not available on Windows.", {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-tools",
-  "version": "9.20.0",
+  "version": "9.21.0",
   "description": "Command-Line Interface for Firebase",
   "main": "./lib/index.js",
   "bin": {

package/lib/deploy/functions/deploymentPlanner.js

@@ -1,113 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createDeploymentPlan = exports.calculateRegionalFunctionChanges = exports.allRegions = exports.functionsByRegion = void 0;
-const functionsDeployHelper_1 = require("./functionsDeployHelper");
-const validate_1 = require("./validate");
-const deploymentTool_1 = require("../../deploymentTool");
-const utils_1 = require("../../utils");
-const backend = require("./backend");
-const gcfv2 = require("../../gcp/cloudfunctionsv2");
-function functionsByRegion(allFunctions) {
-    const partitioned = {};
-    for (const fn of allFunctions) {
-        partitioned[fn.region] = partitioned[fn.region] || [];
-        partitioned[fn.region].push(fn);
-    }
-    return partitioned;
-}
-exports.functionsByRegion = functionsByRegion;
-function allRegions(spec, existing) {
-    return Object.keys(Object.assign(Object.assign({}, spec), existing));
-}
-exports.allRegions = allRegions;
-const matchesId = (hasId) => (test) => {
-    return hasId.id === test.id;
-};
-function calculateRegionalFunctionChanges(want, have, options) {
-    want = want.filter((fn) => functionsDeployHelper_1.functionMatchesAnyGroup(fn, options.filters));
-    have = have.filter((fn) => functionsDeployHelper_1.functionMatchesAnyGroup(fn, options.filters));
-    let upgradedToGCFv2WithoutSettingConcurrency = false;
-    const functionsToCreate = want.filter((fn) => !have.some(matchesId(fn)));
-    const functionsToUpdate = want
-        .filter((fn) => {
-        const haveFn = have.find(matchesId(fn));
-        if (!haveFn) {
-            return false;
-        }
-        validate_1.checkForInvalidChangeOfTrigger(fn, haveFn);
-        if (!options.overwriteEnvs) {
-            fn.environmentVariables = Object.assign(Object.assign({}, haveFn.environmentVariables), fn.environmentVariables);
-        }
-        if (haveFn.platform === "gcfv1" && fn.platform === "gcfv2" && !fn.concurrency) {
-            upgradedToGCFv2WithoutSettingConcurrency = true;
-        }
-        return true;
-    })
-        .map((fn) => {
-        const haveFn = have.find(matchesId(fn));
-        const deleteAndRecreate = needsDeleteAndRecreate(haveFn, fn);
-        return {
-            func: fn,
-            deleteAndRecreate,
-        };
-    });
-    const functionsToDelete = have
-        .filter((fn) => !want.some(matchesId(fn)))
-        .filter((fn) => deploymentTool_1.isFirebaseManaged(fn.labels || {}));
-    if (upgradedToGCFv2WithoutSettingConcurrency) {
-        utils_1.logLabeledBullet("functions", "You are updating one or more functions to Google Cloud Functions v2, " +
-            "which introduces support for concurrent execution. New functions " +
-            "default to 80 concurrent executions, but existing functions keep the " +
-            "old default of 1. You can change this with the 'concurrency' option.");
-    }
-    return { functionsToCreate, functionsToUpdate, functionsToDelete };
-}
-exports.calculateRegionalFunctionChanges = calculateRegionalFunctionChanges;
-function createDeploymentPlan(want, have, options) {
-    const deployment = {
-        regionalDeployments: {},
-        schedulesToUpsert: [],
-        schedulesToDelete: [],
-        topicsToDelete: [],
-    };
-    const wantRegionalFunctions = functionsByRegion(want.cloudFunctions);
-    const haveRegionalFunctions = functionsByRegion(have.cloudFunctions);
-    for (const region of allRegions(wantRegionalFunctions, haveRegionalFunctions)) {
-        const want = wantRegionalFunctions[region] || [];
-        const have = haveRegionalFunctions[region] || [];
-        deployment.regionalDeployments[region] = calculateRegionalFunctionChanges(want, have, options);
-    }
-    deployment.schedulesToUpsert = want.schedules.filter((schedule) => functionsDeployHelper_1.functionMatchesAnyGroup(schedule.targetService, options.filters));
-    deployment.schedulesToDelete = have.schedules
-        .filter((schedule) => !want.schedules.some(matchesId(schedule)))
-        .filter((schedule) => functionsDeployHelper_1.functionMatchesAnyGroup(schedule.targetService, options.filters));
-    deployment.topicsToDelete = have.topics
-        .filter((topic) => !want.topics.some(matchesId(topic)))
-        .filter((topic) => functionsDeployHelper_1.functionMatchesAnyGroup(topic.targetService, options.filters));
-    return deployment;
-}
-exports.createDeploymentPlan = createDeploymentPlan;
-function needsDeleteAndRecreate(exFn, fn) {
-    return changedV2PubSubTopic(exFn, fn);
-}
-function changedV2PubSubTopic(exFn, fn) {
-    if (exFn.platform !== "gcfv2") {
-        return false;
-    }
-    if (fn.platform !== "gcfv2") {
-        return false;
-    }
-    if (!backend.isEventTrigger(exFn.trigger)) {
-        return false;
-    }
-    if (!backend.isEventTrigger(fn.trigger)) {
-        return false;
-    }
-    if (exFn.trigger.eventType !== gcfv2.PUBSUB_PUBLISH_EVENT) {
-        return false;
-    }
-    if (fn.trigger.eventType != gcfv2.PUBSUB_PUBLISH_EVENT) {
-        return false;
-    }
-    return exFn.trigger.eventFilters["resource"] != fn.trigger.eventFilters["resource"];
-}

package/lib/deploy/functions/deploymentTimer.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DeploymentTimer = void 0;
-const logger_1 = require("../../logger");
-const track = require("../../track");
-class DeploymentTimer {
-    constructor() {
-        this.timings = {};
-    }
-    startTimer(name, type) {
-        this.timings[name] = { type: type, t0: process.hrtime() };
-    }
-    endTimer(name) {
-        if (!this.timings[name]) {
-            logger_1.logger.debug("[functions] no timer initialized for", name);
-            return 0;
-        }
-        const duration = process.hrtime(this.timings[name].t0);
-        track("Functions Deploy (Duration)", this.timings[name].type, duration[0] * 1000 + Math.round(duration[1] * 1e-6));
-        return duration[0] * 1000 * Math.round(duration[1] * 1e-6);
-    }
-}
-exports.DeploymentTimer = DeploymentTimer;

package/lib/deploy/functions/errorHandler.js

@@ -1,75 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ErrorHandler = void 0;
-const clc = require("cli-color");
-const logger_1 = require("../../logger");
-const functionsDeployHelper_1 = require("./functionsDeployHelper");
-const error_1 = require("../../error");
-class ErrorHandler {
-    constructor() {
-        this.errors = [];
-        this.warnings = [];
-    }
-    record(level, functionName, operationType, message) {
-        const info = {
-            functionName,
-            operationType,
-            message,
-        };
-        if (level === "error") {
-            this.errors.push(info);
-        }
-        else if (level === "warning") {
-            this.warnings.push(info);
-        }
-    }
-    printErrors() {
-        if (this.errors.length === 0) {
-            return;
-        }
-        logger_1.logger.info("");
-        logger_1.logger.info("Functions deploy had errors with the following functions:");
-        for (const failedDeployment of this.errors) {
-            logger_1.logger.info(`\t${functionsDeployHelper_1.getFunctionLabel(failedDeployment.functionName)}`);
-        }
-        const failedIamCalls = this.errors.filter((e) => e.operationType === "set invoker");
-        if (failedIamCalls.length) {
-            logger_1.logger.info("");
-            logger_1.logger.info("Unable to set the invoker for the IAM policy on the following functions:");
-            for (const failedDep of failedIamCalls) {
-                logger_1.logger.info(`\t${failedDep.functionName}`);
-            }
-            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.");
-        }
-        logger_1.logger.info("");
-        logger_1.logger.info("To try redeploying those functions, run:");
-        logger_1.logger.info("    " +
-            clc.bold("firebase deploy --only ") +
-            clc.bold('"') +
-            clc.bold(this.errors
-                .map((failedDeployment) => `functions:${functionsDeployHelper_1.getFunctionId(failedDeployment.functionName).replace(/-/g, ".")}`)
-                .join(",")) +
-            clc.bold('"'));
-        logger_1.logger.info("");
-        logger_1.logger.info("To continue deploying other features (such as database), run:");
-        logger_1.logger.info("    " + clc.bold("firebase deploy --except functions"));
-        for (const failedDeployment of this.errors) {
-            logger_1.logger.debug(`\tError during ${failedDeployment.operationType} for ${failedDeployment.functionName}: ${failedDeployment.message}`);
-        }
-        throw new error_1.FirebaseError("Functions did not deploy properly.");
-    }
-    printWarnings() {
-        if (this.warnings.length === 0) {
-            return;
-        }
-        for (const failedDeployment of this.warnings) {
-            logger_1.logger.debug(`\tWarning during${failedDeployment.operationType} for ${failedDeployment.functionName}: ${failedDeployment.message}`);
-        }
-    }
-}
-exports.ErrorHandler = ErrorHandler;

package/lib/deploy/functions/release.js

@@ -1,116 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.release = void 0;
-const queue_1 = require("../../throttler/queue");
-const deploymentPlanner_1 = require("./deploymentPlanner");
-const functionsConfig_1 = require("../../functionsConfig");
-const env_1 = require("../../functions/env");
-const prompts_1 = require("./prompts");
-const deploymentTimer_1 = require("./deploymentTimer");
-const errorHandler_1 = require("./errorHandler");
-const previews_1 = require("../../previews");
-const backend = require("./backend");
-const containerCleaner = require("./containerCleaner");
-const helper = require("./functionsDeployHelper");
-const tasks = require("./tasks");
-const utils = require("../../utils");
-const track_1 = require("../../track");
-async function release(context, options, payload) {
-    if (!options.config.has("functions")) {
-        return;
-    }
-    const projectId = context.projectId;
-    const sourceUrl = context.uploadUrl;
-    const functionsSource = options.config.get("functions.source");
-    const appEngineLocation = functionsConfig_1.getAppEngineLocation(context.firebaseConfig);
-    const timer = new deploymentTimer_1.DeploymentTimer();
-    const errorHandler = new errorHandler_1.ErrorHandler();
-    const fullDeployment = deploymentPlanner_1.createDeploymentPlan(payload.functions.backend, await backend.existingBackend(context), {
-        filters: context.filters,
-        overwriteEnvs: previews_1.previews.dotenv &&
-            env_1.hasUserEnvs({
-                functionsSource: options.config.path(functionsSource),
-                projectId,
-                projectAlias: options.projectAlias,
-            }),
-    });
-    const cloudFunctionsQueue = new queue_1.default({
-        retries: 30,
-        backoff: 20000,
-        concurrency: 40,
-        maxBackoff: 40000,
-        handler: tasks.functionsDeploymentHandler(timer, errorHandler),
-    });
-    const schedulerQueue = new queue_1.default({
-        handler: tasks.schedulerDeploymentHandler(errorHandler),
-    });
-    const pubSubQueue = new queue_1.default({
-        handler: tasks.schedulerDeploymentHandler(errorHandler),
-    });
-    const regionPromises = [];
-    const taskParams = {
-        projectId,
-        sourceUrl,
-        storage: context.storage,
-        errorHandler,
-    };
-    const allFnsToDelete = Object.values(fullDeployment.regionalDeployments).reduce((accum, region) => [...accum, ...region.functionsToDelete], []);
-    const shouldDeleteFunctions = await prompts_1.promptForFunctionDeletion(allFnsToDelete, options.force, options.nonInteractive);
-    if (!shouldDeleteFunctions) {
-        fullDeployment.schedulesToDelete = fullDeployment.schedulesToDelete.filter((schedule) => {
-            return !allFnsToDelete.find(backend.sameFunctionName(schedule.targetService));
-        });
-        fullDeployment.topicsToDelete = fullDeployment.topicsToDelete.filter((topic) => {
-            return !allFnsToDelete.find(backend.sameFunctionName(topic.targetService));
-        });
-        for (const regionalDeployment of Object.values(fullDeployment.regionalDeployments)) {
-            regionalDeployment.functionsToDelete = [];
-        }
-    }
-    for (const [region, deployment] of Object.entries(fullDeployment.regionalDeployments)) {
-        regionPromises.push(tasks.runRegionalFunctionDeployment(taskParams, region, deployment, cloudFunctionsQueue));
-    }
-    for (const schedule of fullDeployment.schedulesToUpsert) {
-        const task = tasks.upsertScheduleTask(taskParams, schedule, appEngineLocation);
-        void schedulerQueue.run(task);
-    }
-    for (const schedule of fullDeployment.schedulesToDelete) {
-        const task = tasks.deleteScheduleTask(taskParams, schedule, appEngineLocation);
-        void schedulerQueue.run(task);
-    }
-    for (const topic of fullDeployment.topicsToDelete) {
-        const task = tasks.deleteTopicTask(taskParams, topic);
-        void pubSubQueue.run(task);
-    }
-    const queuePromises = [cloudFunctionsQueue.wait(), schedulerQueue.wait(), pubSubQueue.wait()];
-    cloudFunctionsQueue.process();
-    schedulerQueue.process();
-    pubSubQueue.process();
-    schedulerQueue.close();
-    pubSubQueue.close();
-    await Promise.all(regionPromises);
-    cloudFunctionsQueue.close();
-    try {
-        await Promise.all(queuePromises);
-    }
-    catch (err) {
-        utils.reject("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.", {
-            original: err,
-        });
-    }
-    const functions = payload.functions.backend.cloudFunctions;
-    const gcfv1 = functions.find((fn) => fn.platform === "gcfv1");
-    const gcfv2 = functions.find((fn) => fn.platform === "gcfv2");
-    const tag = gcfv1 && gcfv2 ? "v1+v2" : gcfv1 ? "v1" : "v2";
-    track_1.track("functions_codebase_deploy", tag, functions.length);
-    helper.logAndTrackDeployStats(cloudFunctionsQueue, errorHandler);
-    await containerCleaner.cleanupBuildImages(payload.functions.backend.cloudFunctions);
-    await helper.printTriggerUrls(context, payload.functions.backend);
-    errorHandler.printWarnings();
-    errorHandler.printErrors();
-}
-exports.release = release;