firebase-tools 10.7.2 → 10.8.0

package/lib/commands/ext-configure.js

@@ -19,6 +19,7 @@ const refs = require("../extensions/refs");
 const manifest = require("../extensions/manifest");
 const functional_1 = require("../functional");
 const paramHelper_1 = require("../extensions/paramHelper");
+const askUserForEventsConfig = require("../extensions/askUserForEventsConfig");
 marked.setOptions({
     renderer: new TerminalRenderer(),
 });
@@ -67,6 +68,15 @@ exports.default = new command_1.Command("ext:configure <extensionInstanceId>")
             instanceId,
             reconfiguring: true,
         });
+        const eventsConfig = spec.events
+            ? await askUserForEventsConfig.askForEventsConfig(spec.events, "${param:PROJECT_ID}", instanceId)
+            : undefined;
+        if (eventsConfig) {
+            mutableParamsBindingOptions.EVENTARC_CHANNEL = { baseValue: eventsConfig.channel };
+            mutableParamsBindingOptions.ALLOWED_EVENT_TYPES = {
+                baseValue: eventsConfig.allowedEventTypes.join(","),
+            };
+        }
         const newParamOptions = Object.assign(Object.assign({}, (0, paramHelper_1.buildBindingOptionsWithBaseValue)(oldParamValues)), mutableParamsBindingOptions);
         await manifest.writeToManifest([
             {
@@ -83,20 +93,12 @@ exports.default = new command_1.Command("ext:configure <extensionInstanceId>")
         manifest.showPreviewWarning();
         return;
     }
+    if (!projectId) {
+        throw new error_1.FirebaseError(`Project ID must be provided when re-configuring an instance outside of local mode.`);
+    }
     const spinner = ora(`Configuring ${clc.bold(instanceId)}. This usually takes 3 to 5 minutes...`);
     try {
-        let existingInstance;
-        try {
-            existingInstance = await extensionsApi.getInstance((0, projectUtils_1.needProjectId)({ projectId }), instanceId);
-        }
-        catch (err) {
-            if (err.status === 404) {
-                return utils.reject(`No extension instance ${instanceId} found in project ${projectId}.`, {
-                    exit: 1,
-                });
-            }
-            throw err;
-        }
+        const existingInstance = await extensionsApi.getInstance((0, projectUtils_1.needProjectId)({ projectId }), instanceId);
         const paramSpecWithNewDefaults = paramHelper.getParamsWithCurrentValuesAsDefaults(existingInstance);
         const immutableParams = _.remove(paramSpecWithNewDefaults, (param) => param.immutable);
         const paramBindingOptions = await paramHelper.getParams({
@@ -121,12 +123,21 @@ exports.default = new command_1.Command("ext:configure <extensionInstanceId>")
                 : "To set a different value for this param") +
                 ", uninstall the extension, then install a new instance of this extension.");
         }
+        const pId = (0, projectUtils_1.needProjectId)({ projectId });
+        const spec = existingInstance ? existingInstance.config.source.spec : undefined;
+        const eventsConfig = spec.events
+            ? await askUserForEventsConfig.askForEventsConfig(spec.events, pId, instanceId)
+            : undefined;
         spinner.start();
-        const res = await extensionsApi.configureInstance({
-            projectId: (0, projectUtils_1.needProjectId)({ projectId }),
+        const configureOptions = {
+            projectId: pId,
             instanceId,
             params: paramBindings,
-        });
+            canEmitEvents: eventsConfig ? true : false,
+            eventarcChannel: eventsConfig === null || eventsConfig === void 0 ? void 0 : eventsConfig.channel,
+            allowedEventTypes: eventsConfig === null || eventsConfig === void 0 ? void 0 : eventsConfig.allowedEventTypes,
+        };
+        const res = await extensionsApi.configureInstance(configureOptions);
         spinner.stop();
         utils.logLabeledSuccess(extensionsHelper_1.logPrefix, `successfully configured ${clc.bold(instanceId)}.`);
         utils.logLabeledBullet(extensionsHelper_1.logPrefix, marked(`You can view your reconfigured instance in the Firebase console: ${utils.consoleUrl((0, projectUtils_1.needProjectId)({ projectId }), `/extensions/instances/${instanceId}?tab=config`)}`));

package/lib/commands/ext-export.js

@@ -43,11 +43,20 @@ module.exports = new command_1.Command("ext:export")
         logger_1.logger.info("Exiting. No changes made.");
         return;
     }
-    const manifestSpecs = withRef.map((spec) => ({
-        instanceId: spec.instanceId,
-        ref: spec.ref,
-        params: (0, paramHelper_1.buildBindingOptionsWithBaseValue)(spec.params),
-    }));
+    const manifestSpecs = withRefSubbed.map((spec) => {
+        const paramCopy = Object.assign({}, spec.params);
+        if (spec.eventarcChannel) {
+            paramCopy.EVENTARC_CHANNEL = spec.eventarcChannel;
+        }
+        if (spec.allowedEventTypes) {
+            paramCopy.ALLOWED_EVENT_TYPES = spec.allowedEventTypes.join(",");
+        }
+        return {
+            instanceId: spec.instanceId,
+            ref: spec.ref,
+            params: (0, paramHelper_1.buildBindingOptionsWithBaseValue)(paramCopy),
+        };
+    });
     const existingConfig = manifest.loadConfig(options);
     await manifest.writeToManifest(manifestSpecs, existingConfig, {
         nonInteractive: options.nonInteractive,

package/lib/commands/ext-install.js

@@ -6,6 +6,7 @@ const ora = require("ora");
 const TerminalRenderer = require("marked-terminal");
 const askUserForConsent = require("../extensions/askUserForConsent");
 const displayExtensionInfo_1 = require("../extensions/displayExtensionInfo");
+const askUserForEventsConfig = require("../extensions/askUserForEventsConfig");
 const billingMigrationHelper_1 = require("../extensions/billingMigrationHelper");
 const checkProjectBilling_1 = require("../extensions/checkProjectBilling");
 const cloudbilling_1 = require("../gcp/cloudbilling");
@@ -166,6 +167,15 @@ async function installToManifest(options) {
         paramsEnvPath,
         instanceId,
     });
+    const eventsConfig = spec.events
+        ? await askUserForEventsConfig.askForEventsConfig(spec.events, "${param:PROJECT_ID}", instanceId)
+        : undefined;
+    if (eventsConfig) {
+        paramBindingOptions.EVENTARC_CHANNEL = { baseValue: eventsConfig.channel };
+        paramBindingOptions.ALLOWED_EVENT_TYPES = {
+            baseValue: eventsConfig.allowedEventTypes.join(","),
+        };
+    }
     const ref = extVersion ? refs.parse(extVersion.ref) : undefined;
     await manifest.writeToManifest([
         {
@@ -210,6 +220,12 @@ async function installExtension(options) {
                 reason: `To access and manage secrets which are used by this extension. By using this product you agree to the terms and conditions of the following license: https://console.cloud.google.com/tos?id=cloud&project=${projectId}`,
             });
         }
+        if (spec.events && spec.events.length > 0) {
+            apis.push({
+                apiName: "eventarc.googleapis.com",
+                reason: `When events are enabled, the Eventarc API is required to provision an event channel and publish events.`,
+            });
+        }
         if (apis.length) {
             askUserForConsent.displayApis(spec.displayName || spec.name, projectId, apis);
             const consented = await (0, extensionsHelper_1.confirm)({ nonInteractive, force, default: true });
@@ -248,6 +264,7 @@ async function installExtension(options) {
         }
         let paramBindingOptions;
         let paramBindings;
+        let eventsConfig;
         switch (choice) {
             case "installNew":
                 instanceId = await (0, extensionsHelper_1.promptForValidInstanceId)(`${instanceId}-${(0, utils_1.getRandomString)(4)}`);
@@ -258,6 +275,9 @@ async function installExtension(options) {
                     paramsEnvPath,
                     instanceId,
                 });
+                eventsConfig = spec.events
+                    ? await askUserForEventsConfig.askForEventsConfig(spec.events, projectId, instanceId)
+                    : undefined;
                 paramBindings = (0, paramHelper_1.getBaseParamBindings)(paramBindingOptions);
                 spinner.text = "Installing your extension instance. This usually takes 3 to 5 minutes...";
                 spinner.start();
@@ -267,6 +287,8 @@ async function installExtension(options) {
                     extensionSource: source,
                     extensionVersionRef: extVersion === null || extVersion === void 0 ? void 0 : extVersion.ref,
                     params: paramBindings,
+                    allowedEventTypes: eventsConfig === null || eventsConfig === void 0 ? void 0 : eventsConfig.allowedEventTypes,
+                    eventarcChannel: eventsConfig === null || eventsConfig === void 0 ? void 0 : eventsConfig.channel,
                 });
                 spinner.stop();
                 utils.logLabeledSuccess(extensionsHelper_1.logPrefix, `Successfully installed your instance of ${clc.bold(spec.displayName || spec.name)}! ` +
@@ -280,16 +302,23 @@ async function installExtension(options) {
                     paramsEnvPath,
                     instanceId,
                 });
+                eventsConfig = spec.events
+                    ? await askUserForEventsConfig.askForEventsConfig(spec.events, projectId, instanceId)
+                    : undefined;
                 paramBindings = (0, paramHelper_1.getBaseParamBindings)(paramBindingOptions);
                 spinner.text = "Updating your extension instance. This usually takes 3 to 5 minutes...";
                 spinner.start();
-                await (0, updateHelper_1.update)({
+                const updateOptions = {
                     projectId,
                     instanceId,
                     source,
+                    canEmitEvents: eventsConfig ? true : false,
+                    eventarcChannel: eventsConfig === null || eventsConfig === void 0 ? void 0 : eventsConfig.channel,
+                    allowedEventTypes: eventsConfig === null || eventsConfig === void 0 ? void 0 : eventsConfig.allowedEventTypes,
                     extRef: extVersion === null || extVersion === void 0 ? void 0 : extVersion.ref,
                     params: paramBindings,
-                });
+                };
+                await (0, updateHelper_1.update)(updateOptions);
                 spinner.stop();
                 utils.logLabeledSuccess(extensionsHelper_1.logPrefix, `Successfully updated your instance of ${clc.bold(spec.displayName || spec.name)}! ` +
                     `Its Instance ID is ${clc.bold(instanceId)}.`);

package/lib/commands/ext-update.js

@@ -23,6 +23,7 @@ const requirePermissions_1 = require("../requirePermissions");
 const utils = require("../utils");
 const previews_1 = require("../previews");
 const manifest = require("../extensions/manifest");
+const askUserForEventsConfig = require("../extensions/askUserForEventsConfig");
 marked.setOptions({
     renderer: new TerminalRenderer(),
 });
@@ -86,6 +87,15 @@ exports.default = new command_1.Command("ext:update <extensionInstanceId> [updat
             nonInteractive: options.nonInteractive,
             instanceId,
         });
+        const eventsConfig = newExtensionVersion.spec.events
+            ? await askUserForEventsConfig.askForEventsConfig(newExtensionVersion.spec.events, "${param:PROJECT_ID}", instanceId)
+            : undefined;
+        if (eventsConfig) {
+            newParamBindingOptions.EVENTARC_CHANNEL = { baseValue: eventsConfig.channel };
+            newParamBindingOptions.ALLOWED_EVENT_TYPES = {
+                baseValue: eventsConfig.allowedEventTypes.join(","),
+            };
+        }
         await manifest.writeToManifest([
             {
                 instanceId,
@@ -104,16 +114,7 @@ exports.default = new command_1.Command("ext:update <extensionInstanceId> [updat
     const spinner = ora(`Updating ${clc.bold(instanceId)}. This usually takes 3 to 5 minutes...`);
     try {
         const projectId = (0, projectUtils_1.needProjectId)(options);
-        let existingInstance;
-        try {
-            existingInstance = await extensionsApi.getInstance(projectId, instanceId);
-        }
-        catch (err) {
-            if (err.status === 404) {
-                throw new error_1.FirebaseError(`Extension instance '${clc.bold(instanceId)}' not found in project '${clc.bold(projectId)}'.`);
-            }
-            throw err;
-        }
+        const existingInstance = await extensionsApi.getInstance(projectId, instanceId);
         const existingSpec = existingInstance.config.source.spec;
         if (existingInstance.config.source.state === "DELETED") {
             throw new error_1.FirebaseError(`Instance '${clc.bold(instanceId)}' cannot be updated anymore because the underlying extension was unpublished from Firebase's registry of extensions. Going forward, you will only be able to re-configure or uninstall this instance.`);
@@ -214,11 +215,17 @@ exports.default = new command_1.Command("ext:update <extensionInstanceId> [updat
             nonInteractive: options.nonInteractive,
             instanceId,
         });
+        const eventsConfig = newSpec.events
+            ? await askUserForEventsConfig.askForEventsConfig(newSpec.events, projectId, instanceId)
+            : undefined;
         const newParams = paramHelper.getBaseParamBindings(newParamBindings);
         spinner.start();
         const updateOptions = {
             projectId,
             instanceId,
+            canEmitEvents: eventsConfig ? true : false,
+            eventarcChannel: eventsConfig === null || eventsConfig === void 0 ? void 0 : eventsConfig.channel,
+            allowedEventTypes: eventsConfig === null || eventsConfig === void 0 ? void 0 : eventsConfig.allowedEventTypes,
         };
         if (newSourceName.includes("publisher")) {
             updateOptions.extRef = refs.toExtensionVersionRef(refs.parse(newSourceName));

package/lib/commands/functions-secrets-set.js

@@ -77,17 +77,5 @@ exports.default = new command_1.Command("functions:secrets:set <KEY>")
         (0, utils_1.logBullet)(`Updated function ${e.id}(${e.region}).`);
         return updated;
     });
-    const updatedEndpoints = await Promise.all(updateOps);
-    (0, utils_1.logBullet)(`Pruning stale secrets...`);
-    const prunedResult = await (0, secrets_1.pruneAndDestroySecrets)({ projectId, projectNumber }, updatedEndpoints);
-    if (prunedResult.destroyed.length > 0) {
-        (0, utils_1.logBullet)(`Detroyed unused secret versions: ${prunedResult.destroyed
-            .map((s) => `${s.secret}@${s.version}`)
-            .join(", ")}`);
-    }
-    if (prunedResult.erred.length > 0) {
-        (0, utils_1.logWarning)(`Failed to destroy unused secret versions:\n\t${prunedResult.erred
-            .map((err) => err.message)
-            .join("\n\t")}`);
-    }
+    await Promise.all(updateOps);
 });

package/lib/deploy/extensions/planner.js

@@ -52,6 +52,8 @@ async function have(projectId) {
         const dep = {
             instanceId: i.name.split("/").pop(),
             params: i.config.params,
+            allowedEventTypes: i.config.allowedEventTypes,
+            eventarcChannel: i.config.eventarcChannel,
         };
         if (i.config.extensionRef) {
             const ref = refs.parse(i.config.extensionRef);
@@ -78,11 +80,19 @@ async function want(args) {
             });
             const autoPopulatedParams = await (0, extensionsHelper_1.getFirebaseProjectParams)(args.projectId, args.emulatorMode);
             const subbedParams = (0, extensionsHelper_1.substituteParams)(params, autoPopulatedParams);
+            const allowedEventTypes = subbedParams.ALLOWED_EVENT_TYPES !== undefined
+                ? subbedParams.ALLOWED_EVENT_TYPES.split(",").filter((e) => e !== "")
+                : undefined;
+            const eventarcChannel = subbedParams.EVENTARC_CHANNEL;
+            delete subbedParams["EVENTARC_CHANNEL"];
+            delete subbedParams["ALLOWED_EVENT_TYPES"];
             if ((0, extensionsHelper_1.isLocalPath)(e[1])) {
                 instanceSpecs.push({
                     instanceId,
                     localPath: e[1],
                     params: subbedParams,
+                    allowedEventTypes: allowedEventTypes,
+                    eventarcChannel: eventarcChannel,
                 });
             }
             else {
@@ -92,6 +102,8 @@ async function want(args) {
                     instanceId,
                     ref,
                     params: subbedParams,
+                    allowedEventTypes: allowedEventTypes,
+                    eventarcChannel: eventarcChannel,
                 });
             }
         }

package/lib/deploy/extensions/tasks.js

@@ -33,6 +33,8 @@ function createExtensionInstanceTask(projectId, instanceSpec, validateOnly = fal
                 instanceId: instanceSpec.instanceId,
                 params: instanceSpec.params,
                 extensionVersionRef: refs.toExtensionVersionRef(instanceSpec.ref),
+                allowedEventTypes: instanceSpec.allowedEventTypes,
+                eventarcChannel: instanceSpec.eventarcChannel,
                 validateOnly,
             });
         }
@@ -43,6 +45,8 @@ function createExtensionInstanceTask(projectId, instanceSpec, validateOnly = fal
                 instanceId: instanceSpec.instanceId,
                 params: instanceSpec.params,
                 extensionSource,
+                allowedEventTypes: instanceSpec.allowedEventTypes,
+                eventarcChannel: instanceSpec.eventarcChannel,
                 validateOnly,
             });
         }
