firebase-tools 10.9.2 → 11.1.0

package/lib/commands/ext-install.js

@@ -1,55 +1,45 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.command = void 0;
 const clc = require("cli-color");
 const { marked } = require("marked");
-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");
 const checkMinRequiredVersion_1 = require("../checkMinRequiredVersion");
 const command_1 = require("../command");
 const error_1 = require("../error");
 const projectUtils_1 = require("../projectUtils");
 const extensionsApi = require("../extensions/extensionsApi");
-const secretsUtils = require("../extensions/secretsUtils");
-const provisioningHelper = require("../extensions/provisioningHelper");
 const refs = require("../extensions/refs");
 const warnings_1 = require("../extensions/warnings");
 const paramHelper = require("../extensions/paramHelper");
 const extensionsHelper_1 = require("../extensions/extensionsHelper");
-const updateHelper_1 = require("../extensions/updateHelper");
 const utils_1 = require("../extensions/utils");
 const requirePermissions_1 = require("../requirePermissions");
 const utils = require("../utils");
 const track_1 = require("../track");
-const logger_1 = require("../logger");
 const previews_1 = require("../previews");
 const manifest = require("../extensions/manifest");
-const paramHelper_1 = require("../extensions/paramHelper");
 marked.setOptions({
     renderer: new TerminalRenderer(),
 });
-exports.default = new command_1.Command("ext:install [extensionName]")
+exports.command = new command_1.Command("ext:install [extensionName]")
     .description("install an official extension if [extensionName] or [extensionName@version] is provided; " +
     (previews_1.previews.extdev
         ? "install a local extension if [localPathOrUrl] or [url#root] is provided; install a published extension (not authored by Firebase) if [publisherId/extensionId] is provided "
         : "") +
     "or run with `-i` to see all available extensions.")
+    .option("--local", "deprecated")
     .withForce()
