firebase-tools 10.1.3 → 10.2.1

package/lib/deploy/functions/prepare.js

@@ -2,20 +2,19 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.inferDetailsFromExisting = exports.prepare = void 0;
 const clc = require("cli-color");
-const ensureCloudBuildEnabled_1 = require("./ensureCloudBuildEnabled");
-const functionsDeployHelper_1 = require("./functionsDeployHelper");
-const utils_1 = require("../../utils");
-const prepareFunctionsUpload_1 = require("./prepareFunctionsUpload");
-const prompts_1 = require("./prompts");
 const backend = require("./backend");
 const ensureApiEnabled = require("../../ensureApiEnabled");
 const functionsConfig = require("../../functionsConfig");
 const functionsEnv = require("../../functions/env");
-const previews_1 = require("../../previews");
-const projectUtils_1 = require("../../projectUtils");
-const track_1 = require("../../track");
 const runtimes = require("./runtimes");
 const validate = require("./validate");
+const ensure = require("./ensure");
+const functionsDeployHelper_1 = require("./functionsDeployHelper");
+const utils_1 = require("../../utils");
+const prepareFunctionsUpload_1 = require("./prepareFunctionsUpload");
+const prompts_1 = require("./prompts");
+const projectUtils_1 = require("../../projectUtils");
+const track_1 = require("../../track");
 const logger_1 = require("../../logger");
 const triggerRegionHelper_1 = require("./triggerRegionHelper");
 const checkIam_1 = require("./checkIam");