@@ -67,6 +71,9 @@ function updateExtensionInstanceTask(projectId, instanceSpec, validateOnly = fal
                 instanceId: instanceSpec.instanceId,
                 extRef: refs.toExtensionVersionRef(instanceSpec.ref),
                 params: instanceSpec.params,
+                canEmitEvents: !!instanceSpec.allowedEventTypes,
+                allowedEventTypes: instanceSpec.allowedEventTypes,
+                eventarcChannel: instanceSpec.eventarcChannel,
                 validateOnly,
             });
         }
@@ -77,6 +84,9 @@ function updateExtensionInstanceTask(projectId, instanceSpec, validateOnly = fal
                 instanceId: instanceSpec.instanceId,
                 extensionSource,
                 validateOnly,
+                canEmitEvents: !!instanceSpec.allowedEventTypes,
+                allowedEventTypes: instanceSpec.allowedEventTypes,
+                eventarcChannel: instanceSpec.eventarcChannel,
             });
         }
         else {
@@ -99,6 +109,9 @@ function configureExtensionInstanceTask(projectId, instanceSpec, validateOnly =
                 projectId,
                 instanceId: instanceSpec.instanceId,
                 params: instanceSpec.params,
+                canEmitEvents: !!instanceSpec.allowedEventTypes,
+                allowedEventTypes: instanceSpec.allowedEventTypes,
+                eventarcChannel: instanceSpec.eventarcChannel,
                 validateOnly,
             });
         }