-    .option("--params <paramsFile>", "name of params variables file with .env format.")
-    .option("--local", "save to firebase.json rather than directly install to a Firebase project")
     .before(requirePermissions_1.requirePermissions, ["firebaseextensions.instances.create"])
     .before(extensionsHelper_1.ensureExtensionsApiEnabled)
     .before(checkMinRequiredVersion_1.checkMinRequiredVersion, "extMinVersion")
     .before(extensionsHelper_1.diagnoseAndFixProject)
     .action(async (extensionName, options) => {
-    var _a, _b;
+    var _a;
     const projectId = (0, projectUtils_1.getProjectId)(options);
-    const paramsEnvPath = ((_a = options.params) !== null && _a !== void 0 ? _a : "");
+    const paramsEnvPath = "";
     let learnMore = false;
     if (!extensionName) {
         if (options.interactive) {
@@ -67,6 +57,9 @@ exports.default = new command_1.Command("ext:install [extensionName]")
     if ((0, extensionsHelper_1.isUrlPath)(extensionName)) {
         throw new error_1.FirebaseError(`Installing with a source url is no longer supported in the CLI. Please use Firebase Console instead.`);
     }
+    if (options.local) {
+        utils.logLabeledWarning(extensionsHelper_1.logPrefix, "As of firebase-tools@11.0.0, the `--local` flag is no longer required, as it is the default behavior.");
+    }
     if ((0, extensionsHelper_1.isLocalPath)(extensionName)) {
         source = await (0, extensionsHelper_1.createSourceFromLocation)((0, projectUtils_1.needProjectId)({ projectId }), extensionName);
         (0, displayExtensionInfo_1.displayExtInfo)(extensionName, "", source.spec);
@@ -74,7 +67,7 @@ exports.default = new command_1.Command("ext:install [extensionName]")
     }
     else {
         void (0, track_1.track)("Extension Install", "Install by Extension Ref", options.interactive ? 1 : 0);
-        extensionName = (0, extensionsHelper_1.canonicalizeRefInput)(extensionName);
+        extensionName = await (0, extensionsHelper_1.canonicalizeRefInput)(extensionName);
         extensionVersion = await extensionsApi.getExtensionVersion(extensionName);
         await infoExtensionVersion({
             extensionName,
@@ -91,7 +84,7 @@ exports.default = new command_1.Command("ext:install [extensionName]")
     if (!source && !extensionVersion) {
         throw new error_1.FirebaseError("Could not find a source. Please specify a valid source to continue.");
     }
-    const spec = (_b = source === null || source === void 0 ? void 0 : source.spec) !== null && _b !== void 0 ? _b : extensionVersion === null || extensionVersion === void 0 ? void 0 : extensionVersion.spec;
+    const spec = (_a = source === null || source === void 0 ? void 0 : source.spec) !== null && _a !== void 0 ? _a : extensionVersion === null || extensionVersion === void 0 ? void 0 : extensionVersion.spec;
     if (!spec) {
         throw new error_1.FirebaseError(`Could not find the extension.yaml for extension '${clc.bold(extensionName)}'. Please make sure this is a valid extension and try again.`);
     }
@@ -100,31 +93,10 @@ exports.default = new command_1.Command("ext:install [extensionName]")
             `${spec.description}\n` +
             `View details: https://firebase.google.com/products/extensions/${spec.name}\n`);
     }
-    if (options.local) {
-        try {
-            return installToManifest({
-                paramsEnvPath,
-                projectId,
-                extensionName,
-                source,
-                extVersion: extensionVersion,
-                nonInteractive: options.nonInteractive,
-                force: options.force,
-            });
-        }
-        catch (err) {
-            if (!(err instanceof error_1.FirebaseError)) {
-                throw new error_1.FirebaseError(`Error occurred saving the extension to manifest: ${err.message}`, {
-                    original: err,
-                });
-            }
-            throw err;
-        }
-    }
     try {
-        return installExtension({
+        return installToManifest({
             paramsEnvPath,
-            projectId: projectId,
+            projectId,
             extensionName,
             source,
             extVersion: extensionVersion,
@@ -134,7 +106,7 @@ exports.default = new command_1.Command("ext:install [extensionName]")
     }
     catch (err) {
         if (!(err instanceof error_1.FirebaseError)) {
-            throw new error_1.FirebaseError(`Error occurred installing the extension: ${err.message}`, {
+            throw new error_1.FirebaseError(`Error occurred saving the extension to manifest: ${err.message}`, {
                 original: err,
             });
         }
@@ -186,161 +158,5 @@ async function installToManifest(options) {
             extensionSpec: spec,
         },
     ], config, { nonInteractive, force: force !== null && force !== void 0 ? force : false });
-    manifest.showPreviewWarning();
-}
-async function installExtension(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.`);
-    }
-    const spinner = ora();
-    try {
-        await provisioningHelper.checkProductsProvisioned(projectId, spec);
-        const usesSecrets = secretsUtils.usesSecrets(spec);
-        if (spec.billingRequired || usesSecrets) {
-            const enabled = await (0, cloudbilling_1.checkBillingEnabled)(projectId);
-            if (!enabled && nonInteractive) {
-                throw new error_1.FirebaseError(`This extension requires the Blaze plan, but project ${projectId} is not on the Blaze plan. ` +
-                    marked("Please visit https://console.cloud.google.com/billing/linkedaccount?project=${projectId} to upgrade your project."));
-            }
-            else if (!enabled) {
-                await (0, billingMigrationHelper_1.displayNode10CreateBillingNotice)(spec, false);
-                await (0, checkProjectBilling_1.enableBilling)(projectId);
-            }
-            else {
-                await (0, billingMigrationHelper_1.displayNode10CreateBillingNotice)(spec, !nonInteractive);
-            }
-        }
-        const apis = spec.apis || [];
-        if (usesSecrets) {
-            apis.push({
-                apiName: "secretmanager.googleapis.com",
-                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 });
-            if (!consented) {
-                throw new error_1.FirebaseError("Without explicit consent for the APIs listed, we cannot deploy this extension.");
-            }
-        }
-        if (usesSecrets) {
-            await secretsUtils.ensureSecretManagerApiEnabled(options);
-        }
-        const roles = spec.roles ? spec.roles.map((role) => role.role) : [];
-        if (roles.length) {
-            await askUserForConsent.displayRoles(spec.displayName || spec.name, projectId, roles);
-            const consented = await (0, extensionsHelper_1.confirm)({ nonInteractive, force, default: true });
-            if (!consented) {
-                throw new error_1.FirebaseError("Without explicit consent for the roles listed, we cannot deploy this extension.");
-            }
-        }
-        let instanceId = spec.name;
-        let choice;
-        const anotherInstanceExists = await (0, extensionsHelper_1.instanceIdExists)(projectId, instanceId);
-        if (anotherInstanceExists) {
-            if (!nonInteractive) {
-                choice = await (0, extensionsHelper_1.promptForRepeatInstance)(projectId, spec.name);
-            }
-            else if (nonInteractive && force) {
-                choice = "updateExisting";
-            }
-            else {
-                throw new error_1.FirebaseError(`An extension with the ID '${clc.bold(extensionName)}' already exists in the project '${clc.bold(projectId)}'.` +
-                    ` To update or reconfigure this instance instead, rerun this command with the --force flag.`);
-            }
-        }
-        else {
-            choice = "installNew";
-        }
-        let paramBindingOptions;
-        let paramBindings;
-        let eventsConfig;
-        switch (choice) {
-            case "installNew":
-                instanceId = await (0, extensionsHelper_1.promptForValidInstanceId)(`${instanceId}-${(0, utils_1.getRandomString)(4)}`);
-                paramBindingOptions = await paramHelper.getParams({
-                    projectId,
-                    paramSpecs: spec.params,
-                    nonInteractive,
-                    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();
-                await extensionsApi.createInstance({
-                    projectId,
-                    instanceId,
-                    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)}! ` +
-                    `Its Instance ID is ${clc.bold(instanceId)}.`);
-                break;
-            case "updateExisting":
-                paramBindingOptions = await paramHelper.getParams({
-                    projectId,
-                    paramSpecs: spec.params,
-                    nonInteractive,
-                    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();
-                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)}.`);
-                break;
-            case "cancel":
-                return;
-        }
-        utils.logLabeledBullet(extensionsHelper_1.logPrefix, marked("Go to the Firebase console to view instructions for using your extension, " +
-            `which may include some required post-installation tasks: ${utils.consoleUrl(projectId, `/extensions/instances/${instanceId}?tab=usage`)}`));
-        logger_1.logger.info(marked("You can run `firebase ext` to view available Firebase Extensions commands, " +
-            "including those to update, reconfigure, or delete your installed extension."));
-        manifest.showDeprecationWarning();
-    }
-    catch (err) {
-        if (spinner.isSpinning) {
-            spinner.fail();
-        }
-        if (err instanceof error_1.FirebaseError) {
-            throw err;
-        }
-        throw new error_1.FirebaseError(`Error occurred installing extension: ${err.message}`, {
-            original: err,
-        });
-    }
+    manifest.showPostDeprecationNotice();
 }

package/lib/commands/ext-list.js

@@ -1,12 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.command = void 0;
 const checkMinRequiredVersion_1 = require("../checkMinRequiredVersion");
 const command_1 = require("../command");
 const projectUtils_1 = require("../projectUtils");
 const listExtensions_1 = require("../extensions/listExtensions");
 const extensionsHelper_1 = require("../extensions/extensionsHelper");
 const requirePermissions_1 = require("../requirePermissions");
-module.exports = new command_1.Command("ext:list")
+exports.command = new command_1.Command("ext:list")
     .description("list all the extensions that are installed in your Firebase project")
     .before(requirePermissions_1.requirePermissions, ["firebaseextensions.instances.list"])
     .before(extensionsHelper_1.ensureExtensionsApiEnabled)

package/lib/commands/ext-sources-create.js

@@ -1,12 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.command = void 0;
 const checkMinRequiredVersion_1 = require("../checkMinRequiredVersion");
 const command_1 = require("../command");
 const projectUtils_1 = require("../projectUtils");
 const logger_1 = require("../logger");
 const extensionsHelper_1 = require("../extensions/extensionsHelper");
 const requirePermissions_1 = require("../requirePermissions");
-exports.default = new command_1.Command("ext:sources:create <sourceLocation>")
+exports.command = new command_1.Command("ext:sources:create <sourceLocation>")
     .description(`create a extension source from sourceLocation`)
     .help("sourceLocation can be a local directory containing an extension, or URL pointing to a zipped extension. " +
     'If using a URL, you can specify a root folder for the extension by adding "#<extensionRoot>". ' +

package/lib/commands/ext-uninstall.js

@@ -1,113 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const _ = require("lodash");
-const clc = require("cli-color");
-const ora = require("ora");
+exports.command = void 0;
 const { marked } = require("marked");
 const TerminalRenderer = require("marked-terminal");
 const checkMinRequiredVersion_1 = require("../checkMinRequiredVersion");
 const command_1 = require("../command");
-const error_1 = require("../error");
-const projectUtils_1 = require("../projectUtils");
-const extensionsApi = require("../extensions/extensionsApi");
-const secretsUtils = require("../extensions/secretsUtils");
 const extensionsHelper_1 = require("../extensions/extensionsHelper");
-const prompt_1 = require("../prompt");
 const requirePermissions_1 = require("../requirePermissions");
-const utils = require("../utils");
-const logger_1 = require("../logger");
+const utils_1 = require("../utils");
 const manifest = require("../extensions/manifest");
 marked.setOptions({
     renderer: new TerminalRenderer(),
 });
-exports.default = new command_1.Command("ext:uninstall <extensionInstanceId>")
+exports.command = new command_1.Command("ext:uninstall <extensionInstanceId>")
     .description("uninstall an extension that is installed in your Firebase project by instance ID")
+    .option("--local", "deprecated")
     .withForce()
-    .option("--local", "remove from firebase.json rather than directly uninstall from a Firebase project")
     .before(requirePermissions_1.requirePermissions, ["firebaseextensions.instances.delete"])
     .before(extensionsHelper_1.ensureExtensionsApiEnabled)
     .before(checkMinRequiredVersion_1.checkMinRequiredVersion, "extMinVersion")
     .before(extensionsHelper_1.diagnoseAndFixProject)
-    .action(async (instanceId, options) => {
+    .action((instanceId, options) => {
     if (options.local) {
-        const config = manifest.loadConfig(options);
-        manifest.removeFromManifest(instanceId, config);
-        manifest.showPreviewWarning();
-        return;
+        (0, utils_1.logLabeledWarning)(extensionsHelper_1.logPrefix, "As of firebase-tools@11.0.0, the `--local` flag is no longer required, as it is the default behavior.");
     }
-    const projectId = (0, projectUtils_1.needProjectId)(options);
-    let instance;
-    try {
-        instance = await extensionsApi.getInstance(projectId, instanceId);
-    }
-    catch (err) {
-        if (err.status === 404) {
-            return utils.reject(`No extension instance ${instanceId} in project ${projectId}.`, {
-                exit: 1,
-            });
-        }
-        throw err;
-    }
-    if (_.get(instance, "config.source.spec.name") === "pubsub-stream-bigquery") {
-        return consoleUninstallOnly(projectId, instanceId);
-    }
-    if (!options.force) {
-        const serviceAccountMessage = `Uninstalling deletes the service account used by this extension instance:\n${clc.bold(instance.serviceAccountEmail)}\n\n`;
-        const managedSecrets = await secretsUtils.getManagedSecrets(instance);
-        const resourcesMessage = _.get(instance, "config.source.spec.resources", []).length
-            ? "Uninstalling deletes all extension resources created for this extension instance:\n" +
-                instance.config.source.spec.resources
-                    .map((resource) => clc.bold(`- ${extensionsHelper_1.resourceTypeToNiceName[resource.type] || resource.type}: ${resource.name} \n`))
-                    .join("") +
-                managedSecrets
-                    .map(secretsUtils.prettySecretName)
-                    .map((s) => clc.bold(`- Secret: ${s}\n`))
-                    .join("") +
-                "\n"
-            : "";
-        const artifactsMessage = `The following ${clc.bold("will not")} be deleted:\n` +
-            "Any artifacts (for example, stored images) created by this extension instance.\n" +
-            "Any other project resources with which this extension instance interacted.\n";
-        const extensionDeletionMessage = `Here's what will happen when you uninstall ${clc.bold(instanceId)} from project ${clc.bold(projectId)}. Be aware that this cannot be undone.\n\n` +
-            `${serviceAccountMessage}` +
-            `${resourcesMessage}` +
-            `${artifactsMessage}`;
-        logger_1.logger.info(extensionDeletionMessage);
-        const confirmedExtensionDeletion = await (0, prompt_1.promptOnce)({
-            type: "confirm",
-            default: true,
-            message: "Are you sure that you wish to uninstall this extension?",
-        });
-        if (!confirmedExtensionDeletion) {
-            return utils.reject("Command aborted.", { exit: 1 });
-        }
-    }
-    const spinner = ora(` ${clc.green.bold(extensionsHelper_1.logPrefix)}: uninstalling ${clc.bold(instanceId)}. This usually takes 1 to 2 minutes...`);
-    spinner.start();
-    try {
-        spinner.info();
-        spinner.text = ` ${clc.green.bold(extensionsHelper_1.logPrefix)}: deleting your extension instance's resources.`;
-        spinner.start();
-        await extensionsApi.deleteInstance(projectId, instanceId);
-        spinner.succeed(` ${clc.green.bold(extensionsHelper_1.logPrefix)}: deleted your extension instance's resources.`);
-    }
-    catch (err) {
-        if (spinner.isSpinning) {
-            spinner.fail();
-        }
-        if (err instanceof error_1.FirebaseError) {
-            throw err;
-        }
-        return utils.reject(`Error occurred uninstalling extension ${instanceId}`, { original: err });
-    }
-    utils.logLabeledSuccess(extensionsHelper_1.logPrefix, `uninstalled ${clc.bold(instanceId)}`);
-    manifest.showDeprecationWarning();
+    const config = manifest.loadConfig(options);
+    manifest.removeFromManifest(instanceId, config);
+    manifest.showPostDeprecationNotice();
 });
-function consoleUninstallOnly(projectId, instanceId) {
-    const instanceURL = `https://console.firebase.google.com/project/${projectId}/extensions/instances/${instanceId}`;
-    const consoleUninstall = "This extension has additional uninstall checks that are not currently supported by the CLI, and can only be uninstalled through the Firebase Console. " +
-        `Please visit **[${instanceURL}](${instanceURL})** to uninstall this extension.`;
-    logger_1.logger.info("\n");
-    utils.logLabeledWarning(extensionsHelper_1.logPrefix, marked(consoleUninstall));
-    return Promise.resolve();
-}