firebase-tools 9.22.0 → 9.23.0

package/CHANGELOG.md

@@ -1,3 +1 @@
-- Adds `firebase ext:export` command, and adds `extensions` to `firebase deploy`. See https://firebase.google.com/docs/extensions/reuse-project-config for more infomation on how to manage your extensions with these commands.
-- Fixes issue where `init` would crash with multiple Hosting items selected (#3742).
-- Adds a command (`crashlytics:symbols:upload`) to upload native symbol files, used in Android NDK crash symbolication.
+- `firebase deploy --only extensions` now supports project specifc .env files. When deploying to multiple projects, param values that are different between projects can be put in `extensions/${extensionInstanceId}.env.${projectIdOrAlias}` and common param values can be put in `extensions/${extensionInstanceId}.env`.

package/lib/deploy/extensions/params.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readParams = void 0;
+const path = require("path");
+const logger_1 = require("../../logger");
+const paramHelper_1 = require("../../extensions/paramHelper");
+const error_1 = require("../../error");
+const ENV_DIRECTORY = "extensions";
+function readParams(args) {
+    const filesToCheck = [
+        `${args.instanceId}.env`,
+        ...args.aliases.map((alias) => `${args.instanceId}.env.${alias}`),
+        `${args.instanceId}.env.${args.projectNumber}`,
+        `${args.instanceId}.env.${args.projectId}`,
+    ];
+    let noFilesFound = true;
+    const combinedParams = {};
+    for (const fileToCheck of filesToCheck) {
+        try {
+            const params = readParamsFile(args.projectDir, fileToCheck);
+            logger_1.logger.debug(`Successfully read params from ${fileToCheck}`);
+            noFilesFound = false;
+            Object.assign(combinedParams, params);
+        }
+        catch (err) {
+            logger_1.logger.debug(`${err}`);
+        }
+    }
+    if (noFilesFound) {
+        throw new error_1.FirebaseError(`No params file found for ${args.instanceId}`);
+    }
+    return combinedParams;
+}
+exports.readParams = readParams;
+function readParamsFile(projectDir, fileName) {
+    const paramPath = path.join(projectDir, ENV_DIRECTORY, fileName);
+    const params = paramHelper_1.readEnvFile(paramPath);
+    return params;
+}

package/lib/deploy/extensions/planner.js

@@ -1,13 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolveVersion = exports.want = exports.have = exports.getExtension = exports.getExtensionVersion = void 0;
-const path = require("path");
 const semver = require("semver");
 const error_1 = require("../../error");
 const extensionsApi = require("../../extensions/extensionsApi");
 const extensionsHelper_1 = require("../../extensions/extensionsHelper");
 const refs = require("../../extensions/refs");
-const paramHelper_1 = require("../../extensions/paramHelper");
+const params_1 = require("./params");
 const logger_1 = require("../../logger");
 async function getExtensionVersion(i) {
     if (!i.extensionVersion) {
@@ -29,7 +28,6 @@ async function getExtension(i) {
     return i.extension;
 }
 exports.getExtension = getExtension;
-const ENV_DIRECTORY = "extensions";
 async function have(projectId) {
     const instances = await extensionsApi.listInstances(projectId);
     return instances.map((i) => {
@@ -46,16 +44,22 @@ async function have(projectId) {
     });
 }
 exports.have = have;
-async function want(projectId, projectDir, extensions) {
+async function want(args) {
     const instanceSpecs = [];
     const errors = [];
-    for (const e of Object.entries(extensions)) {
+    for (const e of Object.entries(args.extensions)) {
         try {
             const instanceId = e[0];
             const ref = refs.parse(e[1]);
             ref.version = await resolveVersion(ref);
-            const params = readParams(projectDir, instanceId);
-            const autoPopulatedParams = await extensionsHelper_1.getFirebaseProjectParams(projectId);
+            const params = params_1.readParams({
+                projectDir: args.projectDir,
+                instanceId,
+                projectId: args.projectId,
+                projectNumber: args.projectNumber,
+                aliases: args.aliases,
+            });
+            const autoPopulatedParams = await extensionsHelper_1.getFirebaseProjectParams(args.projectId);
             const subbedParams = extensionsHelper_1.substituteParams(params, autoPopulatedParams);
             instanceSpecs.push({
                 instanceId,
@@ -88,8 +92,3 @@ async function resolveVersion(ref) {
     return maxSatisfying;
 }
 exports.resolveVersion = resolveVersion;
-function readParams(projectDir, instanceId) {
-    const paramPath = path.join(projectDir, ENV_DIRECTORY, `${instanceId}.env`);
-    const params = paramHelper_1.readEnvFile(paramPath);
-    return params;
-}

package/lib/deploy/extensions/prepare.js

@@ -16,10 +16,18 @@ const warnings_1 = require("../../extensions/warnings");
 async function prepare(context, options, payload) {
     var _a;
     const projectId = projectUtils_1.needProjectId(options);
+    const projectNumber = await projectUtils_1.needProjectNumber(options);
+    const aliases = projectUtils_1.getAliases(options, projectId);
     await extensionsHelper_1.ensureExtensionsApiEnabled(options);
     await requirePermissions_1.requirePermissions(options, ["firebaseextensions.instances.list"]);
     context.have = await planner.have(projectId);
-    context.want = await planner.want(projectId, options.config.projectDir, options.config.get("extensions"));
+    context.want = await planner.want({
+        projectId,
+        projectNumber,
+        aliases,
+        projectDir: options.config.projectDir,
+        extensions: options.config.get("extensions"),
+    });
     const usingSecrets = await Promise.all((_a = context.have) === null || _a === void 0 ? void 0 : _a.map(secrets_1.checkSpecForSecrets));
     if (usingSecrets.some((i) => i)) {
         await secretsUtils_1.ensureSecretManagerApiEnabled(options);

package/lib/deploy/functions/containerCleaner.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DockerHelper = exports.deleteGcfArtifacts = exports.listGcfPaths = exports.ContainerRegistryCleaner = exports.ArtifactRegistryCleaner = exports.cleanupBuildImages = exports.SUBDOMAIN_MAPPING = void 0;
 const clc = require("cli-color");
 const error_1 = require("../../error");
-const previews_1 = require("../../previews");
 const api_1 = require("../../api");
 const logger_1 = require("../../logger");
 const artifactregistry = require("../../gcp/artifactregistry");
@@ -62,44 +61,37 @@ async function retry(func) {
 async function cleanupBuildImages(haveFunctions, deletedFunctions, cleaners = {}) {
     utils.logBullet(clc.bold.cyan("functions: ") + "cleaning up build files...");
     const failedDomains = new Set();
-    if (previews_1.previews.artifactregistry) {
-        const arCleaner = cleaners.ar || new ArtifactRegistryCleaner();
-        await Promise.all([
-            ...haveFunctions.map(async (func) => {
-                try {
-                    await arCleaner.cleanupFunction(func);
-                }
-                catch (err) {
-                    const path = `${func.project}/${func.region}/gcf-artifacts`;
-                    failedDomains.add(`https://console.cloud.google.com/artifacts/docker/${path}`);
-                }
-            }),
-            ...deletedFunctions.map(async (func) => {
-                try {
-                    await Promise.all([
-                        arCleaner.cleanupFunction(func),
-                        arCleaner.cleanupFunctionCache(func),
-                    ]);
-                }
-                catch (err) {
-                    const path = `${func.project}/${func.region}/gcf-artifacts`;
-                    failedDomains.add(`https://console.cloud.google.com/artifacts/docker/${path}`);
-                }
-            }),
-        ]);
-    }
-    else {
-        const gcrCleaner = cleaners.gcr || new ContainerRegistryCleaner();
-        await Promise.all([...haveFunctions, ...deletedFunctions].map(async (func) => {
-            try {
-                await gcrCleaner.cleanupFunction(func);
-            }
-            catch (err) {
-                const path = `${func.project}/${exports.SUBDOMAIN_MAPPING[func.region]}/gcf`;
-                failedDomains.add(`https://console.cloud.google.com/gcr/images/${path}`);
-            }
-        }));
-    }
+    const cleanup = [];
+    const arCleaner = cleaners.ar || new ArtifactRegistryCleaner();
+    cleanup.push(...haveFunctions.map(async (func) => {
+        try {
+            await arCleaner.cleanupFunction(func);
+        }
+        catch (err) {
+            const path = `${func.project}/${func.region}/gcf-artifacts`;
+            failedDomains.add(`https://console.cloud.google.com/artifacts/docker/${path}`);
+        }
+    }));
+    cleanup.push(...deletedFunctions.map(async (func) => {
+        try {
+            await Promise.all([arCleaner.cleanupFunction(func), arCleaner.cleanupFunctionCache(func)]);
+        }
+        catch (err) {
+            const path = `${func.project}/${func.region}/gcf-artifacts`;
+            failedDomains.add(`https://console.cloud.google.com/artifacts/docker/${path}`);
+        }
+    }));
+    const gcrCleaner = cleaners.gcr || new ContainerRegistryCleaner();
+    cleanup.push(...[...haveFunctions, ...deletedFunctions].map(async (func) => {
+        try {
+            await gcrCleaner.cleanupFunction(func);
+        }
+        catch (err) {
+            const path = `${func.project}/${exports.SUBDOMAIN_MAPPING[func.region]}/gcf`;
+            failedDomains.add(`https://console.cloud.google.com/gcr/images/${path}`);
+        }
+    }));
+    await Promise.all(cleanup);
     if (failedDomains.size) {
         let message = "Unhandled error cleaning up build images. This could result in a small monthly bill if not corrected. ";
         message +=
@@ -119,7 +111,16 @@ class ArtifactRegistryCleaner {
         return `projects/${func.project}/locations/${func.region}/repositories/gcf-artifacts/packages/${func.id}`;
     }
     async cleanupFunction(func) {
-        const op = await artifactregistry.deletePackage(ArtifactRegistryCleaner.packagePath(func));
+        let op;
+        try {
+            op = await artifactregistry.deletePackage(ArtifactRegistryCleaner.packagePath(func));
+        }
+        catch (err) {
+            if (err.status === 404) {
+                return;
+            }
+            throw err;
+        }
         if (op.done) {
             return;
         }

package/lib/deploy/functions/prepare.js

@@ -39,6 +39,7 @@ async function prepare(context, options, payload) {
         ensureApiEnabled.ensure(projectId, "cloudfunctions.googleapis.com", "functions"),
         ensureApiEnabled.check(projectId, "runtimeconfig.googleapis.com", "runtimeconfig", true),
         ensureCloudBuildEnabled_1.ensureCloudBuildEnabled(projectId),
+        ensureApiEnabled.ensure(projectId, "artifactregistry.googleapis.com", "functions"),
     ]);
     context.runtimeConfigEnabled = checkAPIsEnabled[1];
     const firebaseConfig = await functionsConfig.getFirebaseConfig(options);

package/lib/deploy/index.js

@@ -38,6 +38,7 @@ var deploy = function (targetNames, options, customContext = {}) {
     var deploys = [];
     var releases = [];
     var postdeploys = [];
+    var startTime = Date.now();
     for (var i = 0; i < targetNames.length; i++) {
         var targetName = targetNames[i];
         var target = TARGETS[targetName];
@@ -75,8 +76,15 @@ var deploy = function (targetNames, options, customContext = {}) {
     })
         .then(function () {
         if (_.has(options, "config.notes.databaseRules")) {
-            track("Rules Deploy", options.config.notes.databaseRules);
+            return track("Rules Deploy", options.config.notes.databaseRules);
         }
+        return;
+    })
+        .then(function () {
+        const duration = Date.now() - startTime;
+        return track("Product Deploy", [...targetNames].sort().join(","), duration);
+    })
+        .then(function () {
         logger.info();
         utils.logSuccess(clc.underline.bold("Deploy complete!"));
         logger.info();

package/lib/gcp/cloudfunctions.js

@@ -4,7 +4,6 @@ exports.functionFromEndpoint = exports.endpointFromFunction = exports.listAllFun
 const clc = require("cli-color");
 const error_1 = require("../error");
 const logger_1 = require("../logger");
-const previews_1 = require("../previews");
 const api = require("../api");
 const backend = require("../deploy/functions/backend");
 const utils = require("../utils");
@@ -51,11 +50,8 @@ async function createFunction(cloudFunction) {
     const apiPath = cloudFunction.name.substring(0, cloudFunction.name.lastIndexOf("/"));
     const endpoint = `/${exports.API_VERSION}/${apiPath}`;
     try {
-        const headers = previews_1.previews.artifactregistry
-            ? { "X-Firebase-Artifact-Registry": "optin" }
-            : undefined;
         const res = await api.request("POST", endpoint, {
-            headers,
+            headers: { "X-Firebase-Artifact-Registry": "optin" },
             auth: true,
             data: cloudFunction,
             origin: api.functionsOrigin,
@@ -150,11 +146,8 @@ async function updateFunction(cloudFunction) {
     const endpoint = `/${exports.API_VERSION}/${cloudFunction.name}`;
     const fieldMasks = proto.fieldMasks(cloudFunction, "labels", "environmentVariables");
     try {
-        const headers = previews_1.previews.artifactregistry
-            ? { "X-Firebase-Artifact-Registry": "optin" }
-            : undefined;
         const res = await api.request("PATCH", endpoint, {
-            headers,
+            headers: { "X-Firebase-Artifact-Registry": "optin" },
             qs: {
                 updateMask: fieldMasks.join(","),
             },

package/lib/previews.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.previews = void 0;
 const lodash_1 = require("lodash");
 const configstore_1 = require("./configstore");
-exports.previews = Object.assign({ rtdbrules: false, ext: false, extdev: false, rtdbmanagement: false, functionsv2: false, golang: false, deletegcfartifacts: false, dotenv: false, artifactregistry: false }, configstore_1.configstore.get("previews"));
+exports.previews = Object.assign({ rtdbrules: false, ext: false, extdev: false, rtdbmanagement: false, functionsv2: false, golang: false, deletegcfartifacts: false, dotenv: false }, configstore_1.configstore.get("previews"));
 if (process.env.FIREBASE_CLI_PREVIEWS) {
     process.env.FIREBASE_CLI_PREVIEWS.split(",").forEach((feature) => {
         if (lodash_1.has(exports.previews, feature)) {

package/lib/projectUtils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.needProjectNumber = exports.needProjectId = exports.getProjectId = void 0;
+exports.getAliases = exports.needProjectNumber = exports.needProjectId = exports.getProjectId = void 0;
 const projects_1 = require("./management/projects");
 const clc = require("cli-color");
 const marked = require("marked");
@@ -48,3 +48,12 @@ async function needProjectNumber(options) {
     return options.projectNumber;
 }
 exports.needProjectNumber = needProjectNumber;
+function getAliases(options, projectId) {
+    if (options.rc.hasProjects) {
+        return Object.entries(options.rc.projects)
+            .filter((entry) => entry[1] === projectId)
+            .map((entry) => entry[0]);
+    }
+    return [];
+}
+exports.getAliases = getAliases;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-tools",
-  "version": "9.22.0",
+  "version": "9.23.0",
   "description": "Command-Line Interface for Firebase",
   "main": "./lib/index.js",
   "bin": {
@@ -94,7 +94,7 @@
     "chokidar": "^3.0.2",
     "cjson": "^0.3.1",
     "cli-color": "^1.2.0",
-    "cli-table": "^0.3.1",
+    "cli-table": "^0.3.8",
     "commander": "^4.0.1",
     "configstore": "^5.0.1",
     "cors": "^2.8.5",
@@ -138,7 +138,7 @@
     "universal-analytics": "^0.4.16",
     "unzipper": "^0.10.10",
     "update-notifier": "^5.1.0",
-    "uuid": "^3.0.0",
+    "uuid": "^8.3.2",
     "winston": "^3.0.0",
     "winston-transport": "^4.4.0",
     "ws": "^7.2.3"
@@ -182,7 +182,7 @@
     "@types/tmp": "^0.1.0",
     "@types/triple-beam": "^1.3.0",
     "@types/unzipper": "^0.10.0",
-    "@types/uuid": "^3.4.4",
+    "@types/uuid": "^8.3.1",
     "@types/winston": "^2.4.4",
     "@types/ws": "^7.2.3",
     "@typescript-eslint/eslint-plugin": "^4.12.0",