package/lib/deploy/functions/backend.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.compareFunctions = exports.missingEndpoint = exports.hasEndpoint = exports.regionalEndpoints = exports.matchingBackend = exports.findEndpoint = exports.someEndpoint = exports.allEndpoints = exports.checkAvailability = exports.existingBackend = exports.scheduleIdForFunction = exports.functionName = exports.isEmptyBackend = exports.merge = exports.of = exports.empty = exports.isBlockingTriggered = exports.isTaskQueueTriggered = exports.isScheduleTriggered = exports.isEventTriggered = exports.isCallableTriggered = exports.isHttpsTriggered = exports.AllFunctionsPlatforms = exports.secretVersionName = exports.SCHEDULED_FUNCTION_LABEL = exports.MIN_MEMORY_FOR_CONCURRENCY = exports.DEFAULT_MEMORY = exports.memoryOptionDisplayName = exports.AllMemoryOptions = exports.AllIngressSettings = exports.AllVpcEgressSettings = exports.endpointTriggerType = void 0;
+exports.compareFunctions = exports.missingEndpoint = exports.hasEndpoint = exports.regionalEndpoints = exports.matchingBackend = exports.findEndpoint = exports.someEndpoint = exports.allEndpoints = exports.checkAvailability = exports.existingBackend = exports.scheduleIdForFunction = exports.functionName = exports.isEmptyBackend = exports.merge = exports.of = exports.empty = exports.isBlockingTriggered = exports.isTaskQueueTriggered = exports.isScheduleTriggered = exports.isEventTriggered = exports.isCallableTriggered = exports.isHttpsTriggered = exports.AllFunctionsPlatforms = exports.secretVersionName = exports.SCHEDULED_FUNCTION_LABEL = exports.MIN_CPU_FOR_CONCURRENCY = exports.DEFAULT_MEMORY = exports.DEFAULT_CONCURRENCY = exports.memoryToGen2Cpu = exports.memoryToGen1Cpu = exports.memoryOptionDisplayName = exports.AllMemoryOptions = exports.AllIngressSettings = exports.AllVpcEgressSettings = exports.endpointTriggerType = void 0;
 const gcf = require("../../gcp/cloudfunctions");
 const gcfV2 = require("../../gcp/cloudfunctionsv2");