@@ -24,14 +23,7 @@ function hasUserConfig(config) {
     return Object.keys(config).length > 1;
 }
 function hasDotenv(opts) {
-    return previews_1.previews.dotenv && functionsEnv.hasUserEnvs(opts);
-}
-async function maybeEnableAR(projectId) {
-    if (!previews_1.previews.artifactregistry) {
-        return ensureApiEnabled.check(projectId, "artifactregistry.googleapis.com", "functions", true);
-    }
-    await ensureApiEnabled.ensure(projectId, "artifactregistry.googleapis.com", "functions");
-    return true;
+    return functionsEnv.hasUserEnvs(opts);
 }
 async function prepare(context, options, payload) {
     const projectId = (0, projectUtils_1.needProjectId)(options);
@@ -54,8 +46,8 @@ async function prepare(context, options, payload) {
     const checkAPIsEnabled = await Promise.all([
         ensureApiEnabled.ensure(projectId, "cloudfunctions.googleapis.com", "functions"),
         ensureApiEnabled.check(projectId, "runtimeconfig.googleapis.com", "runtimeconfig", true),
-        (0, ensureCloudBuildEnabled_1.ensureCloudBuildEnabled)(projectId),
-        maybeEnableAR(projectId),
+        ensure.cloudBuildEnabled(projectId),
+        ensure.maybeEnableAR(projectId),
     ]);
     context.runtimeConfigEnabled = checkAPIsEnabled[1];
     context.artifactRegistryEnabled = checkAPIsEnabled[3];
@@ -125,6 +117,8 @@ async function prepare(context, options, payload) {
     await (0, prompts_1.promptForFailurePolicies)(options, matchingBackend, haveBackend);
     await (0, prompts_1.promptForMinInstances)(options, matchingBackend, haveBackend);
     await backend.checkAvailability(context, wantBackend);
+    await validate.secretsAreValid(projectId, matchingBackend);
+    await ensure.secretAccess(projectId, matchingBackend, haveBackend);
 }
 exports.prepare = prepare;
 function inferDetailsFromExisting(want, have, usedDotenv) {

package/lib/deploy/functions/runtimes/discovery/v1alpha1.js

@@ -56,6 +56,7 @@ function parseEndpoints(manifest, id, project, defaultRegion, runtime) {
         labels: "object",
         ingressSettings: "string",
         environmentVariables: "object",
+        secretEnvironmentVariables: "array",
         httpsTrigger: "object",
         eventTrigger: "object",
         scheduleTrigger: "object",

package/lib/deploy/functions/runtimes/node/parseTriggers.js

@@ -107,6 +107,18 @@ function addResourcesToBackend(projectId, runtime, annotation, want) {
             }
             endpoint.vpcConnector = maybeId;
         }
+        if (annotation.secrets) {
+            const secretEnvs = [];
+            for (const secret of annotation.secrets) {
+                const secretEnv = {
+                    secret,
+                    projectId,
+                    key: secret,
+                };
+                secretEnvs.push(secretEnv);
+            }
+            endpoint.secretEnvironmentVariables = secretEnvs;
+        }
         proto.copyIfPresent(endpoint, annotation, "concurrency", "serviceAccountEmail", "labels", "vpcConnectorEgressSettings", "ingressSettings", "timeout", "maxInstances", "minInstances", "availableMemoryMb");
         want.endpoints[region] = want.endpoints[region] || {};
         want.endpoints[region][endpoint.id] = endpoint;

package/lib/deploy/functions/validate.js

@@ -1,11 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.functionIdsAreValid = exports.functionsDirectoryExists = exports.endpointsAreValid = void 0;
+exports.secretsAreValid = exports.functionIdsAreValid = exports.functionsDirectoryExists = exports.endpointsAreValid = void 0;
 const path = require("path");
 const clc = require("cli-color");
 const error_1 = require("../../error");
+const secretManager_1 = require("../../gcp/secretManager");
+const logger_1 = require("../../logger");
 const fsutils = require("../../fsutils");
 const backend = require("./backend");
+const utils = require("../../utils");
+const secrets = require("../../functions/secrets");
 function endpointsAreValid(wantBackend) {
     functionIdsAreValid(backend.allEndpoints(wantBackend));
     const gcfV1WithConcurrency = backend
@@ -62,3 +66,54 @@ function functionIdsAreValid(functions) {
     }
 }
 exports.functionIdsAreValid = functionIdsAreValid;
+async function secretsAreValid(projectId, wantBackend) {
+    const endpoints = backend
+        .allEndpoints(wantBackend)
+        .filter((e) => e.secretEnvironmentVariables && e.secretEnvironmentVariables.length > 0);
+    validatePlatformTargets(endpoints);
+    await validateSecretVersions(projectId, endpoints);
+}
+exports.secretsAreValid = secretsAreValid;
+function validatePlatformTargets(endpoints) {
+    const supportedPlatforms = ["gcfv1"];
+    const unsupported = endpoints.filter((e) => !supportedPlatforms.includes(e.platform));
+    if (unsupported.length > 0) {
+        const errs = unsupported.map((e) => `${e.id}[platform=${e.platform}]`);
+        throw new error_1.FirebaseError(`Tried to set secret environment variables on ${errs.join(", ")}. ` +
+            `Only ${supportedPlatforms.join(", ")} support secret environments.`);
+    }
+}
+async function validateSecretVersions(projectId, endpoints) {
+    const toResolve = new Set();
+    for (const s of secrets.of(endpoints)) {
+        toResolve.add(s.secret);
+    }
+    const results = await utils.allSettled(Array.from(toResolve).map(async (secret) => {
+        const sv = await (0, secretManager_1.getSecretVersion)(projectId, secret, "latest");
+        logger_1.logger.debug(`Resolved secret version of ${clc.bold(secret)} to ${clc.bold(sv.versionId)}.`);
+        return sv;
+    }));
+    const secretVersions = {};
+    const errs = [];
+    for (const result of results) {
+        if (result.status === "fulfilled") {
+            const sv = result.value;
+            if (sv.state != "ENABLED") {
+                errs.push(new error_1.FirebaseError(`Expected secret ${sv.secret.name}@${sv.versionId} to be in state ENABLED not ${sv.state}.`));
+            }
+            secretVersions[sv.secret.name] = sv;
+        }
+        else {
+            errs.push(new error_1.FirebaseError(result.reason.message));
+        }
+    }
+    if (errs.length) {
+        throw new error_1.FirebaseError("Failed to validate secret versions", { children: errs });
+    }
+    for (const s of secrets.of(endpoints)) {
+        s.version = secretVersions[s.secret].versionId;
+        if (!s.version) {
+            throw new error_1.FirebaseError("Secret version is unexpectedly undefined. This should never happen.");
+        }
+    }
+}

package/lib/deploy/hosting/client.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.client = void 0;
+const api_1 = require("../../api");
+const apiv2_1 = require("../../apiv2");
+exports.client = new apiv2_1.Client({
+    urlPrefix: api_1.hostingApiOrigin,
+    apiVersion: "v1beta1",
+});

package/lib/deploy/hosting/convertConfig.js

@@ -46,6 +46,12 @@ function convertConfig(config) {
             }
             else if ("function" in rewrite) {
                 vRewrite.function = rewrite.function;
+                if (rewrite.region) {
+                    vRewrite.functionRegion = rewrite.region;
+                }
+                else {
+                    vRewrite.functionRegion = "us-central1";
+                }
             }
             else if ("dynamicLinks" in rewrite) {
                 vRewrite.dynamicLinks = rewrite.dynamicLinks;

package/lib/deploy/hosting/index.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.release = exports.deploy = exports.prepare = void 0;
-const prepare = require("./prepare");
-exports.prepare = prepare;
-const deploy_1 = require("./deploy");
+var prepare_1 = require("./prepare");
+Object.defineProperty(exports, "prepare", { enumerable: true, get: function () { return prepare_1.prepare; } });
+var deploy_1 = require("./deploy");
 Object.defineProperty(exports, "deploy", { enumerable: true, get: function () { return deploy_1.deploy; } });
-const release = require("./release");
-exports.release = release;
+var release_1 = require("./release");
+Object.defineProperty(exports, "release", { enumerable: true, get: function () { return release_1.release; } });

package/lib/deploy/hosting/prepare.js

@@ -1,44 +1,44 @@
 "use strict";
-const _ = require("lodash");
-const api = require("../../api");
-const { convertConfig } = require("./convertConfig");
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.prepare = void 0;
+const error_1 = require("../../error");
+const client_1 = require("./client");
+const projectUtils_1 = require("../../projectUtils");
+const normalizedHostingConfigs_1 = require("../../hosting/normalizedHostingConfigs");
+const validate_1 = require("./validate");
+const convertConfig_1 = require("./convertConfig");
 const deploymentTool = require("../../deploymentTool");
-const { FirebaseError } = require("../../error");
-const { normalizedHostingConfigs } = require("../../hosting/normalizedHostingConfigs");
-const { validateDeploy } = require("./validate");
-module.exports = function (context, options) {
+async function prepare(context, options) {
     if (options.public) {
-        if (_.isArray(options.config.get("hosting"))) {
-            throw new FirebaseError("Cannot specify --public option with multi-site configuration.");
+        if (Array.isArray(options.config.get("hosting"))) {
+            throw new error_1.FirebaseError("Cannot specify --public option with multi-site configuration.");
         }
         options.config.set("hosting.public", options.public);
     }
-    const configs = normalizedHostingConfigs(options, { resolveTargets: true });
+    const projectNumber = await (0, projectUtils_1.needProjectNumber)(options);
+    const configs = (0, normalizedHostingConfigs_1.normalizedHostingConfigs)(options, { resolveTargets: true });
     if (configs.length === 0) {
         return Promise.resolve();
     }
     context.hosting = {
-        deploys: configs.map(function (cfg) {
+        deploys: configs.map((cfg) => {
             return { config: cfg, site: cfg.site };
         }),
     };
     const versionCreates = [];
-    _.each(context.hosting.deploys, function (deploy) {
+    for (const deploy of context.hosting.deploys) {
         const cfg = deploy.config;
-        validateDeploy(deploy, options);
+        (0, validate_1.validateDeploy)(deploy, options);
         const data = {
-            config: convertConfig(cfg),
+            config: (0, convertConfig_1.convertConfig)(cfg),
             labels: deploymentTool.labels(),
         };
-        versionCreates.push(api
-            .request("POST", `/v1beta1/sites/${deploy.site}/versions`, {
-            origin: api.hostingApiOrigin,
-            auth: true,
-            data,
-        })
-            .then(function (result) {
-            deploy.version = result.body.name;
+        versionCreates.push(client_1.client
+            .post(`/projects/${projectNumber}/sites/${deploy.site}/versions`, data)
+            .then((res) => {
+            deploy.version = res.body.name;
         }));
-    });
-    return Promise.all(versionCreates);
-};
+    }
+    await Promise.all(versionCreates);
+}
+exports.prepare = prepare;

package/lib/deploy/hosting/release.js

@@ -1,34 +1,31 @@
 "use strict";
-const api = require("../../api");
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.release = void 0;
+const client_1 = require("./client");
+const logger_1 = require("../../logger");
+const projectUtils_1 = require("../../projectUtils");
 const utils = require("../../utils");
-const { logger } = require("../../logger");
-module.exports = function (context, options) {
+async function release(context, options) {
     if (!context.hosting || !context.hosting.deploys) {
-        return Promise.resolve();
+        return;
     }
-    logger.debug(JSON.stringify(context.hosting.deploys, null, 2));
-    return Promise.all(context.hosting.deploys.map(async function (deploy) {
-        utils.logLabeledBullet("hosting[" + deploy.site + "]", "finalizing version...");
-        const finalizeResult = await api.request("PATCH", `/v1beta1/${deploy.version}?updateMask=status`, {
-            origin: api.hostingApiOrigin,
-            auth: true,
-            data: { status: "FINALIZED" },
-        });
-        logger.debug("[hosting] finalized version for " + deploy.site + ":", finalizeResult.body);
-        utils.logLabeledSuccess("hosting[" + deploy.site + "]", "version finalized");
-        utils.logLabeledBullet("hosting[" + deploy.site + "]", "releasing new version...");
+    const projectNumber = await (0, projectUtils_1.needProjectNumber)(options);
+    logger_1.logger.debug(JSON.stringify(context.hosting.deploys, null, 2));
+    await Promise.all(context.hosting.deploys.map(async (deploy) => {
+        utils.logLabeledBullet(`hosting[${deploy.site}]`, "finalizing version...");
+        const finalizeResult = await client_1.client.patch(`/${deploy.version}`, { status: "FINALIZED" }, { queryParams: { updateMask: "status" } });
+        logger_1.logger.debug(`[hosting] finalized version for ${deploy.site}:${finalizeResult.body}`);
+        utils.logLabeledSuccess(`hosting[${deploy.site}]`, "version finalized");
+        utils.logLabeledBullet(`hosting[${deploy.site}]`, "releasing new version...");
         const channelSegment = context.hostingChannel && context.hostingChannel !== "live"
             ? `/channels/${context.hostingChannel}`
             : "";
         if (channelSegment) {
-            logger.debug("[hosting] releasing to channel:", context.hostingChannel);
+            logger_1.logger.debug("[hosting] releasing to channel:", context.hostingChannel);
         }
-        const releaseResult = await api.request("POST", `/v1beta1/sites/${deploy.site}${channelSegment}/releases?version_name=${deploy.version}`, {
-            auth: true,
-            origin: api.hostingApiOrigin,
-            data: { message: options.message || null },
-        });
-        logger.debug("[hosting] release:", releaseResult.body);
-        utils.logLabeledSuccess("hosting[" + deploy.site + "]", "release complete");
+        const releaseResult = await client_1.client.post(`/projects/${projectNumber}/sites/${deploy.site}${channelSegment}/releases`, { message: options.message || null }, { queryParams: { versionName: deploy.version } });
+        logger_1.logger.debug("[hosting] release:", releaseResult.body);
+        utils.logLabeledSuccess(`hosting[${deploy.site}]`, "release complete");
     }));
-};
+}
+exports.release = release;

package/lib/emulator/commandUtils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.emulatorExec = exports.shutdownWhenKilled = exports.setExportOnExitOptions = exports.parseInspectionPort = exports.beforeEmulatorCommand = exports.warnEmulatorNotSupported = exports.printNoticeIfEmulated = exports.DESC_TEST_PARAMS = exports.FLAG_TEST_PARAMS = exports.DESC_TEST_CONFIG = exports.FLAG_TEST_CONFIG = exports.DESC_UI = exports.FLAG_UI = exports.EXPORT_ON_EXIT_USAGE_ERROR = exports.DESC_EXPORT_ON_EXIT = exports.FLAG_EXPORT_ON_EXIT = exports.FLAG_EXPORT_ON_EXIT_NAME = exports.DESC_IMPORT = exports.FLAG_IMPORT = exports.DESC_INSPECT_FUNCTIONS = exports.FLAG_INSPECT_FUNCTIONS = exports.DESC_ONLY = exports.FLAG_ONLY = void 0;
+exports.emulatorExec = exports.shutdownWhenKilled = exports.setExportOnExitOptions = exports.parseInspectionPort = exports.beforeEmulatorCommand = exports.warnEmulatorNotSupported = exports.printNoticeIfEmulated = exports.DESC_TEST_PARAMS = exports.FLAG_TEST_PARAMS = exports.DESC_TEST_CONFIG = exports.FLAG_TEST_CONFIG = exports.DESC_UI = exports.FLAG_UI = exports.EXPORT_ON_EXIT_CWD_DANGER = exports.EXPORT_ON_EXIT_USAGE_ERROR = exports.DESC_EXPORT_ON_EXIT = exports.FLAG_EXPORT_ON_EXIT = exports.FLAG_EXPORT_ON_EXIT_NAME = exports.DESC_IMPORT = exports.FLAG_IMPORT = exports.DESC_INSPECT_FUNCTIONS = exports.FLAG_INSPECT_FUNCTIONS = exports.DESC_ONLY = exports.FLAG_ONLY = void 0;
 const clc = require("cli-color");
 const childProcess = require("child_process");
 const controller = require("../emulator/controller");
@@ -36,6 +36,7 @@ exports.DESC_EXPORT_ON_EXIT = "automatically export emulator data (emulators:exp
     `when no dir is provided the location of ${exports.FLAG_IMPORT} is used`;
 exports.EXPORT_ON_EXIT_USAGE_ERROR = `"${exports.FLAG_EXPORT_ON_EXIT_NAME}" must be used with "${exports.FLAG_IMPORT}"` +
     ` or provide a dir directly to "${exports.FLAG_EXPORT_ON_EXIT}"`;
+exports.EXPORT_ON_EXIT_CWD_DANGER = `"${exports.FLAG_EXPORT_ON_EXIT_NAME}" must not point to the current directory or parents. Please choose a new/dedicated directory for exports.`;
 exports.FLAG_UI = "--ui";
 exports.DESC_UI = "run the Emulator UI";
 exports.FLAG_TEST_CONFIG = "--test-config <firebase.json file>";
@@ -131,6 +132,9 @@ function setExportOnExitOptions(options) {
         if (options.exportOnExit === true || !options.exportOnExit) {
             throw new error_1.FirebaseError(exports.EXPORT_ON_EXIT_USAGE_ERROR);
         }
+        if (path.resolve(".").startsWith(path.resolve(options.exportOnExit))) {
+            throw new error_1.FirebaseError(exports.EXPORT_ON_EXIT_CWD_DANGER);
+        }
     }
     return;
 }

package/lib/emulator/controller.js

@@ -246,7 +246,8 @@ async function startAll(options, showUI = true) {
         utils.assertDefined(options.config.src.functions);
         utils.assertDefined(options.config.src.functions.source, "Error: 'functions.source' is not defined");
         utils.assertIsStringOrUndefined(options.extensionDir);
-        const functionsDir = path.join(options.extensionDir || options.config.projectDir, options.config.src.functions.source);
+        const projectDir = options.extensionDir || options.config.projectDir;
+        const functionsDir = path.join(projectDir, options.config.src.functions.source);
         let inspectFunctions;
         if (options.inspectFunctions) {
             inspectFunctions = commandUtils.parseInspectionPort(options);
@@ -269,6 +270,7 @@ async function startAll(options, showUI = true) {
         ];
         const functionsEmulator = new functionsEmulator_1.FunctionsEmulator({
             projectId,
+            projectDir,
             emulatableBackends,
             account,
             host: functionsAddr.host,

package/lib/emulator/downloadableEmulators.js

@@ -13,6 +13,7 @@ const path = require("path");
 const os = require("os");
 const registry_1 = require("./registry");
 const download_1 = require("../emulator/download");
+const previews_1 = require("../previews");
 const EMULATOR_INSTANCE_KILL_TIMEOUT = 4000;
 const CACHE_DIR = process.env.FIREBASE_EMULATORS_PATH || path.join(os.homedir(), ".cache", "firebase", "emulators");
 exports.DownloadDetails = {
@@ -49,19 +50,35 @@ exports.DownloadDetails = {
             namePrefix: "cloud-storage-rules-emulator",
         },
     },
-    ui: {
-        version: "1.6.4",
-        downloadPath: path.join(CACHE_DIR, "ui-v1.6.4.zip"),
-        unzipDir: path.join(CACHE_DIR, "ui-v1.6.4"),
-        binaryPath: path.join(CACHE_DIR, "ui-v1.6.4", "server.bundle.js"),
-        opts: {
-            cacheDir: CACHE_DIR,
-            remoteUrl: "https://storage.googleapis.com/firebase-preview-drop/emulator/ui-v1.6.4.zip",
-            expectedSize: 3757300,
-            expectedChecksum: "20d4ee71e4ff7527b1843b6a8636142e",
-            namePrefix: "ui",
+    ui: previews_1.previews.emulatoruisnapshot
+        ? {
+            version: "SNAPSHOT",
+            downloadPath: path.join(CACHE_DIR, "ui-vSNAPSHOT.zip"),
+            unzipDir: path.join(CACHE_DIR, "ui-vSNAPSHOT"),
+            binaryPath: path.join(CACHE_DIR, "ui-vSNAPSHOT", "server.bundle.js"),
+            opts: {
+                cacheDir: CACHE_DIR,
+                remoteUrl: "https://storage.googleapis.com/firebase-preview-drop/emulator/ui-vSNAPSHOT.zip",
+                expectedSize: -1,
+                expectedChecksum: "",
+                skipCache: true,
+                skipChecksumAndSize: true,
+                namePrefix: "ui",
+            },
+        }
+        : {
+            version: "1.6.5",
+            downloadPath: path.join(CACHE_DIR, "ui-v1.6.5.zip"),
+            unzipDir: path.join(CACHE_DIR, "ui-v1.6.5"),
+            binaryPath: path.join(CACHE_DIR, "ui-v1.6.5", "server.bundle.js"),
+            opts: {
+                cacheDir: CACHE_DIR,
+                remoteUrl: "https://storage.googleapis.com/firebase-preview-drop/emulator/ui-v1.6.5.zip",
+                expectedSize: 3816994,
+                expectedChecksum: "92dfff4b2ef8ab616e8a60cc93e0a00b",
+                namePrefix: "ui",
+            },
         },
-    },
     pubsub: {
         downloadPath: path.join(CACHE_DIR, "pubsub-emulator-0.1.0.zip"),
         version: "0.1.0",

package/lib/emulator/emulatorLogger.js

@@ -13,6 +13,7 @@ const TYPE_VERBOSITY = {
     USER: 2,
     WARN: 2,
     WARN_ONCE: 2,
+    ERROR: 2,
 };
 var Verbosity;
 (function (Verbosity) {
@@ -79,6 +80,9 @@ class EmulatorLogger {
             case "SUCCESS":
                 utils.logSuccess(text, "info", mergedData);
                 break;
+            case "ERROR":
+                utils.logBullet(text, "error", mergedData);
+                break;
         }
     }
     handleRuntimeLog(log, ignore = []) {
@@ -196,6 +200,9 @@ You can probably fix this by running "npm install ${systemLog.data.name}@latest"
                     EmulatorLogger.warnOnceCache.add(text);
                 }
                 break;
+            case "ERROR":
+                utils.logLabeledError(label, text, "error", mergedData);
+                break;
         }
     }
     static shouldSupress(type) {