firebase-tools 10.4.1 → 10.4.2

package/lib/commands/ext-configure.js

@@ -35,7 +35,7 @@ exports.default = new command_1.Command("ext:configure <extensionInstanceId>")
     .before(extensionsHelper_1.diagnoseAndFixProject)
     .action(async (instanceId, options) => {
     var _a;
-    const projectId = (0, projectUtils_1.needProjectId)(options);
+    const projectId = (0, projectUtils_1.getProjectId)(options);
     if (options.local) {
         if (options.nonInteractive) {
             throw new error_1.FirebaseError(`Command not supported in non-interactive mode, edit ./extensions/${instanceId}.env directly instead`);
@@ -77,7 +77,7 @@ exports.default = new command_1.Command("ext:configure <extensionInstanceId>")
     try {
         let existingInstance;
         try {
-            existingInstance = await extensionsApi.getInstance(projectId, instanceId);
+            existingInstance = await extensionsApi.getInstance((0, projectUtils_1.needProjectId)({ projectId }), instanceId);
         }
         catch (err) {
             if (err.status === 404) {
@@ -113,13 +113,13 @@ exports.default = new command_1.Command("ext:configure <extensionInstanceId>")
         }
         spinner.start();
         const res = await extensionsApi.configureInstance({
-            projectId,
+            projectId: (0, projectUtils_1.needProjectId)({ projectId }),
             instanceId,
             params: paramBindings,
         });
         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(projectId, `/extensions/instances/${instanceId}?tab=config`)}`));
+        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`)}`));
         manifest.showDeprecationWarning();
         return res;
     }

package/lib/commands/ext-install.js

@@ -47,7 +47,7 @@ exports.default = new command_1.Command("ext:install [extensionName]")
     .before(extensionsHelper_1.diagnoseAndFixProject)
     .action(async (extensionName, options) => {
     var _a;
-    const projectId = (0, projectUtils_1.needProjectId)(options);
+    const projectId = (0, projectUtils_1.getProjectId)(options);
     const paramsEnvPath = ((_a = options.params) !== null && _a !== void 0 ? _a : "");
     let learnMore = false;
     if (!extensionName) {
@@ -71,7 +71,7 @@ exports.default = new command_1.Command("ext:install [extensionName]")
         if (options.local) {
             throw new error_1.FirebaseError("Installing a local source locally is not supported yet, please use ext:dev:emulator commands");
         }
-        source = await infoInstallBySource(projectId, extensionName);
+        source = await infoInstallBySource((0, projectUtils_1.needProjectId)({ projectId }), extensionName);
     }
     else {
         void (0, track_1.track)("Extension Install", "Install by Extension Ref", options.interactive ? 1 : 0);
@@ -120,7 +120,7 @@ exports.default = new command_1.Command("ext:install [extensionName]")
     try {
         return installExtension({
             paramsEnvPath,
-            projectId,
+            projectId: projectId,
             extensionName,
             source,
             extVersion,
@@ -195,7 +195,8 @@ async function installToManifest(options) {
     manifest.showPreviewWarning();
 }
 async function installExtension(options) {
-    const { projectId, extensionName, source, extVersion, paramsEnvPath, nonInteractive, force } = options;
+    const { extensionName, source, extVersion, paramsEnvPath, nonInteractive, force } = options;
+    const projectId = (0, projectUtils_1.needProjectId)({ projectId: options.projectId });
     const spec = (source === null || source === void 0 ? void 0 : source.spec) || (extVersion === null || extVersion === void 0 ? void 0 : extVersion.spec);
     if (!spec) {
         throw new error_1.FirebaseError(`Could not find the extension.yaml for ${extensionName}. Please make sure this is a valid extension and try again.`);

package/lib/commands/ext-update.js

@@ -42,8 +42,8 @@ exports.default = new command_1.Command("ext:update <extensionInstanceId> [updat
     .option("--local", "save the update to firebase.json rather than directly update an existing Extension instance on a Firebase project")
     .action(async (instanceId, updateSource, options) => {
     var _a, _b;
-    const projectId = (0, projectUtils_1.needProjectId)(options);
     if (options.local) {
+        const projectId = (0, projectUtils_1.getProjectId)(options);
         const config = manifest.loadConfig(options);
         const oldRef = manifest.getInstanceRef(instanceId, config);
         const oldExtensionVersion = await extensionsApi.getExtensionVersion(refs.toExtensionVersionRef(oldRef));
@@ -95,6 +95,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);

package/lib/deploy/functions/checkIam.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ensureServiceAgentRoles = exports.mergeBindings = exports.checkHttpIam = exports.checkServiceAccountIam = void 0;
+exports.ensureServiceAgentRoles = exports.mergeBindings = exports.obtainEventarcServiceAgentBindings = exports.obtainDefaultComputeServiceAgentBindings = exports.obtainPubSubServiceAgentBindings = exports.obtainBinding = exports.checkHttpIam = exports.checkServiceAccountIam = exports.EVENTARC_SERVICE_AGENT_ROLE = 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");
@@ -12,6 +12,10 @@ const utils = require("../../utils");
 const resourceManager_1 = require("../../gcp/resourceManager");
 const services_1 = require("./services");
 const PERMISSION = "cloudfunctions.functions.setIamPolicy";
+exports.SERVICE_ACCOUNT_TOKEN_CREATOR_ROLE = "roles/iam.serviceAccountTokenCreator";
+exports.RUN_INVOKER_ROLE = "roles/run.invoker";
+exports.EVENTARC_EVENT_RECEIVER_ROLE = "roles/eventarc.eventReceiver";
+exports.EVENTARC_SERVICE_AGENT_ROLE = "roles/eventarc.serviceAgent";
 async function checkServiceAccountIam(projectId) {
     const saEmail = `${projectId}@appspot.gserviceaccount.com`;
     let passed = false;
@@ -67,6 +71,37 @@ 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)];
+}
+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];
+}
+exports.obtainDefaultComputeServiceAgentBindings = obtainDefaultComputeServiceAgentBindings;
+function obtainEventarcServiceAgentBindings(projectNumber, existingPolicy) {
+    const eventarcServiceAgent = `serviceAccount:service-${projectNumber}@gcp-sa-eventarc.iam.gserviceaccount.com`;
+    return [obtainBinding(existingPolicy, eventarcServiceAgent, exports.EVENTARC_SERVICE_AGENT_ROLE)];
+}
+exports.obtainEventarcServiceAgentBindings = obtainEventarcServiceAgentBindings;
 function mergeBindings(policy, allRequiredBindings) {
     for (const requiredBindings of allRequiredBindings) {
         if (requiredBindings.length === 0) {
@@ -107,6 +142,14 @@ async function ensureServiceAgentRoles(projectNumber, want, have) {
     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));
+        allRequiredBindings.push(obtainEventarcServiceAgentBindings(projectNumber, policy));
+    }
+    if (!allRequiredBindings.find((bindings) => bindings.length > 0)) {
+        return;
+    }
     mergeBindings(policy, allRequiredBindings);
     try {
         await (0, resourceManager_1.setIamPolicy)(projectNumber, policy, "bindings");

package/lib/deploy/functions/services/firebaseAlerts.js

@@ -1,23 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ensureFirebaseAlertsTriggerRegion = exports.obtainFirebaseAlertsBindings = exports.SERVICE_ACCOUNT_TOKEN_CREATOR_ROLE = void 0;
+exports.ensureFirebaseAlertsTriggerRegion = void 0;
 const error_1 = require("../../../error");
-exports.SERVICE_ACCOUNT_TOKEN_CREATOR_ROLE = "roles/iam.serviceAccountTokenCreator";
-function obtainFirebaseAlertsBindings(projectNumber, existingPolicy) {
-    const pubsubServiceAgent = `serviceAccount:service-${projectNumber}@gcp-sa-pubsub.iam.gserviceaccount.com`;
-    let pubsubBinding = existingPolicy.bindings.find((b) => b.role === exports.SERVICE_ACCOUNT_TOKEN_CREATOR_ROLE);
-    if (!pubsubBinding) {
-        pubsubBinding = {
-            role: exports.SERVICE_ACCOUNT_TOKEN_CREATOR_ROLE,
-            members: [],
-        };
-    }
-    if (!pubsubBinding.members.find((m) => m === pubsubServiceAgent)) {
-        pubsubBinding.members.push(pubsubServiceAgent);
-    }
-    return Promise.resolve([pubsubBinding]);
-}
-exports.obtainFirebaseAlertsBindings = obtainFirebaseAlertsBindings;
 function ensureFirebaseAlertsTriggerRegion(endpoint) {
     if (!endpoint.eventTrigger.region) {
         endpoint.eventTrigger.region = "global";

package/lib/deploy/functions/services/index.js

@@ -5,6 +5,7 @@ const backend = require("../backend");
 const storage_1 = require("./storage");
 const firebaseAlerts_1 = require("./firebaseAlerts");
 const noop = () => Promise.resolve();
+const noopProjectBindings = () => Promise.resolve([]);
 exports.NoOpService = {
     name: "noop",
     api: "",
@@ -26,7 +27,7 @@ exports.StorageService = {
 exports.FirebaseAlertsService = {
     name: "firebasealerts",
     api: "logging.googleapis.com",
-    requiredProjectBindings: firebaseAlerts_1.obtainFirebaseAlertsBindings,
+    requiredProjectBindings: noopProjectBindings,
     ensureTriggerRegion: firebaseAlerts_1.ensureFirebaseAlertsTriggerRegion,
 };
 exports.EVENT_SERVICE_MAPPING = {

package/lib/emulator/functionsEmulator.js

@@ -289,7 +289,7 @@ class FunctionsEmulator {
         });
         for (const definition of toSetup) {
             try {
-                (0, validate_1.functionIdsAreValid)([definition]);
+                (0, validate_1.functionIdsAreValid)([Object.assign(Object.assign({}, definition), { id: definition.name })]);
             }
             catch (e) {
                 this.logger.logLabeled("WARN", `functions[${definition.id}]`, `Invalid function id: ${e.message}`);
@@ -488,26 +488,16 @@ class FunctionsEmulator {
         return def.eventTrigger ? `${def.id}-${this.triggerGeneration}` : def.id;
     }
     getBackendInfo() {
-        const cf3Triggers = Object.values(this.triggers)
-            .filter((t) => !t.backend.extensionInstanceId)
-            .map((t) => t.def);
+        const cf3Triggers = this.getCF3Triggers();
         return this.args.emulatableBackends.map((e) => {
-            var _a;
-            const envWithSecrets = Object.assign({}, e.env);
-            for (const s of e.secretEnv) {
-                envWithSecrets[s.key] = backend.secretVersionName(s);
-            }
-            return {
-                directory: e.functionsDir,
-                env: envWithSecrets,
-                extensionInstanceId: e.extensionInstanceId,
-                extension: e.extension,
-                extensionVersion: e.extensionVersion,
-                extensionSpec: e.extensionSpec,
-                functionTriggers: (_a = e.predefinedTriggers) !== null && _a !== void 0 ? _a : cf3Triggers,
-            };
+            return (0, functionsEmulatorShared_1.toBackendInfo)(e, cf3Triggers);
         });
     }
+    getCF3Triggers() {
+        return Object.values(this.triggers)
+            .filter((t) => !t.backend.extensionInstanceId)
+            .map((t) => t.def);
+    }
     addTriggerRecord(def, opts) {
         const key = this.getTriggerKey(def);
         this.triggers[key] = {

package/lib/emulator/functionsEmulatorShared.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSecretLocalPath = exports.getSignatureType = exports.formatHost = exports.findModuleRoot = exports.waitForBody = exports.getServiceFromEventType = exports.getFunctionService = exports.getTemporarySocketPath = exports.getEmulatedTriggersFromDefinitions = exports.emulatedFunctionsByRegion = exports.emulatedFunctionsFromEndpoints = exports.EmulatedTrigger = exports.HttpConstants = void 0;
+exports.toBackendInfo = exports.getSecretLocalPath = exports.getSignatureType = exports.formatHost = exports.findModuleRoot = exports.waitForBody = exports.getServiceFromEventType = exports.getFunctionService = exports.getTemporarySocketPath = exports.getEmulatedTriggersFromDefinitions = exports.emulatedFunctionsByRegion = exports.emulatedFunctionsFromEndpoints = exports.EmulatedTrigger = exports.HttpConstants = void 0;
 const _ = require("lodash");
 const os = require("os");
 const path = require("path");
@@ -10,6 +10,7 @@ const constants_1 = require("./constants");
 const proto_1 = require("../gcp/proto");
 const logger_1 = require("../logger");
 const manifest_1 = require("../extensions/manifest");
+const extensionsHelper_1 = require("../extensions/extensionsHelper");
 const memoryLookup = {
     "128MB": 128,
     "256MB": 256,
@@ -242,3 +243,28 @@ function getSecretLocalPath(backend, projectDir) {
     return path.join(secretDirectory, secretsFile);
 }
 exports.getSecretLocalPath = getSecretLocalPath;
+function toBackendInfo(e, cf3Triggers) {
+    var _a;
+    const envWithSecrets = Object.assign({}, e.env);
+    for (const s of e.secretEnv) {
+        envWithSecrets[s.key] = backend.secretVersionName(s);
+    }
+    let extensionVersion = e.extensionVersion;
+    if (extensionVersion) {
+        extensionVersion = (0, extensionsHelper_1.substituteParams)(extensionVersion, e.env);
+    }
+    let extensionSpec = e.extensionSpec;
+    if (extensionSpec) {
+        extensionSpec = (0, extensionsHelper_1.substituteParams)(extensionSpec, e.env);
+    }
+    return JSON.parse(JSON.stringify({
+        directory: e.functionsDir,
+        env: envWithSecrets,
+        extensionInstanceId: e.extensionInstanceId,
+        extension: e.extension,
+        extensionVersion: extensionVersion,
+        extensionSpec: extensionSpec,
+        functionTriggers: (_a = e.predefinedTriggers) !== null && _a !== void 0 ? _a : cf3Triggers,
+    }));
+}
+exports.toBackendInfo = toBackendInfo;

package/lib/extensions/askUserForParam.js

@@ -12,6 +12,7 @@ const utils_1 = require("./utils");
 const logger_1 = require("../logger");
 const prompt_1 = require("../prompt");
 const utils = require("../utils");
+const projectUtils_1 = require("../projectUtils");
 var SecretLocation;
 (function (SecretLocation) {
     SecretLocation[SecretLocation["CLOUD"] = 1] = "CLOUD";
@@ -60,21 +61,21 @@ function checkResponse(response, spec) {
     return valid;
 }
 exports.checkResponse = checkResponse;
-async function ask(projectId, instanceId, paramSpecs, firebaseProjectParams, reconfiguring) {
-    if (_.isEmpty(paramSpecs)) {
+async function ask(args) {
+    if (_.isEmpty(args.paramSpecs)) {
         logger_1.logger.debug("No params were specified for this extension.");
         return {};
     }
     utils.logLabeledBullet(extensionsHelper_1.logPrefix, "answer the questions below to configure your extension:");
-    const substituted = (0, extensionsHelper_1.substituteParams)(paramSpecs, firebaseProjectParams);
+    const substituted = (0, extensionsHelper_1.substituteParams)(args.paramSpecs, args.firebaseProjectParams);
     const result = {};
     const promises = _.map(substituted, (paramSpec) => {
         return async () => {
             result[paramSpec.param] = await askForParam({
-                projectId,
-                instanceId,
-                paramSpec,
-                reconfiguring,
+                projectId: args.projectId,
+                instanceId: args.instanceId,
+                paramSpec: paramSpec,
+                reconfiguring: args.reconfiguring,
             });
         };
     });
@@ -133,9 +134,10 @@ async function askForParam(args) {
                     secretLocations = await promptSecretLocations(paramSpec);
                 } while (!isValidSecretLocations(secretLocations, paramSpec));
                 if (secretLocations.includes(SecretLocation.CLOUD.toString())) {
+                    const projectId = (0, projectUtils_1.needProjectId)({ projectId: args.projectId });
                     response = args.reconfiguring
-                        ? await promptReconfigureSecret(args.projectId, args.instanceId, paramSpec)
-                        : await promptCreateSecret(args.projectId, args.instanceId, paramSpec);
+                        ? await promptReconfigureSecret(projectId, args.instanceId, paramSpec)
+                        : await promptCreateSecret(projectId, args.instanceId, paramSpec);
                 }
                 if (secretLocations.includes(SecretLocation.LOCAL.toString())) {
                     responseForLocal = await promptLocalSecret(args.instanceId, paramSpec);

package/lib/extensions/extensionsHelper.js

@@ -80,6 +80,9 @@ function getDBInstanceFromURL(databaseUrl = "") {
 exports.getDBInstanceFromURL = getDBInstanceFromURL;
 async function getFirebaseProjectParams(projectId, emulatorMode = false) {
     var _a, _b;
+    if (!projectId) {
+        return {};
+    }
     const body = emulatorMode
         ? await (0, adminSdkConfig_1.getProjectAdminSdkConfigOrCached)(projectId)
         : await (0, functionsConfig_1.getFirebaseConfig)({ project: projectId });
@@ -263,7 +266,10 @@ async function promptForValidInstanceId(instanceId) {
 }
 exports.promptForValidInstanceId = promptForValidInstanceId;
 async function ensureExtensionsApiEnabled(options) {
-    const projectId = (0, projectUtils_1.needProjectId)(options);
+    const projectId = (0, projectUtils_1.getProjectId)(options);
+    if (!projectId) {
+        return;
+    }
     return await (0, ensureApiEnabled_1.ensure)(projectId, "firebaseextensions.googleapis.com", "extensions", options.markdown);
 }
 exports.ensureExtensionsApiEnabled = ensureExtensionsApiEnabled;
@@ -519,7 +525,10 @@ async function confirm(args) {
 }
 exports.confirm = confirm;
 async function diagnoseAndFixProject(options) {
-    const projectId = (0, projectUtils_1.needProjectId)(options);
+    const projectId = (0, projectUtils_1.getProjectId)(options);
+    if (!projectId) {
+        return;
+    }
     const ok = await (0, diagnose_1.diagnose)(projectId);
     if (!ok) {
         throw new error_1.FirebaseError("Unable to proceed until all issues are resolved.");

package/lib/extensions/paramHelper.js

@@ -57,14 +57,19 @@ async function getParams(args) {
     }
     else if (args.paramsEnvPath) {
         params = getParamsFromFile({
-            projectId: args.projectId,
             paramSpecs: args.paramSpecs,
             paramsEnvPath: args.paramsEnvPath,
         });
     }
     else {
         const firebaseProjectParams = await (0, extensionsHelper_1.getFirebaseProjectParams)(args.projectId);
-        params = await askUserForParam.ask(args.projectId, args.instanceId, args.paramSpecs, firebaseProjectParams, !!args.reconfiguring);
+        params = await askUserForParam.ask({
+            projectId: args.projectId,
+            instanceId: args.instanceId,
+            paramSpecs: args.paramSpecs,
+            firebaseProjectParams,
+            reconfiguring: !!args.reconfiguring,
+        });
     }
     void track("Extension Params", _.isEmpty(params) ? "Not Present" : "Present", _.size(params));
     return params;
@@ -85,7 +90,6 @@ async function getParamsForUpdate(args) {
     }
     else if (args.paramsEnvPath) {
         params = getParamsFromFile({
-            projectId: args.projectId,
             paramSpecs: args.newSpec.params,
             paramsEnvPath: args.paramsEnvPath,
         });

package/lib/requirePermissions.js

@@ -9,7 +9,10 @@ const error_1 = require("./error");
 const iam_1 = require("./gcp/iam");
 const BASE_PERMISSIONS = ["firebase.projects.get"];
 async function requirePermissions(options, permissions = []) {
-    const projectId = (0, projectUtils_1.needProjectId)(options);
+    const projectId = (0, projectUtils_1.getProjectId)(options);
+    if (!projectId) {
+        return;
+    }
     const requiredPermissions = BASE_PERMISSIONS.concat(permissions).sort();
     await (0, requireAuth_1.requireAuth)(options);
     logger_1.logger.debug(`[iam] checking project ${projectId} for permissions ${JSON.stringify(requiredPermissions)}`);

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "firebase-tools",
-  "version": "10.4.1",
+  "version": "10.4.2",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "firebase-tools",
-      "version": "10.4.1",
+      "version": "10.4.2",
       "license": "MIT",
       "dependencies": {
         "@google-cloud/pubsub": "^2.18.4",

package/package.json

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