+const run = require("../../gcp/run");
 const utils = require("../../utils");
 const error_1 = require("../../error");
 const previews_1 = require("../../previews");
@@ -37,7 +38,9 @@ exports.AllIngressSettings = [
     "ALLOW_INTERNAL_ONLY",
     "ALLOW_INTERNAL_AND_GCLB",
 ];
-exports.AllMemoryOptions = [128, 256, 512, 1024, 2048, 4096, 8192];
+exports.AllMemoryOptions = [
+    128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768,
+];
 function memoryOptionDisplayName(option) {
     return {
         128: "128MB",
@@ -47,11 +50,42 @@ function memoryOptionDisplayName(option) {
         2048: "2GB",
         4096: "4GB",
         8192: "8GB",
+        16384: "16GB",
+        32768: "32GB",
     }[option];
 }
 exports.memoryOptionDisplayName = memoryOptionDisplayName;
+function memoryToGen1Cpu(memory) {
+    return {
+        128: 0.0833,
+        256: 0.1666,
+        512: 0.3333,
+        1024: 0.5833,
+        2048: 1,
+        4096: 2,
+        8192: 2,
+        16384: 3,
+        32768: 4,
+    }[memory];
+}
+exports.memoryToGen1Cpu = memoryToGen1Cpu;
+function memoryToGen2Cpu(memory) {
+    return {
+        128: 1,
+        256: 1,
+        512: 1,
+        1024: 1,
+        2048: 1,
+        4096: 2,
+        8192: 2,
+        16384: 3,
+        32768: 4,
+    }[memory];
+}
+exports.memoryToGen2Cpu = memoryToGen2Cpu;
+exports.DEFAULT_CONCURRENCY = 80;
 exports.DEFAULT_MEMORY = 256;
-exports.MIN_MEMORY_FOR_CONCURRENCY = 2048;
+exports.MIN_CPU_FOR_CONCURRENCY = 1;
 exports.SCHEDULED_FUNCTION_LABEL = Object.freeze({ deployment: "firebase-schedule" });
 function secretVersionName(s) {
     var _a;
@@ -164,6 +198,16 @@ async function loadExistingBackend(ctx) {
     let gcfV2Results;
     try {
         gcfV2Results = await gcfV2.listAllFunctions(ctx.projectId);
+        const runResults = await Promise.all(gcfV2Results.functions.map((fn) => run.getService(fn.serviceConfig.service)));
+        for (const [apiFunction, runService] of (0, functional_1.zip)(gcfV2Results.functions, runResults)) {
+            const endpoint = gcfV2.endpointFromFunction(apiFunction);
+            endpoint.concurrency = runService.spec.template.spec.containerConcurrency || 1;
+            endpoint.cpu = +runService.spec.template.spec.containers[0].resources.limits.cpu;
+            ctx.existingBackend.endpoints[endpoint.region] =
+                ctx.existingBackend.endpoints[endpoint.region] || {};
+            ctx.existingBackend.endpoints[endpoint.region][endpoint.id] = endpoint;
+        }
+        ctx.unreachableRegions.gcfV2 = gcfV2Results.unreachable;
     }
     catch (err) {
         if (err.status === 404 && ((_a = err.message) === null || _a === void 0 ? void 0 : _a.toLowerCase().includes("method not found"))) {
@@ -171,13 +215,6 @@ async function loadExistingBackend(ctx) {
         }
         throw err;
     }
-    for (const apiFunction of gcfV2Results.functions) {
-        const endpoint = gcfV2.endpointFromFunction(apiFunction);
-        ctx.existingBackend.endpoints[endpoint.region] =
-            ctx.existingBackend.endpoints[endpoint.region] || {};
-        ctx.existingBackend.endpoints[endpoint.region][endpoint.id] = endpoint;
-    }
-    ctx.unreachableRegions.gcfV2 = gcfV2Results.unreachable;
 }
 async function checkAvailability(context, want) {
     const ctx = context;

package/lib/deploy/functions/build.js

@@ -50,7 +50,15 @@ function resolveBoolean(from) {
 function isMemoryOption(value) {
     return value == null || [128, 256, 512, 1024, 2048, 4096, 8192].includes(value);
 }
-function resolveBackend(build) {
+function resolveBackend(build, userEnvs) {
+    for (const param of build.params) {
+        const expectedEnv = param.param;
+        if (!userEnvs.hasOwnProperty(expectedEnv)) {
+            throw new error_1.FirebaseError("Build specified parameter " +
+                expectedEnv +
+                " but it was not present in the user dotenv files");
+        }
+    }
     const bkEndpoints = [];
     for (const endpointId of Object.keys(build.endpoints)) {
         const endpoint = build.endpoints[endpointId];

package/lib/deploy/functions/checkIam.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ensureServiceAgentRoles = exports.mergeBindings = exports.obtainDefaultComputeServiceAgentBindings = exports.obtainPubSubServiceAgentBindings = exports.obtainBinding = exports.checkHttpIam = exports.checkServiceAccountIam = exports.EVENTARC_EVENT_RECEIVER_ROLE = exports.RUN_INVOKER_ROLE = exports.SERVICE_ACCOUNT_TOKEN_CREATOR_ROLE = void 0;
+exports.ensureServiceAgentRoles = exports.mergeBindings = exports.obtainDefaultComputeServiceAgentBindings = exports.obtainPubSubServiceAgentBindings = exports.checkHttpIam = exports.checkServiceAccountIam = exports.EVENTARC_EVENT_RECEIVER_ROLE = exports.RUN_INVOKER_ROLE = exports.SERVICE_ACCOUNT_TOKEN_CREATOR_ROLE = void 0;
 const cli_color_1 = require("cli-color");
 const logger_1 = require("../../logger");
 const functionsDeployHelper_1 = require("./functionsDeployHelper");
@@ -67,6 +67,12 @@ async function checkHttpIam(context, options, payload) {
     logger_1.logger.debug("[functions] found setIamPolicy permission, proceeding with deploy");
 }
 exports.checkHttpIam = checkHttpIam;
+function getPubsubServiceAgent(projectNumber) {
+    return `serviceAccount:service-${projectNumber}@gcp-sa-pubsub.iam.gserviceaccount.com`;
+}
+function getDefaultComputeServiceAgent(projectNumber) {
+    return `serviceAccount:${projectNumber}-compute@developer.gserviceaccount.com`;
+}
 function reduceEventsToServices(services, endpoint) {
     const service = (0, services_1.serviceForEndpoint)(endpoint);
     if (service.requiredProjectBindings && !services.find((s) => s.name === service.name)) {
@@ -74,84 +80,97 @@ function reduceEventsToServices(services, endpoint) {
     }
     return services;
 }
-function obtainBinding(existingPolicy, serviceAccount, role) {
-    let binding = existingPolicy.bindings.find((b) => b.role === role);
-    if (!binding) {
-        binding = {
-            role,
-            members: [],
-        };
-    }
-    if (!binding.members.find((m) => m === serviceAccount)) {
-        binding.members.push(serviceAccount);
-    }
-    return binding;
-}
-exports.obtainBinding = obtainBinding;
-function obtainPubSubServiceAgentBindings(projectNumber, existingPolicy) {
-    const pubsubServiceAgent = `serviceAccount:service-${projectNumber}@gcp-sa-pubsub.iam.gserviceaccount.com`;
-    return [obtainBinding(existingPolicy, pubsubServiceAgent, exports.SERVICE_ACCOUNT_TOKEN_CREATOR_ROLE)];
+function obtainPubSubServiceAgentBindings(projectNumber) {
+    const serviceAccountTokenCreatorBinding = {
+        role: exports.SERVICE_ACCOUNT_TOKEN_CREATOR_ROLE,
+        members: [getPubsubServiceAgent(projectNumber)],
+    };
+    return [serviceAccountTokenCreatorBinding];
 }
 exports.obtainPubSubServiceAgentBindings = obtainPubSubServiceAgentBindings;
-function obtainDefaultComputeServiceAgentBindings(projectNumber, existingPolicy) {
-    const defaultComputeServiceAgent = `serviceAccount:${projectNumber}-compute@developer.gserviceaccount.com`;
-    const invokerBinding = obtainBinding(existingPolicy, defaultComputeServiceAgent, exports.RUN_INVOKER_ROLE);
-    const eventReceiverBinding = obtainBinding(existingPolicy, defaultComputeServiceAgent, exports.EVENTARC_EVENT_RECEIVER_ROLE);
-    return [invokerBinding, eventReceiverBinding];
+function obtainDefaultComputeServiceAgentBindings(projectNumber) {
+    const defaultComputeServiceAgent = getDefaultComputeServiceAgent(projectNumber);
+    const runInvokerBinding = {
+        role: exports.RUN_INVOKER_ROLE,
+        members: [defaultComputeServiceAgent],
+    };
+    const eventarcEventReceiverBinding = {
+        role: exports.EVENTARC_EVENT_RECEIVER_ROLE,
+        members: [defaultComputeServiceAgent],
+    };
+    return [runInvokerBinding, eventarcEventReceiverBinding];
 }
 exports.obtainDefaultComputeServiceAgentBindings = obtainDefaultComputeServiceAgentBindings;
-function mergeBindings(policy, allRequiredBindings) {
-    for (const requiredBindings of allRequiredBindings) {
-        if (requiredBindings.length === 0) {
+function mergeBindings(policy, requiredBindings) {
+    let updated = false;
+    for (const requiredBinding of requiredBindings) {
+        const match = policy.bindings.find((b) => b.role === requiredBinding.role);
+        if (!match) {
+            updated = true;
+            policy.bindings.push(requiredBinding);
             continue;
         }
-        for (const requiredBinding of requiredBindings) {
-            const ndx = policy.bindings.findIndex((policyBinding) => policyBinding.role === requiredBinding.role);
-            if (ndx === -1) {
-                policy.bindings.push(requiredBinding);
-                continue;
+        for (const requiredMember of requiredBinding.members) {
+            if (!match.members.find((m) => m === requiredMember)) {
+                updated = true;
+                match.members.push(requiredMember);
             }
-            requiredBinding.members.forEach((updatedMember) => {
-                if (!policy.bindings[ndx].members.find((member) => member === updatedMember)) {
-                    policy.bindings[ndx].members.push(updatedMember);
-                }
-            });
         }
     }
+    return updated;
 }
 exports.mergeBindings = mergeBindings;
-async function ensureServiceAgentRoles(projectNumber, want, have) {
+function printManualIamConfig(requiredBindings, projectId) {
+    utils.logLabeledBullet("functions", "Failed to verify the project has the correct IAM bindings for a successful deployment.", "warn");
+    utils.logLabeledBullet("functions", "You can either re-run `firebase deploy` as a project owner or manually run the following set of `gcloud` commands:", "warn");
+    for (const binding of requiredBindings) {
+        for (const member of binding.members) {
+            utils.logLabeledBullet("functions", `\`gcloud projects add-iam-policy-binding ${projectId} ` +
+                `--member=${member} ` +
+                `--role=${binding.role}\``, "warn");
+        }
+    }
+}
+async function ensureServiceAgentRoles(projectId, projectNumber, want, have) {
     const wantServices = backend.allEndpoints(want).reduce(reduceEventsToServices, []);
     const haveServices = backend.allEndpoints(have).reduce(reduceEventsToServices, []);
     const newServices = wantServices.filter((wantS) => !haveServices.find((haveS) => wantS.name === haveS.name));
     if (newServices.length === 0) {
         return;
     }
+    const requiredBindingsPromises = [];
+    for (const service of newServices) {
+        requiredBindingsPromises.push(service.requiredProjectBindings(projectNumber));
+    }
+    const nestedRequiredBindings = await Promise.all(requiredBindingsPromises);
+    const requiredBindings = [...(0, functional_1.flattenArray)(nestedRequiredBindings)];
+    if (haveServices.length === 0) {
+        requiredBindings.push(...obtainPubSubServiceAgentBindings(projectNumber));
+        requiredBindings.push(...obtainDefaultComputeServiceAgentBindings(projectNumber));
+    }
+    if (requiredBindings.length === 0) {
+        return;
+    }
     let policy;
     try {
         policy = await (0, resourceManager_1.getIamPolicy)(projectNumber);
     }
     catch (err) {
+        printManualIamConfig(requiredBindings, projectId);
         utils.logLabeledBullet("functions", "Could not verify the necessary IAM configuration for the following newly-integrated services: " +
             `${newServices.map((service) => service.api).join(", ")}` +
             ". Deployment may fail.", "warn");
         return;
     }
-    const findRequiredBindings = [];
-    newServices.forEach((service) => findRequiredBindings.push(service.requiredProjectBindings(projectNumber, policy)));
-    const allRequiredBindings = await Promise.all(findRequiredBindings);
-    if (haveServices.length === 0) {
-        allRequiredBindings.push(obtainPubSubServiceAgentBindings(projectNumber, policy));
-        allRequiredBindings.push(obtainDefaultComputeServiceAgentBindings(projectNumber, policy));
-    }
-    if (!allRequiredBindings.find((bindings) => bindings.length > 0)) {
+    const hasUpdatedBindings = mergeBindings(policy, requiredBindings);
+    if (!hasUpdatedBindings) {
         return;
     }
-    mergeBindings(policy, allRequiredBindings);
     try {
         await (0, resourceManager_1.setIamPolicy)(projectNumber, policy, "bindings");
     }
     catch (err) {
+        printManualIamConfig(requiredBindings, projectId);
         throw new error_1.FirebaseError("We failed to modify the IAM policy for the project. The functions " +
             "deployment requires specific roles to be granted to service agents," +
             " otherwise the deployment will fail.", { original: err });

package/lib/deploy/functions/functionsDeployHelper.js

@@ -70,7 +70,7 @@ exports.getEndpointFilters = getEndpointFilters;
 function getFunctionLabel(fn) {
     let id = `${fn.id}(${fn.region})`;
     if (fn.codebase && fn.codebase !== projectConfig_1.DEFAULT_CODEBASE) {
-        id = `[${fn.codebase}]${id}`;
+        id = `${fn.codebase}:${id}`;
     }
     return id;
 }