firebase-tools 10.9.1 → 11.0.1

package/README.md

@@ -136,15 +136,21 @@ Detailed doc is [here](https://firebase.google.com/docs/cli/auth).
 
 ### Cloud Functions Commands
 
-| Command                    | Description                                                                                                  |
-| -------------------------- | ------------------------------------------------------------------------------------------------------------ |
-| **functions:log**          | Read logs from deployed Cloud Functions.                                                                     |
-| **functions:config:set**   | Store runtime configuration values for the current project's Cloud Functions.                                |
-| **functions:config:get**   | Retrieve existing configuration values for the current project's Cloud Functions.                            |
-| **functions:config:unset** | Remove values from the current project's runtime configuration.                                              |
-| **functions:config:clone** | Copy runtime configuration from one project environment to another.                                          |
-| **functions:delete**       | Delete one or more Cloud Functions by name or group name.                                                    |
-| **functions:shell**        | Locally emulate functions and start Node.js shell where these local functions can be invoked with test data. |
+| Command                       | Description                                                                                                  |
+| ----------------------------- | ------------------------------------------------------------------------------------------------------------ |
+| **functions:log**             | Read logs from deployed Cloud Functions.                                                                     |
+| **functions:list**            | List all deployed functions in your Firebase project.                                                        |
+| **functions:config:set**      | Store runtime configuration values for the current project's Cloud Functions.                                |
+| **functions:config:get**      | Retrieve existing configuration values for the current project's Cloud Functions.                            |
+| **functions:config:unset**    | Remove values from the current project's runtime configuration.                                              |
+| **functions:config:clone**    | Copy runtime configuration from one project environment to another.                                          |
+| **functions:secrets:set**     | Create or update a secret for use in Cloud Functions for Firebase.                                           |
+| **functions:secrets:get**     | Get metadata for secret and its versions.                                                                    |
+| **functions:secrets:access**  | Access secret value given secret and its version. Defaults to accessing the latest version.                  |
+| **functions:secrets:prune**   | Destroys unused secrets.                                                                                     |
+| **functions:secrets:destroy** | Destroy a secret. Defaults to destroying the latest version.                                                 |
+| **functions:delete**          | Delete one or more Cloud Functions by name or group name.                                                    |
+| **functions:shell**           | Locally emulate functions and start Node.js shell where these local functions can be invoked with test data. |
 
 ### Hosting Commands
 

package/lib/appdistribution/client.js

@@ -2,11 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AppDistributionClient = exports.UploadReleaseResult = exports.IntegrationState = void 0;
 const _ = require("lodash");
-const api = require("../api");
 const utils = require("../utils");
 const operationPoller = require("../operation-poller");
 const error_1 = require("../error");
 const apiv2_1 = require("../apiv2");
+const api_1 = require("../api");
 var IntegrationState;
 (function (IntegrationState) {
     IntegrationState["AAB_INTEGRATION_STATE_UNSPECIFIED"] = "AAB_INTEGRATION_STATE_UNSPECIFIED";
@@ -27,35 +27,33 @@ var UploadReleaseResult;
 class AppDistributionClient {
     constructor() {
         this.appDistroV2Client = new apiv2_1.Client({
-            urlPrefix: api.appDistributionOrigin,
+            urlPrefix: api_1.appDistributionOrigin,
             apiVersion: "v1",
         });
     }
     async getAabInfo(appName) {
-        const apiResponse = await api.request("GET", `/v1/${appName}/aabInfo`, {
-            origin: api.appDistributionOrigin,
-            auth: true,
-        });
-        return _.get(apiResponse, "body");
+        const apiResponse = await this.appDistroV2Client.get(`/${appName}/aabInfo`);
+        return apiResponse.body;
     }
     async uploadRelease(appName, distribution) {
-        const apiResponse = await api.request("POST", `/upload/v1/${appName}/releases:upload`, {
-            auth: true,
-            origin: api.appDistributionOrigin,
+        const client = new apiv2_1.Client({ urlPrefix: api_1.appDistributionOrigin });
+        const apiResponse = await client.request({
+            method: "POST",
+            path: `/upload/v1/${appName}/releases:upload`,
             headers: {
                 "X-Goog-Upload-File-Name": distribution.getFileName(),
                 "X-Goog-Upload-Protocol": "raw",
                 "Content-Type": "application/octet-stream",
             },
-            data: distribution.readStream(),
-            json: false,
+            responseType: "json",
+            body: distribution.readStream(),
         });
-        return _.get(JSON.parse(apiResponse.body), "name");
+        return apiResponse.body.name;
     }
     async pollUploadStatus(operationName) {
         return operationPoller.pollOperation({
             pollerName: "App Distribution Upload Poller",
-            apiOrigin: api.appDistributionOrigin,
+            apiOrigin: api_1.appDistributionOrigin,
             apiVersion: "v1",
             operationResourceName: operationName,
             masterTimeout: 5 * 60 * 1000,
@@ -75,15 +73,12 @@ class AppDistributionClient {
                 text: releaseNotes,
             },
         };
+        const queryParams = { updateMask: "release_notes.text" };
         try {
-            await api.request("PATCH", `/v1/${releaseName}?updateMask=release_notes.text`, {
-                origin: api.appDistributionOrigin,
-                auth: true,
-                data,
-            });
+            await this.appDistroV2Client.patch(`/${releaseName}`, data, { queryParams });
         }
         catch (err) {
-            throw new error_1.FirebaseError(`failed to update release notes with ${err === null || err === void 0 ? void 0 : err.message}`, { exit: 1 });
+            throw new error_1.FirebaseError(`failed to update release notes with ${err === null || err === void 0 ? void 0 : err.message}`);
         }
         utils.logSuccess("added release notes successfully");
     }
@@ -98,11 +93,7 @@ class AppDistributionClient {
             groupAliases,
         };
         try {
-            await api.request("POST", `/v1/${releaseName}:distribute`, {
-                origin: api.appDistributionOrigin,
-                auth: true,
-                data,
-            });
+            await this.appDistroV2Client.post(`/${releaseName}:distribute`, data);
         }
         catch (err) {
             let errorMessage = err.message;

package/lib/commands/apps-sdkconfig.js

@@ -10,11 +10,14 @@ const error_1 = require("../error");
 const requireAuth_1 = require("../requireAuth");
 const logger_1 = require("../logger");
 const prompt_1 = require("../prompt");
-async function selectAppInteractively(apps, appPlatform) {
-    if (apps.length === 0) {
+function checkForApps(apps, appPlatform) {
+    if (!apps.length) {
         throw new error_1.FirebaseError(`There are no ${appPlatform === apps_1.AppPlatform.ANY ? "" : appPlatform + " "}apps ` +
             "associated with this Firebase project");
     }
+}
+async function selectAppInteractively(apps, appPlatform) {
+    checkForApps(apps, appPlatform);
     const choices = apps.map((app) => {
         return {
             name: `${app.displayName || app.bundleId || app.packageName}` +
@@ -46,6 +49,7 @@ module.exports = new command_1.Command("apps:sdkconfig [platform] [appId]")
             projectId = result.projectId;
         }
         const apps = await (0, apps_1.listFirebaseApps)(projectId, appPlatform);
+        checkForApps(apps, appPlatform);
         if (apps.length === 1) {
             appId = apps[0].appId;
             appPlatform = apps[0].platform;

package/lib/commands/ext-configure.js

@@ -1,9 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const _ = require("lodash");
-const clc = require("cli-color");
 const { marked } = require("marked");
-const ora = require("ora");
 const TerminalRenderer = require("marked-terminal");
 const checkMinRequiredVersion_1 = require("../checkMinRequiredVersion");
 const command_1 = require("../command");
@@ -26,8 +23,7 @@ marked.setOptions({
 exports.default = new command_1.Command("ext:configure <extensionInstanceId>")
     .description("configure an existing extension instance")
     .withForce()
-    .option("--params <paramsFile>", "path of params file with .env format.")
-    .option("--local", "save to firebase.json rather than directly install to a Firebase project")
+    .option("--local", "deprecated")
     .before(requirePermissions_1.requirePermissions, [
     "firebaseextensions.instances.update",
     "firebaseextensions.instances.get",
@@ -35,126 +31,65 @@ exports.default = new command_1.Command("ext:configure <extensionInstanceId>")
     .before(checkMinRequiredVersion_1.checkMinRequiredVersion, "extMinVersion")
     .before(extensionsHelper_1.diagnoseAndFixProject)
     .action(async (instanceId, options) => {
-    var _a;
     const projectId = (0, projectUtils_1.getProjectId)(options);
+    if (options.nonInteractive) {
+        throw new error_1.FirebaseError(`Command not supported in non-interactive mode, edit ./extensions/${instanceId}.env directly instead. ` +
+            `See https://firebase.google.com/docs/extensions/manifest for more details.`);
+    }
     if (options.local) {
-        if (options.nonInteractive) {
-            throw new error_1.FirebaseError(`Command not supported in non-interactive mode, edit ./extensions/${instanceId}.env directly instead`);
-        }
-        const config = manifest.loadConfig(options);
-        const refOrPath = manifest.getInstanceTarget(instanceId, config);
-        const isLocalSource = (0, extensionsHelper_1.isLocalPath)(refOrPath);
-        let spec;
-        if (isLocalSource) {
-            const source = await (0, extensionsHelper_1.createSourceFromLocation)((0, projectUtils_1.needProjectId)({ projectId }), refOrPath);
-            spec = source.spec;
-        }
-        else {
-            const extensionVersion = await extensionsApi.getExtensionVersion(refOrPath);
-            spec = extensionVersion.spec;
-        }
-        const oldParamValues = manifest.readInstanceParam({
-            instanceId,
-            projectDir: config.projectDir,
-        });
-        const [immutableParams, tbdParams] = (0, functional_1.partition)(spec.params, (param) => { var _a; return (_a = param.immutable) !== null && _a !== void 0 ? _a : false; });
-        infoImmutableParams(immutableParams, oldParamValues);
-        paramHelper.setNewDefaults(tbdParams, oldParamValues);
-        const mutableParamsBindingOptions = await paramHelper.getParams({
-            projectId,
-            paramSpecs: tbdParams,
-            nonInteractive: false,
-            paramsEnvPath: ((_a = options.params) !== null && _a !== void 0 ? _a : ""),
-            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([
-            {
-                instanceId,
-                ref: !isLocalSource ? refs.parse(refOrPath) : undefined,
-                localPath: isLocalSource ? refOrPath : undefined,
-                params: newParamOptions,
-                extensionSpec: spec,
-            },
-        ], config, {
-            nonInteractive: false,
-            force: true,
-        });
-        manifest.showPreviewWarning();
-        return;
+        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 (!projectId) {
-        throw new error_1.FirebaseError(`Project ID must be provided when re-configuring an instance outside of local mode.`);
+    const config = manifest.loadConfig(options);
+    const refOrPath = manifest.getInstanceTarget(instanceId, config);
+    const isLocalSource = (0, extensionsHelper_1.isLocalPath)(refOrPath);
+    let spec;
+    if (isLocalSource) {
+        const source = await (0, extensionsHelper_1.createSourceFromLocation)((0, projectUtils_1.needProjectId)({ projectId }), refOrPath);
+        spec = source.spec;
     }
-    const spinner = ora(`Configuring ${clc.bold(instanceId)}. This usually takes 3 to 5 minutes...`);
-    try {
-        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({
-            projectId,
-            paramSpecs: paramSpecWithNewDefaults,
-            nonInteractive: options.nonInteractive,
-            paramsEnvPath: options.params,
-            instanceId,
-            reconfiguring: true,
-        });
-        const paramBindings = (0, paramHelper_1.getBaseParamBindings)(paramBindingOptions);
-        if (immutableParams.length) {
-            const plural = immutableParams.length > 1;
-            logger_1.logger.info(`The following param${plural ? "s are" : " is"} immutable:`);
-            for (const { param } of immutableParams) {
-                const value = _.get(existingInstance, `config.params.${param}`);
-                logger_1.logger.info(`param: ${param}, value: ${value}`);
-                paramBindings[param] = value;
-            }
-            logger_1.logger.info((plural
-                ? "To set different values for these params"
-                : "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 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`)}`));
-        manifest.showDeprecationWarning();
-        return res;
+    else {
+        const extensionVersion = await extensionsApi.getExtensionVersion(refOrPath);
+        spec = extensionVersion.spec;
     }
-    catch (err) {
-        if (spinner.isSpinning) {
-            spinner.fail();
-        }
-        if (!(err instanceof error_1.FirebaseError)) {
-            throw new error_1.FirebaseError(`Error occurred while configuring the instance: ${err.message}`, {
-                original: err,
-            });
-        }
-        throw err;
+    const oldParamValues = manifest.readInstanceParam({
+        instanceId,
+        projectDir: config.projectDir,
+    });
+    const [immutableParams, tbdParams] = (0, functional_1.partition)(spec.params, (param) => { var _a; return (_a = param.immutable) !== null && _a !== void 0 ? _a : false; });
+    infoImmutableParams(immutableParams, oldParamValues);
+    paramHelper.setNewDefaults(tbdParams, oldParamValues);
+    const mutableParamsBindingOptions = await paramHelper.getParams({
+        projectId,
+        paramSpecs: tbdParams,
+        nonInteractive: false,
+        paramsEnvPath: "",
+        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([
+        {
+            instanceId,
+            ref: !isLocalSource ? refs.parse(refOrPath) : undefined,
+            localPath: isLocalSource ? refOrPath : undefined,
+            params: newParamOptions,
+            extensionSpec: spec,
+        },
+    ], config, {
+        nonInteractive: false,
+        force: true,
+    });
+    manifest.showPostDeprecationNotice();
+    return;
 });
 function infoImmutableParams(immutableParams, paramValues) {
     if (!immutableParams.length) {

package/lib/commands/ext-dev-emulators-exec.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const clc = require("cli-color");
 const checkMinRequiredVersion_1 = require("../checkMinRequiredVersion");
 const command_1 = require("../command");
+const error_1 = require("../error");
 const commandUtils = require("../emulator/commandUtils");
-const optionsHelper = require("../extensions/emulator/optionsHelper");
 module.exports = new command_1.Command("ext:dev:emulators:exec <script>")
-    .description("emulate an extension, run a test script, then shut down the emulators")
+    .description("deprecated: please use `firebase emulators:exec` instead")
     .before(commandUtils.setExportOnExitOptions)
     .option(commandUtils.FLAG_INSPECT_FUNCTIONS, commandUtils.DESC_INSPECT_FUNCTIONS)
     .option(commandUtils.FLAG_TEST_CONFIG, commandUtils.DESC_TEST_CONFIG)
@@ -14,8 +15,12 @@ module.exports = new command_1.Command("ext:dev:emulators:exec <script>")
     .option(commandUtils.FLAG_EXPORT_ON_EXIT, commandUtils.DESC_EXPORT_ON_EXIT)
     .option(commandUtils.FLAG_UI, commandUtils.DESC_UI)
     .before(checkMinRequiredVersion_1.checkMinRequiredVersion, "extDevMinVersion")
-    .action(async (script, options) => {
-    const emulatorOptions = await optionsHelper.buildOptions(options);
-    commandUtils.beforeEmulatorCommand(emulatorOptions);
-    await commandUtils.emulatorExec(script, emulatorOptions);
+    .action((script, options) => {
+    const localInstallCommand = `firebase ext:install ${process.cwd()}`;
+    const emulatorsExecCommand = `firebase emulators:exec '${script}`;
+    throw new error_1.FirebaseError("ext:dev:emulators:exec is no longer supported. " +
+        "Instead, navigate to a Firebase project directory and add this extension to the extensions manifest by running:\n" +
+        clc.bold(localInstallCommand) +
+        "\nThen, you can emulate this extension as part of that project by running:\n" +
+        clc.bold(emulatorsExecCommand));
 });

package/lib/commands/ext-dev-emulators-start.js

@@ -1,39 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const checkMinRequiredVersion_1 = require("../checkMinRequiredVersion");
+const clc = require("cli-color");
 const command_1 = require("../command");
-const controller = require("../emulator/controller");
 const commandUtils = require("../emulator/commandUtils");
-const optionsHelper = require("../extensions/emulator/optionsHelper");
-const utils = require("../utils");
 const error_1 = require("../error");
 module.exports = new command_1.Command("ext:dev:emulators:start")
-    .description("start the local Firebase extension emulator")
+    .description("deprecated: please use `firebase emulators:start`")
     .before(commandUtils.setExportOnExitOptions)
     .option(commandUtils.FLAG_INSPECT_FUNCTIONS, commandUtils.DESC_INSPECT_FUNCTIONS)
     .option(commandUtils.FLAG_TEST_CONFIG, commandUtils.DESC_TEST_CONFIG)
     .option(commandUtils.FLAG_TEST_PARAMS, commandUtils.DESC_TEST_PARAMS)
     .option(commandUtils.FLAG_IMPORT, commandUtils.DESC_IMPORT)
     .option(commandUtils.FLAG_EXPORT_ON_EXIT, commandUtils.DESC_EXPORT_ON_EXIT)
-    .before(checkMinRequiredVersion_1.checkMinRequiredVersion, "extDevMinVersion")
-    .action(async (options) => {
-    const killSignalPromise = commandUtils.shutdownWhenKilled(options);
-    const emulatorOptions = await optionsHelper.buildOptions(options);
-    let deprecationNotices;
-    try {
-        commandUtils.beforeEmulatorCommand(emulatorOptions);
-        ({ deprecationNotices } = await controller.startAll(emulatorOptions));
-    }
-    catch (e) {
-        await controller.cleanShutdown();
-        if (!(e instanceof error_1.FirebaseError)) {
-            throw new error_1.FirebaseError("Error in ext:dev:emulator:start", e);
-        }
-        throw e;
-    }
-    utils.logSuccess("All emulators ready, it is now safe to connect.");
-    for (const notice of deprecationNotices) {
-        utils.logLabeledWarning("emulators", notice, "warn");
-    }
-    await killSignalPromise;
+    .action((options) => {
+    const localInstallCommand = `firebase ext:install ${process.cwd()}`;
+    const emulatorsStartCommand = "firebase emulators:start";
+    throw new error_1.FirebaseError("ext:dev:emulators:start is no longer supported. " +
+        "Instead, navigate to a Firebase project directory and add this extension to the extensions manifest by running:\n" +
+        clc.bold(localInstallCommand) +
+        "\nThen, you can emulate this extension as part of that project by running:\n" +
+        clc.bold(emulatorsStartCommand));
 });