firebase-tools 13.17.0 → 13.19.0

package/README.md

@@ -117,15 +117,16 @@ Detailed doc is [here](https://firebase.google.com/docs/cli/auth).
 
 ### Extensions Commands
 
-| Command           | Description                                                                                 |
-| ----------------- | ------------------------------------------------------------------------------------------- |
-| **ext**           | Display information on how to use ext commands and extensions installed to your project.    |
-| **ext:configure** | Configure an existing extension instance.                                                   |
-| **ext:info**      | Display information about an extension by name (extensionName@x.y.z for a specific version) |
-| **ext:install**   | Install an extension.                                                                       |
-| **ext:list**      | List all the extensions that are installed in your Firebase project.                        |
-| **ext:uninstall** | Uninstall an extension that is installed in your Firebase project by Instance ID.           |
-| **ext:update**    | Update an existing extension instance to the latest version.                                |
+| Command             | Description                                                                                 |
+| ------------------- | ------------------------------------------------------------------------------------------- |
+| **ext**             | Display information on how to use ext commands and extensions installed to your project.    |
+| **ext:configure**   | Configure an existing extension instance.                                                   |
+| **ext:info**        | Display information about an extension by name (extensionName@x.y.z for a specific version) |
+| **ext:install**     | Install an extension.                                                                       |
+| **ext:sdk:install** | Install and SDK for an extension so you can define the extension in a functions codebase.   |
+| **ext:list**        | List all the extensions that are installed in your Firebase project.                        |
+| **ext:uninstall**   | Uninstall an extension that is installed in your Firebase project by Instance ID.           |
+| **ext:update**      | Update an existing extension instance to the latest version.                                |
 
 ### Cloud Firestore Commands
 

package/lib/commands/dataconnect-services-list.js

@@ -36,14 +36,15 @@ exports.command = new command_1.Command("dataconnect:services:list")
     for (const service of services) {
         const schema = (_a = (await client.getSchema(service.name))) !== null && _a !== void 0 ? _a : {
             name: "",
-            primaryDatasource: {},
+            datasources: [{}],
             source: { files: [] },
         };
         const connectors = await client.listConnectors(service.name);
         const serviceName = names.parseServiceName(service.name);
-        const instanceName = (_c = (_b = schema === null || schema === void 0 ? void 0 : schema.primaryDatasource.postgresql) === null || _b === void 0 ? void 0 : _b.cloudSql.instance) !== null && _c !== void 0 ? _c : "";
+        const postgresDatasource = schema === null || schema === void 0 ? void 0 : schema.datasources.find((d) => d.postgresql);
+        const instanceName = (_c = (_b = postgresDatasource === null || postgresDatasource === void 0 ? void 0 : postgresDatasource.postgresql) === null || _b === void 0 ? void 0 : _b.cloudSql.instance) !== null && _c !== void 0 ? _c : "";
         const instanceId = instanceName.split("/").pop();
-        const dbId = (_e = (_d = schema === null || schema === void 0 ? void 0 : schema.primaryDatasource.postgresql) === null || _d === void 0 ? void 0 : _d.database) !== null && _e !== void 0 ? _e : "";
+        const dbId = (_e = (_d = postgresDatasource === null || postgresDatasource === void 0 ? void 0 : postgresDatasource.postgresql) === null || _d === void 0 ? void 0 : _d.database) !== null && _e !== void 0 ? _e : "";
         const dbName = `CloudSQL Instance: ${instanceId}\nDatabase: ${dbId}`;
         table.push([
             serviceName.serviceId,

package/lib/commands/dataconnect-sql-grant.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.command = void 0;
+const command_1 = require("../command");
+const projectUtils_1 = require("../projectUtils");
+const ensureApis_1 = require("../dataconnect/ensureApis");
+const requirePermissions_1 = require("../requirePermissions");
+const fileUtils_1 = require("../dataconnect/fileUtils");
+const schemaMigration_1 = require("../dataconnect/schemaMigration");
+const requireAuth_1 = require("../requireAuth");
+const error_1 = require("../error");
+const permissions_1 = require("../gcp/cloudsql/permissions");
+const allowedRoles = Object.keys(permissions_1.fdcSqlRoleMap);
+exports.command = new command_1.Command("dataconnect:sql:grant [serviceId]")
+    .description("Grants the SQL role <role> to the provided user or service account <email>.")
+    .option("-R, --role <role>", "The SQL role to grant. One of: owner, writer, or reader.")
+    .option("-E, --email <email>", "The email of the user or service account we would like to grant the role to.")
+    .before(requirePermissions_1.requirePermissions, ["firebasedataconnect.services.list"])
+    .before(requireAuth_1.requireAuth)
+    .action(async (serviceId, options) => {
+    const role = options.role;
+    const email = options.email;
+    if (!role) {
+        throw new error_1.FirebaseError("-R, --role <role> is required. Run the command with -h for more info.");
+    }
+    if (!email) {
+        throw new error_1.FirebaseError("-E, --email <email> is required. Run the command with -h for more info.");
+    }
+    if (!allowedRoles.includes(role.toLowerCase())) {
+        throw new error_1.FirebaseError(`Role should be one of ${allowedRoles.join(" | ")}.`);
+    }
+    const projectId = (0, projectUtils_1.needProjectId)(options);
+    await (0, ensureApis_1.ensureApis)(projectId);
+    const serviceInfo = await (0, fileUtils_1.pickService)(projectId, options.config, serviceId);
+    await (0, schemaMigration_1.grantRoleToUserInSchema)(options, serviceInfo.schema);
+    return { projectId, serviceId };
+});

package/lib/commands/dataconnect-sql-migrate.js

@@ -21,7 +21,7 @@ exports.command = new command_1.Command("dataconnect:sql:migrate [serviceId]")
     .before(requireAuth_1.requireAuth)
     .withForce("Execute any required database changes without prompting")
     .action(async (serviceId, options) => {
-    var _a;
+    var _a, _b;
     const projectId = (0, projectUtils_1.needProjectId)(options);
     await (0, ensureApis_1.ensureApis)(projectId);
     const serviceInfo = await (0, fileUtils_1.pickService)(projectId, options.config, serviceId);
@@ -33,6 +33,7 @@ exports.command = new command_1.Command("dataconnect:sql:migrate [serviceId]")
         options,
         schema: serviceInfo.schema,
         validateOnly: true,
+        schemaValidation: (_b = serviceInfo.dataConnectYaml.schema.datasource.postgresql) === null || _b === void 0 ? void 0 : _b.schemaValidation,
     });
     if (diffs.length) {
         (0, utils_1.logLabeledSuccess)("dataconnect", `Database schema sucessfully migrated! Run 'firebase deploy' to deploy your new schema to your Data Connect service.`);

package/lib/commands/deploy.js

@@ -86,6 +86,8 @@ exports.command = new command_1.Command("deploy")
     "For data connect, can specify filters with colons to deploy only a service, connector, or schema" +
     '(e.g. "--only dataconnect:serviceId,dataconnect:serviceId:connectorId,dataconnect:serviceId:schema"). ')
     .option("--except <targets>", 'deploy to all targets except specified (e.g. "database")')
+    .option("--dry-run", "Perform a dry run of your deployment. Validates your changes and builds your code without deploying any changes to your project. " +
+    "In order to provide better validation, this may still enable APIs on the target project.")
     .before(requireConfig_1.requireConfig)
     .before((options) => {
     options.filteredTargets = (0, filterTargets_1.filterTargets)(options, exports.VALID_DEPLOY_TARGETS);

package/lib/commands/ext-info.js

@@ -110,7 +110,9 @@ exports.command = new command_1.Command("ext:info <extensionName>")
     else {
         marked_1.marked.use((0, marked_terminal_1.markedTerminal)());
         logger_1.logger.info(await (0, marked_1.marked)(lines.join("\n")));
-        utils.logLabeledBullet(extensionsHelper_1.logPrefix, `to install this extension, type ` +
+        utils.logLabeledBullet(extensionsHelper_1.logPrefix, `to install this extension, run ` +
             clc.bold(`firebase ext:install ${extensionName} --project=YOUR_PROJECT`));
+        utils.logLabeledBullet(extensionsHelper_1.logPrefix, `to install an autogenerated SDK for this extension into your functions codebase, run ` +
+            clc.bold(`firebase ext:sdk:install ${extensionName} --project=YOUR_PROJECT`));
     }
 });

package/lib/commands/ext-sdk-install.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.command = void 0;
+const clc = require("colorette");
+const semver = require("semver");
+const checkMinRequiredVersion_1 = require("../checkMinRequiredVersion");
+const command_1 = require("../command");
+const extensionsApi = require("../extensions/extensionsApi");
+const extensionsHelper_1 = require("../extensions/extensionsHelper");
+const localHelper_1 = require("../extensions/localHelper");
+const requirePermissions_1 = require("../requirePermissions");
+const common_1 = require("../extensions/runtimes/common");
+const error_1 = require("../error");
+const displayExtensionInfo_1 = require("../extensions/displayExtensionInfo");
+const refs = require("../extensions/refs");
+const logger_1 = require("../logger");
+const prompt_1 = require("../prompt");
+const utils = require("../utils");
+exports.command = new command_1.Command("ext:sdk:install <extensionName>")
+    .description("get an SDK for this extension. The SDK will be put in the 'generated' directory")
+    .option(`--codebase <codebase>`, `specifies a codebase to install the SDK into`)
+    .option(`--force`, `will overwrite existing sdk files if true`)
+    .before(checkMinRequiredVersion_1.checkMinRequiredVersion, "extDevMinVersion")
+    .action(async (extensionName, options) => {
+    const runtime = await (0, common_1.getCodebaseRuntime)(options);
+    if (!runtime.startsWith("nodejs")) {
+        throw new error_1.FirebaseError(`Extension SDK generation is currently only supported for NodeJs. We detected the target source to be: ${runtime}`);
+    }
+    let spec;
+    let extensionRef;
+    let localPath;
+    if ((0, localHelper_1.isLocalExtension)(extensionName)) {
+        spec = await (0, localHelper_1.getLocalExtensionSpec)(extensionName);
+        spec.systemParams = [];
+        localPath = extensionName;
+        await (0, displayExtensionInfo_1.displayExtensionVersionInfo)({ spec });
+    }
+    else {
+        await (0, requirePermissions_1.requirePermissions)(options, ["firebaseextensions.sources.get"]);
+        await (0, extensionsHelper_1.ensureExtensionsApiEnabled)(options);
+        const hasPublisherId = extensionName.split("/").length >= 2;
+        if (hasPublisherId) {
+            const nameAndVersion = extensionName.split("/")[1];
+            if (nameAndVersion.split("@").length < 2) {
+                extensionName = extensionName + "@latest";
+            }
+        }
+        else {
+            const [name, version] = extensionName.split("@");
+            extensionName = `firebase/${name}@${version || "latest"}`;
+        }
+        const ref = refs.parse(extensionName);
+        const extension = await extensionsApi.getExtension(refs.toExtensionRef(ref));
+        const version = await extensionsApi.getExtensionVersion(extensionName);
+        spec = version.spec;
+        extensionRef = version.ref;
+        await (0, displayExtensionInfo_1.displayExtensionVersionInfo)({
+            spec,
+            extensionVersion: version,
+            latestApprovedVersion: extension.latestApprovedVersion,
+            latestVersion: extension.latestVersion,
+        });
+        if (version.state === "DEPRECATED") {
+            throw new error_1.FirebaseError(`Extension version ${clc.bold(extensionName)} is deprecated and cannot be installed. To install an SDK for the ` +
+                `latest non-deprecated version, omit the version in the extension ref.`);
+        }
+        logger_1.logger.info();
+        if ((extension.latestApprovedVersion &&
+            semver.gt(extension.latestApprovedVersion, version.spec.version)) ||
+            (!extension.latestApprovedVersion &&
+                extension.latestVersion &&
+                semver.gt(extension.latestVersion, version.spec.version))) {
+            const latest = extension.latestApprovedVersion || extension.latestVersion;
+            logger_1.logger.info(`You are about to install an SDK for extension version ${clc.bold(version.spec.version)} which is older than the latest ${extension.latestApprovedVersion ? "accepted version" : "version"} ${clc.bold(latest)}.`);
+        }
+    }
+    if (!(await (0, prompt_1.confirm)({
+        nonInteractive: options.nonInteractive,
+        force: options.force,
+        default: true,
+    }))) {
+        return;
+    }
+    const codeSample = await (0, common_1.writeSDK)(extensionRef, localPath, spec, options);
+    logger_1.logger.info();
+    utils.logSuccess("Extension SDK installed successfully");
+    logger_1.logger.info(codeSample);
+});

package/lib/commands/ext.js

@@ -23,6 +23,7 @@ exports.command = new command_1.Command("ext")
         "ext:configure",
         "ext:update",
         "ext:uninstall",
+        "ext:sdk:install",
     ];
     for (const commandName of commandNames) {
         const command = firebaseTools.getCommand(commandName);

package/lib/commands/index.js

@@ -83,6 +83,8 @@ function load(client) {
     client.ext.list = loadCommand("ext-list");
     client.ext.uninstall = loadCommand("ext-uninstall");
     client.ext.update = loadCommand("ext-update");
+    client.ext.sdk = {};
+    client.ext.sdk.install = loadCommand("ext-sdk-install");
     client.ext.dev = {};
     client.ext.dev.init = loadCommand("ext-dev-init");
     client.ext.dev.list = loadCommand("ext-dev-list");
@@ -207,6 +209,7 @@ function load(client) {
     client.dataconnect.sql = {};
     client.dataconnect.sql.diff = loadCommand("dataconnect-sql-diff");
     client.dataconnect.sql.migrate = loadCommand("dataconnect-sql-migrate");
+    client.dataconnect.sql.grant = loadCommand("dataconnect-sql-grant");
     client.dataconnect.sdk = {};
     client.dataconnect.sdk.generate = loadCommand("dataconnect-sdk-generate");
     client.target = loadCommand("target");

package/lib/dataconnect/client.js

@@ -5,7 +5,7 @@ const api_1 = require("../api");
 const apiv2_1 = require("../apiv2");
 const operationPoller = require("../operation-poller");
 const types = require("./types");
-const DATACONNECT_API_VERSION = "v1alpha";
+const DATACONNECT_API_VERSION = "v1beta";
 const PAGE_SIZE_MAX = 100;
 const dataconnectClient = () => new apiv2_1.Client({
     urlPrefix: (0, api_1.dataconnectOrigin)(),

package/lib/dataconnect/dataplaneClient.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.executeGraphQL = void 0;
 const api_1 = require("../api");
 const apiv2_1 = require("../apiv2");
-const DATACONNECT_API_VERSION = "v1alpha";
+const DATACONNECT_API_VERSION = "v1beta";
 const dataconnectDataplaneClient = () => new apiv2_1.Client({
     urlPrefix: (0, api_1.dataconnectOrigin)(),
     apiVersion: DATACONNECT_API_VERSION,

package/lib/dataconnect/ensureApis.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ensureApis = void 0;
+exports.ensureSparkApis = exports.ensureApis = void 0;
 const api = require("../api");
 const ensureApiEnabled_1 = require("../ensureApiEnabled");
 async function ensureApis(projectId) {
@@ -10,3 +10,8 @@ async function ensureApis(projectId) {
     await (0, ensureApiEnabled_1.ensure)(projectId, api.computeOrigin(), prefix);
 }
 exports.ensureApis = ensureApis;
+async function ensureSparkApis(projectId) {
+    const prefix = "dataconnect";
+    await (0, ensureApiEnabled_1.ensure)(projectId, api.cloudSQLAdminOrigin(), prefix);
+}
+exports.ensureSparkApis = ensureSparkApis;

package/lib/dataconnect/load.js

@@ -30,7 +30,9 @@ async function load(projectId, config, sourceDirectory) {
         sourceDirectory: resolvedDir,
         schema: {
             name: `${serviceName}/schemas/${types_1.SCHEMA_ID}`,
-            primaryDatasource: (0, types_1.toDatasource)(projectId, dataConnectYaml.location, dataConnectYaml.schema.datasource),
+            datasources: [
+                (0, types_1.toDatasource)(projectId, dataConnectYaml.location, dataConnectYaml.schema.datasource),
+            ],
             source: {
                 files: schemaGQLs,
             },

package/lib/dataconnect/provisionCloudSql.js

@@ -11,19 +11,22 @@ const freeTrial_1 = require("./freeTrial");
 const error_1 = require("../error");
 async function provisionCloudSql(args) {
     let connectionName = "";
-    const { projectId, locationId, instanceId, databaseId, enableGoogleMlIntegration, waitForCreation, silent, } = args;
+    const { projectId, locationId, instanceId, databaseId, enableGoogleMlIntegration, waitForCreation, silent, dryRun, } = args;
     try {
         const existingInstance = await cloudSqlAdminClient.getInstance(projectId, instanceId);
         silent || utils.logLabeledBullet("dataconnect", `Found existing instance ${instanceId}.`);
         connectionName = (existingInstance === null || existingInstance === void 0 ? void 0 : existingInstance.connectionName) || "";
         const why = getUpdateReason(existingInstance, enableGoogleMlIntegration);
         if (why) {
+            const cta = dryRun
+                ? `It will be updated on your next deploy.`
+                : `Updating instance. This may take a few minutes...`;
             silent ||
-                utils.logLabeledBullet("dataconnect", `Instance ${instanceId} settings not compatible with Firebase Data Connect. ` +
-                    `Updating instance. This may take a few minutes...` +
-                    why);
-            await (0, utils_1.promiseWithSpinner)(() => cloudSqlAdminClient.updateInstanceForDataConnect(existingInstance, enableGoogleMlIntegration), "Updating your instance...");
-            silent || utils.logLabeledBullet("dataconnect", "Instance updated");
+                utils.logLabeledBullet("dataconnect", `Instance ${instanceId} settings not compatible with Firebase Data Connect. ` + cta + why);
+            if (!dryRun) {
+                await (0, utils_1.promiseWithSpinner)(() => cloudSqlAdminClient.updateInstanceForDataConnect(existingInstance, enableGoogleMlIntegration), "Updating your instance...");
+                silent || utils.logLabeledBullet("dataconnect", "Instance updated");
+            }
         }
     }
     catch (err) {
@@ -35,19 +38,23 @@ async function provisionCloudSql(args) {
             (0, freeTrial_1.printFreeTrialUnavailable)(projectId, freeTrialInstanceId);
             throw new error_1.FirebaseError("Free trial unavailable.");
         }
+        const cta = dryRun ? "It will be created on your next deploy" : "Creating it now.";
         silent ||
-            utils.logLabeledBullet("dataconnect", `CloudSQL instance '${instanceId}' not found, creating it.` +
+            utils.logLabeledBullet("dataconnect", `CloudSQL instance '${instanceId}' not found.` +
+                cta +
                 `\nThis instance is provided under the terms of the Data Connect free trial ${(0, freeTrial_1.freeTrialTermsLink)()}` +
                 `\nMonitor the progress at ${cloudSqlAdminClient.instanceConsoleLink(projectId, instanceId)}`);
-        const newInstance = await (0, utils_1.promiseWithSpinner)(() => cloudSqlAdminClient.createInstance(projectId, locationId, instanceId, enableGoogleMlIntegration, waitForCreation), "Creating your instance...");
-        if (newInstance) {
-            silent || utils.logLabeledBullet("dataconnect", "Instance created");
-            connectionName = (newInstance === null || newInstance === void 0 ? void 0 : newInstance.connectionName) || "";
-        }
-        else {
-            silent ||
-                utils.logLabeledBullet("dataconnect", "Cloud SQL instance creation started - it should be ready shortly. Database and users will be created on your next deploy.");
-            return connectionName;
+        if (!dryRun) {
+            const newInstance = await (0, utils_1.promiseWithSpinner)(() => cloudSqlAdminClient.createInstance(projectId, locationId, instanceId, enableGoogleMlIntegration, waitForCreation), "Creating your instance...");
+            if (newInstance) {
+                silent || utils.logLabeledBullet("dataconnect", "Instance created");
+                connectionName = (newInstance === null || newInstance === void 0 ? void 0 : newInstance.connectionName) || "";
+            }
+            else {
+                silent ||
+                    utils.logLabeledBullet("dataconnect", "Cloud SQL instance creation started - it should be ready shortly. Database and users will be created on your next deploy.");
+                return connectionName;
+            }
         }
     }
     try {
@@ -56,17 +63,23 @@ async function provisionCloudSql(args) {
     }
     catch (err) {
         if (err.status === 404) {
-            silent ||
-                utils.logLabeledBullet("dataconnect", `Database ${databaseId} not found, creating it now...`);
-            await cloudSqlAdminClient.createDatabase(projectId, instanceId, databaseId);
-            silent || utils.logLabeledBullet("dataconnect", `Database ${databaseId} created.`);
+            if (dryRun) {
+                silent ||
+                    utils.logLabeledBullet("dataconnect", `Database ${databaseId} not found. It will be created on your next deploy.`);
+            }
+            else {
+                silent ||
+                    utils.logLabeledBullet("dataconnect", `Database ${databaseId} not found, creating it now...`);
+                await cloudSqlAdminClient.createDatabase(projectId, instanceId, databaseId);
+                silent || utils.logLabeledBullet("dataconnect", `Database ${databaseId} created.`);
+            }
         }
         else {
             logger_1.logger.debug(`Unexpected error from CloudSQL: ${err}`);
             silent || utils.logLabeledWarning("dataconnect", `Database ${databaseId} is not accessible.`);
         }
     }
-    if (enableGoogleMlIntegration) {
+    if (enableGoogleMlIntegration && !dryRun) {
         await (0, checkIam_1.grantRolesToCloudSqlServiceAccount)(projectId, instanceId, [GOOGLE_ML_INTEGRATION_ROLE]);
     }
     return connectionName;